mirror of
https://github.com/fuffc/WeakestAuras.git
synced 2026-11-16 16:10:36 +00:00
Custom Check conditions and a performance pass - Conditions gain a "Custom Check": your own Lua, re-run on events you name. It is the only way to gate a condition on an aura's author options. - Shift-click a colour swatch to copy its colour, ctrl-click another to paste. - Author options honour soft slider bounds, clamp a number to the author's range, sort dropdowns alphabetically, and reset a single array entry. - Group custom code can read its children's options via aura_env.child_envs. - Performance improvement: the per-frame paths no longer allocate every frame. - /wa prof measures where time and allocations go. Off by default.
111 lines
5.1 KiB
Lua
111 lines
5.1 KiB
Lua
-- WeakestAuras -- Lua 5.0 shims the ported WeakAuras2 idioms lean on. Kept
|
|
-- deliberately small: only what's actually used, no speculative polyfills.
|
|
-- Upstream section refs (§N) point at design/architecture/weakauras2-reference.md
|
|
|
|
if WeakestAuras.disabled then return end
|
|
|
|
local WA = WeakestAuras
|
|
|
|
-- 5.1 added `math.huge`; 5.0 reads it back as nil, so `x or math.huge` inside a
|
|
-- comparison is a runtime error rather than the large number it looks like. The
|
|
-- division is how 5.0 spells the same infinity.
|
|
WA.INF = 1 / 0
|
|
|
|
-- One 2^32-millisecond period, in seconds -- the width of the engine's tick
|
|
-- counter expressed on GetTime()'s scale.
|
|
local TICK_WRAP = 4294967.296
|
|
|
|
-- Repairs a timestamp ClassicAPI read into a *signed* 32-bit int. Its
|
|
-- cooldown backports do `int startMs` and hand back `startMs * 0.001`
|
|
-- (src/spell/Cooldown.cpp, src/item/Cooldown.cpp -- the latter shared by
|
|
-- GetItemCooldown and C_Container.GetItemCooldown), while the engine's counter
|
|
-- is unsigned. Once the machine has been up past 2^31 ms (~24.9 days) every
|
|
-- timestamp from those two reads back exactly one period short, and negative:
|
|
-- a real start of 2697363.158 arrives as -1597604.138. A timestamp is never
|
|
-- legitimately negative, so the sign is the whole test.
|
|
--
|
|
-- Deliberately not applied everywhere: ClassicAPI's aura and cast paths cast
|
|
-- through uint32_t and are already right, as are vanilla's own
|
|
-- GetSpellCooldown/GetInventoryItemCooldown. Wrapping a correct value would
|
|
-- push it 49.7 days into the future.
|
|
function WA.UnwrapTick(t)
|
|
if t and t < 0 then return t + TICK_WRAP end
|
|
return t
|
|
end
|
|
|
|
-- 5.0 has no `wipe`; clearing keys in place preserves the table identity that
|
|
-- callers (memoization caches, per-tick scratch tables) hold a reference to.
|
|
function WA.wipe(t)
|
|
for k in pairs(t) do t[k] = nil end
|
|
return t
|
|
end
|
|
|
|
-- The first `n` *characters* of a UTF-8 string. A plain string.sub cuts on a
|
|
-- byte and can land inside a multi-byte sequence, which renders as a garbage
|
|
-- glyph -- and every accented spell name on this client is Latin-1 encoded as
|
|
-- UTF-8, so that is the common case rather than the exotic one. Continuation
|
|
-- bytes are 0x80-0xBF, so anything outside that range starts a character.
|
|
function WA.Utf8Sub(s, n)
|
|
if type(s) ~= "string" or type(n) ~= "number" or n < 0 then return s end
|
|
local len = string.len(s)
|
|
local chars = 0
|
|
for i = 1, len do
|
|
local b = string.byte(s, i)
|
|
if b < 128 or b >= 192 then
|
|
if chars == n then return string.sub(s, 1, i - 1) end
|
|
chars = chars + 1
|
|
end
|
|
end
|
|
return s
|
|
end
|
|
|
|
-- xpcall-wrapped call with the aura id prefixed onto any error, so a broken
|
|
-- aura reports itself and fails alone rather than taking down a whole tick
|
|
-- (§12's error-attribution pattern, minus the sandbox). 5.0's xpcall
|
|
-- takes no call args, so the arguments are staged in the file-locals below and
|
|
-- consumed by one persistent dispatcher -- capped at eleven, which is what the
|
|
-- widest call site needs: a compiled trigger function takes (state, event,
|
|
-- arg1..arg9). Returns the pcall-style (ok, result-or-error) so callers can
|
|
-- branch on success.
|
|
--
|
|
-- The staging is safe under nesting, and the reason is load-bearing: to execute
|
|
-- `return dfn(d1, ...)` Lua reads every one of these upvalues onto the stack
|
|
-- *before* the call, so by the time dfn's body runs -- the only place a nested
|
|
-- safecall can overwrite them -- the outer call has already consumed them. Do
|
|
-- not "simplify" this back to a fresh closure per call: safecall sits under
|
|
-- nearly every dispatch in the addon, and two closures per call was a real
|
|
-- share of the steady-state allocation churn.
|
|
local errHandler = function(err) return err end
|
|
local dfn, d1, d2, d3, d4, d5, d6, d7, d8, d9, d10, d11
|
|
local function dispatch()
|
|
return dfn(d1, d2, d3, d4, d5, d6, d7, d8, d9, d10, d11)
|
|
end
|
|
function WA.safecall(errTag, fn, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11)
|
|
if type(fn) ~= "function" then return false, "not a function" end
|
|
dfn = fn
|
|
d1, d2, d3, d4, d5, d6 = a1, a2, a3, a4, a5, a6
|
|
d7, d8, d9, d10, d11 = a7, a8, a9, a10, a11
|
|
local ok, res = xpcall(dispatch, errHandler)
|
|
if not ok then
|
|
-- The options preview runs trigger code that was written to read a live
|
|
-- event payload, and an aura opted into swallowing that (WA2's
|
|
-- ignoreOptionsEventErrors) wants the failure gone, not reported once per
|
|
-- preview. Nothing else sets this, and the one setter clears it in the
|
|
-- same call.
|
|
if WA.silenceErrors then return ok, res end
|
|
local message = "[" .. tostring(errTag) .. "] " .. tostring(res)
|
|
-- `errTag` is a label for a chat line, and half the call sites are not an
|
|
-- aura at all (Comm, the trigger-system dispatch), so it cannot key a
|
|
-- per-aura registry. The aura is read off the ambient instead; nil means
|
|
-- chat only, which is what a non-aura caller gets. Late-bound because this
|
|
-- file loads before both the registry and the aura environment.
|
|
local uid = WA.CurrentWarningUid and WA.CurrentWarningUid()
|
|
if uid and WA.UpdateWarning then
|
|
WA.UpdateWarning(uid, "runtime:" .. tostring(errTag), "error", message, true)
|
|
else
|
|
DEFAULT_CHAT_FRAME:AddMessage("|cffff0000WeakestAuras|r " .. message, 1, 0.3, 0.3)
|
|
end
|
|
end
|
|
return ok, res
|
|
end
|