From 6fb52d3ddf2f515fd0bf3c2e877793799f55cab5 Mon Sep 17 00:00:00 2001
From: Casey Raethke <casey.j.raethke@gmail.com>
Date: Wed, 30 Aug 2023 09:49:28 -0500
Subject: [PATCH] Change TipHooker from lib into single-purpose module

---
 .pkgmeta                             |  83 +++---
 RatingBuster.lua                     |  23 +-
 RatingBuster.toc                     |   3 +-
 RatingBuster_TBC.toc                 |   5 +-
 RatingBuster_Vanilla.toc             |   3 +-
 TipHooker.lua                        |  62 +++++
 embeds.xml                           |   2 -
 libs/TipHooker-1.0/TipHooker-1.0.lua | 378 ---------------------------
 8 files changed, 115 insertions(+), 444 deletions(-)
 create mode 100644 TipHooker.lua
 delete mode 100644 libs/TipHooker-1.0/TipHooker-1.0.lua

diff --git a/.pkgmeta b/.pkgmeta
index 401d6fc..09ee925 100644
--- a/.pkgmeta
+++ b/.pkgmeta
@@ -1,43 +1,40 @@
-package-as: RatingBuster
-
-externals:
-  libs/StatLogic/libs/LibStub:
-    url: https://repos.wowace.com/wow/libstub/trunk
-  libs/StatLogic/libs/AceLocale-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceLocale-3.0
-
-  libs/CallbackHandler-1.0:
-    url: https://repos.wowace.com/wow/callbackhandler/trunk/CallbackHandler-1.0
-  libs/AceConsole-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceConsole-3.0
-  libs/AceEvent-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceEvent-3.0
-  libs/AceTimer-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceTimer-3.0
-  libs/AceBucket-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceBucket-3.0
-  libs/AceDB-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceDB-3.0
-  libs/AceDBOptions-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceDBOptions-3.0
-  libs/AceAddon-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceAddon-3.0
-  libs/AceGUI-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceGUI-3.0
-  libs/AceConfig-3.0:
-    url: https://repos.wowace.com/wow/ace3/trunk/AceConfig-3.0
-  libs/LibDualSpec-1.0:
-    url: git://git.wowace.com/wow/libdualspec-1-0/mainline.git
-
-move-folders:
-  RatingBuster/libs/StatLogic: StatLogic
-
-ignore:
-  - *.txt
-  - *.jpg
-
-plain-copy:
-  - LICENSE.txt
-
-embedded-libraries:
-  - TipHookerLib
+package-as: RatingBuster
+
+externals:
+  libs/StatLogic/libs/LibStub:
+    url: https://repos.wowace.com/wow/libstub/trunk
+  libs/StatLogic/libs/AceLocale-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceLocale-3.0
+
+  libs/CallbackHandler-1.0:
+    url: https://repos.wowace.com/wow/callbackhandler/trunk/CallbackHandler-1.0
+  libs/AceConsole-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceConsole-3.0
+  libs/AceEvent-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceEvent-3.0
+  libs/AceTimer-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceTimer-3.0
+  libs/AceBucket-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceBucket-3.0
+  libs/AceDB-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceDB-3.0
+  libs/AceDBOptions-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceDBOptions-3.0
+  libs/AceAddon-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceAddon-3.0
+  libs/AceGUI-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceGUI-3.0
+  libs/AceConfig-3.0:
+    url: https://repos.wowace.com/wow/ace3/trunk/AceConfig-3.0
+  libs/LibDualSpec-1.0:
+    url: git://git.wowace.com/wow/libdualspec-1-0/mainline.git
+
+move-folders:
+  RatingBuster/libs/StatLogic: StatLogic
+
+ignore:
+  - *.txt
+  - *.jpg
+
+plain-copy:
+  - LICENSE.txt
\ No newline at end of file
diff --git a/RatingBuster.lua b/RatingBuster.lua
index b1fe4c5..637ef4b 100644
--- a/RatingBuster.lua
+++ b/RatingBuster.lua
@@ -1,4 +1,4 @@
-local addonName = ...
+local addonName, addon = ...
 
 --[[
 Name: RatingBuster
@@ -10,7 +10,6 @@ Description: Converts combat ratings in tooltips into normal percentages.
 ---------------
 -- Libraries --
 ---------------
-local TipHooker = LibStub("TipHooker-1.0")
 local StatLogic = LibStub("StatLogic")
 local GSM = function(...)
 	return StatLogic:GetStatMod(...)
@@ -1637,8 +1636,7 @@ end
 
 -- OnEnable() called at PLAYER_LOGIN
 function RatingBuster:OnEnable()
-	-- Hook item tooltips
-	TipHooker:Hook(self.ProcessTooltip, "item")
+	addon:EnableHook(self.ProcessTooltip)
 	-- Initialize playerLevel
 	playerLevel = UnitLevel("player")
 	-- for setting a new level
@@ -1649,8 +1647,7 @@ function RatingBuster:OnEnable()
 end
 
 function RatingBuster:OnDisable()
-	-- Unhook item tooltips
-	TipHooker:Unhook(self.ProcessTooltip, "item")
+	addon:DisableHook()
 end
 
 -- event = PLAYER_LEVEL_UP
@@ -3472,17 +3469,9 @@ function RatingBuster:StatSummary(tooltip, name, link)
 	-- Determine tooltipLevel and id
 	if globalDB.calcDiff and (globalDB.sumDiffStyle == "comp") then
 		-- Obtain main tooltip
-		for _, t in pairs(TipHooker.SupportedTooltips) do
-			if mainTooltip:IsOwned(t) then
-				mainTooltip = t
-				break
-			end
-		end
-		for _, t in pairs(TipHooker.SupportedTooltips) do
-			if mainTooltip:IsOwned(t) then
-				mainTooltip = t
-				break
-			end
+		local owner = tooltip:GetOwner()
+	    if owner.GetObjectType and owner:GetObjectType() == "GameTooltip" then
+			mainTooltip = owner
 		end
 		-- Detemine tooltip level
 		local _, mainlink, difflink1, difflink2 = StatLogic:GetDiffID(mainTooltip, globalDB.sumIgnoreEnchant, globalDB.sumIgnoreGems, globalDB.sumIgnoreExtraSockets, red, yellow, blue, meta)
diff --git a/RatingBuster.toc b/RatingBuster.toc
index 3d3e634..4b8f915 100644
--- a/RatingBuster.toc
+++ b/RatingBuster.toc
@@ -5,7 +5,7 @@
 ## Author: Whitetooth, raethkcj
 ## SavedVariables: RatingBusterDB
 ## Dependencies: StatLogic
-## OptionalDeps: Ace3, TipHookerLib, LibDualSpec-1.0
+## OptionalDeps: Ace3, LibDualSpec-1.0
 ## X-Category: Interface Enhancements
 ## X-License: GPL v2
 ## X-WoWI-ID: 26235
@@ -19,4 +19,5 @@ embeds.xml
 locales\locales.xml
 
 # Core
+TipHooker.lua
 RatingBuster.lua
diff --git a/RatingBuster_TBC.toc b/RatingBuster_TBC.toc
index 2700094..7daddd3 100644
--- a/RatingBuster_TBC.toc
+++ b/RatingBuster_TBC.toc
@@ -1,11 +1,11 @@
-## Interface: 20504
+## Interface: 20504
 ## Title: RatingBuster
 ## Notes: Item stat breakdown, analysis and comparing
 ## Notes-zhTW: 裝備數值解析與比較
 ## Author: Whitetooth, raethkcj
 ## SavedVariables: RatingBusterDB
 ## Dependencies: StatLogic
-## OptionalDeps: Ace3, TipHookerLib
+## OptionalDeps: Ace3
 ## X-Category: Interface Enhancements
 ## X-License: GPL v2
 ## X-WoWI-ID: 26235
@@ -19,4 +19,5 @@ embeds.xml
 locales\locales.xml
 
 # Core
+TipHooker.lua
 RatingBuster.lua
diff --git a/RatingBuster_Vanilla.toc b/RatingBuster_Vanilla.toc
index c188e40..4fcd672 100644
--- a/RatingBuster_Vanilla.toc
+++ b/RatingBuster_Vanilla.toc
@@ -5,7 +5,7 @@
 ## Author: Whitetooth, raethkcj
 ## SavedVariables: RatingBusterDB
 ## Dependencies: StatLogic
-## OptionalDeps: Ace3, TipHookerLib
+## OptionalDeps: Ace3
 ## X-Category: Interface Enhancements
 ## X-License: GPL v2
 ## X-WoWI-ID: 26235
@@ -19,4 +19,5 @@ embeds.xml
 locales\locales.xml
 
 # Core
+TipHooker.lua
 RatingBuster.lua
diff --git a/TipHooker.lua b/TipHooker.lua
new file mode 100644
index 0000000..ed7090f
--- /dev/null
+++ b/TipHooker.lua
@@ -0,0 +1,62 @@
+local _, addon = ...
+
+local handler
+local enabled = false
+
+local OnTooltipSetItem = function(tooltip)
+	if not tooltip.GetItem then return end
+	local name, link = tooltip:GetItem()
+	if not name then return end
+
+	if enabled then
+		handler(tooltip, name, link)
+	end
+end
+
+local TooltipList = {
+	"GameTooltip",
+	"ItemRefTooltip",
+	"ShoppingTooltip",
+	"LinkWrangler",
+	"AtlasLootTooltip",
+}
+
+local initialized = false
+local function InitializeHook()
+	local frame = EnumerateFrames()
+	while frame do
+	    if frame.GetObjectType and frame:GetObjectType() == "GameTooltip" then
+	        local name = frame:GetName()
+	        if name then
+		        for _, v in ipairs(TooltipList) do
+		        	if strfind(name, v) then
+						frame:HookScript("OnTooltipSetItem", OnTooltipSetItem)
+						break
+					end
+		        end
+		    end
+	    end
+	    frame = EnumerateFrames(frame)
+	end
+	initialized = true
+end
+
+local variablesLoaded = false
+EventRegistry:RegisterFrameEventAndCallbackWithHandle("VARIABLES_LOADED", function()
+	variablesLoaded = true
+	if handler and not initialized then
+		InitializeHook()
+	end
+end)
+
+function addon:EnableHook(h)
+	handler = h
+	if variablesLoaded and not initialized then
+		InitializeHook()
+	end
+	enabled = true
+end
+
+function addon:DisableHook()
+	enabled = false
+end
\ No newline at end of file
diff --git a/embeds.xml b/embeds.xml
index d398bcb..4f9ba7d 100644
--- a/embeds.xml
+++ b/embeds.xml
@@ -16,6 +16,4 @@
 		<Include file="libs\LibDualSpec-1.0\LibDualSpec-1.0.lua"/>
 	@end-non-debug@-->
 
-	<Script file="libs\TipHooker-1.0\TipHooker-1.0.lua"/>
-
 </Ui>
diff --git a/libs/TipHooker-1.0/TipHooker-1.0.lua b/libs/TipHooker-1.0/TipHooker-1.0.lua
deleted file mode 100644
index 4e5ca1f..0000000
--- a/libs/TipHooker-1.0/TipHooker-1.0.lua
+++ /dev/null
@@ -1,378 +0,0 @@
---[[
-Name: TipHooker-1.0
-Description: A Library for hooking tooltips.
-Revision: $Revision: 67029 $
-Author: Whitetooth@Cenarius (hotdogee@bahamut.twbbs.org)
-LastUpdate: $Date: 2008-03-30 13:22:17 +0800 (星期日, 30 三月 2008) $
-Website:
-Documentation:
-SVN: $URL: http://svn.wowace.com/wowace/trunk/TipHookerLib/TipHooker-1.0/TipHooker-1.0.lua $
-License: LGPL v2.1
-]]
-
--- This library is still in early development
-
---[[ Tips for using TipHooker
-{
-This library provides tooltip hooks, mainly for use with tooltip modification, you can eazily append or modify text in a tooltip with TipHookerLib.
-If you need to not only modify the tooltip but also need to scan the tooltip for information, you should use other libraries with TipHookerLib.
-Bedcause TipHookerLib passes the real tooltip frame to your handler function,
-which may already be modifided by other addons and may not be suited for scanning.
-For simple custom scaning you can use GratuityLib, it creates a custom tooltip and scan that for patterns.
-For a complete item scanning solution to stat scanning you can use ItemBonusLib, or my more light weight version: StatLogicLib.
-}
---]]
-
-
-local MAJOR_VERSION = "TipHooker-1.0"
-local MINOR_VERSION = tonumber(("$Revision: 67029 $"):sub(12, -3))
-
-local TipHooker = LibStub:NewLibrary(MAJOR_VERSION, MINOR_VERSION)
-local VariablesLoaded
-
------------
--- Tools --
------------
-local DEBUG = false
-
--- Localize globals
-local _G = getfenv(0)
-local select = select
-local pairs = pairs
-local ipairs = ipairs
-local IsAddOnLoaded = IsAddOnLoaded
-
-local function print(text)
-	if DEBUG then
-		DEFAULT_CHAT_FRAME:AddMessage(text)
-	end
-end
-
--- copyTable
-local function copyTable(to, from)
-	if not to then
-		to = {}
-	end
-	for k,v in pairs(from) do
-		if type(k) == "table" then
-			k = copyTable({}, k)
-		end
-		if type(v) == "table" then
-			v = copyTable({}, v)
-		end
-		to[k] = v
-	end
-	setmetatable(to, getmetatable(from))
-	return to
-end
-
------------------------
--- Hook Tooltip Core --
------------------------
-local TooltipList = {
-	item = {
-		"GameTooltip",
-		"ItemRefTooltip",
-		"ShoppingTooltip",
-		-- EquipCompare support
-		"ComparisonTooltip",
-		-- EQCompare support
-		"EQCompareTooltip",
-		-- takKompare support
-		"tekKompareTooltip",
-		-- LinkWrangler support
-		"IRR_",
-		"LinkWrangler",
-		-- MultiTips support
-		-- Links support
-		"LinksTooltip",
-		-- AtlasLoot support
-		"AtlasLootTooltip",
-		-- ItemMagic support
-		"ItemMagicTooltip",
-		-- Sniff support
-		"SniffTooltip",
-		-- LinkHeaven support
-		"LH_",
-		-- Mirror support
-		"MirrorTooltip",
-		-- TooltipExchange support
-		"TooltipExchange_TooltipShow",
-		-- AtlasQuest support
-		"AtlasQuestTooltip",
-	},
-	buff = {
-		"GameTooltip",
-	},
-	spell = {
-		"GameTooltip",
-	},
-	talant = {
-		"GameTooltip",
-	},
-	unit = {
-		"GameTooltip",
-	},
-	action = {
-		"GameTooltip",
-	},
-}
-
-local MethodList = {
-	item = {
-		"OnTooltipSetItem"
-	},
-	buff = {
-		"SetPlayerBuff",
-		"SetUnitBuff",
-		"SetUnitDebuff",
-	},
-	spell = {
-		"SetSpell",
-		"SetTrackingSpell",
-		"SetShapeshift",
-	},
-	talant = {
-		"SetTalent",
-	},
-	unit = {
-		"SetUnit",
-	},
-	action = {
-		"SetAction",
-		"SetPetAction",
-	},
-}
-
-local HandlerList = {}
-
-local Set = {
-	item = function(tooltip)
-		if not tooltip.GetItem then return end
-		local name, link = tooltip:GetItem()
-		-- Check for empty slots
-		if not name then return end
-		for handler in pairs(HandlerList.item) do
-			handler(tooltip, name, link)
-		end
-	end,
-	buff = function(tooltip, unitId, buffIndex, raidFilter)
-		if not unitId then
-			unitId = "player"
-		end
-		for handler in pairs(HandlerList.buff) do
-			handler(tooltip, unitId, buffIndex, raidFilter)
-		end
-	end,
-	spell = function(tooltip, spellId, bookType)
-		for handler in pairs(HandlerList.spell) do
-			handler(tooltip, spellId, bookType)
-		end
-	end,
-	talant = function(tooltip, tabIndex, talentIndex)
-		for handler in pairs(HandlerList.talant) do
-			handler(tooltip, tabIndex, talentIndex)
-		end
-	end,
-	unit = function(tooltip, unit)
-		if not tooltip.GetUnit then return end
-		local name = tooltip:GetUnit()
-		for handler in pairs(HandlerList.unit) do
-			handler(tooltip, unit)
-		end
-	end,
-	action = function(tooltip, slot)
-		for handler in pairs(HandlerList.action) do
-			handler(tooltip, slot)
-		end
-	end,
-}
-
-
--- This gets called during VARIABLES_LOADED and :Hook()
--- InitializeHook will hook all methods in MethodList[tipType]
--- from tooltips in TooltipList[tipType] to the Set[tipType] function
-local Initialized = {}
-TipHooker.SupportedTooltips = {}
-TipHooker.HookedFrames = {}
-local function InitializeHook(tipType)
-	if Initialized[tipType] then return end
-	-- Walk through all frames
-	local tooltip = EnumerateFrames()
-	while tooltip do
-	    if tooltip.GetObjectType and tooltip:GetObjectType() == "GameTooltip" then
-	        local name = tooltip:GetName()
-	        if name then
-		        for _, v in ipairs(TooltipList[tipType]) do
-		        	if strfind(name, v) then
-			        	print("InitializeHook("..tipType..") = "..name)
-						for _, methodName in ipairs(MethodList[tipType]) do
-							if type(tooltip[methodName]) == "function" then
-								hooksecurefunc(tooltip, methodName, Set[tipType])
-							elseif tooltip:HasScript(methodName) then
-								tooltip:HookScript(methodName, Set[tipType])
-							end
-						end
-						tinsert(TipHooker.SupportedTooltips, tooltip)
-						break
-					end
-		        end
-		    end
-	    end
-	    tooltip = EnumerateFrames(tooltip)
-	end
-	-- Destroy tooltip list so we don't have double hooking accidents
-	Initialized[tipType] = true
-end
-
-local function CreateFrameHook(frameType, name, parent, inheritFrame)
-	if name and frameType == "GameTooltip" then
-		for tipType in pairs(HandlerList) do
-	        for _, v in ipairs(TooltipList[tipType]) do
-	        	if strfind(name, v) then
-			        print("CreateFrameHook("..tipType..") = "..name)
-		        	local tooltip = _G[name]
-					for _, methodName in ipairs(MethodList[tipType]) do
-						-- prevent double hooking by checking HookedFrames table
-						if (type(tooltip[methodName]) == "function") and (not TipHooker.HookedFrames[name]) then
-							TipHooker.HookedFrames[name] = true
-							hooksecurefunc(tooltip, methodName, Set[tipType])
-						end
-					end
-					tinsert(TipHooker.SupportedTooltips, tooltip)
-					break
-				end
-	        end
-		end
-	end
-end
-
-
-------------------
--- OnEventFrame --
-------------------
-local OnEventFrame = CreateFrame("Frame")
-
-OnEventFrame:RegisterEvent("VARIABLES_LOADED")
---OnEventFrame:RegisterEvent("PLAYER_LOGIN")
-
-OnEventFrame:SetScript("OnEvent", function(self, event, ...)
-	print(event)
-	VariablesLoaded = true
-	print("VariablesLoaded = true")
-	-- Check for exsiting hooks
-	for tipType in pairs(HandlerList) do
-		InitializeHook(tipType)
-	end
-	hooksecurefunc("CreateFrame", CreateFrameHook)
-end)
-
-TipHooker.OnEventFrame = OnEventFrame
-
-
-----------------
--- Activation --
-----------------
--- Called when a newer version is registered
-local function activate(self, oldLib)
-	if not oldLib then
-		print("not oldLib")
-		-- HandlerList
-		self.HandlerList = HandlerList
-	else
-		print("oldLib")
-		oldLib.OnEventFrame:UnregisterAllEvents()
-		oldLib.OnEventFrame:SetScript("OnEvent", nil)
-		if oldLib.HandlerList then
-			HandlerList = oldLib.HandlerList
-		end
-		self.HandlerList = HandlerList
-	end
-end
-
-
---[[---------------------------------
-{	:Hook(handler, ...)
--------------------------------------
--- Description
-	Hooks tooltip SetX methods with handler
--- Args
-	handler
-	    func - handler func
-	...
-	    string - list of tooltips that you want to hook:
-	        "item": Items
-	        "buff": Buff/Debuff
-	        "spell": Spells
-	        "talant": Talants
-	        "unit": Units
-	        "action": Action button
--- Examples
-}
------------------------------------]]
-function TipHooker:Hook(handler, ...)
-	for i = 1, select('#', ...) do
-		local tipType = select(i, ...)
-		print("TipHooker:Hook("..tipType..")")
-		if VariablesLoaded then
-			InitializeHook(tipType)
-		end
-		if not HandlerList[tipType] then
-			HandlerList[tipType] = {}
-		end
-		HandlerList[tipType][handler] = true
-	end
-end
-
---[[---------------------------------
-{	:Unhook(handler, ...)
--------------------------------------
--- Description
-	Unhooks handler from tooltip SetX methods
--- Args
-	handler
-	    func - handler func
-	...
-	    string - list of tooltips that you want to hook:
-	        "item": Items
-	        "buff": Buff/Debuff
-	        "spell": Spells
-	        "talant": Talants
-	        "unit": Units
-	        "action": Action button
--- Examples
-}
------------------------------------]]
-function TipHooker:Unhook(handler, ...)
-	for i = 1, select('#', ...) do
-		local tipType = select(i, ...)
-		if HandlerList[tipType] then
-			HandlerList[tipType][handler] = nil
-		end
-	end
-end
-
---[[---------------------------------
-{	:IsHooked(handler, tipType)
--------------------------------------
--- Description
-	Unhooks handler from tooltip SetX methods
--- Args
-	handler
-	    func - handler func
-	tipType
-	    string - tooltip that you want to hook:
-	        "item": Items
-	        "buff": Buff/Debuff
-	        "spell": Spells
-	        "talant": Talants
-	        "unit": Units
-	        "action": Action button
--- Examples
-}
------------------------------------]]
-function TipHooker:IsHooked(handler, tipType)
-	if HandlerList[tipType] then
-		return HandlerList[tipType][handler]
-	end
-end
\ No newline at end of file