wow/hotcorners: Libs/AceTimer-3.0/AceTimer-3.0.lua comparison

comparison Libs/AceTimer-3.0/AceTimer-3.0.lua @ 5:c31ee4251181

Libs Update

author	tercio
date	Tue, 25 Nov 2014 21:15:10 -0200
parents	fc346da3afd9
children	9ad7f3c634f1

comparison

equal deleted inserted replaced

-:453c68ff5d72
+:c31ee4251181
 --- **AceTimer-3.0** provides a central facility for registering timers.
 -- AceTimer supports one-shot timers and repeating timers. All timers are stored in an efficient
 -- data structure that allows easy dispatching and fast rescheduling. Timers can be registered
 -- or canceled at any time, even from within a running timer, without conflict or large overhead.\\
--- AceTimer is currently limited to firing timers at a frequency of 0.01s. This constant may change
+-- AceTimer is currently limited to firing timers at a frequency of 0.01s as this is what the WoW timer API
--- in the future, but for now it's required as animations with lower frequencies are buggy.
+-- restricts us to.
 --
 -- All `:Schedule` functions will return a handle to the current timer, which you will need to store if you
 -- need to cancel the timer you just registered.
 --
 -- **AceTimer-3.0** can be embeded into your addon, either explicitly by calling AceTimer:Embed(MyAddon) or by
 -- and can be accessed directly, without having to explicitly call AceTimer itself.\\
 -- It is recommended to embed AceTimer, otherwise you'll have to specify a custom `self` on all calls you
 -- make into AceTimer.
 -- @class file
 -- @name AceTimer-3.0
--- @release $Id: AceTimer-3.0.lua 1079 2013-02-17 19:56:06Z funkydude $
+-- @release $Id: AceTimer-3.0.lua 1119 2014-10-14 17:23:29Z nevcairiel $
-local MAJOR, MINOR = "AceTimer-3.0", 16 -- Bump minor on changes
+local MAJOR, MINOR = "AceTimer-3.0", 17 -- Bump minor on changes
 local AceTimer, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
 if not AceTimer then return end -- No upgrade needed
+AceTimer.activeTimers = AceTimer.activeTimers or {} -- Active timer list
-AceTimer.frame = AceTimer.frame or CreateFrame("Frame", "AceTimer30Frame") -- Animation parent
+local activeTimers = AceTimer.activeTimers -- Upvalue our private data
-AceTimer.inactiveTimers = AceTimer.inactiveTimers or {}                    -- Timer recycling storage
-AceTimer.activeTimers = AceTimer.activeTimers or {}                        -- Active timer list
 -- Lua APIs
-local type, unpack, next, error, pairs, tostring, select = type, unpack, next, error, pairs, tostring, select
+local type, unpack, next, error, select = type, unpack, next, error, select
+-- WoW APIs
--- Upvalue our private data
+local GetTime, C_TimerAfter = GetTime, C_Timer.After
-local inactiveTimers = AceTimer.inactiveTimers
-local activeTimers = AceTimer.activeTimers
-local function OnFinished(self)
-	local id = self.id
-	if type(self.func) == "string" then
-		-- We manually set the unpack count to prevent issues with an arg set that contains nil and ends with nil
-		-- e.g. local t = {1, 2, nil, 3, nil} print(#t) will result in 2, instead of 5. This fixes said issue.
-		self.object[self.func](self.object, unpack(self.args, 1, self.argsCount))
-	else
-		self.func(unpack(self.args, 1, self.argsCount))
-	end
-	-- If the id is different it means that the timer was already cancelled
-	-- and has been used to create a new timer during the OnFinished callback.
-	if not self.looping and id == self.id then
-		activeTimers[self.id] = nil
-		self.args = nil
-		inactiveTimers[self] = true
-	end
-end
 local function new(self, loop, func, delay, ...)
-	local timer = next(inactiveTimers)
-	if timer then
-		inactiveTimers[timer] = nil
-	else
-		local anim = AceTimer.frame:CreateAnimationGroup()
-		timer = anim:CreateAnimation()
-		timer:SetScript("OnFinished", OnFinished)
-	end
-	-- Very low delays cause the animations to fail randomly.
-	-- A limited resolution of 0.01 seems reasonable.
 	if delay < 0.01 then
-		delay = 0.01
+		delay = 0.01 -- Restrict to the lowest time that the C_Timer API allows us
 	end
+	local timer = {...}
 	timer.object = self
 	timer.func = func
 	timer.looping = loop
-	timer.args = {...}
 	timer.argsCount = select("#", ...)
+	timer.delay = delay
-	local anim = timer:GetParent()
+	timer.ends = GetTime() + delay
-	if loop then
-		anim:SetLooping("REPEAT")
+	activeTimers[timer] = timer
-	else
-		anim:SetLooping("NONE")
+	-- Create new timer closure to wrap the "timer" object
-	end
+	timer.callback = function()
-	timer:SetDuration(delay)
+		if not timer.cancelled then
+			if type(timer.func) == "string" then
-	local id = tostring(timer.args)
+				-- We manually set the unpack count to prevent issues with an arg set that contains nil and ends with nil
-	timer.id = id
+				-- e.g. local t = {1, 2, nil, 3, nil} print(#t) will result in 2, instead of 5. This fixes said issue.
-	activeTimers[id] = timer
+				timer.object[timer.func](timer.object, unpack(timer, 1, timer.argsCount))
+			else
-	anim:Play()
+				timer.func(unpack(timer, 1, timer.argsCount))
-	return id
+			end
+			if timer.looping and not timer.cancelled then
+				-- Compensate delay to get a perfect average delay, even if individual times don't match up perfectly
+				-- due to fps differences
+				local time = GetTime()
+				local delay = timer.delay - (time - timer.ends)
+				-- Ensure the delay doesn't go below the threshold
+				if delay < 0.01 then delay = 0.01 end
+				C_TimerAfter(delay, timer.callback)
+				timer.ends = time + delay
+			else
+				activeTimers[timer.handle or timer] = nil
+			end
+		end
+	end
+	C_TimerAfter(delay, timer.callback)
+	return timer
 end
 --- Schedule a new one-shot timer.
 -- The timer will fire once in `delay` seconds, unless canceled before.
 -- @param callback Callback function for the timer pulse (funcref or method name).
 -- Both one-shot and repeating timers can be canceled with this function, as long as the `id` is valid
 -- and the timer has not fired yet or was canceled before.
 -- @param id The id of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer`
 function AceTimer:CancelTimer(id)
 	local timer = activeTimers[id]
-	if not timer then return false end
+	if not timer then
-	local anim = timer:GetParent()
+		return false
-	anim:Stop()
+	else
+		timer.cancelled = true
-	activeTimers[id] = nil
+		activeTimers[id] = nil
-	timer.args = nil
+		return true
-	inactiveTimers[timer] = true
+	end
-	return true
 end
 --- Cancels all timers registered to the current addon object ('self')
 function AceTimer:CancelAllTimers()
 	for k,v in pairs(activeTimers) do
 -- This function will return 0 when the id is invalid.
 -- @param id The id of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer`
 -- @return The time left on the timer.
 function AceTimer:TimeLeft(id)
 	local timer = activeTimers[id]
-	if not timer then return 0 end
+	if not timer then
-	return timer:GetDuration() - timer:GetElapsed()
+		return 0
+	else
+		return timer.ends - GetTime()
+	end
 end
 -- ---------------------------------------------------------------------
 -- Upgrading
--- Upgrade from old hash-bucket based timers to animation timers
+-- Upgrade from old hash-bucket based timers to C_Timer.After timers.
 if oldminor and oldminor < 10 then
 	-- disable old timer logic
 	AceTimer.frame:SetScript("OnUpdate", nil)
 	AceTimer.frame:SetScript("OnEvent", nil)
 	AceTimer.frame:UnregisterAllEvents()
 	-- convert timers
 	for object,timers in pairs(AceTimer.selfs) do
 		for handle,timer in pairs(timers) do
 			if type(timer) == "table" and timer.callback then
-				local id
+				local newTimer
 				if timer.delay then
-					id = AceTimer.ScheduleRepeatingTimer(timer.object, timer.callback, timer.delay, timer.arg)
+					newTimer = AceTimer.ScheduleRepeatingTimer(timer.object, timer.callback, timer.delay, timer.arg)
 				else
-					id = AceTimer.ScheduleTimer(timer.object, timer.callback, timer.when - GetTime(), timer.arg)
+					newTimer = AceTimer.ScheduleTimer(timer.object, timer.callback, timer.when - GetTime(), timer.arg)
 				end
-				-- change id to the old handle
+				-- Use the old handle for old timers
-				local t = activeTimers[id]
+				activeTimers[newTimer] = nil
-				activeTimers[id] = nil
+				activeTimers[handle] = newTimer
-				activeTimers[handle] = t
+				newTimer.handle = handle
-				t.id = handle
 			end
 		end
 	end
 	AceTimer.selfs = nil
 	AceTimer.hash = nil
 	AceTimer.debug = nil
-elseif oldminor and oldminor < 13 then
+elseif oldminor and oldminor < 17 then
-	for handle, id in pairs(AceTimer.hashCompatTable) do
+	-- Upgrade from old animation based timers to C_Timer.After timers.
-		local t = activeTimers[id]
+	AceTimer.inactiveTimers = nil
-		if t then
+	AceTimer.frame = nil
-			activeTimers[id] = nil
+	local oldTimers = AceTimer.activeTimers
-			activeTimers[handle] = t
+	-- Clear old timer table and update upvalue
-			t.id = handle
+	AceTimer.activeTimers = {}
-		end
+	activeTimers = AceTimer.activeTimers
-	end
+	for handle, timer in pairs(oldTimers) do
-	AceTimer.hashCompatTable = nil
+		local newTimer
-end
+		-- Stop the old timer animation
+		local duration, elapsed = timer:GetDuration(), timer:GetElapsed()
--- upgrade existing timers to the latest OnFinished
+		timer:GetParent():Stop()
-for timer in pairs(inactiveTimers) do
+		if timer.looping then
-	timer:SetScript("OnFinished", OnFinished)
+			newTimer = AceTimer.ScheduleRepeatingTimer(timer.object, timer.func, duration, unpack(timer.args, 1, timer.argsCount))
-end
+		else
+			newTimer = AceTimer.ScheduleTimer(timer.object, timer.func, duration - elapsed, unpack(timer.args, 1, timer.argsCount))
-for _,timer in pairs(activeTimers) do
+		end
-	timer:SetScript("OnFinished", OnFinished)
+		-- Use the old handle for old timers
+		activeTimers[newTimer] = nil
+		activeTimers[handle] = newTimer
+		newTimer.handle = handle
+	end
+	-- Migrate transitional handles
+	if oldminor < 13 and AceTimer.hashCompatTable then
+		for handle, id in pairs(AceTimer.hashCompatTable) do
+			local t = activeTimers[id]
+			if t then
+				activeTimers[id] = nil
+				activeTimers[handle] = t
+				t.handle = handle
+			end
+		end
+		AceTimer.hashCompatTable = nil
+	end
 end
 -- ---------------------------------------------------------------------
 -- Embed handling

Mercurial > wow > hotcorners

comparison Libs/AceTimer-3.0/AceTimer-3.0.lua @ 5:c31ee4251181