15 Commits

Author SHA1 Message Date
florian.berthold 967bec7bde refactor(sortBtn): drop dead accumulator left after DoContainerMoves rewrite
release / release (push) Successful in 3s
2026-05-29 10:43:54 +02:00
florian.berthold 5ad41f372b ci: respect GITHUB_REPOSITORY + tolerate per-asset upload failures
release / release (push) Successful in 3s
2026-05-25 12:16:11 +02:00
florian.berthold 52f1f79c6a ci: add Gitea Actions release workflow (per-addon git-archive zip)
release / release (push) Successful in 3s
2026-05-25 12:01:28 +02:00
florian.berthold 576484b04b chore: remove .github/ (upstream templates, not relevant on Gitea) 2026-05-25 11:02:44 +02:00
florian.berthold 8745782014 chore(libs): sync Ace3 to coa-ace3 (WoWUIDev master @ 52e5f2c)
Bring every embedded Ace3 / CallbackHandler / LibStub copy in line with the
canonical Exiles/coa-ace3 bundle so LibStub resolution is predictable across
all Exiles forks regardless of which addons are enabled.

Libraries updated in this fork:
  AceAddon-3.0           13  (5 → 13)
  AceBucket-3.0          4
  AceConsole-3.0         7
  AceEvent-3.0           4  (3 → 4)
  AceLocale-3.0          6  (2 → 6)
  AceTimer-3.0           17  (5 → 17)
  CallbackHandler-1.0    8  (5 → 8)
  LibStub                2
2026-05-23 13:42:15 +02:00
florian.berthold da2d323018 fix(sort): refuse to sort inventory when read is inconsistent with server
Post-sort holes were caused by the planning phase, not the execution
phase. When GetContainerItemInfo/Link transiently returns nil for an
occupied slot during server lag, CreateBagFromID marks it <EMPTY>, the
sort algorithm moves real items into that "destination", and we end up
with literal gaps where the misclassified items used to be.

Validate the read against GetContainerNumFreeSlots before sorting; if
counts disagree, print a chat warning and abort instead of corrupting
the layout. User retries after a moment.
2026-05-16 10:36:16 +02:00
florian.berthold 844f9c8a4e fix(sort): retry failed pickups instead of dropping moves on lag
DoContainerMoves dropped moves entirely when PickupContainerItem didn't
land on the cursor — on a laggy server this fires constantly because
the previous swap's client state hasn't propagated yet, leaving items
un-sorted. Retry up to MAX_PICKUP_RETRIES (8 * 150ms = 1.2s) before
giving up. Also bump CONTAINER_SWAP_DELAY 50ms -> 150ms; the inline
comment already pointed at this as the knob to raise on desyncs.
2026-05-15 20:21:26 +02:00
florian.berthold f132bb1861 fix(items): also handle first-render-under-lag empty slots
Previous grace-window fix only kicked in when self.hasItem was already
set, so first-render-under-lag (login/reloadui while bag data is in
flight) still drew empty. Arm a single re-verify on any nil read so a
late-arriving item gets redrawn; the verifyArmed flag prevents
re-scheduling on genuinely empty slots — it only clears when we see a
valid link.
2026-05-15 19:53:49 +02:00
florian.berthold c955937b12 fix(items): grace window for nil-after-occupied without retry polling
GetContainerItemInfo returns nil for some occupied slots during server
lag, causing Bagnon to draw the slot empty. Earlier retry-polling
approach caused massive lag because every legitimately emptied slot
also matched the "previously had item, now nil" condition and ran ~30
live reads over 3s per move.

New approach: on a nil-after-occupied read, if we're within
GRACE_WINDOW (0.5s) of the last good draw, keep the prior draw and
queue ONE re-check at the deadline — no polling. A genuinely emptied
slot resolves at the deadline; a recovered slot redraws with correct
data. lastGoodTime is set only on non-nil reads, so persistent lag
eventually accepts the empty.
2026-05-15 16:13:34 +02:00
florian.berthold 592808792a Revert "fix(items): defer empty draw when slot reads nil after lag"
This reverts commit 1af22578d7.
2026-05-14 06:20:03 +02:00
florian.berthold af80a3003d Revert "fix(items): keep retrying nil slot reads instead of accepting after one pass"
This reverts commit 60e3cea9fd.
2026-05-14 06:20:03 +02:00
florian.berthold 0eaf815f61 Revert "fix(items): retry render when slot reads nil for a previously occupied slot"
This reverts commit 770695dc77.
2026-05-14 06:20:03 +02:00
florian.berthold 770695dc77 fix(items): retry render when slot reads nil for a previously occupied slot
The event-level retry only protected the ITEM_SLOT_UPDATE broadcast, but
ItemSlot:Update() reads GetContainerItemInfo live on every call and is
invoked from many paths (OnShow → ReloadAllItemSlots, AddItemSlot,
BAG_UPDATE_TYPE, search updates). On a laggy server those live reads
flash slots empty. Add a shared retry queue at the slot-render level so
a slot with self.hasItem set will defer rather than draw nil; cap at
RENDER_RETRY_MAX so a genuinely emptied slot still resolves within ~3s.
2026-05-14 04:27:35 +02:00
florian.berthold 60e3cea9fd fix(items): keep retrying nil slot reads instead of accepting after one pass
Single-retry was still flashing slots empty on the inventory when lag
exceeded 0.25s — the retry pass would read nil and broadcast the empty.
Track a per-slot retry counter (capped at RETRY_MAX=12, ~3s) so we keep
deferring until the link comes back or we hit the ceiling. Bank was
never affected — it goes through PLAYERBANKSLOTS_CHANGED, not BAG_UPDATE.
2026-05-14 02:12:38 +02:00
florian.berthold 1af22578d7 fix(items): defer empty draw when slot reads nil after lag
Under server lag BAG_UPDATE can fire before item data arrives, causing
GetContainerItemInfo to return nil for a still-occupied slot and Bagnon
to broadcast ITEM_SLOT_UPDATE with no link — the slot then renders empty
until the next bag event. UpdateItem now queues a single ~0.25s retry
for the bag when a previously occupied slot reads nil; the retry pass
trusts whatever it reads, so genuine empties still resolve.
2026-05-14 01:50:42 +02:00
20 changed files with 615 additions and 758 deletions
+71
View File
@@ -0,0 +1,71 @@
name: release
on:
push:
tags:
- '*-coa.*' # Asc-1.1.6-coa.2, 9.1.40-coa.3, etc.
- 'v*' # v0.3.0 for repos without an upstream version
jobs:
release:
runs-on: linux-amd64
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # build_zip uses git archive HEAD; full history is fine
- name: Build per-addon zip(s)
run: bash tools/build_zip.sh
- name: Publish release (Gitea API direct; no action dependency)
env:
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
REPO: ${{ github.repository }}
TAG: ${{ github.ref_name }}
API: ${{ github.server_url }}/api/v1
# Gitea attachment ceiling is 200 MiB (see roles/gitea config).
# Skip anything larger so one oversized asset doesn't fail the job.
MAX_BYTES: 209715200
run: |
set -euo pipefail
# Create the release (or reuse if it already exists for this tag).
RID=$(curl -s -H "Authorization: token $GITEA_TOKEN" \
"$API/repos/$REPO/releases/tags/$TAG" 2>/dev/null \
| jq -r '.id // empty')
if [ -z "$RID" ]; then
RID=$(curl -sf -X POST -H "Authorization: token $GITEA_TOKEN" \
-H "Content-Type: application/json" \
"$API/repos/$REPO/releases" \
-d "$(jq -nc --arg t "$TAG" '{tag_name:$t,name:$t,draft:false,prerelease:false}')" \
| jq -r '.id')
fi
echo "release id: $RID"
# Upload every dist/*.zip. Per-asset failures don't fail the job —
# we want partial releases to still publish rather than block the
# whole pipeline on one big file.
failed=0
uploaded=0
for f in dist/*.zip; do
name=$(basename "$f")
size=$(stat -c '%s' "$f")
if [ "$size" -gt "$MAX_BYTES" ]; then
echo "::warning::skip $name (${size} B > ${MAX_BYTES} B Gitea limit; host on CDN instead)"
failed=$((failed+1))
continue
fi
echo "uploading $name ($(numfmt --to=iec "$size"))"
if curl -sf -X POST -H "Authorization: token $GITEA_TOKEN" \
-F "attachment=@$f" \
"$API/repos/$REPO/releases/$RID/assets?name=$name" \
| jq -r '" -> " + .browser_download_url'; then
uploaded=$((uploaded+1))
else
echo "::warning::upload failed for $name"
failed=$((failed+1))
fi
done
echo "release published: $uploaded uploaded, $failed skipped/failed"
# Only fail the job if NO assets uploaded — a release with zero
# attachments isn't useful to anyone.
[ "$uploaded" -gt 0 ]
-77
View File
@@ -1,77 +0,0 @@
name: "Bug Report"
description: Create a report to help us improve this addon
labels: '🐛 Bug'
body:
- type: markdown
attributes:
value: |
Please search for existing issues before creating a new one.
- type: textarea
attributes:
label: Description
description: What did you expect to happen and what happened instead?
validations:
required: true
- type: dropdown
id: flavor
attributes:
label: Realm
description: What realm did this occur on?
options:
- Area 52 (Default)
- Seasonal
- Grizzly Hills
- Rexxar
- Other
validations:
required: true
- type: checkboxes
id: testing
attributes:
label: Tested with only this addon
description: Did you try having just this addon as the only enabled addon and everything else disabled?
options:
- label: "Yes"
- label: "No"
validations:
required: true
- type: textarea
attributes:
label: Lua Error
description: |
Do you have an error log of what happened? If you don't see any errors, make sure that error reporting is enabled (`/console scriptErrors 1`)
validations:
required: false
- type: textarea
attributes:
label: Reproduction Steps
description: Please list out the steps to reproduce your bug.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: input
attributes:
label: Last Good Version
description: |
Was it working in a previous version? If yes, which update did it stop working? If you don't know, when was the last date you were aware it was working
placeholder: "MM/DD/YYYY"
validations:
required: false
- type: textarea
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
placeholder: Click here to attach your screenshots via the editor button in the top right.
validations:
required: false
-1
View File
@@ -1 +0,0 @@
blank_issues_enabled: false
-20
View File
@@ -1,20 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
-28
View File
@@ -1,28 +0,0 @@
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
<!-- A #issueNumber will be sufficient. -->
Fixes #(issue)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
## How Has This Been Tested
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
- [ ] Test A
- [ ] Test B
## Checklist
<!-- These can be checked off after the pull request is submitted, in case you want discussion before they are completely ready -->
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
<!-- Is there any additional work that needs to be done? If so, add it to the above list -->
+2 -1
View File
@@ -4,4 +4,5 @@
.install .install
.lua/* .lua/*
.vscode .vscode
.idea .idea
dist/
+53
View File
@@ -248,12 +248,65 @@ end
--[[ Update Methods ]] --[[ Update Methods ]]
-- --
-- Lag-race protection for slots that read nil briefly after being occupied.
-- When this happens we keep the prior draw and schedule ONE re-check at the
-- grace deadline; we never poll. After the deadline, whatever the live read
-- says wins, so genuinely emptied slots resolve within GRACE_WINDOW seconds.
local GRACE_WINDOW = 0.5
local pendingVerify = {} -- slot -> deadline (GetTime)
local verifyFrame = CreateFrame('Frame')
verifyFrame:Hide()
verifyFrame:SetScript('OnUpdate', function(self, elapsed)
self.tick = (self.tick or 0) + elapsed
if self.tick < 0.1 then return end
self.tick = 0
local now = GetTime()
for slot, deadline in pairs(pendingVerify) do
if now >= deadline then
pendingVerify[slot] = nil
if slot:IsVisible() then
slot:Update()
end
end
end
if not next(pendingVerify) then
self:Hide()
end
end)
local function scheduleVerify(slot)
if pendingVerify[slot] then return end
pendingVerify[slot] = GetTime() + GRACE_WINDOW
verifyFrame:Show()
end
-- Update the texture, lock status, and other information about an item -- Update the texture, lock status, and other information about an item
function ItemSlot:Update() function ItemSlot:Update()
if not self:IsVisible() then return end if not self:IsVisible() then return end
local texture, count, locked, quality, readable, lootable, link = self:GetItemSlotInfo() local texture, count, locked, quality, readable, lootable, link = self:GetItemSlotInfo()
local now = GetTime()
-- Any nil read might be a lag race (server hasn't delivered item data
-- yet). Arm a single re-check so a late arrival redraws correctly. The
-- flag stays armed until we see a valid link, so a genuinely empty slot
-- doesn't keep re-scheduling.
if not link then
if not self.verifyArmed then
self.verifyArmed = true
scheduleVerify(self)
end
-- If we had a confirmed item recently, also suppress the empty draw
-- so the slot doesn't flash. After the grace window we let the empty
-- through (genuine moves still resolve at ~0.5s).
if self.hasItem and (self.lastGoodTime or 0) + GRACE_WINDOW > now then
return
end
else
self.lastGoodTime = now
self.verifyArmed = nil
end
self:SetItem(link) self:SetItem(link)
self:SetTexture(texture) self:SetTexture(texture)
+45 -5
View File
@@ -14,7 +14,6 @@ local NORMAL_TEXTURE_SIZE = 64 * (SIZE / 36)
-- Bag Sorter code from Sushi Regular -- Bag Sorter code from Sushi Regular
local moves = {}; local moves = {};
local frame = CreateFrame("Frame"); local frame = CreateFrame("Frame");
local t = 0;
local current = nil; local current = nil;
local isGuildBankSort = false; local isGuildBankSort = false;
@@ -86,9 +85,13 @@ end
-- Minimum time between starting consecutive container swaps. Blasting them -- Minimum time between starting consecutive container swaps. Blasting them
-- back-to-back outpaces the realm server (which rate-limits inbound packets) -- back-to-back outpaces the realm server (which rate-limits inbound packets)
-- and the predicted client state desyncs after ~10 moves. 50ms = ~20 swaps/sec -- and the predicted client state desyncs after ~10 moves. 150ms = ~6 swaps/sec
-- sustained; raise this if you see desyncs, lower it if your ping is very low. -- sustained; raise if you see desyncs, lower if your ping is very low.
local CONTAINER_SWAP_DELAY = 0.05 local CONTAINER_SWAP_DELAY = 0.15
-- A pickup that doesn't land on the cursor is almost always a lag race where
-- the previous swap's state hasn't propagated yet. Retry instead of dropping
-- the move (which used to leave items un-sorted on laggy servers).
local MAX_PICKUP_RETRIES = 8
local nextSwapAt = 0 local nextSwapAt = 0
local function DoContainerMoves() local function DoContainerMoves()
@@ -119,10 +122,18 @@ local function DoContainerMoves()
PickupContainerItem(move.sourcebag, move.sourceslot) PickupContainerItem(move.sourcebag, move.sourceslot)
if not CursorHasItem() then if not CursorHasItem() then
-- Source slot empty/locked; drop the move and try the next. -- Pickup didn't take. On a laggy server this usually means the
-- previous swap's client state hasn't caught up; retry a few times
-- before giving up so we don't silently drop the move.
move.retries = (move.retries or 0) + 1
if move.retries < MAX_PICKUP_RETRIES then
nextSwapAt = GetTime() + CONTAINER_SWAP_DELAY
return
end
table.remove(moves, 1) table.remove(moves, 1)
return return
end end
move.retries = nil
PickupContainerItem(move.targetbag, move.targetslot) PickupContainerItem(move.targetbag, move.targetslot)
if CursorHasItem() then if CursorHasItem() then
@@ -245,6 +256,23 @@ local function SortBag(bag)
end end
end end
-- Returns true iff every slot in `bagID` whose GetContainerItemLink is nil
-- is also reported empty by GetContainerNumFreeSlots. When the server is
-- laggy GetContainerItemInfo/Link can transiently return nil for slots that
-- actually contain items; sorting on that snapshot generates moves that
-- treat occupied slots as empty destinations, leaving holes in the result.
local function IsBagReadConsistent(bagID)
local slots = GetContainerNumSlots(bagID) or 0
local reportedFree = select(1, GetContainerNumFreeSlots(bagID)) or 0
local actualEmpty = 0
for s = 1, slots do
if not GetContainerItemLink(bagID, s) then
actualEmpty = actualEmpty + 1
end
end
return actualEmpty == reportedFree, actualEmpty, reportedFree
end
local function CreateBagFromID(bagID) local function CreateBagFromID(bagID)
local items = GetContainerNumSlots(bagID); local items = GetContainerNumSlots(bagID);
local bag = {}; local bag = {};
@@ -337,6 +365,18 @@ function SortBtn:OnClick()
local bags = {}; local bags = {};
if self.frameID == "inventory" then if self.frameID == "inventory" then
-- Refuse to sort if any bag's read is inconsistent with the server's
-- reported free-slot count — sorting on that snapshot is what causes
-- the post-sort holes on a laggy server.
for i = 0, NUM_BAG_FRAMES, 1 do
local ok, empty, reported = IsBagReadConsistent(i)
if not ok then
DEFAULT_CHAT_FRAME:AddMessage(format(
"|cFFFFAA00Bagnon: bag %d not fully loaded (read %d empty, server says %d) — try sort again in a moment.|r",
i, empty, reported))
return
end
end
isGuildBankSort = false; isGuildBankSort = false;
for i = 0, NUM_BAG_FRAMES, 1 do for i = 0, NUM_BAG_FRAMES, 1 do
local bag = CreateBagFromID(i); local bag = CreateBagFromID(i);
+113 -106
View File
@@ -6,31 +6,31 @@
-- * **OnEnable** which gets called during the PLAYER_LOGIN event, when most of the data provided by the game is already present. -- * **OnEnable** which gets called during the PLAYER_LOGIN event, when most of the data provided by the game is already present.
-- * **OnDisable**, which is only called when your addon is manually being disabled. -- * **OnDisable**, which is only called when your addon is manually being disabled.
-- @usage -- @usage
-- -- A small (but complete) addon, that doesn't do anything, -- -- A small (but complete) addon, that doesn't do anything,
-- -- but shows usage of the callbacks. -- -- but shows usage of the callbacks.
-- local MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon") -- local MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon")
-- --
-- function MyAddon:OnInitialize() -- function MyAddon:OnInitialize()
-- -- do init tasks here, like loading the Saved Variables, -- -- do init tasks here, like loading the Saved Variables,
-- -- or setting up slash commands. -- -- or setting up slash commands.
-- end -- end
-- --
-- function MyAddon:OnEnable() -- function MyAddon:OnEnable()
-- -- Do more initialization here, that really enables the use of your addon. -- -- Do more initialization here, that really enables the use of your addon.
-- -- Register Events, Hook functions, Create Frames, Get information from -- -- Register Events, Hook functions, Create Frames, Get information from
-- -- the game that wasn't available in OnInitialize -- -- the game that wasn't available in OnInitialize
-- end -- end
-- --
-- function MyAddon:OnDisable() -- function MyAddon:OnDisable()
-- -- Unhook, Unregister Events, Hide frames that you created. -- -- Unhook, Unregister Events, Hide frames that you created.
-- -- You would probably only use an OnDisable if you want to -- -- You would probably only use an OnDisable if you want to
-- -- build a "standby" mode, or be able to toggle modules on/off. -- -- build a "standby" mode, or be able to toggle modules on/off.
-- end -- end
-- @class file -- @class file
-- @name AceAddon-3.0.lua -- @name AceAddon-3.0.lua
-- @release $Id: AceAddon-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ -- @release $Id$
local MAJOR, MINOR = "AceAddon-3.0", 5 local MAJOR, MINOR = "AceAddon-3.0", 13
local AceAddon, oldminor = LibStub:NewLibrary(MAJOR, MINOR) local AceAddon, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
if not AceAddon then return end -- No Upgrade needed. if not AceAddon then return end -- No Upgrade needed.
@@ -49,10 +49,6 @@ local select, pairs, next, type, unpack = select, pairs, next, type, unpack
local loadstring, assert, error = loadstring, assert, error local loadstring, assert, error = loadstring, assert, error
local setmetatable, getmetatable, rawset, rawget = setmetatable, getmetatable, rawset, rawget local setmetatable, getmetatable, rawset, rawget = setmetatable, getmetatable, rawset, rawget
-- 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, IsLoggedIn, geterrorhandler
--[[ --[[
xpcall safecall implementation xpcall safecall implementation
]] ]]
@@ -62,43 +58,12 @@ local function errorhandler(err)
return geterrorhandler()(err) return geterrorhandler()(err)
end end
local function CreateDispatcher(argCount)
local code = [[
local xpcall, eh = ...
local method, ARGS
local function call() return method(ARGS) end
local function dispatch(func, ...)
method = func
if not method then return end
ARGS = ...
return xpcall(call, eh)
end
return dispatch
]]
local ARGS = {}
for i = 1, argCount do ARGS[i] = "arg"..i end
code = code:gsub("ARGS", tconcat(ARGS, ", "))
return assert(loadstring(code, "safecall Dispatcher["..argCount.."]"))(xpcall, errorhandler)
end
local Dispatchers = setmetatable({}, {__index=function(self, argCount)
local dispatcher = CreateDispatcher(argCount)
rawset(self, argCount, dispatcher)
return dispatcher
end})
Dispatchers[0] = function(func)
return xpcall(func, errorhandler)
end
local function safecall(func, ...) local function safecall(func, ...)
-- we check to see if the func is passed is actually a function here and don't error when it isn't -- we check to see if the func is passed is actually a function here and don't error when it isn't
-- this safecall is used for optional functions like OnInitialize OnEnable etc. When they are not -- this safecall is used for optional functions like OnInitialize OnEnable etc. When they are not
-- present execution should continue without hinderance -- present execution should continue without hinderance
if type(func) == "function" then if type(func) == "function" then
return Dispatchers[select('#', ...)](func, ...) return xpcall(func, errorhandler, ...)
end end
end end
@@ -106,17 +71,27 @@ end
local Enable, Disable, EnableModule, DisableModule, Embed, NewModule, GetModule, GetName, SetDefaultModuleState, SetDefaultModuleLibraries, SetEnabledState, SetDefaultModulePrototype local Enable, Disable, EnableModule, DisableModule, Embed, NewModule, GetModule, GetName, SetDefaultModuleState, SetDefaultModuleLibraries, SetEnabledState, SetDefaultModulePrototype
-- used in the addon metatable -- used in the addon metatable
local function addontostring( self ) return self.name end local function addontostring( self ) return self.name end
-- Check if the addon is queued for initialization
local function queuedForInitialization(addon)
for i = 1, #AceAddon.initializequeue do
if AceAddon.initializequeue[i] == addon then
return true
end
end
return false
end
--- Create a new AceAddon-3.0 addon. --- Create a new AceAddon-3.0 addon.
-- Any libraries you specified will be embeded, and the addon will be scheduled for -- Any libraries you specified will be embeded, and the addon will be scheduled for
-- its OnInitialize and OnEnable callbacks. -- its OnInitialize and OnEnable callbacks.
-- The final addon object, with all libraries embeded, will be returned. -- The final addon object, with all libraries embeded, will be returned.
-- @paramsig [object ,]name[, lib, ...] -- @paramsig [object ,]name[, lib, ...]
-- @param object Table to use as a base for the addon (optional) -- @param object Table to use as a base for the addon (optional)
-- @param name Name of the addon object to create -- @param name Name of the addon object to create
-- @param lib List of libraries to embed into the addon -- @param lib List of libraries to embed into the addon
-- @usage -- @usage
-- -- Create a simple addon object -- -- Create a simple addon object
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceEvent-3.0") -- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceEvent-3.0")
-- --
@@ -136,10 +111,10 @@ function AceAddon:NewAddon(objectorname, ...)
if type(name)~="string" then if type(name)~="string" then
error(("Usage: NewAddon([object,] name, [lib, lib, lib, ...]): 'name' - string expected got '%s'."):format(type(name)), 2) error(("Usage: NewAddon([object,] name, [lib, lib, lib, ...]): 'name' - string expected got '%s'."):format(type(name)), 2)
end end
if self.addons[name] then if self.addons[name] then
error(("Usage: NewAddon([object,] name, [lib, lib, lib, ...]): 'name' - Addon '%s' already exists."):format(name), 2) error(("Usage: NewAddon([object,] name, [lib, lib, lib, ...]): 'name' - Addon '%s' already exists."):format(name), 2)
end end
object = object or {} object = object or {}
object.name = name object.name = name
@@ -149,14 +124,15 @@ function AceAddon:NewAddon(objectorname, ...)
for k, v in pairs(oldmeta) do addonmeta[k] = v end for k, v in pairs(oldmeta) do addonmeta[k] = v end
end end
addonmeta.__tostring = addontostring addonmeta.__tostring = addontostring
setmetatable( object, addonmeta ) setmetatable( object, addonmeta )
self.addons[name] = object self.addons[name] = object
object.modules = {} object.modules = {}
object.orderedModules = {}
object.defaultModuleLibraries = {} object.defaultModuleLibraries = {}
Embed( object ) -- embed NewModule, GetModule methods Embed( object ) -- embed NewModule, GetModule methods
self:EmbedLibraries(object, select(i,...)) self:EmbedLibraries(object, select(i,...))
-- add to queue of addons to be initialized upon ADDON_LOADED -- add to queue of addons to be initialized upon ADDON_LOADED
tinsert(self.initializequeue, object) tinsert(self.initializequeue, object)
return object return object
@@ -167,7 +143,7 @@ end
-- Throws an error if the addon object cannot be found (except if silent is set). -- Throws an error if the addon object cannot be found (except if silent is set).
-- @param name unique name of the addon object -- @param name unique name of the addon object
-- @param silent if true, the addon is optional, silently return nil if its not found -- @param silent if true, the addon is optional, silently return nil if its not found
-- @usage -- @usage
-- -- Get the Addon -- -- Get the Addon
-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon")
function AceAddon:GetAddon(name, silent) function AceAddon:GetAddon(name, silent)
@@ -222,7 +198,7 @@ end
-- @paramsig name[, silent] -- @paramsig name[, silent]
-- @param name unique name of the module -- @param name unique name of the module
-- @param silent if true, the module is optional, silently return nil if its not found (optional) -- @param silent if true, the module is optional, silently return nil if its not found (optional)
-- @usage -- @usage
-- -- Get the Addon -- -- Get the Addon
-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon")
-- -- Get the Module -- -- Get the Module
@@ -245,23 +221,23 @@ local function IsModuleTrue(self) return true end
-- @param name unique name of the module -- @param name unique name of the module
-- @param prototype object to derive this module from, methods and values from this table will be mixed into the module (optional) -- @param prototype object to derive this module from, methods and values from this table will be mixed into the module (optional)
-- @param lib List of libraries to embed into the addon -- @param lib List of libraries to embed into the addon
-- @usage -- @usage
-- -- Create a module with some embeded libraries -- -- Create a module with some embeded libraries
-- MyModule = MyAddon:NewModule("MyModule", "AceEvent-3.0", "AceHook-3.0") -- MyModule = MyAddon:NewModule("MyModule", "AceEvent-3.0", "AceHook-3.0")
-- --
-- -- Create a module with a prototype -- -- Create a module with a prototype
-- local prototype = { OnEnable = function(self) print("OnEnable called!") end } -- local prototype = { OnEnable = function(self) print("OnEnable called!") end }
-- MyModule = MyAddon:NewModule("MyModule", prototype, "AceEvent-3.0", "AceHook-3.0") -- MyModule = MyAddon:NewModule("MyModule", prototype, "AceEvent-3.0", "AceHook-3.0")
function NewModule(self, name, prototype, ...) function NewModule(self, name, prototype, ...)
if type(name) ~= "string" then error(("Usage: NewModule(name, [prototype, [lib, lib, lib, ...]): 'name' - string expected got '%s'."):format(type(name)), 2) end if type(name) ~= "string" then error(("Usage: NewModule(name, [prototype, [lib, lib, lib, ...]): 'name' - string expected got '%s'."):format(type(name)), 2) end
if type(prototype) ~= "string" and type(prototype) ~= "table" and type(prototype) ~= "nil" then error(("Usage: NewModule(name, [prototype, [lib, lib, lib, ...]): 'prototype' - table (prototype), string (lib) or nil expected got '%s'."):format(type(prototype)), 2) end if type(prototype) ~= "string" and type(prototype) ~= "table" and type(prototype) ~= "nil" then error(("Usage: NewModule(name, [prototype, [lib, lib, lib, ...]): 'prototype' - table (prototype), string (lib) or nil expected got '%s'."):format(type(prototype)), 2) end
if self.modules[name] then error(("Usage: NewModule(name, [prototype, [lib, lib, lib, ...]): 'name' - Module '%s' already exists."):format(name), 2) end if self.modules[name] then error(("Usage: NewModule(name, [prototype, [lib, lib, lib, ...]): 'name' - Module '%s' already exists."):format(name), 2) end
-- modules are basically addons. We treat them as such. They will be added to the initializequeue properly as well. -- modules are basically addons. We treat them as such. They will be added to the initializequeue properly as well.
-- NewModule can only be called after the parent addon is present thus the modules will be initialized after their parent is. -- NewModule can only be called after the parent addon is present thus the modules will be initialized after their parent is.
local module = AceAddon:NewAddon(fmt("%s_%s", self.name or tostring(self), name)) local module = AceAddon:NewAddon(fmt("%s_%s", self.name or tostring(self), name))
module.IsModule = IsModuleTrue module.IsModule = IsModuleTrue
module:SetEnabledState(self.defaultModuleState) module:SetEnabledState(self.defaultModuleState)
module.moduleName = name module.moduleName = name
@@ -276,23 +252,24 @@ function NewModule(self, name, prototype, ...)
if not prototype or type(prototype) == "string" then if not prototype or type(prototype) == "string" then
prototype = self.defaultModulePrototype or nil prototype = self.defaultModulePrototype or nil
end end
if type(prototype) == "table" then if type(prototype) == "table" then
local mt = getmetatable(module) local mt = getmetatable(module)
mt.__index = prototype mt.__index = prototype
setmetatable(module, mt) -- More of a Base class type feel. setmetatable(module, mt) -- More of a Base class type feel.
end end
safecall(self.OnModuleCreated, self, module) -- Was in Ace2 and I think it could be a cool thing to have handy. safecall(self.OnModuleCreated, self, module) -- Was in Ace2 and I think it could be a cool thing to have handy.
self.modules[name] = module self.modules[name] = module
tinsert(self.orderedModules, module)
return module return module
end end
--- Returns the real name of the addon or module, without any prefix. --- Returns the real name of the addon or module, without any prefix.
-- @name //addon//:GetName -- @name //addon//:GetName
-- @paramsig -- @paramsig
-- @usage -- @usage
-- print(MyAddon:GetName()) -- print(MyAddon:GetName())
-- -- prints "MyAddon" -- -- prints "MyAddon"
function GetName(self) function GetName(self)
@@ -304,15 +281,20 @@ end
-- and enabling all modules of the addon (unless explicitly disabled).\\ -- and enabling all modules of the addon (unless explicitly disabled).\\
-- :Enable() also sets the internal `enableState` variable to true -- :Enable() also sets the internal `enableState` variable to true
-- @name //addon//:Enable -- @name //addon//:Enable
-- @paramsig -- @paramsig
-- @usage -- @usage
-- -- Enable MyModule -- -- Enable MyModule
-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon")
-- MyModule = MyAddon:GetModule("MyModule") -- MyModule = MyAddon:GetModule("MyModule")
-- MyModule:Enable() -- MyModule:Enable()
function Enable(self) function Enable(self)
self:SetEnabledState(true) self:SetEnabledState(true)
return AceAddon:EnableAddon(self)
-- nevcairiel 2013-04-27: don't enable an addon/module if its queued for init still
-- it'll be enabled after the init process
if not queuedForInitialization(self) then
return AceAddon:EnableAddon(self)
end
end end
--- Disables the Addon, if possible, return true or false depending on success. --- Disables the Addon, if possible, return true or false depending on success.
@@ -320,8 +302,8 @@ end
-- and disabling all modules of the addon.\\ -- and disabling all modules of the addon.\\
-- :Disable() also sets the internal `enableState` variable to false -- :Disable() also sets the internal `enableState` variable to false
-- @name //addon//:Disable -- @name //addon//:Disable
-- @paramsig -- @paramsig
-- @usage -- @usage
-- -- Disable MyAddon -- -- Disable MyAddon
-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon")
-- MyAddon:Disable() -- MyAddon:Disable()
@@ -334,7 +316,7 @@ end
-- Short-hand function that retrieves the module via `:GetModule` and calls `:Enable` on the module object. -- Short-hand function that retrieves the module via `:GetModule` and calls `:Enable` on the module object.
-- @name //addon//:EnableModule -- @name //addon//:EnableModule
-- @paramsig name -- @paramsig name
-- @usage -- @usage
-- -- Enable MyModule using :GetModule -- -- Enable MyModule using :GetModule
-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon")
-- MyModule = MyAddon:GetModule("MyModule") -- MyModule = MyAddon:GetModule("MyModule")
@@ -352,7 +334,7 @@ end
-- Short-hand function that retrieves the module via `:GetModule` and calls `:Disable` on the module object. -- Short-hand function that retrieves the module via `:GetModule` and calls `:Disable` on the module object.
-- @name //addon//:DisableModule -- @name //addon//:DisableModule
-- @paramsig name -- @paramsig name
-- @usage -- @usage
-- -- Disable MyModule using :GetModule -- -- Disable MyModule using :GetModule
-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon")
-- MyModule = MyAddon:GetModule("MyModule") -- MyModule = MyAddon:GetModule("MyModule")
@@ -371,7 +353,7 @@ end
-- @name //addon//:SetDefaultModuleLibraries -- @name //addon//:SetDefaultModuleLibraries
-- @paramsig lib[, lib, ...] -- @paramsig lib[, lib, ...]
-- @param lib List of libraries to embed into the addon -- @param lib List of libraries to embed into the addon
-- @usage -- @usage
-- -- Create the addon object -- -- Create the addon object
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon")
-- -- Configure default libraries for modules (all modules need AceEvent-3.0) -- -- Configure default libraries for modules (all modules need AceEvent-3.0)
@@ -390,7 +372,7 @@ end
-- @name //addon//:SetDefaultModuleState -- @name //addon//:SetDefaultModuleState
-- @paramsig state -- @paramsig state
-- @param state Default state for new modules, true for enabled, false for disabled -- @param state Default state for new modules, true for enabled, false for disabled
-- @usage -- @usage
-- -- Create the addon object -- -- Create the addon object
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon") -- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon")
-- -- Set the default state to "disabled" -- -- Set the default state to "disabled"
@@ -410,7 +392,7 @@ end
-- @name //addon//:SetDefaultModulePrototype -- @name //addon//:SetDefaultModulePrototype
-- @paramsig prototype -- @paramsig prototype
-- @param prototype Default prototype for the new modules (table) -- @param prototype Default prototype for the new modules (table)
-- @usage -- @usage
-- -- Define a prototype -- -- Define a prototype
-- local prototype = { OnEnable = function(self) print("OnEnable called!") end } -- local prototype = { OnEnable = function(self) print("OnEnable called!") end }
-- -- Set the default prototype -- -- Set the default prototype
@@ -442,8 +424,8 @@ end
--- Return an iterator of all modules associated to the addon. --- Return an iterator of all modules associated to the addon.
-- @name //addon//:IterateModules -- @name //addon//:IterateModules
-- @paramsig -- @paramsig
-- @usage -- @usage
-- -- Enable all modules -- -- Enable all modules
-- for name, module in MyAddon:IterateModules() do -- for name, module in MyAddon:IterateModules() do
-- module:Enable() -- module:Enable()
@@ -452,13 +434,13 @@ local function IterateModules(self) return pairs(self.modules) end
-- Returns an iterator of all embeds in the addon -- Returns an iterator of all embeds in the addon
-- @name //addon//:IterateEmbeds -- @name //addon//:IterateEmbeds
-- @paramsig -- @paramsig
local function IterateEmbeds(self) return pairs(AceAddon.embeds[self]) end local function IterateEmbeds(self) return pairs(AceAddon.embeds[self]) end
--- Query the enabledState of an addon. --- Query the enabledState of an addon.
-- @name //addon//:IsEnabled -- @name //addon//:IsEnabled
-- @paramsig -- @paramsig
-- @usage -- @usage
-- if MyAddon:IsEnabled() then -- if MyAddon:IsEnabled() then
-- MyAddon:Disable() -- MyAddon:Disable()
-- end -- end
@@ -489,32 +471,34 @@ local pmixins = {
-- target (object) - target object to embed aceaddon in -- target (object) - target object to embed aceaddon in
-- --
-- this is a local function specifically since it's meant to be only called internally -- this is a local function specifically since it's meant to be only called internally
function Embed(target) function Embed(target, skipPMixins)
for k, v in pairs(mixins) do for k, v in pairs(mixins) do
target[k] = v target[k] = v
end end
for k, v in pairs(pmixins) do if not skipPMixins then
target[k] = target[k] or v for k, v in pairs(pmixins) do
target[k] = target[k] or v
end
end end
end end
-- - Initialize the addon after creation. -- - Initialize the addon after creation.
-- This function is only used internally during the ADDON_LOADED event -- This function is only used internally during the ADDON_LOADED event
-- It will call the **OnInitialize** function on the addon object (if present), -- It will call the **OnInitialize** function on the addon object (if present),
-- and the **OnEmbedInitialize** function on all embeded libraries. -- and the **OnEmbedInitialize** function on all embeded libraries.
-- --
-- **Note:** Do not call this function manually, unless you're absolutely sure that you know what you are doing. -- **Note:** Do not call this function manually, unless you're absolutely sure that you know what you are doing.
-- @param addon addon object to intialize -- @param addon addon object to intialize
function AceAddon:InitializeAddon(addon) function AceAddon:InitializeAddon(addon)
safecall(addon.OnInitialize, addon) safecall(addon.OnInitialize, addon)
local embeds = self.embeds[addon] local embeds = self.embeds[addon]
for i = 1, #embeds do for i = 1, #embeds do
local lib = LibStub:GetLibrary(embeds[i], true) local lib = LibStub:GetLibrary(embeds[i], true)
if lib then safecall(lib.OnEmbedInitialize, lib, addon) end if lib then safecall(lib.OnEmbedInitialize, lib, addon) end
end end
-- we don't call InitializeAddon on modules specifically, this is handled -- we don't call InitializeAddon on modules specifically, this is handled
-- from the event handler and only done _once_ -- from the event handler and only done _once_
end end
@@ -522,7 +506,7 @@ end
-- - Enable the addon after creation. -- - Enable the addon after creation.
-- Note: This function is only used internally during the PLAYER_LOGIN event, or during ADDON_LOADED, -- Note: This function is only used internally during the PLAYER_LOGIN event, or during ADDON_LOADED,
-- if IsLoggedIn() already returns true at that point, e.g. for LoD Addons. -- if IsLoggedIn() already returns true at that point, e.g. for LoD Addons.
-- It will call the **OnEnable** function on the addon object (if present), -- It will call the **OnEnable** function on the addon object (if present),
-- and the **OnEmbedEnable** function on all embeded libraries.\\ -- and the **OnEmbedEnable** function on all embeded libraries.\\
-- This function does not toggle the enable state of the addon itself, and will return early if the addon is disabled. -- This function does not toggle the enable state of the addon itself, and will return early if the addon is disabled.
-- --
@@ -532,12 +516,12 @@ end
function AceAddon:EnableAddon(addon) function AceAddon:EnableAddon(addon)
if type(addon) == "string" then addon = AceAddon:GetAddon(addon) end if type(addon) == "string" then addon = AceAddon:GetAddon(addon) end
if self.statuses[addon.name] or not addon.enabledState then return false end if self.statuses[addon.name] or not addon.enabledState then return false end
-- set the statuses first, before calling the OnEnable. this allows for Disabling of the addon in OnEnable. -- set the statuses first, before calling the OnEnable. this allows for Disabling of the addon in OnEnable.
self.statuses[addon.name] = true self.statuses[addon.name] = true
safecall(addon.OnEnable, addon) safecall(addon.OnEnable, addon)
-- make sure we're still enabled before continueing -- make sure we're still enabled before continueing
if self.statuses[addon.name] then if self.statuses[addon.name] then
local embeds = self.embeds[addon] local embeds = self.embeds[addon]
@@ -545,10 +529,11 @@ function AceAddon:EnableAddon(addon)
local lib = LibStub:GetLibrary(embeds[i], true) local lib = LibStub:GetLibrary(embeds[i], true)
if lib then safecall(lib.OnEmbedEnable, lib, addon) end if lib then safecall(lib.OnEmbedEnable, lib, addon) end
end end
-- enable possible modules. -- enable possible modules.
for name, module in pairs(addon.modules) do local modules = addon.orderedModules
self:EnableAddon(module) for i = 1, #modules do
self:EnableAddon(modules[i])
end end
end end
return self.statuses[addon.name] -- return true if we're disabled return self.statuses[addon.name] -- return true if we're disabled
@@ -556,40 +541,41 @@ end
-- - Disable the addon -- - Disable the addon
-- Note: This function is only used internally. -- Note: This function is only used internally.
-- It will call the **OnDisable** function on the addon object (if present), -- It will call the **OnDisable** function on the addon object (if present),
-- and the **OnEmbedDisable** function on all embeded libraries.\\ -- and the **OnEmbedDisable** function on all embeded libraries.\\
-- This function does not toggle the enable state of the addon itself, and will return early if the addon is still enabled. -- This function does not toggle the enable state of the addon itself, and will return early if the addon is still enabled.
-- --
-- **Note:** Do not call this function manually, unless you're absolutely sure that you know what you are doing. -- **Note:** Do not call this function manually, unless you're absolutely sure that you know what you are doing.
-- Use :Disable on the addon itself instead. -- Use :Disable on the addon itself instead.
-- @param addon addon object to enable -- @param addon addon object to enable
function AceAddon:DisableAddon(addon) function AceAddon:DisableAddon(addon)
if type(addon) == "string" then addon = AceAddon:GetAddon(addon) end if type(addon) == "string" then addon = AceAddon:GetAddon(addon) end
if not self.statuses[addon.name] then return false end if not self.statuses[addon.name] then return false end
-- set statuses first before calling OnDisable, this allows for aborting the disable in OnDisable. -- set statuses first before calling OnDisable, this allows for aborting the disable in OnDisable.
self.statuses[addon.name] = false self.statuses[addon.name] = false
safecall( addon.OnDisable, addon ) safecall( addon.OnDisable, addon )
-- make sure we're still disabling... -- make sure we're still disabling...
if not self.statuses[addon.name] then if not self.statuses[addon.name] then
local embeds = self.embeds[addon] local embeds = self.embeds[addon]
for i = 1, #embeds do for i = 1, #embeds do
local lib = LibStub:GetLibrary(embeds[i], true) local lib = LibStub:GetLibrary(embeds[i], true)
if lib then safecall(lib.OnEmbedDisable, lib, addon) end if lib then safecall(lib.OnEmbedDisable, lib, addon) end
end end
-- disable possible modules. -- disable possible modules.
for name, module in pairs(addon.modules) do local modules = addon.orderedModules
self:DisableAddon(module) for i = 1, #modules do
self:DisableAddon(modules[i])
end end
end end
return not self.statuses[addon.name] -- return true if we're disabled return not self.statuses[addon.name] -- return true if we're disabled
end end
--- Get an iterator over all registered addons. --- Get an iterator over all registered addons.
-- @usage -- @usage
-- -- Print a list of all installed AceAddon's -- -- Print a list of all installed AceAddon's
-- for name, addon in AceAddon:IterateAddons() do -- for name, addon in AceAddon:IterateAddons() do
-- print("Addon: " .. name) -- print("Addon: " .. name)
@@ -597,7 +583,7 @@ end
function AceAddon:IterateAddons() return pairs(self.addons) end function AceAddon:IterateAddons() return pairs(self.addons) end
--- Get an iterator over the internal status registry. --- Get an iterator over the internal status registry.
-- @usage -- @usage
-- -- Print a list of all enabled addons -- -- Print a list of all enabled addons
-- for name, status in AceAddon:IterateAddonStatus() do -- for name, status in AceAddon:IterateAddonStatus() do
-- if status then -- if status then
@@ -611,9 +597,20 @@ function AceAddon:IterateAddonStatus() return pairs(self.statuses) end
function AceAddon:IterateEmbedsOnAddon(addon) return pairs(self.embeds[addon]) end function AceAddon:IterateEmbedsOnAddon(addon) return pairs(self.embeds[addon]) end
function AceAddon:IterateModulesOfAddon(addon) return pairs(addon.modules) end function AceAddon:IterateModulesOfAddon(addon) return pairs(addon.modules) end
-- Blizzard AddOns which can load very early in the loading process and mess with Ace3 addon loading
local BlizzardEarlyLoadAddons = {
Blizzard_DebugTools = true,
Blizzard_TimeManager = true,
Blizzard_BattlefieldMap = true,
Blizzard_MapCanvas = true,
Blizzard_SharedMapDataProviders = true,
Blizzard_CombatLog = true,
}
-- Event Handling -- Event Handling
local function onEvent(this, event, arg1) local function onEvent(this, event, arg1)
if event == "ADDON_LOADED" or event == "PLAYER_LOGIN" then -- 2020-08-28 nevcairiel - ignore the load event of Blizzard addons which occur early in the loading process
if (event == "ADDON_LOADED" and (arg1 == nil or not BlizzardEarlyLoadAddons[arg1])) or event == "PLAYER_LOGIN" then
-- if a addon loads another addon, recursion could happen here, so we need to validate the table on every iteration -- if a addon loads another addon, recursion could happen here, so we need to validate the table on every iteration
while(#AceAddon.initializequeue > 0) do while(#AceAddon.initializequeue > 0) do
local addon = tremove(AceAddon.initializequeue, 1) local addon = tremove(AceAddon.initializequeue, 1)
@@ -622,7 +619,7 @@ local function onEvent(this, event, arg1)
AceAddon:InitializeAddon(addon) AceAddon:InitializeAddon(addon)
tinsert(AceAddon.enablequeue, addon) tinsert(AceAddon.enablequeue, addon)
end end
if IsLoggedIn() then if IsLoggedIn() then
while(#AceAddon.enablequeue > 0) do while(#AceAddon.enablequeue > 0) do
local addon = tremove(AceAddon.enablequeue, 1) local addon = tremove(AceAddon.enablequeue, 1)
@@ -638,5 +635,15 @@ AceAddon.frame:SetScript("OnEvent", onEvent)
-- upgrade embeded -- upgrade embeded
for name, addon in pairs(AceAddon.addons) do for name, addon in pairs(AceAddon.addons) do
Embed(addon) Embed(addon, true)
end
-- 2010-10-27 nevcairiel - add new "orderedModules" table
if oldminor and oldminor < 10 then
for name, addon in pairs(AceAddon.addons) do
addon.orderedModules = {}
for module_name, module in pairs(addon.modules) do
tinsert(addon.orderedModules, module)
end
end
end end
+4 -14
View File
@@ -34,7 +34,7 @@
-- end -- end
-- @class file -- @class file
-- @name AceBucket-3.0.lua -- @name AceBucket-3.0.lua
-- @release $Id: AceBucket-3.0.lua 1202 2019-05-15 23:11:22Z nevcairiel $ -- @release $Id$
local MAJOR, MINOR = "AceBucket-3.0", 4 local MAJOR, MINOR = "AceBucket-3.0", 4
local AceBucket, oldminor = LibStub:NewLibrary(MAJOR, MINOR) local AceBucket, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
@@ -53,16 +53,12 @@ local type, next, pairs, select = type, next, pairs, select
local tonumber, tostring, rawset = tonumber, tostring, rawset local tonumber, tostring, rawset = tonumber, tostring, rawset
local assert, loadstring, error = assert, loadstring, error local assert, loadstring, error = assert, loadstring, error
-- 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, geterrorhandler
local bucketCache = setmetatable({}, {__mode='k'}) local bucketCache = setmetatable({}, {__mode='k'})
--[[ --[[
pcall safecall implementation xpcall safecall implementation
]] ]]
local pcall = pcall local xpcall = xpcall
local function errorhandler(err) local function errorhandler(err)
return geterrorhandler()(err) return geterrorhandler()(err)
@@ -70,13 +66,7 @@ end
local function safecall(func, ...) local function safecall(func, ...)
if func then if func then
local ok, err = pcall(func, ...) return xpcall(func, errorhandler, ...)
if ok then
return true
else
errorhandler(err)
return false
end
end end
end end
+1 -1
View File
@@ -1,4 +1,4 @@
<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/ <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"> ..\FrameXML\UI.xsd">
<Script file="AceBucket-3.0.lua"/> <Script file="AceBucket-3.0.lua"/>
</Ui> </Ui>
+22 -26
View File
@@ -2,14 +2,14 @@
-- You can register slash commands to your custom functions and use the `GetArgs` function to parse them -- You can register slash commands to your custom functions and use the `GetArgs` function to parse them
-- to your addons individual needs. -- to your addons individual needs.
-- --
-- **AceConsole-3.0** can be embeded into your addon, either explicitly by calling AceConsole:Embed(MyAddon) or by -- **AceConsole-3.0** can be embeded into your addon, either explicitly by calling AceConsole:Embed(MyAddon) or by
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object -- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object
-- and can be accessed directly, without having to explicitly call AceConsole itself.\\ -- and can be accessed directly, without having to explicitly call AceConsole itself.\\
-- It is recommended to embed AceConsole, otherwise you'll have to specify a custom `self` on all calls you -- It is recommended to embed AceConsole, otherwise you'll have to specify a custom `self` on all calls you
-- make into AceConsole. -- make into AceConsole.
-- @class file -- @class file
-- @name AceConsole-3.0 -- @name AceConsole-3.0
-- @release $Id: AceConsole-3.0.lua 878 2009-11-02 18:51:58Z nevcairiel $ -- @release $Id$
local MAJOR,MINOR = "AceConsole-3.0", 7 local MAJOR,MINOR = "AceConsole-3.0", 7
local AceConsole, oldminor = LibStub:NewLibrary(MAJOR, MINOR) local AceConsole, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
@@ -29,10 +29,6 @@ local max = math.max
-- WoW APIs -- WoW APIs
local _G = _G local _G = _G
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
-- List them here for Mikk's FindGlobals script
-- GLOBALS: DEFAULT_CHAT_FRAME, SlashCmdList, hash_SlashCmdList
local tmp={} local tmp={}
local function Print(self,frame,...) local function Print(self,frame,...)
local n=0 local n=0
@@ -84,11 +80,11 @@ end
-- @param persist if false, the command will be soft disabled/enabled when aceconsole is used as a mixin (default: true) -- @param persist if false, the command will be soft disabled/enabled when aceconsole is used as a mixin (default: true)
function AceConsole:RegisterChatCommand( command, func, persist ) function AceConsole:RegisterChatCommand( command, func, persist )
if type(command)~="string" then error([[Usage: AceConsole:RegisterChatCommand( "command", func[, persist ]): 'command' - expected a string]], 2) end if type(command)~="string" then error([[Usage: AceConsole:RegisterChatCommand( "command", func[, persist ]): 'command' - expected a string]], 2) end
if persist==nil then persist=true end -- I'd rather have my addon's "/addon enable" around if the author screws up. Having some extra slash regged when it shouldnt be isn't as destructive. True is a better default. /Mikk if persist==nil then persist=true end -- I'd rather have my addon's "/addon enable" around if the author screws up. Having some extra slash regged when it shouldnt be isn't as destructive. True is a better default. /Mikk
local name = "ACECONSOLE_"..command:upper() local name = "ACECONSOLE_"..command:upper()
if type( func ) == "string" then if type( func ) == "string" then
SlashCmdList[name] = function(input, editBox) SlashCmdList[name] = function(input, editBox)
self[func](self, input, editBox) self[func](self, input, editBox)
@@ -132,11 +128,11 @@ local function nils(n, ...)
return ... return ...
end end
end end
--- Retreive one or more space-separated arguments from a string.
--- Retreive one or more space-separated arguments from a string.
-- Treats quoted strings and itemlinks as non-spaced. -- Treats quoted strings and itemlinks as non-spaced.
-- @param string The raw argument string -- @param str The raw argument string
-- @param numargs How many arguments to get (default 1) -- @param numargs How many arguments to get (default 1)
-- @param startpos Where in the string to start scanning (default 1) -- @param startpos Where in the string to start scanning (default 1)
-- @return Returns arg1, arg2, ..., nextposition\\ -- @return Returns arg1, arg2, ..., nextposition\\
@@ -144,7 +140,7 @@ end
function AceConsole:GetArgs(str, numargs, startpos) function AceConsole:GetArgs(str, numargs, startpos)
numargs = numargs or 1 numargs = numargs or 1
startpos = max(startpos or 1, 1) startpos = max(startpos or 1, 1)
local pos=startpos local pos=startpos
-- find start of new arg -- find start of new arg
@@ -169,24 +165,24 @@ function AceConsole:GetArgs(str, numargs, startpos)
else else
delim_or_pipe="([| ])" delim_or_pipe="([| ])"
end end
startpos = pos startpos = pos
while true do while true do
-- find delimiter or hyperlink -- find delimiter or hyperlink
local ch,_ local _
pos,_,ch = strfind(str, delim_or_pipe, pos) pos,_,ch = strfind(str, delim_or_pipe, pos)
if not pos then break end if not pos then break end
if ch=="|" then if ch=="|" then
-- some kind of escape -- some kind of escape
if strsub(str,pos,pos+1)=="|H" then if strsub(str,pos,pos+1)=="|H" then
-- It's a |H....|hhyper link!|h -- It's a |H....|hhyper link!|h
pos=strfind(str, "|h", pos+2) -- first |h pos=strfind(str, "|h", pos+2) -- first |h
if not pos then break end if not pos then break end
pos=strfind(str, "|h", pos+2) -- second |h pos=strfind(str, "|h", pos+2) -- second |h
if not pos then break end if not pos then break end
elseif strsub(str,pos, pos+1) == "|T" then elseif strsub(str,pos, pos+1) == "|T" then
@@ -194,16 +190,16 @@ function AceConsole:GetArgs(str, numargs, startpos)
pos=strfind(str, "|t", pos+2) pos=strfind(str, "|t", pos+2)
if not pos then break end if not pos then break end
end end
pos=pos+2 -- skip past this escape (last |h if it was a hyperlink) pos=pos+2 -- skip past this escape (last |h if it was a hyperlink)
else else
-- found delimiter, done with this arg -- found delimiter, done with this arg
return strsub(str, startpos, pos-1), AceConsole:GetArgs(str, numargs-1, pos+1) return strsub(str, startpos, pos-1), AceConsole:GetArgs(str, numargs-1, pos+1)
end end
end end
-- search aborted, we hit end of string. return it all as one argument. (yes, even if it's an unterminated quote or hyperlink) -- search aborted, we hit end of string. return it all as one argument. (yes, even if it's an unterminated quote or hyperlink)
return strsub(str, startpos), nils(numargs-1, 1e9) return strsub(str, startpos), nils(numargs-1, 1e9)
end end
@@ -214,10 +210,10 @@ end
local mixins = { local mixins = {
"Print", "Print",
"Printf", "Printf",
"RegisterChatCommand", "RegisterChatCommand",
"UnregisterChatCommand", "UnregisterChatCommand",
"GetArgs", "GetArgs",
} }
-- Embeds AceConsole into the target object making the functions from the mixins list available on target:.. -- Embeds AceConsole into the target object making the functions from the mixins list available on target:..
-- @param target target object to embed AceBucket in -- @param target target object to embed AceBucket in
+11 -11
View File
@@ -2,15 +2,17 @@
-- All dispatching is done using **CallbackHandler-1.0**. AceEvent is a simple wrapper around -- All dispatching is done using **CallbackHandler-1.0**. AceEvent is a simple wrapper around
-- CallbackHandler, and dispatches all game events or addon message to the registrees. -- CallbackHandler, and dispatches all game events or addon message to the registrees.
-- --
-- **AceEvent-3.0** can be embeded into your addon, either explicitly by calling AceEvent:Embed(MyAddon) or by -- **AceEvent-3.0** can be embeded into your addon, either explicitly by calling AceEvent:Embed(MyAddon) or by
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object -- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object
-- and can be accessed directly, without having to explicitly call AceEvent itself.\\ -- and can be accessed directly, without having to explicitly call AceEvent itself.\\
-- It is recommended to embed AceEvent, otherwise you'll have to specify a custom `self` on all calls you -- It is recommended to embed AceEvent, otherwise you'll have to specify a custom `self` on all calls you
-- make into AceEvent. -- make into AceEvent.
-- @class file -- @class file
-- @name AceEvent-3.0 -- @name AceEvent-3.0
-- @release $Id: AceEvent-3.0.lua 877 2009-11-02 15:56:50Z nevcairiel $ -- @release $Id$
local MAJOR, MINOR = "AceEvent-3.0", 3 local CallbackHandler = LibStub("CallbackHandler-1.0")
local MAJOR, MINOR = "AceEvent-3.0", 4
local AceEvent = LibStub:NewLibrary(MAJOR, MINOR) local AceEvent = LibStub:NewLibrary(MAJOR, MINOR)
if not AceEvent then return end if not AceEvent then return end
@@ -18,29 +20,27 @@ if not AceEvent then return end
-- Lua APIs -- Lua APIs
local pairs = pairs local pairs = pairs
local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0")
AceEvent.frame = AceEvent.frame or CreateFrame("Frame", "AceEvent30Frame") -- our event frame AceEvent.frame = AceEvent.frame or CreateFrame("Frame", "AceEvent30Frame") -- our event frame
AceEvent.embeds = AceEvent.embeds or {} -- what objects embed this lib AceEvent.embeds = AceEvent.embeds or {} -- what objects embed this lib
-- APIs and registry for blizzard events, using CallbackHandler lib -- APIs and registry for blizzard events, using CallbackHandler lib
if not AceEvent.events then if not AceEvent.events then
AceEvent.events = CallbackHandler:New(AceEvent, AceEvent.events = CallbackHandler:New(AceEvent,
"RegisterEvent", "UnregisterEvent", "UnregisterAllEvents") "RegisterEvent", "UnregisterEvent", "UnregisterAllEvents")
end end
function AceEvent.events:OnUsed(target, eventname) function AceEvent.events:OnUsed(target, eventname)
AceEvent.frame:RegisterEvent(eventname) AceEvent.frame:RegisterEvent(eventname)
end end
function AceEvent.events:OnUnused(target, eventname) function AceEvent.events:OnUnused(target, eventname)
AceEvent.frame:UnregisterEvent(eventname) AceEvent.frame:UnregisterEvent(eventname)
end end
-- APIs and registry for IPC messages, using CallbackHandler lib -- APIs and registry for IPC messages, using CallbackHandler lib
if not AceEvent.messages then if not AceEvent.messages then
AceEvent.messages = CallbackHandler:New(AceEvent, AceEvent.messages = CallbackHandler:New(AceEvent,
"RegisterMessage", "UnregisterMessage", "UnregisterAllMessages" "RegisterMessage", "UnregisterMessage", "UnregisterAllMessages"
) )
AceEvent.SendMessage = AceEvent.messages.Fire AceEvent.SendMessage = AceEvent.messages.Fire
@@ -55,7 +55,7 @@ local mixins = {
} }
--- Register for a Blizzard Event. --- Register for a Blizzard Event.
-- The callback will always be called with the event as the first argument, and if supplied, the `arg` as second argument. -- The callback will be called with the optional `arg` as the first argument (if supplied), and the event name as the second (or first, if no arg was supplied)
-- Any arguments to the event will be passed on after that. -- Any arguments to the event will be passed on after that.
-- @name AceEvent:RegisterEvent -- @name AceEvent:RegisterEvent
-- @class function -- @class function
@@ -71,7 +71,7 @@ local mixins = {
-- @param event The event to unregister -- @param event The event to unregister
--- Register for a custom AceEvent-internal message. --- Register for a custom AceEvent-internal message.
-- The callback will always be called with the event as the first argument, and if supplied, the `arg` as second argument. -- The callback will be called with the optional `arg` as the first argument (if supplied), and the event name as the second (or first, if no arg was supplied)
-- Any arguments to the event will be passed on after that. -- Any arguments to the event will be passed on after that.
-- @name AceEvent:RegisterMessage -- @name AceEvent:RegisterMessage
-- @class function -- @class function
+24 -27
View File
@@ -1,8 +1,8 @@
--- **AceLocale-3.0** manages localization in addons, allowing for multiple locale to be registered with fallback to the base locale for untranslated strings. --- **AceLocale-3.0** manages localization in addons, allowing for multiple locale to be registered with fallback to the base locale for untranslated strings.
-- @class file -- @class file
-- @name AceLocale-3.0 -- @name AceLocale-3.0
-- @release $Id: AceLocale-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ -- @release $Id$
local MAJOR,MINOR = "AceLocale-3.0", 2 local MAJOR,MINOR = "AceLocale-3.0", 6
local AceLocale, oldminor = LibStub:NewLibrary(MAJOR, MINOR) local AceLocale, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
@@ -10,11 +10,7 @@ if not AceLocale then return end -- no upgrade needed
-- Lua APIs -- Lua APIs
local assert, tostring, error = assert, tostring, error local assert, tostring, error = assert, tostring, error
local setmetatable, rawset, rawget = setmetatable, rawset, rawget local getmetatable, setmetatable, rawset, rawget = getmetatable, setmetatable, rawset, rawget
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
-- List them here for Mikk's FindGlobals script
-- GLOBALS: GAME_LOCALE, geterrorhandler
local gameLocale = GetLocale() local gameLocale = GetLocale()
if gameLocale == "enGB" then if gameLocale == "enGB" then
@@ -56,10 +52,10 @@ local writeproxy = setmetatable({}, {
__index = assertfalse __index = assertfalse
}) })
-- This metatable proxy is used when registering the default locale. -- This metatable proxy is used when registering the default locale.
-- It refuses to overwrite existing values -- It refuses to overwrite existing values
-- Reason 1: Allows loading locales in any order -- Reason 1: Allows loading locales in any order
-- Reason 2: If 2 modules have the same string, but only the first one to be -- Reason 2: If 2 modules have the same string, but only the first one to be
-- loaded has a translation for the current locale, the translation -- loaded has a translation for the current locale, the translation
-- doesn't get overwritten. -- doesn't get overwritten.
-- --
@@ -79,7 +75,7 @@ local writedefaultproxy = setmetatable({}, {
-- @param application Unique name of addon / module -- @param application Unique name of addon / module
-- @param locale Name of the locale to register, e.g. "enUS", "deDE", etc. -- @param locale Name of the locale to register, e.g. "enUS", "deDE", etc.
-- @param isDefault If this is the default locale being registered (your addon is written in this language, generally enUS) -- @param isDefault If this is the default locale being registered (your addon is written in this language, generally enUS)
-- @param silent If true, the locale will not issue warnings for missing keys. Can only be set on the default locale. -- @param silent If true, the locale will not issue warnings for missing keys. Must be set on the first locale registered. If set to "raw", nils will be returned for unknown keys (no metatable used).
-- @usage -- @usage
-- -- enUS.lua -- -- enUS.lua
-- local L = LibStub("AceLocale-3.0"):NewLocale("TestLocale", "enUS", true) -- local L = LibStub("AceLocale-3.0"):NewLocale("TestLocale", "enUS", true)
@@ -91,31 +87,32 @@ local writedefaultproxy = setmetatable({}, {
-- L["string1"] = "Zeichenkette1" -- L["string1"] = "Zeichenkette1"
-- @return Locale Table to add localizations to, or nil if the current locale is not required. -- @return Locale Table to add localizations to, or nil if the current locale is not required.
function AceLocale:NewLocale(application, locale, isDefault, silent) function AceLocale:NewLocale(application, locale, isDefault, silent)
if silent and not isDefault then
error("Usage: NewLocale(application, locale[, isDefault[, silent]]): 'silent' can only be specified for the default locale", 2)
end
-- GAME_LOCALE allows translators to test translations of addons without having that wow client installed
-- Ammo: I still think this is a bad idea, for instance an addon that checks for some ingame string will fail, just because some other addon
-- gives the user the illusion that they can run in a different locale? Ditch this whole thing or allow a setting per 'application'. I'm of the
-- opinion to remove this.
local gameLocale = GAME_LOCALE or gameLocale
if locale ~= gameLocale and not isDefault then -- GAME_LOCALE allows translators to test translations of addons without having that wow client installed
return -- nop, we don't need these translations local activeGameLocale = GAME_LOCALE or gameLocale
end
local app = AceLocale.apps[application] local app = AceLocale.apps[application]
if silent and app and getmetatable(app) ~= readmetasilent then
geterrorhandler()("Usage: NewLocale(application, locale[, isDefault[, silent]]): 'silent' must be specified for the first locale registered")
end
if not app then if not app then
app = setmetatable({}, silent and readmetasilent or readmeta) if silent=="raw" then
app = {}
else
app = setmetatable({}, silent and readmetasilent or readmeta)
end
AceLocale.apps[application] = app AceLocale.apps[application] = app
AceLocale.appnames[app] = application AceLocale.appnames[app] = application
end end
if locale ~= activeGameLocale and not isDefault then
return -- nop, we don't need these translations
end
registering = app -- remember globally for writeproxy and writedefaultproxy registering = app -- remember globally for writeproxy and writedefaultproxy
if isDefault then if isDefault then
return writedefaultproxy return writedefaultproxy
end end
+172 -367
View File
@@ -1,296 +1,124 @@
--- **AceTimer-3.0** provides a central facility for registering timers. --- **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 -- 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, rescheduled -- 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.\\ -- 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.1s. 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 seemed like a good compromise in efficiency and accuracy. -- restricts us to.
-- --
-- All `:Schedule` functions will return a handle to the current timer, which you will need to store if you -- All `:Schedule` functions will return a handle to the current timer, which you will need to store if you
-- need to cancel or reschedule the timer you just registered. -- 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 -- **AceTimer-3.0** can be embeded into your addon, either explicitly by calling AceTimer:Embed(MyAddon) or by
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object -- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object
-- and can be accessed directly, without having to explicitly call AceTimer itself.\\ -- 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 -- It is recommended to embed AceTimer, otherwise you'll have to specify a custom `self` on all calls you
-- make into AceTimer. -- make into AceTimer.
-- @class file -- @class file
-- @name AceTimer-3.0 -- @name AceTimer-3.0
-- @release $Id: AceTimer-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ -- @release $Id$
--[[ local MAJOR, MINOR = "AceTimer-3.0", 17 -- Bump minor on changes
Basic assumptions:
* In a typical system, we do more re-scheduling per second than there are timer pulses per second
* Regardless of timer implementation, we cannot guarantee timely delivery due to FPS restriction (may be as low as 10)
This implementation:
CON: The smallest timer interval is constrained by HZ (currently 1/10s).
PRO: It will still correctly fire any timer slower than HZ over a length of time, e.g. 0.11s interval -> 90 times over 10 seconds
PRO: In lag bursts, the system simly skips missed timer intervals to decrease load
CON: Algorithms depending on a timer firing "N times per minute" will fail
PRO: (Re-)scheduling is O(1) with a VERY small constant. It's a simple linked list insertion in a hash bucket.
CAUTION: The BUCKETS constant constrains how many timers can be efficiently handled. With too many hash collisions, performance will decrease.
Major assumptions upheld:
- ALLOWS scheduling multiple timers with the same funcref/method
- ALLOWS scheduling more timers during OnUpdate processing
- ALLOWS unscheduling ANY timer (including the current running one) at any time, including during OnUpdate processing
]]
local MAJOR, MINOR = "AceTimer-3.0", 5
local AceTimer, oldminor = LibStub:NewLibrary(MAJOR, MINOR) local AceTimer, oldminor = LibStub:NewLibrary(MAJOR, MINOR)
if not AceTimer then return end -- No upgrade needed if not AceTimer then return end -- No upgrade needed
AceTimer.activeTimers = AceTimer.activeTimers or {} -- Active timer list
AceTimer.hash = AceTimer.hash or {} -- Array of [0..BUCKET-1] = linked list of timers (using .next member) local activeTimers = AceTimer.activeTimers -- Upvalue our private data
-- Linked list gets around ACE-88 and ACE-90.
AceTimer.selfs = AceTimer.selfs or {} -- Array of [self]={[handle]=timerobj, [handle2]=timerobj2, ...}
AceTimer.frame = AceTimer.frame or CreateFrame("Frame", "AceTimer30Frame")
-- Lua APIs -- Lua APIs
local assert, error, loadstring = assert, error, loadstring local type, unpack, next, error, select = type, unpack, next, error, select
local setmetatable, rawset, rawget = setmetatable, rawset, rawget
local select, pairs, type, next, tostring = select, pairs, type, next, tostring
local floor, max, min = math.floor, math.max, math.min
local tconcat = table.concat
-- WoW APIs -- WoW APIs
local GetTime = GetTime local GetTime, C_TimerAfter = GetTime, C_Timer.After
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded local function new(self, loop, func, delay, ...)
-- List them here for Mikk's FindGlobals script if delay < 0.01 then
-- GLOBALS: DEFAULT_CHAT_FRAME, geterrorhandler delay = 0.01 -- Restrict to the lowest time that the C_Timer API allows us
-- Simple ONE-SHOT timer cache. Much more efficient than a full compost for our purposes.
local timerCache = nil
--[[
Timers will not be fired more often than HZ-1 times per second.
Keep at intended speed PLUS ONE or we get bitten by floating point rounding errors (n.5 + 0.1 can be n.599999)
If this is ever LOWERED, all existing timers need to be enforced to have a delay >= 1/HZ on lib upgrade.
If this number is ever changed, all entries need to be rehashed on lib upgrade.
]]
local HZ = 11
--[[
Prime for good distribution
If this number is ever changed, all entries need to be rehashed on lib upgrade.
]]
local BUCKETS = 131
local hash = AceTimer.hash
for i=1,BUCKETS do
hash[i] = hash[i] or false -- make it an integer-indexed array; it's faster than hashes
end
--[[
xpcall safecall implementation
]]
local xpcall = xpcall
local function errorhandler(err)
return geterrorhandler()(err)
end
local function CreateDispatcher(argCount)
local code = [[
local xpcall, eh = ... -- our arguments are received as unnamed values in "..." since we don't have a proper function declaration
local method, ARGS
local function call() return method(ARGS) end
local function dispatch(func, ...)
method = func
if not method then return end
ARGS = ...
return xpcall(call, eh)
end
return dispatch
]]
local ARGS = {}
for i = 1, argCount do ARGS[i] = "arg"..i end
code = code:gsub("ARGS", tconcat(ARGS, ", "))
return assert(loadstring(code, "safecall Dispatcher["..argCount.."]"))(xpcall, errorhandler)
end
local Dispatchers = setmetatable({}, {
__index=function(self, argCount)
local dispatcher = CreateDispatcher(argCount)
rawset(self, argCount, dispatcher)
return dispatcher
end end
})
Dispatchers[0] = function(func)
return xpcall(func, errorhandler)
end
local function safecall(func, ...)
return Dispatchers[select('#', ...)](func, ...)
end
local lastint = floor(GetTime() * HZ) local timer = {
object = self,
func = func,
looping = loop,
argsCount = select("#", ...),
delay = delay,
ends = GetTime() + delay,
...
}
-- -------------------------------------------------------------------- activeTimers[timer] = timer
-- OnUpdate handler
--
-- traverse buckets, always chasing "now", and fire timers that have expired
local function OnUpdate() -- Create new timer closure to wrap the "timer" object
local now = GetTime() timer.callback = function()
local nowint = floor(now * HZ) if not timer.cancelled then
if type(timer.func) == "string" then
-- Have we passed into a new hash bucket? -- We manually set the unpack count to prevent issues with an arg set that contains nil and ends with nil
if nowint == lastint then return end -- e.g. local t = {1, 2, nil, 3, nil} print(#t) will result in 2, instead of 5. This fixes said issue.
timer.object[timer.func](timer.object, unpack(timer, 1, timer.argsCount))
local soon = now + 1 -- +1 is safe as long as 1 < HZ < BUCKETS/2 else
timer.func(unpack(timer, 1, timer.argsCount))
-- Pass through each bucket at most once end
-- Happens on e.g. instance loads, but COULD happen on high local load situations also
for curint = (max(lastint, nowint - BUCKETS) + 1), nowint do -- loop until we catch up with "now", usually only 1 iteration
local curbucket = (curint % BUCKETS)+1
-- Yank the list of timers out of the bucket and empty it. This allows reinsertion in the currently-processed bucket from callbacks.
local nexttimer = hash[curbucket]
hash[curbucket] = false -- false rather than nil to prevent the array from becoming a hash
while nexttimer do if timer.looping and not timer.cancelled then
local timer = nexttimer -- Compensate delay to get a perfect average delay, even if individual times don't match up perfectly
nexttimer = timer.next -- due to fps differences
local when = timer.when local time = GetTime()
local ndelay = timer.delay - (time - timer.ends)
if when < soon then -- Ensure the delay doesn't go below the threshold
-- Call the timer func, either as a method on given object, or a straight function ref if ndelay < 0.01 then ndelay = 0.01 end
local callback = timer.callback C_TimerAfter(ndelay, timer.callback)
if type(callback) == "string" then timer.ends = time + ndelay
safecall(timer.object[callback], timer.object, timer.arg) else
elseif callback then activeTimers[timer.handle or timer] = nil
safecall(callback, timer.arg) end
else
-- probably nilled out by CancelTimer
timer.delay = nil -- don't reschedule it
end
local delay = timer.delay -- NOW make a local copy, can't do it earlier in case the timer cancelled itself in the callback
if not delay then
-- single-shot timer (or cancelled)
AceTimer.selfs[timer.object][tostring(timer)] = nil
timerCache = timer
else
-- repeating timer
local newtime = when + delay
if newtime < now then -- Keep lag from making us firing a timer unnecessarily. (Note that this still won't catch too-short-delay timers though.)
newtime = now + delay
end
timer.when = newtime
-- add next timer execution to the correct bucket
local bucket = (floor(newtime * HZ) % BUCKETS) + 1
timer.next = hash[bucket]
hash[bucket] = timer
end
else -- if when>=soon
-- reinsert (yeah, somewhat expensive, but shouldn't be happening too often either due to hash distribution)
timer.next = hash[curbucket]
hash[curbucket] = timer
end -- if when<soon ... else
end -- while nexttimer do
end -- for curint=lastint,nowint
lastint = nowint
end
-- ---------------------------------------------------------------------
-- Reg( callback, delay, arg, repeating )
--
-- callback( function or string ) - direct function ref or method name in our object for the callback
-- delay(int) - delay for the timer
-- arg(variant) - any argument to be passed to the callback function
-- repeating(boolean) - repeating timer, or oneshot
--
-- returns the handle of the timer for later processing (canceling etc)
local function Reg(self, callback, delay, arg, repeating)
if type(callback) ~= "string" and type(callback) ~= "function" then
local error_origin = repeating and "ScheduleRepeatingTimer" or "ScheduleTimer"
error(MAJOR..": " .. error_origin .. "(callback, delay, arg): 'callback' - function or method name expected.", 3)
end
if type(callback) == "string" then
if type(self)~="table" then
local error_origin = repeating and "ScheduleRepeatingTimer" or "ScheduleTimer"
error(MAJOR..": " .. error_origin .. "(\"methodName\", delay, arg): 'self' - must be a table.", 3)
end
if type(self[callback]) ~= "function" then
local error_origin = repeating and "ScheduleRepeatingTimer" or "ScheduleTimer"
error(MAJOR..": " .. error_origin .. "(\"methodName\", delay, arg): 'methodName' - method not found on target object.", 3)
end end
end end
if delay < (1 / (HZ - 1)) then
delay = 1 / (HZ - 1)
end
-- Create and stuff timer in the correct hash bucket
local now = GetTime()
local timer = timerCache or {} -- Get new timer object (from cache if available)
timerCache = nil
timer.object = self
timer.callback = callback
timer.delay = (repeating and delay)
timer.arg = arg
timer.when = now + delay
local bucket = (floor((now+delay)*HZ) % BUCKETS) + 1 C_TimerAfter(delay, timer.callback)
timer.next = hash[bucket] return timer
hash[bucket] = timer
-- Insert timer in our self->handle->timer registry
local handle = tostring(timer)
local selftimers = AceTimer.selfs[self]
if not selftimers then
selftimers = {}
AceTimer.selfs[self] = selftimers
end
selftimers[handle] = timer
selftimers.__ops = (selftimers.__ops or 0) + 1
return handle
end end
--- Schedule a new one-shot timer. --- Schedule a new one-shot timer.
-- The timer will fire once in `delay` seconds, unless canceled before. -- The timer will fire once in `delay` seconds, unless canceled before.
-- @param callback Callback function for the timer pulse (funcref or method name). -- @param func Callback function for the timer pulse (funcref or method name).
-- @param delay Delay for the timer, in seconds. -- @param delay Delay for the timer, in seconds.
-- @param arg An optional argument to be passed to the callback function. -- @param ... An optional, unlimited amount of arguments to pass to the callback function.
-- @usage -- @usage
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("TimerTest", "AceTimer-3.0") -- MyAddOn = LibStub("AceAddon-3.0"):NewAddon("MyAddOn", "AceTimer-3.0")
-- --
-- function MyAddon:OnEnable() -- function MyAddOn:OnEnable()
-- self:ScheduleTimer("TimerFeedback", 5) -- self:ScheduleTimer("TimerFeedback", 5)
-- end -- end
-- --
-- function MyAddon:TimerFeedback() -- function MyAddOn:TimerFeedback()
-- print("5 seconds passed") -- print("5 seconds passed")
-- end -- end
function AceTimer:ScheduleTimer(callback, delay, arg) function AceTimer:ScheduleTimer(func, delay, ...)
return Reg(self, callback, delay, arg) if not func or not delay then
error(MAJOR..": ScheduleTimer(callback, delay, args...): 'callback' and 'delay' must have set values.", 2)
end
if type(func) == "string" then
if type(self) ~= "table" then
error(MAJOR..": ScheduleTimer(callback, delay, args...): 'self' - must be a table.", 2)
elseif not self[func] then
error(MAJOR..": ScheduleTimer(callback, delay, args...): Tried to register '"..func.."' as the callback, but it doesn't exist in the module.", 2)
end
end
return new(self, nil, func, delay, ...)
end end
--- Schedule a repeating timer. --- Schedule a repeating timer.
-- The timer will fire every `delay` seconds, until canceled. -- The timer will fire every `delay` seconds, until canceled.
-- @param callback Callback function for the timer pulse (funcref or method name). -- @param func Callback function for the timer pulse (funcref or method name).
-- @param delay Delay for the timer, in seconds. -- @param delay Delay for the timer, in seconds.
-- @param arg An optional argument to be passed to the callback function. -- @param ... An optional, unlimited amount of arguments to pass to the callback function.
-- @usage -- @usage
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("TimerTest", "AceTimer-3.0") -- MyAddOn = LibStub("AceAddon-3.0"):NewAddon("MyAddOn", "AceTimer-3.0")
-- --
-- function MyAddon:OnEnable() -- function MyAddOn:OnEnable()
-- self.timerCount = 0 -- self.timerCount = 0
-- self.testTimer = self:ScheduleRepeatingTimer("TimerFeedback", 5) -- self.testTimer = self:ScheduleRepeatingTimer("TimerFeedback", 5)
-- end -- end
-- --
-- function MyAddon:TimerFeedback() -- function MyAddOn:TimerFeedback()
-- self.timerCount = self.timerCount + 1 -- self.timerCount = self.timerCount + 1
-- print(("%d seconds passed"):format(5 * self.timerCount)) -- print(("%d seconds passed"):format(5 * self.timerCount))
-- -- run 30 seconds in total -- -- run 30 seconds in total
@@ -298,129 +126,124 @@ end
-- self:CancelTimer(self.testTimer) -- self:CancelTimer(self.testTimer)
-- end -- end
-- end -- end
function AceTimer:ScheduleRepeatingTimer(callback, delay, arg) function AceTimer:ScheduleRepeatingTimer(func, delay, ...)
return Reg(self, callback, delay, arg, true) if not func or not delay then
error(MAJOR..": ScheduleRepeatingTimer(callback, delay, args...): 'callback' and 'delay' must have set values.", 2)
end
if type(func) == "string" then
if type(self) ~= "table" then
error(MAJOR..": ScheduleRepeatingTimer(callback, delay, args...): 'self' - must be a table.", 2)
elseif not self[func] then
error(MAJOR..": ScheduleRepeatingTimer(callback, delay, args...): Tried to register '"..func.."' as the callback, but it doesn't exist in the module.", 2)
end
end
return new(self, true, func, delay, ...)
end end
--- Cancels a timer with the given handle, registered by the same addon object as used for `:ScheduleTimer` --- Cancels a timer with the given id, registered by the same addon object as used for `:ScheduleTimer`
-- Both one-shot and repeating timers can be canceled with this function, as long as the `handle` is valid -- 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. -- and the timer has not fired yet or was canceled before.
-- @param handle The handle of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer` -- @param id The id of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer`
-- @param silent If true, no error is raised if the timer handle is invalid (expired or already canceled) function AceTimer:CancelTimer(id)
-- @return True if the timer was successfully cancelled. local timer = activeTimers[id]
function AceTimer:CancelTimer(handle, silent)
if not handle then return end -- nil handle -> bail out without erroring if not timer then
if type(handle) ~= "string" then return false
error(MAJOR..": CancelTimer(handle): 'handle' - expected a string", 2) -- for now, anyway
end
local selftimers = AceTimer.selfs[self]
local timer = selftimers and selftimers[handle]
if silent then
if timer then
timer.callback = nil -- don't run it again
timer.delay = nil -- if this is the currently-executing one: don't even reschedule
-- The timer object is removed in the OnUpdate loop
end
return not not timer -- might return "true" even if we double-cancel. we'll live.
else else
if not timer then timer.cancelled = true
geterrorhandler()(MAJOR..": CancelTimer(handle[, silent]): '"..tostring(handle).."' - no such timer registered") activeTimers[id] = nil
return false
end
if not timer.callback then
geterrorhandler()(MAJOR..": CancelTimer(handle[, silent]): '"..tostring(handle).."' - timer already cancelled or expired")
return false
end
timer.callback = nil -- don't run it again
timer.delay = nil -- if this is the currently-executing one: don't even reschedule
return true return true
end end
end end
--- Cancels all timers registered to the current addon object ('self') --- Cancels all timers registered to the current addon object ('self')
function AceTimer:CancelAllTimers() function AceTimer:CancelAllTimers()
if not(type(self) == "string" or type(self) == "table") then for k,v in next, activeTimers do
error(MAJOR..": CancelAllTimers(): 'self' - must be a string or a table",2) if v.object == self then
end AceTimer.CancelTimer(self, k)
if self == AceTimer then
error(MAJOR..": CancelAllTimers(): supply a meaningful 'self'", 2)
end
local selftimers = AceTimer.selfs[self]
if selftimers then
for handle,v in pairs(selftimers) do
if type(v) == "table" then -- avoid __ops, etc
AceTimer.CancelTimer(self, handle, true)
end
end end
end end
end end
--- Returns the time left for a timer with the given handle, registered by the current addon object ('self'). --- Returns the time left for a timer with the given id, registered by the current addon object ('self').
-- This function will raise a warning when the handle is invalid, but not stop execution. -- This function will return 0 when the id is invalid.
-- @param handle The handle of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer` -- @param id The id of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer`
-- @return The time left on the timer, or false if the handle is invalid. -- @return The time left on the timer.
function AceTimer:TimeLeft(handle) function AceTimer:TimeLeft(id)
if not handle then return end local timer = activeTimers[id]
if type(handle) ~= "string" then
error(MAJOR..": TimeLeft(handle): 'handle' - expected a string", 2) -- for now, anyway
end
local selftimers = AceTimer.selfs[self]
local timer = selftimers and selftimers[handle]
if not timer then if not timer then
geterrorhandler()(MAJOR..": TimeLeft(handle): '"..tostring(handle).."' - no such timer registered") return 0
return false else
return timer.ends - GetTime()
end end
return timer.when - GetTime()
end end
-- --------------------------------------------------------------------- -- ---------------------------------------------------------------------
-- PLAYER_REGEN_ENABLED: Run through our .selfs[] array step by step -- Upgrading
-- and clean it out - otherwise the table indices can grow indefinitely
-- if an addon starts and stops a lot of timers. AceBucket does this!
--
-- See ACE-94 and tests/AceTimer-3.0-ACE-94.lua
local lastCleaned = nil -- 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 next, AceTimer.selfs do
for handle,timer in next, timers do
if type(timer) == "table" and timer.callback then
local newTimer
if timer.delay then
newTimer = AceTimer.ScheduleRepeatingTimer(timer.object, timer.callback, timer.delay, timer.arg)
else
newTimer = AceTimer.ScheduleTimer(timer.object, timer.callback, timer.when - GetTime(), timer.arg)
end
-- Use the old handle for old timers
activeTimers[newTimer] = nil
activeTimers[handle] = newTimer
newTimer.handle = handle
end
end
end
AceTimer.selfs = nil
AceTimer.hash = nil
AceTimer.debug = nil
elseif oldminor and oldminor < 17 then
-- Upgrade from old animation based timers to C_Timer.After timers.
AceTimer.inactiveTimers = nil
AceTimer.frame = nil
local oldTimers = AceTimer.activeTimers
-- Clear old timer table and update upvalue
AceTimer.activeTimers = {}
activeTimers = AceTimer.activeTimers
for handle, timer in next, oldTimers do
local newTimer
-- Stop the old timer animation
local duration, elapsed = timer:GetDuration(), timer:GetElapsed()
timer:GetParent():Stop()
if timer.looping then
newTimer = AceTimer.ScheduleRepeatingTimer(timer.object, timer.func, duration, unpack(timer.args, 1, timer.argsCount))
else
newTimer = AceTimer.ScheduleTimer(timer.object, timer.func, duration - elapsed, unpack(timer.args, 1, timer.argsCount))
end
-- Use the old handle for old timers
activeTimers[newTimer] = nil
activeTimers[handle] = newTimer
newTimer.handle = handle
end
local function OnEvent(this, event) -- Migrate transitional handles
if event~="PLAYER_REGEN_ENABLED" then if oldminor < 13 and AceTimer.hashCompatTable then
return for handle, id in next, 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
-- Get the next 'self' to process
local selfs = AceTimer.selfs
local self = next(selfs, lastCleaned)
if not self then
self = next(selfs)
end
lastCleaned = self
if not self then -- should only happen if .selfs[] is empty
return
end
-- Time to clean it out?
local list = selfs[self]
if (list.__ops or 0) < 250 then -- 250 slosh indices = ~10KB wasted (max!). For one 'self'.
return
end
-- Create a new table and copy all members over
local newlist = {}
local n=0
for k,v in pairs(list) do
newlist[k] = v
n=n+1
end
newlist.__ops = 0 -- Reset operation count
-- And since we now have a count of the number of live timers, check that it's reasonable. Emit a warning if not.
if n>BUCKETS then
DEFAULT_CHAT_FRAME:AddMessage(MAJOR..": Warning: The addon/module '"..tostring(self).."' has "..n.." live timers. Surely that's not intended?")
end
selfs[self] = newlist
end end
-- --------------------------------------------------------------------- -- ---------------------------------------------------------------------
@@ -429,45 +252,27 @@ end
AceTimer.embeds = AceTimer.embeds or {} AceTimer.embeds = AceTimer.embeds or {}
local mixins = { local mixins = {
"ScheduleTimer", "ScheduleRepeatingTimer", "ScheduleTimer", "ScheduleRepeatingTimer",
"CancelTimer", "CancelAllTimers", "CancelTimer", "CancelAllTimers",
"TimeLeft" "TimeLeft"
} }
function AceTimer:Embed(target) function AceTimer:Embed(target)
AceTimer.embeds[target] = true AceTimer.embeds[target] = true
for _,v in pairs(mixins) do for _,v in next, mixins do
target[v] = AceTimer[v] target[v] = AceTimer[v]
end end
return target return target
end end
-- AceTimer:OnEmbedDisable( target ) -- AceTimer:OnEmbedDisable(target)
-- target (object) - target object that AceTimer is embedded in. -- target (object) - target object that AceTimer is embedded in.
-- --
-- cancel all timers registered for the object -- cancel all timers registered for the object
function AceTimer:OnEmbedDisable( target ) function AceTimer:OnEmbedDisable(target)
target:CancelAllTimers() target:CancelAllTimers()
end end
for addon in next, AceTimer.embeds do
for addon in pairs(AceTimer.embeds) do
AceTimer:Embed(addon) AceTimer:Embed(addon)
end end
-- ---------------------------------------------------------------------
-- Debug tools (expose copies of internals to test suites)
AceTimer.debug = AceTimer.debug or {}
AceTimer.debug.HZ = HZ
AceTimer.debug.BUCKETS = BUCKETS
-- ---------------------------------------------------------------------
-- Finishing touchups
AceTimer.frame:SetScript("OnUpdate", OnUpdate)
AceTimer.frame:SetScript("OnEvent", OnEvent)
AceTimer.frame:RegisterEvent("PLAYER_REGEN_ENABLED")
-- In theory, we should hide&show the frame based on there being timers or not.
-- However, this job is fairly expensive, and the chance that there will
-- actually be zero timers running is diminuitive to say the lest.
@@ -1,5 +1,5 @@
--[[ $Id: CallbackHandler-1.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ ]] --[[ $Id: CallbackHandler-1.0.lua 25 2022-12-12 15:02:36Z nevcairiel $ ]]
local MAJOR, MINOR = "CallbackHandler-1.0", 5 local MAJOR, MINOR = "CallbackHandler-1.0", 8
local CallbackHandler = LibStub:NewLibrary(MAJOR, MINOR) local CallbackHandler = LibStub:NewLibrary(MAJOR, MINOR)
if not CallbackHandler then return end -- No upgrade needed if not CallbackHandler then return end -- No upgrade needed
@@ -7,56 +7,20 @@ if not CallbackHandler then return end -- No upgrade needed
local meta = {__index = function(tbl, key) tbl[key] = {} return tbl[key] end} local meta = {__index = function(tbl, key) tbl[key] = {} return tbl[key] end}
-- Lua APIs -- Lua APIs
local tconcat = table.concat local securecallfunction, error = securecallfunction, error
local assert, error, loadstring = assert, error, loadstring local setmetatable, rawget = setmetatable, rawget
local setmetatable, rawset, rawget = setmetatable, rawset, rawget
local next, select, pairs, type, tostring = next, select, pairs, type, tostring local next, select, pairs, type, tostring = next, select, pairs, type, tostring
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
-- List them here for Mikk's FindGlobals script
-- GLOBALS: geterrorhandler
local xpcall = xpcall local function Dispatch(handlers, ...)
local index, method = next(handlers)
local function errorhandler(err) if not method then return end
return geterrorhandler()(err) repeat
securecallfunction(method, ...)
index, method = next(handlers, index)
until not method
end end
local function CreateDispatcher(argCount)
local code = [[
local next, xpcall, eh = ...
local method, ARGS
local function call() method(ARGS) end
local function dispatch(handlers, ...)
local index
index, method = next(handlers)
if not method then return end
local OLD_ARGS = ARGS
ARGS = ...
repeat
xpcall(call, eh)
index, method = next(handlers, index)
until not method
ARGS = OLD_ARGS
end
return dispatch
]]
local ARGS, OLD_ARGS = {}, {}
for i = 1, argCount do ARGS[i], OLD_ARGS[i] = "arg"..i, "old_arg"..i end
code = code:gsub("OLD_ARGS", tconcat(OLD_ARGS, ", ")):gsub("ARGS", tconcat(ARGS, ", "))
return assert(loadstring(code, "safecall Dispatcher["..argCount.."]"))(next, xpcall, errorhandler)
end
local Dispatchers = setmetatable({}, {__index=function(self, argCount)
local dispatcher = CreateDispatcher(argCount)
rawset(self, argCount, dispatcher)
return dispatcher
end})
-------------------------------------------------------------------------- --------------------------------------------------------------------------
-- CallbackHandler:New -- CallbackHandler:New
-- --
@@ -65,9 +29,7 @@ end})
-- UnregisterName - name of the callback unregistration API, default "UnregisterCallback" -- UnregisterName - name of the callback unregistration API, default "UnregisterCallback"
-- UnregisterAllName - name of the API to unregister all callbacks, default "UnregisterAllCallbacks". false == don't publish this API. -- UnregisterAllName - name of the API to unregister all callbacks, default "UnregisterAllCallbacks". false == don't publish this API.
function CallbackHandler:New(target, RegisterName, UnregisterName, UnregisterAllName, OnUsed, OnUnused) function CallbackHandler.New(_self, target, RegisterName, UnregisterName, UnregisterAllName)
-- TODO: Remove this after beta has gone out
assert(not OnUsed and not OnUnused, "ACE-80: OnUsed/OnUnused are deprecated. Callbacks are now done to registry.OnUsed and registry.OnUnused")
RegisterName = RegisterName or "RegisterCallback" RegisterName = RegisterName or "RegisterCallback"
UnregisterName = UnregisterName or "UnregisterCallback" UnregisterName = UnregisterName or "UnregisterCallback"
@@ -89,19 +51,19 @@ function CallbackHandler:New(target, RegisterName, UnregisterName, UnregisterAll
local oldrecurse = registry.recurse local oldrecurse = registry.recurse
registry.recurse = oldrecurse + 1 registry.recurse = oldrecurse + 1
Dispatchers[select('#', ...) + 1](events[eventname], eventname, ...) Dispatch(events[eventname], eventname, ...)
registry.recurse = oldrecurse registry.recurse = oldrecurse
if registry.insertQueue and oldrecurse==0 then if registry.insertQueue and oldrecurse==0 then
-- Something in one of our callbacks wanted to register more callbacks; they got queued -- Something in one of our callbacks wanted to register more callbacks; they got queued
for eventname,callbacks in pairs(registry.insertQueue) do for event,callbacks in pairs(registry.insertQueue) do
local first = not rawget(events, eventname) or not next(events[eventname]) -- test for empty before. not test for one member after. that one member may have been overwritten. local first = not rawget(events, event) or not next(events[event]) -- test for empty before. not test for one member after. that one member may have been overwritten.
for self,func in pairs(callbacks) do for object,func in pairs(callbacks) do
events[eventname][self] = func events[event][object] = func
-- fire OnUsed callback? -- fire OnUsed callback?
if first and registry.OnUsed then if first and registry.OnUsed then
registry.OnUsed(registry, target, eventname) registry.OnUsed(registry, target, event)
first = nil first = nil
end end
end end
@@ -147,9 +109,9 @@ function CallbackHandler:New(target, RegisterName, UnregisterName, UnregisterAll
regfunc = function(...) self[method](self,...) end regfunc = function(...) self[method](self,...) end
end end
else else
-- function ref with self=object or self="addonId" -- function ref with self=object or self="addonId" or self=thread
if type(self)~="table" and type(self)~="string" then if type(self)~="table" and type(self)~="string" and type(self)~="thread" then
error("Usage: "..RegisterName.."(self or \"addonId\", eventname, method): 'self or addonId': table or string expected.", 2) error("Usage: "..RegisterName.."(self or \"addonId\", eventname, method): 'self or addonId': table or string or thread expected.", 2)
end end
if select("#",...)>=1 then -- this is not the same as testing for arg==nil! if select("#",...)>=1 then -- this is not the same as testing for arg==nil!
-1
View File
@@ -1 +0,0 @@
package-as: LibStub
+5 -5
View File
@@ -7,24 +7,24 @@ if not LibStub or LibStub.minor < LIBSTUB_MINOR then
LibStub = LibStub or {libs = {}, minors = {} } LibStub = LibStub or {libs = {}, minors = {} }
_G[LIBSTUB_MAJOR] = LibStub _G[LIBSTUB_MAJOR] = LibStub
LibStub.minor = LIBSTUB_MINOR LibStub.minor = LIBSTUB_MINOR
function LibStub:NewLibrary(major, minor) function LibStub:NewLibrary(major, minor)
assert(type(major) == "string", "Bad argument #2 to `NewLibrary' (string expected)") assert(type(major) == "string", "Bad argument #2 to `NewLibrary' (string expected)")
minor = assert(tonumber(strmatch(minor, "%d+")), "Minor version must either be a number or contain a number.") minor = assert(tonumber(string.match(minor, "%d+")), "Minor version must either be a number or contain a number.")
local oldminor = self.minors[major] local oldminor = self.minors[major]
if oldminor and oldminor >= minor then return nil end if oldminor and oldminor >= minor then return nil end
self.minors[major], self.libs[major] = minor, self.libs[major] or {} self.minors[major], self.libs[major] = minor, self.libs[major] or {}
return self.libs[major], oldminor return self.libs[major], oldminor
end end
function LibStub:GetLibrary(major, silent) function LibStub:GetLibrary(major, silent)
if not self.libs[major] and not silent then if not self.libs[major] and not silent then
error(("Cannot find a library instance of %q."):format(tostring(major)), 2) error(("Cannot find a library instance of %q."):format(tostring(major)), 2)
end end
return self.libs[major], self.minors[major] return self.libs[major], self.minors[major]
end end
function LibStub:IterateLibraries() return pairs(self.libs) end function LibStub:IterateLibraries() return pairs(self.libs) end
setmetatable(LibStub, { __call = LibStub.GetLibrary }) setmetatable(LibStub, { __call = LibStub.GetLibrary })
end end
-9
View File
@@ -1,9 +0,0 @@
## Interface: 20400
## Title: Lib: LibStub
## Notes: Universal Library Stub
## Credits: Kaelten, Cladhaire, ckknight, Mikk, Ammo, Nevcairiel
## X-Website: http://jira.wowace.com/browse/LS
## X-Category: Library
## X-License: Public Domain
LibStub.lua
+71
View File
@@ -0,0 +1,71 @@
#!/usr/bin/env bash
# Build per-addon zip artefacts from HEAD via git-archive.
#
# - Discovers top-level addon folders (Foo/Foo.toc).
# - Re-creates dist/ each run.
# - Always archives HEAD, so the working tree state is irrelevant.
# - If more than one addon folder is present, also emits <repo>-all.zip
# with every addon folder side-by-side at the zip root.
# - When run inside Gitea Actions the working tree lives under a
# per-job dir like /var/lib/act_runner/work/.../hostexecutor, so the
# repo name comes from $GITHUB_REPOSITORY (set by the runner) and
# only falls back to the toplevel basename for local invocations.
set -euo pipefail
root=$(git rev-parse --show-toplevel)
cd "$root"
# Gitea Actions sets GITHUB_REPOSITORY=owner/repo. The basename of
# `git rev-parse --show-toplevel` inside the runner is the worker dir
# (e.g. `hostexecutor`), which would name the bundle wrong.
if [ -n "${GITHUB_REPOSITORY:-}" ]; then
repo_name="${GITHUB_REPOSITORY##*/}"
else
repo_name=$(basename "$root")
fi
dist="$root/dist"
# Find Foo/Foo.toc pairs at depth 1; ignore libs nested deeper.
addons=()
while IFS= read -r toc; do
dir=$(dirname "$toc")
folder=$(basename "$dir")
base=$(basename "$toc" .toc)
# Accept Foo.toc and Foo_Wrath.toc style flavour variants; folder must match
# at least one toc basename prefix (Foo).
case "$base" in
"$folder"|"$folder"_*) addons+=("$folder") ;;
esac
done < <(command find . -mindepth 2 -maxdepth 2 -type f -name '*.toc' | sed 's|^\./||' | sort)
# Dedupe (a folder with Foo.toc + Foo_Wrath.toc shows up twice).
if [ ${#addons[@]} -gt 0 ]; then
mapfile -t addons < <(printf '%s\n' "${addons[@]}" | awk '!seen[$0]++')
fi
if [ ${#addons[@]} -eq 0 ]; then
echo "no addon folders found (looking for */Foo.toc with matching folder name)" >&2
exit 1
fi
rm -rf "$dist"
mkdir -p "$dist"
for folder in "${addons[@]}"; do
out="$dist/$folder.zip"
# No --prefix: the folder already sits at the repo root, so git-archive
# emits entries as <folder>/... which is exactly what
# Interface/AddOns/ expects after extraction.
git archive HEAD --format=zip -o "$out" -- "$folder"
echo "built dist/$folder.zip"
done
# Combined bundle only makes sense when there are multiple addons.
if [ ${#addons[@]} -gt 1 ]; then
tmp=$(mktemp -d)
trap 'rm -rf "$tmp"' EXIT
git archive HEAD --format=tar -- "${addons[@]}" | tar -x -C "$tmp"
out="$dist/$repo_name-all.zip"
( cd "$tmp" && zip -qr "$out" "${addons[@]}" )
echo "built dist/$repo_name-all.zip"
fi