replace Ace3v with Ace3 ElvUI-TBC version

or easy tracking of code difference

ElvUI/Libraries/AceComm-3.0/AceComm-3.0.lua

@@ -9,7 +9,7 @@
 -- make into AceComm.
 -- @class file
 -- @name AceComm-3.0
--- @release $Id: AceComm-3.0.lua 1107 2014-02-19 16:40:32Z nevcairiel $
+-- @release $Id: AceComm-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $
 
 --[[ AceComm-3.0
 
@@ -17,25 +17,23 @@ TODO: Time out old data rotting around from dead senders? Not a HUGE deal since
 
 ]]
 
-local MAJOR, MINOR = "AceComm-3.0", 9
+local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0")
+local CTL = assert(ChatThrottleLib, "AceComm-3.0 requires ChatThrottleLib")
 
+local MAJOR, MINOR = "AceComm-3.0", 10
 local AceComm,oldminor = LibStub:NewLibrary(MAJOR, MINOR)
 
 if not AceComm then return end
 
-local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0")
-local CTL = assert(ChatThrottleLib, "AceComm-3.0 requires ChatThrottleLib")
-
 -- Lua APIs
 local type, next, pairs, tostring = type, next, pairs, tostring
-local strlen, strsub, strfind = string.len, string.sub, string.find
-local tinsert, tconcat, tgetn, tremove = table.insert, table.concat, table.getn, table.remove
+local strsub, strfind = string.sub, string.find
+local tinsert, tconcat = table.insert, table.concat
 local error, assert = error, assert
 
-
 -- 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, DEFAULT_CHAT_FRAME, geterrorhandler, RegisterAddonMessagePrefix
+-- GLOBALS: LibStub, DEFAULT_CHAT_FRAME, geterrorhandler
 
 AceComm.embeds = AceComm.embeds or {}
 
@@ -43,27 +41,21 @@ AceComm.embeds = AceComm.embeds or {}
 local MSG_MULTI_FIRST = "\001"
 local MSG_MULTI_NEXT  = "\002"
 local MSG_MULTI_LAST  = "\003"
-local MSG_ESCAPE = "\004"
 
--- remove old structures (pre WoW 4.0)
-AceComm.multipart_origprefixes = nil
-AceComm.multipart_reassemblers = nil
+AceComm.multipart_origprefixes = AceComm.multipart_origprefixes or {} -- e.g. "Prefix\001"="Prefix", "Prefix\002"="Prefix"
+AceComm.multipart_reassemblers = AceComm.multipart_reassemblers or {} -- e.g. "Prefix\001"="OnReceiveMultipartFirst"
 
 -- the multipart message spool: indexed by a combination of sender+distribution+
 AceComm.multipart_spool = AceComm.multipart_spool or {}
 
 --- Register for Addon Traffic on a specified prefix
--- @param prefix A printable character (\032-\255) classification of the message (typically AddonName or AddonNameEvent), max 16 characters
+-- @param prefix A printable character (\032-\255) classification of the message (typically AddonName or AddonNameEvent)
 -- @param method Callback to call on message reception: Function reference, or method name (string) to call on self. Defaults to "OnCommReceived"
 function AceComm:RegisterComm(prefix, method)
 	if method == nil then
 		method = "OnCommReceived"
 	end
 
-	if strlen(prefix) > 16 then -- TODO: 15?
-		error("AceComm:RegisterComm(prefix,method): prefix length is limited to 16 characters")
-	end
-
 	return AceComm._RegisterComm(self, prefix, method)	-- created by CallbackHandler
 end
 
@@ -88,10 +80,19 @@ function AceComm:SendCommMessage(prefix, text, distribution, target, prio, callb
 		error('Usage: SendCommMessage(addon, "prefix", "text", "distribution"[, "target"[, "prio"[, callbackFn, callbackarg]]])', 2)
 	end
 
-	local textlen = strlen(text)
-	-- Yes, the max is 255 even if the dev post said 256. I tested. Char 256+ get silently truncated. /Mikk, 20110327
-	-- Ace3v: substract the prefix length
-	local maxtextlen = 254 - strlen(prefix)
+	if strfind(prefix, "[\001-\009]") then
+		if strfind(prefix, "[\001-\003]") then
+			error("SendCommMessage: Characters \\001--\\003 in prefix are reserved for AceComm metadata", 2)
+		elseif not warnedPrefix then
+			-- I have some ideas about future extensions that require more control characters /mikk, 20090808
+			geterrorhandler()("SendCommMessage: Heads-up developers: Characters \\004--\\009 in prefix are reserved for AceComm future extension")
+			warnedPrefix = true
+		end
+	end
+
+
+	local textlen = #text
+	local maxtextlen = 254 - #prefix	-- 254 is the max length of prefix + text that can be sent in one message
 	local queueName = prefix..distribution..(target or "")
 
 	local ctlCallback = nil
@@ -101,38 +102,29 @@ function AceComm:SendCommMessage(prefix, text, distribution, target, prio, callb
 		end
 	end
 
-	local forceMultipart
-	if strfind(text, "^[\001-\009]") then -- 4.1+: see if the first character is a control character
-		-- we need to escape the first character with a \004
-		if textlen+1 > maxtextlen then	-- would we go over the size limit?
-			forceMultipart = true	-- just make it multipart, no escape problems then
-		else
-			text = "\004" .. text
-		end
-	end
-
-	if not forceMultipart and textlen <= maxtextlen then
+	if textlen <= maxtextlen then
 		-- fits all in one message
 		CTL:SendAddonMessage(prio, prefix, text, distribution, target, queueName, ctlCallback, textlen)
 	else
-		maxtextlen = maxtextlen - 1	-- 1 extra byte for part indicator in prefix(4.0)/start of message(4.1)
+		maxtextlen = maxtextlen - 1	-- 1 extra byte for part indicator in prefix
 
 		-- first part
 		local chunk = strsub(text, 1, maxtextlen)
-		CTL:SendAddonMessage(prio, prefix, MSG_MULTI_FIRST..chunk, distribution, target, queueName, ctlCallback, maxtextlen)
+		CTL:SendAddonMessage(prio, prefix..MSG_MULTI_FIRST, chunk, distribution, target, queueName, ctlCallback, maxtextlen)
 
 		-- continuation
 		local pos = 1+maxtextlen
+		local prefix2 = prefix..MSG_MULTI_NEXT
 
 		while pos+maxtextlen <= textlen do
 			chunk = strsub(text, pos, pos+maxtextlen-1)
-			CTL:SendAddonMessage(prio, prefix, MSG_MULTI_NEXT..chunk, distribution, target, queueName, ctlCallback, pos+maxtextlen-1)
+			CTL:SendAddonMessage(prio, prefix2, chunk, distribution, target, queueName, ctlCallback, pos+maxtextlen-1)
 			pos = pos + maxtextlen
 		end
 
 		-- final part
 		chunk = strsub(text, pos)
-		CTL:SendAddonMessage(prio, prefix, MSG_MULTI_LAST..chunk, distribution, target, queueName, ctlCallback, textlen)
+		CTL:SendAddonMessage(prio, prefix..MSG_MULTI_LAST, chunk, distribution, target, queueName, ctlCallback, textlen)
 	end
 end
 
@@ -147,8 +139,8 @@ do
 		local t = next(compost)
 		if t then
 			compost[t]=nil
-			for i=tgetn(t),3,-1 do	-- faster than pairs loop. don't even nil out 1/2 since they'll be overwritten
-				tremove(t)	-- Ace3v: t[i] = nil wont affect the tgetn return value
+			for i=#t,3,-1 do	-- faster than pairs loop. don't even nil out 1/2 since they'll be overwritten
+				t[i]=nil
 			end
 			return t
 		end
@@ -210,11 +202,11 @@ do
 		if type(olddata) == "table" then
 			-- if we've received a "next", the spooled data will be a table for rapid & garbage-free tconcat
 			tinsert(olddata, message)
-			AceComm.callbacks:Fire(prefix, 3, tconcat(olddata, ""), distribution, sender)
+			AceComm.callbacks:Fire(prefix, tconcat(olddata, ""), distribution, sender)
 			compost[olddata] = true
 		else
 			-- if we've only received a "first", the spooled data will still only be a string
-			AceComm.callbacks:Fire(prefix, 3, olddata..message, distribution, sender)
+			AceComm.callbacks:Fire(prefix, olddata..message, distribution, sender)
 		end
 	end
 end
@@ -229,40 +221,50 @@ end
 ----------------------------------------
 
 if not AceComm.callbacks then
+	-- ensure that 'prefix to watch' table is consistent with registered
+	-- callbacks
+	AceComm.__prefixes = {}
+
 	AceComm.callbacks = CallbackHandler:New(AceComm,
 						"_RegisterComm",
 						"UnregisterComm",
 						"UnregisterAllComm")
 end
 
-AceComm.callbacks.OnUsed = nil
-AceComm.callbacks.OnUnused = nil
+function AceComm.callbacks:OnUsed(target, prefix)
+	AceComm.multipart_origprefixes[prefix..MSG_MULTI_FIRST] = prefix
+	AceComm.multipart_reassemblers[prefix..MSG_MULTI_FIRST] = "OnReceiveMultipartFirst"
 
--- Ace3v: in vanilla, global vars:
---   event -> event type
---   arg1  -> prefix
---   arg2  -> message
---   arg3  -> channel
---   arg4  -> sender
-local function OnEvent()
-	local prefix, message, distribution, sender = arg1, arg2, arg3, arg4
+	AceComm.multipart_origprefixes[prefix..MSG_MULTI_NEXT] = prefix
+	AceComm.multipart_reassemblers[prefix..MSG_MULTI_NEXT] = "OnReceiveMultipartNext"
+
+	AceComm.multipart_origprefixes[prefix..MSG_MULTI_LAST] = prefix
+	AceComm.multipart_reassemblers[prefix..MSG_MULTI_LAST] = "OnReceiveMultipartLast"
+end
+
+function AceComm.callbacks:OnUnused(target, prefix)
+	AceComm.multipart_origprefixes[prefix..MSG_MULTI_FIRST] = nil
+	AceComm.multipart_reassemblers[prefix..MSG_MULTI_FIRST] = nil
+
+	AceComm.multipart_origprefixes[prefix..MSG_MULTI_NEXT] = nil
+	AceComm.multipart_reassemblers[prefix..MSG_MULTI_NEXT] = nil
+
+	AceComm.multipart_origprefixes[prefix..MSG_MULTI_LAST] = nil
+	AceComm.multipart_reassemblers[prefix..MSG_MULTI_LAST] = nil
+end
+
+local function OnEvent(this, event, ...)
 	if event == "CHAT_MSG_ADDON" then
-		local _, _, control, rest = strfind(message, "^([\001-\009])(.*)")
-		if control then
-			if control==MSG_MULTI_FIRST then
-				AceComm:OnReceiveMultipartFirst(prefix, rest, distribution, sender)
-			elseif control==MSG_MULTI_NEXT then
-				AceComm:OnReceiveMultipartNext(prefix, rest, distribution, sender)
-			elseif control==MSG_MULTI_LAST then
-				AceComm:OnReceiveMultipartLast(prefix, rest, distribution, sender)
-			elseif control==MSG_ESCAPE then
-				AceComm.callbacks:Fire(prefix, 3, rest, distribution, sender)
-			else
-				-- unknown control character, ignore SILENTLY (dont warn unnecessarily about future extensions!)
-			end
+		local prefix,message,distribution,sender = ...
+		local reassemblername = AceComm.multipart_reassemblers[prefix]
+		if reassemblername then
+			-- multipart: reassemble
+			local aceCommReassemblerFunc = AceComm[reassemblername]
+			local origprefix = AceComm.multipart_origprefixes[prefix]
+			aceCommReassemblerFunc(AceComm, origprefix, message, distribution, sender)
 		else
 			-- single part: fire it off immediately and let CallbackHandler decide if it's registered or not
-			AceComm.callbacks:Fire(prefix, 3, message, distribution, sender)
+			AceComm.callbacks:Fire(prefix, message, distribution, sender)
 		end
 	else
 		assert(false, "Received "..tostring(event).." event?!")
@@ -303,4 +305,4 @@ end
 -- Update embeds
 for target, v in pairs(AceComm.embeds) do
 	AceComm:Embed(target)
-end
+end

ElvUI/Libraries/AceComm-3.0/AceComm-3.0.xml

@@ -1,4 +1,5 @@
-<Ui xmlns="http://www.blizzard.com/wow/ui/">
+<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="ChatThrottleLib.lua"/>
 	<Script file="AceComm-3.0.lua"/>
 </Ui>

ElvUI/Libraries/AceComm-3.0/ChatThrottleLib.lua

@@ -20,15 +20,10 @@
 --
 -- Can run as a standalone addon also, but, really, just embed it! :-)
 --
--- LICENSE: ChatThrottleLib is released into the Public Domain
---
 
-local CTL_VERSION = 23
+local CTL_VERSION = 21
 
-local AceCore = LibStub("AceCore-3.0")
-local _G = AceCore._G
-local hooksecurefunc = AceCore.hooksecurefunc
-local wipe = AceCore.wipe
+local _G = _G
 
 if _G.ChatThrottleLib then
 	if _G.ChatThrottleLib.version >= CTL_VERSION then
@@ -70,7 +65,6 @@ ChatThrottleLib.MIN_FPS = 20				-- Reduce output CPS to half (and don't burst) i
 
 local setmetatable = setmetatable
 local table_remove = table.remove
-local tinsert = table.insert
 local tostring = tostring
 local GetTime = GetTime
 local math_min = math.min
@@ -78,9 +72,7 @@ local math_max = math.max
 local next = next
 local strlen = string.len
 local GetFramerate = GetFramerate
-local strlower = string.lower
-local unpack,type,pairs,wipe = unpack,type,pairs,wipe
-local UnitInRaid,UnitInParty = UnitInRaid,UnitInParty
+
 
 
 -----------------------------------------------------------------------
@@ -123,20 +115,24 @@ end
 
 -----------------------------------------------------------------------
 -- Recycling bin for pipes
--- A pipe is a plain integer-indexed queue of messages
--- Pipes normally live in Rings of pipes  (3 rings total, one per priority)
+-- A pipe is a plain integer-indexed queue, which also happens to be a ring member
 
 ChatThrottleLib.PipeBin = nil -- pre-v19, drastically different
 local PipeBin = setmetatable({}, {__mode="k"})
 
 local function DelPipe(pipe)
+	for i = #pipe, 1, -1 do
+		pipe[i] = nil
+	end
+	pipe.prev = nil
+	pipe.next = nil
+
 	PipeBin[pipe] = true
 end
 
 local function NewPipe()
 	local pipe = next(PipeBin)
 	if pipe then
-		wipe(pipe)
 		PipeBin[pipe] = nil
 		return pipe
 	end
@@ -213,12 +209,12 @@ function ChatThrottleLib:Init()
 		-- Use secure hooks as of v16. Old regular hook support yanked out in v21.
 		self.securelyHooked = true
 		--SendChatMessage
-		hooksecurefunc("SendChatMessage", function(text, chattype, language, destination)
-			return ChatThrottleLib.Hook_SendChatMessage(text, chattype, language, destination)
+		hooksecurefunc("SendChatMessage", function(...)
+			return ChatThrottleLib.Hook_SendChatMessage(...)
 		end)
 		--SendAddonMessage
-		hooksecurefunc("SendAddonMessage", function(prefix, text, chattype, destination)
-			return ChatThrottleLib.Hook_SendAddonMessage(prefix, text, chattype, destination)
+		hooksecurefunc("SendAddonMessage", function(...)
+			return ChatThrottleLib.Hook_SendAddonMessage(...)
 		end)
 	end
 	self.nBypass = 0
@@ -230,7 +226,7 @@ end
 
 local bMyTraffic = false
 
-function ChatThrottleLib.Hook_SendChatMessage(text, chattype, language, destination)
+function ChatThrottleLib.Hook_SendChatMessage(text, chattype, language, destination, ...)
 	if bMyTraffic then
 		return
 	end
@@ -239,13 +235,13 @@ function ChatThrottleLib.Hook_SendChatMessage(text, chattype, language, destinat
 	self.avail = self.avail - size
 	self.nBypass = self.nBypass + size	-- just a statistic
 end
-function ChatThrottleLib.Hook_SendAddonMessage(prefix, text, chattype, destination)
+function ChatThrottleLib.Hook_SendAddonMessage(prefix, text, chattype, destination, ...)
 	if bMyTraffic then
 		return
 	end
 	local self = ChatThrottleLib
-	local size = strlen(tostring(text or "")) + strlen(tostring(prefix or ""));
-	size = size + strlen(tostring(destination or "")) + self.MSG_OVERHEAD
+	local size = tostring(text or ""):len() + tostring(prefix or ""):len();
+	size = size + tostring(destination or ""):len() + self.MSG_OVERHEAD
 	self.avail = self.avail - size
 	self.nBypass = self.nBypass + size	-- just a statistic
 end
@@ -266,7 +262,7 @@ function ChatThrottleLib:UpdateAvail()
 		-- First 5 seconds after startup/zoning: VERY hard clamping to avoid irritating the server rate limiter, it seems very cranky then
 		avail = math_min(avail + (newavail*0.1), MAX_CPS*0.5)
 		self.bChoking = true
-	elseif GetFramerate() < self.MIN_FPS then		-- GetFrameRate call takes ~0.002 secs
+	elseif GetFramerate() < self.MIN_FPS then		-- GetFramerate call takes ~0.002 secs
 		avail = math_min(MAX_CPS, avail + newavail*0.5)
 		self.bChoking = true		-- just a statistic
 	else
@@ -285,16 +281,12 @@ end
 
 -----------------------------------------------------------------------
 -- Despooling logic
--- Reminder:
--- - We have 3 Priorities, each containing a "Ring" construct ...
--- - ... made up of N "Pipe"s (1 for each destination/pipename)
--- - and each pipe contains messages
 
 function ChatThrottleLib:Despool(Prio)
 	local ring = Prio.Ring
 	while ring.pos and Prio.avail > ring.pos[1].nSize do
-		local msg = table_remove(ring.pos, 1)
-		if not ring.pos[1] then  -- did we remove last msg in this pipe?
+		local msg = table_remove(Prio.Ring.pos, 1)
+		if not Prio.Ring.pos[1] then
 			local pipe = Prio.Ring.pos
 			Prio.Ring:Remove(pipe)
 			Prio.ByName[pipe.name] = nil
@@ -302,31 +294,20 @@ function ChatThrottleLib:Despool(Prio)
 		else
 			Prio.Ring.pos = Prio.Ring.pos.next
 		end
-		local didSend=false
-		local lowerDest = strlower(msg[3] or "")
-		if lowerDest == "raid" and not UnitInRaid("player") then
-			-- do nothing
-		elseif lowerDest == "party" and not UnitInParty("player") then
-			-- do nothing
-		else
-			Prio.avail = Prio.avail - msg.nSize
-			bMyTraffic = true
-			msg.f(unpack(msg, 1, msg.n))
-			bMyTraffic = false
-			Prio.nTotalSent = Prio.nTotalSent + msg.nSize
-			DelMsg(msg)
-			didSend = true
-		end
-		-- notify caller of delivery (even if we didn't send it)
+		Prio.avail = Prio.avail - msg.nSize
+		bMyTraffic = true
+		msg.f(unpack(msg, 1, msg.n))
+		bMyTraffic = false
+		Prio.nTotalSent = Prio.nTotalSent + msg.nSize
+		DelMsg(msg)
 		if msg.callbackFn then
-			msg.callbackFn (msg.callbackArg, didSend)
+			msg.callbackFn (msg.callbackArg)
 		end
-		-- USER CALLBACK MAY ERROR
 	end
 end
 
 
-function ChatThrottleLib.OnEvent()
+function ChatThrottleLib.OnEvent(this,event)
 	-- v11: We know that the rate limiter is touchy after login. Assume that it's touchy after zoning, too.
 	local self = ChatThrottleLib
 	if event == "PLAYER_ENTERING_WORLD" then
@@ -336,10 +317,10 @@ function ChatThrottleLib.OnEvent()
 end
 
 
-function ChatThrottleLib.OnUpdate()
+function ChatThrottleLib.OnUpdate(this,delay)
 	local self = ChatThrottleLib
 
-	self.OnUpdateDelay = self.OnUpdateDelay + arg1
+	self.OnUpdateDelay = self.OnUpdateDelay + delay
 	if self.OnUpdateDelay < 0.08 then
 		return
 	end
@@ -393,6 +374,7 @@ end
 -----------------------------------------------------------------------
 -- Spooling logic
 
+
 function ChatThrottleLib:Enqueue(prioname, pipename, msg)
 	local Prio = self.Prio[prioname]
 	local pipe = Prio.ByName[pipename]
@@ -404,11 +386,13 @@ function ChatThrottleLib:Enqueue(prioname, pipename, msg)
 		Prio.Ring:Add(pipe)
 	end
 
-	tinsert(pipe,msg)
+	pipe[#pipe + 1] = msg
 
 	self.bQueueing = true
 end
 
+
+
 function ChatThrottleLib:SendChatMessage(prio, prefix,   text, chattype, language, destination, queueName, callbackFn, callbackArg)
 	if not self or not prio or not prefix or not text or not self.Prio[prio] then
 		error('Usage: ChatThrottleLib:SendChatMessage("{BULK||NORMAL||ALERT}", "prefix", "text"[, "chattype"[, "language"[, "destination"]]]', 2)
@@ -417,7 +401,7 @@ function ChatThrottleLib:SendChatMessage(prio, prefix,   text, chattype, languag
 		error('ChatThrottleLib:ChatMessage(): callbackFn: expected function, got '..type(callbackFn), 2)
 	end
 
-	local nSize = strlen(text)
+	local nSize = text:len()
 
 	if nSize>255 then
 		error("ChatThrottleLib:SendChatMessage(): message length cannot exceed 255 bytes", 2)
@@ -433,9 +417,8 @@ function ChatThrottleLib:SendChatMessage(prio, prefix,   text, chattype, languag
 		bMyTraffic = false
 		self.Prio[prio].nTotalSent = self.Prio[prio].nTotalSent + nSize
 		if callbackFn then
-			callbackFn (callbackArg, true)
+			callbackFn (callbackArg)
 		end
-		-- USER CALLBACK MAY ERROR
 		return
 	end
 
@@ -463,17 +446,10 @@ function ChatThrottleLib:SendAddonMessage(prio, prefix, text, chattype, target,
 		error('ChatThrottleLib:SendAddonMessage(): callbackFn: expected function, got '..type(callbackFn), 2)
 	end
 
-	local nSize = strlen(text);
+	local nSize = prefix:len() + 1 + text:len();
 
-	if RegisterAddonMessagePrefix then
-		if nSize>255 then
-			error("ChatThrottleLib:SendAddonMessage(): message length cannot exceed 255 bytes", 2)
-		end
-	else
-		nSize = nSize + strlen(prefix) + 1
-		if nSize>255 then
-			error("ChatThrottleLib:SendAddonMessage(): prefix + message length cannot exceed 254 bytes", 2)
-		end
+	if nSize>255 then
+		error("ChatThrottleLib:SendAddonMessage(): prefix + message length cannot exceed 254 bytes", 2)
 	end
 
 	nSize = nSize + self.MSG_OVERHEAD;
@@ -486,9 +462,8 @@ function ChatThrottleLib:SendAddonMessage(prio, prefix, text, chattype, target,
 		bMyTraffic = false
 		self.Prio[prio].nTotalSent = self.Prio[prio].nTotalSent + nSize
 		if callbackFn then
-			callbackFn (callbackArg, true)
+			callbackFn (callbackArg)
 		end
-		-- USER CALLBACK MAY ERROR
 		return
 	end
 
@@ -525,3 +500,4 @@ if(WOWB_VER) then
 end
 ]]
 
+