diff --git a/Artemis/Artemis/Artemis.csproj b/Artemis/Artemis/Artemis.csproj index 9f1be00a2..461ac63df 100644 --- a/Artemis/Artemis/Artemis.csproj +++ b/Artemis/Artemis/Artemis.csproj @@ -410,6 +410,7 @@ + @@ -811,6 +812,16 @@ Code + + + + + + + + + + Designer @@ -1085,6 +1096,12 @@ + + + + + + diff --git a/Artemis/Artemis/InjectionModules/BaseModules.cs b/Artemis/Artemis/InjectionModules/BaseModules.cs index 3cf6d05be..5013b4d2a 100644 --- a/Artemis/Artemis/InjectionModules/BaseModules.cs +++ b/Artemis/Artemis/InjectionModules/BaseModules.cs @@ -2,6 +2,7 @@ using Artemis.Managers; using Artemis.Models; using Artemis.Modules.Abstract; +using Artemis.Modules.Games.WoW; using Artemis.Profiles.Layers.Abstract; using Artemis.Profiles.Layers.Interfaces; using Artemis.Profiles.Layers.Types.Audio.AudioCapturing; @@ -65,7 +66,7 @@ namespace Artemis.InjectionModules #endregion - #region Effects + #region Modules Kernel.Bind(x => x.FromThisAssembly() @@ -81,6 +82,7 @@ namespace Artemis.InjectionModules .BindAllBaseClasses() .Configure(b => b.InSingletonScope()) ); + Bind().ToSelf(); #endregion diff --git a/Artemis/Artemis/Modules/Games/WoW/Models/WoWAura.cs b/Artemis/Artemis/Modules/Games/WoW/Models/WoWAura.cs index 3511e7db7..583283e07 100644 --- a/Artemis/Artemis/Modules/Games/WoW/Models/WoWAura.cs +++ b/Artemis/Artemis/Modules/Games/WoW/Models/WoWAura.cs @@ -9,17 +9,16 @@ namespace Artemis.Modules.Games.WoW.Models { public string Name { get; set; } public int Id { get; set; } - public string Caster { get; set; } public int Stacks { get; set; } public DateTime StartTime { set; get; } public DateTime EndTime { get; set; } public void ApplyJson(JToken buffJson) { - Name = buffJson["name"].Value(); - Id = buffJson["spellID"].Value(); - Stacks = buffJson["count"].Value(); - Caster = buffJson["caster"]?.Value(); + Name = buffJson["n"].Value(); + Id = buffJson["id"].Value(); + if (buffJson["c"] != null) + Stacks = buffJson["c"].Value(); // TODO: Duration } diff --git a/Artemis/Artemis/Modules/Games/WoW/Models/WoWCastBar.cs b/Artemis/Artemis/Modules/Games/WoW/Models/WoWCastBar.cs index 37cc83c79..bad744da5 100644 --- a/Artemis/Artemis/Modules/Games/WoW/Models/WoWCastBar.cs +++ b/Artemis/Artemis/Modules/Games/WoW/Models/WoWCastBar.cs @@ -20,15 +20,15 @@ namespace Artemis.Modules.Games.WoW.Models public void ApplyJson(JToken spellJson) { - var castMs = spellJson["endTime"].Value() - spellJson["startTime"].Value(); + var castMs = spellJson["e"].Value() - spellJson["s"].Value(); var tickCount = Environment.TickCount; - var difference = tickCount - spellJson["startTime"].Value(); + var difference = tickCount - spellJson["s"].Value(); - Spell.Name = spellJson["name"].Value(); - Spell.Id = spellJson["spellID"].Value(); + Spell.Name = spellJson["n"].Value(); + Spell.Id = spellJson["sid"].Value(); StartTime = new DateTime(DateTime.Now.Ticks + difference); EndTime = StartTime.AddMilliseconds(castMs); - NonInterruptible = spellJson["notInterruptible"].Value(); + NonInterruptible = spellJson["ni"].Value(); } public void UpdateProgress() diff --git a/Artemis/Artemis/Modules/Games/WoW/Models/WoWSpecialization.cs b/Artemis/Artemis/Modules/Games/WoW/Models/WoWSpecialization.cs index 63e66fd09..3582359c8 100644 --- a/Artemis/Artemis/Modules/Games/WoW/Models/WoWSpecialization.cs +++ b/Artemis/Artemis/Modules/Games/WoW/Models/WoWSpecialization.cs @@ -12,9 +12,9 @@ namespace Artemis.Modules.Games.WoW.Models public void ApplyJson(JToken specJson) { - Name = specJson["name"].Value(); + Name = specJson["n"].Value(); Id = specJson["id"].Value(); - Role = specJson["role"].Value(); + Role = specJson["r"].Value(); } } } diff --git a/Artemis/Artemis/Modules/Games/WoW/Models/WoWUnit.cs b/Artemis/Artemis/Modules/Games/WoW/Models/WoWUnit.cs index de82392e5..537864486 100644 --- a/Artemis/Artemis/Modules/Games/WoW/Models/WoWUnit.cs +++ b/Artemis/Artemis/Modules/Games/WoW/Models/WoWUnit.cs @@ -39,47 +39,47 @@ namespace Artemis.Modules.Games.WoW.Models public List Debuffs { get; } public List RecentIntantCasts { get; private set; } - public void ApplyJson(JObject json) + public void ApplyJson(JToken json) { - if (json["name"] == null) + if (json["n"] == null) return; - Name = json["name"].Value(); - Level = json["level"].Value(); - Class = json["class"].Value(); - Gender = json["gender"].Value() == 3 ? WoWGender.Female : WoWGender.Male; + Name = json["n"].Value(); + Level = json["l"].Value(); + Class = json["c"].Value(); + Gender = json["g"].Value() == 3 ? WoWGender.Female : WoWGender.Male; - if (json["race"] != null) - Race = GeneralHelpers.ParseEnum(json["race"].Value()); - if (json["specialization"] != null) - Specialization.ApplyJson(json["specialization"]); + if (json["r"] != null) + Race = GeneralHelpers.ParseEnum(json["r"].Value()); + if (json["s"] != null) + Specialization.ApplyJson(json["s"]); } - public void ApplyStateJson(JObject json) + public void ApplyStateJson(JToken json) { - Health = json["health"].Value(); - MaxHealth = json["maxHealth"].Value(); - PowerType = GeneralHelpers.ParseEnum(json["powerType"].Value().ToString()); - Power = json["power"].Value(); - MaxPower = json["maxPower"].Value(); + Health = json["h"].Value(); + MaxHealth = json["mh"].Value(); + PowerType = GeneralHelpers.ParseEnum(json["t"].Value().ToString()); + Power = json["p"].Value(); + MaxPower = json["mp"].Value(); } - public void ApplyAuraJson(JObject json) + public void ApplyAuraJson(JToken json, bool buffs) { - Buffs.Clear(); - if (json["buffs"] != null) + if (buffs) { - foreach (var auraJson in json["buffs"].Children()) + Buffs.Clear(); + foreach (var auraJson in json.Children()) { var aura = new WoWAura(); aura.ApplyJson(auraJson); Buffs.Add(aura); } } - Debuffs.Clear(); - if (json["debuffs"] != null) + else { - foreach (var auraJson in json["debuffs"].Children()) + Debuffs.Clear(); + foreach (var auraJson in json.Children()) { var aura = new WoWAura(); aura.ApplyJson(auraJson); @@ -103,7 +103,7 @@ namespace Artemis.Modules.Games.WoW.Models // Remove all casts that weren't cast in the after the last frame RecentIntantCasts.Clear(); RecentIntantCasts.AddRange(_currentFrameCasts); - + // Clear the that were after the last frame so that they are removed next frame when this method is called again _currentFrameCasts.Clear(); } diff --git a/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Artemis.toc b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Artemis.toc new file mode 100644 index 000000000..824da3279 --- /dev/null +++ b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Artemis.toc @@ -0,0 +1,9 @@ +## Interface: 70300 +## Title: Artemis +## Notes: Transmits ingame data to Artemis +## Author: SpoinkyNL +## Version: 1.0.0 + +embeds.xml + +Core.lua diff --git a/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Core.lua b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Core.lua new file mode 100644 index 000000000..e1b562ff9 --- /dev/null +++ b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Core.lua @@ -0,0 +1,297 @@ +Artemis = LibStub("AceAddon-3.0"):NewAddon("Artemis", "AceConsole-3.0", "AceEvent-3.0", "AceTimer-3.0", "AceComm-3.0") +json = LibStub("json") +local debugging = false +local lastLine = {} +local unitUpdates = {} +local lastTransmitMessage +local lastTransmitTime +local lastBuffs = ""; +local lastDebuffs = ""; +local prefixCounts = {} + +function Artemis:OnEnable() + Artemis:RegisterEvent("PLAYER_ENTERING_WORLD") + Artemis:RegisterEvent("PLAYER_LEVEL_UP") + Artemis:RegisterEvent("ACHIEVEMENT_EARNED") + Artemis:RegisterEvent("ACTIVE_TALENT_GROUP_CHANGED") + Artemis:RegisterEvent("UNIT_TARGET") + Artemis:RegisterEvent("UNIT_HEALTH") + Artemis:RegisterEvent("UNIT_POWER") + Artemis:RegisterEvent("UNIT_AURA") + Artemis:RegisterEvent("UNIT_SPELLCAST_START") + Artemis:RegisterEvent("UNIT_SPELLCAST_SUCCEEDED") + Artemis:RegisterEvent("UNIT_SPELLCAST_FAILED") + Artemis:RegisterEvent("UNIT_SPELLCAST_INTERRUPTED") + Artemis:RegisterEvent("ZONE_CHANGED") + Artemis:RegisterEvent("ZONE_CHANGED_NEW_AREA") + + Artemis:RegisterChatCommand("artemis", "HandleChatCommand") +end + +function Artemis:HandleChatCommand(input) + if input == "debug" then + debugging = not (debugging) + if debugging then + Artemis:Print("Debugging enabled.") + else + Artemis:Print("Debugging disabled.") + end + end + if input == "rc" then + prefixCounts = {} + Artemis:Print("Reset the send counters.") + end + if input == nill or input == "" or input == "help" then + Artemis:Print("Available chat commands:") + Artemis:Printf("|cffb7b7b7/artemis debug|r: Toggle debugging") + Artemis:Printf("|cffb7b7b7/artemis rc|r: Reset the debug counters") + end +end + +function Artemis:Transmit(prefix, data, prio) + local msg = "artemis(".. prefix .. "|" .. json.encode(data) ..")" + -- If the message is the same as the previous, make sure it wasn't sent less than 250ms ago + if msg == lastTransmitMessage then + if not (lastTransmitTime == nil) then + local diff = GetTime() - lastTransmitTime; + if (diff < 0.25) then + return + end + end + end + + lastTransmitTime = GetTime() + + if debugging == true then + if prefixCounts[prefix] == nill then + prefixCounts[prefix] = 0 + end + prefixCounts[prefix] = prefixCounts[prefix] + 1 + end + + if debugging == true then + Artemis:Printf("Transmitting with prefix |cfffdff71" .. prefix .. "|r (" .. prefixCounts[prefix] .. ").") + Artemis:Print(msg) + end + Artemis:SendCommMessage("(artemis)", msg, "WHISPER", UnitName("player"), prio) +end + +function Artemis:TransmitUnitState(unit, ignoreThrottle) + if not ignoreThrottle then + if not (unitUpdates[unit] == nil) then + local diff = GetTime() - unitUpdates[unit] + if (diff < 0.5) then + return + end + end + end + + local table = { + h = UnitHealth(unit), + mh = UnitHealthMax(unit), + p = UnitPower(unit), + mp = UnitPowerMax(unit), + t = UnitPowerType(unit) + }; + + unitUpdates[unit] = GetTime() + Artemis:Transmit(unit .. "State", table) +end + +function Artemis:GetUnitDetails(unit) + return { + n = UnitName(unit), + c = UnitClass(unit), + l = UnitLevel(unit), + r = UnitRace(unit), + g = UnitSex(unit), + f = UnitFactionGroup(unit) + }; +end + +function Artemis:GetPlayerDetails() + local details = Artemis:GetUnitDetails("player") + local id, name, _, _, role = GetSpecializationInfo(GetSpecialization()) + + details.realm = GetRealmName() + details.achievementPoints = GetTotalAchievementPoints(false) + details.s = {id = id, n = name, r = role} + + return details +end + +function Artemis:GetUnitAuras(unit, filter) + local auras = {}; + for index = 1, 40 do + local name, _, _, count, _, duration, expires, caster, _, _, spellID = UnitAura(unit, index, filter); + if not (name == nil) then + local buffTable = {n = name, id = spellID} + -- Leave these values out if they are 0 to save some space + if count > 0 then + buffTable["c"] = count + end + if duration > 0 then + buffTable["d"] = duration + end + if expires > 0 then + buffTable["e"] = expires + end + table.insert(auras, buffTable) + end + end + return auras +end + +function Artemis:PLAYER_ENTERING_WORLD(...) + Artemis:Transmit("player", Artemis:GetPlayerDetails()) + Artemis:TransmitUnitState("player", true); +end + +function Artemis:PLAYER_LEVEL_UP(...) + Artemis:Transmit("player", Artemis:GetPlayerDetails()) +end + +function Artemis:ACHIEVEMENT_EARNED(...) + Artemis:Transmit("player", Artemis:GetPlayerDetails()) +end + +function Artemis:ACTIVE_TALENT_GROUP_CHANGED(...) + Artemis:Transmit("player", Artemis:GetPlayerDetails()) +end + +function Artemis:UNIT_TARGET(...) + local _, source = ... + if not (source == "player") then + return + end + + local details = Artemis:GetUnitDetails("target") + + Artemis:Transmit("target", details) + Artemis:TransmitUnitState("target", true); +end + +function Artemis:UNIT_HEALTH(...) + local _, source = ... + if not (source == "player") and not (source == "target") then + return + end + + Artemis:TransmitUnitState(source, false); +end + +function Artemis:UNIT_POWER(...) + local _, source = ... + if not (source == "player") and not (source == "target") then + return + end + + Artemis:TransmitUnitState(source, false); +end + +function Artemis:UNIT_AURA(...) + local _, source = ... + if not (source == "player") then + return + end + + local buffs = Artemis:GetUnitAuras(source, "PLAYER|HELPFUL") + local debuffs = Artemis:GetUnitAuras(source, "PLAYER|HARMFUL") + + local newBuffs = json.encode(buffs) + local newDebuffs = json.encode(debuffs) + + if not (lastBuffs == newBuffs) then + Artemis:Transmit("buffs", buffs) + end + if not (lastDebuffs == newDebuffs) then + Artemis:Transmit("debuffs", debuffs) + end + + lastBuffs = newBuffs + lastDebuffs = newDebuffs +end + +-- Detect non-instant spell casts +function Artemis:UNIT_SPELLCAST_START(...) + local _, unitID, spell, rank, lineID, spellID = ... + if not (unitID == "player") and not (unitID == "target") then + return + end + + local name, _, _, _, startTime, endTime, _, _, notInterruptible = UnitCastingInfo(unitID) + local table = {uid = unitID, n = name, sid = spellID, s = startTime, e = endTime, ni = notInterruptible} + lastLine[unitID] = lineID + + Artemis:Transmit("spellCast", table, "ALERT") +end + +-- Detect instant spell casts +function Artemis:UNIT_SPELLCAST_SUCCEEDED (...) + local _, unitID, spell, rank, lineID, spellID = ... + if not (unitID == "player") and not (unitID == "target") then + return + end + -- Many spells are irrelevant system spells, don't transmit these + if unitID == "player" and not (IsPlayerSpell(spellID)) then + return + end + + local name, subText, text, texture, startTime, endTime, isTradeSkill, castID, notInterruptible = UnitCastingInfo(unitID) + -- Don't trigger on the success of a non instant cast + if not (lastLine[unitID] == nil) and lastLine[unitID] == lineID then + return + end + + -- Set back the last line to what is currently being cast (Fireblast during Fireball per example) + if not (name == nil) then + lastLine[unitID] = castID + else + lastLine[unitID] = nil + end + + local table = {uid = unitID, n = spell, sid = spellID} + + Artemis:Transmit("instantSpellCast", table, "ALERT") +end + +-- Detect falure of non instant casts +function Artemis:UNIT_SPELLCAST_FAILED (...) + local source, unitID, _, _, lineID = ... + if not (unitID == "player") and not (unitID == "target") then + return + end + if lastLine[unitID] == nil or not (lastLine[unitID] == lineID) then + return + end + + lastLine[unitID] = nil + + Artemis:Transmit("spellCastFailed", unitID, "ALERT") +end + +-- Detect cancellation of non instant casts +function Artemis:UNIT_SPELLCAST_INTERRUPTED (...) + local source, unitID, _, _, lineID = ... + if not (unitID == "player") and not (unitID == "target") then + return + end + if lastLine[unitID] == nil or not (lastLine[unitID] == lineID) then + return + end + + lastLine[unitID] = nil + + Artemis:Transmit("spellCastInterrupted", unitID, "ALERT") +end + +function Artemis:ZONE_CHANGED_NEW_AREA (...) + local pvpType, isSubZonePVP, factionName = GetZonePVPInfo() + + Artemis:Transmit("zone", {z = GetRealZoneText(), s = GetSubZoneText(), t = pvpType, p = isSubZonePVP, f = factionName}) +end +function Artemis:ZONE_CHANGED (...) + local pvpType, isSubZonePVP, factionName = GetZonePVPInfo() + + Artemis:Transmit("zone", {z = GetRealZoneText(), s = GetSubZoneText(), t = pvpType, p = isSubZonePVP, f = factionName}) +end \ No newline at end of file diff --git a/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Libs/AceAddon-3.0/AceAddon-3.0.lua b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Libs/AceAddon-3.0/AceAddon-3.0.lua new file mode 100644 index 000000000..a7f7279cc --- /dev/null +++ b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Libs/AceAddon-3.0/AceAddon-3.0.lua @@ -0,0 +1,674 @@ +--- **AceAddon-3.0** provides a template for creating addon objects. +-- It'll provide you with a set of callback functions that allow you to simplify the loading +-- process of your addon.\\ +-- Callbacks provided are:\\ +-- * **OnInitialize**, which is called directly after the addon is fully loaded. +-- * **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. +-- @usage +-- -- A small (but complete) addon, that doesn't do anything, +-- -- but shows usage of the callbacks. +-- local MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon") +-- +-- function MyAddon:OnInitialize() +-- -- do init tasks here, like loading the Saved Variables, +-- -- or setting up slash commands. +-- end +-- +-- function MyAddon:OnEnable() +-- -- Do more initialization here, that really enables the use of your addon. +-- -- Register Events, Hook functions, Create Frames, Get information from +-- -- the game that wasn't available in OnInitialize +-- end +-- +-- function MyAddon:OnDisable() +-- -- Unhook, Unregister Events, Hide frames that you created. +-- -- You would probably only use an OnDisable if you want to +-- -- build a "standby" mode, or be able to toggle modules on/off. +-- end +-- @class file +-- @name AceAddon-3.0.lua +-- @release $Id: AceAddon-3.0.lua 1084 2013-04-27 20:14:11Z nevcairiel $ + +local MAJOR, MINOR = "AceAddon-3.0", 12 +local AceAddon, oldminor = LibStub:NewLibrary(MAJOR, MINOR) + +if not AceAddon then return end -- No Upgrade needed. + +AceAddon.frame = AceAddon.frame or CreateFrame("Frame", "AceAddon30Frame") -- Our very own frame +AceAddon.addons = AceAddon.addons or {} -- addons in general +AceAddon.statuses = AceAddon.statuses or {} -- statuses of addon. +AceAddon.initializequeue = AceAddon.initializequeue or {} -- addons that are new and not initialized +AceAddon.enablequeue = AceAddon.enablequeue or {} -- addons that are initialized and waiting to be enabled +AceAddon.embeds = AceAddon.embeds or setmetatable({}, {__index = function(tbl, key) tbl[key] = {} return tbl[key] end }) -- contains a list of libraries embedded in an addon + +-- Lua APIs +local tinsert, tconcat, tremove = table.insert, table.concat, table.remove +local fmt, tostring = string.format, tostring +local select, pairs, next, type, unpack = select, pairs, next, type, unpack +local loadstring, assert, error = loadstring, assert, error +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 +]] +local xpcall = xpcall + +local function errorhandler(err) + return geterrorhandler()(err) +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, ...) + -- 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 + -- present execution should continue without hinderance + if type(func) == "function" then + return Dispatchers[select('#', ...)](func, ...) + end +end + +-- local functions that will be implemented further down +local Enable, Disable, EnableModule, DisableModule, Embed, NewModule, GetModule, GetName, SetDefaultModuleState, SetDefaultModuleLibraries, SetEnabledState, SetDefaultModulePrototype + +-- used in the addon metatable +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. +-- Any libraries you specified will be embeded, and the addon will be scheduled for +-- its OnInitialize and OnEnable callbacks. +-- The final addon object, with all libraries embeded, will be returned. +-- @paramsig [object ,]name[, lib, ...] +-- @param object Table to use as a base for the addon (optional) +-- @param name Name of the addon object to create +-- @param lib List of libraries to embed into the addon +-- @usage +-- -- Create a simple addon object +-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceEvent-3.0") +-- +-- -- Create a Addon object based on the table of a frame +-- local MyFrame = CreateFrame("Frame") +-- MyAddon = LibStub("AceAddon-3.0"):NewAddon(MyFrame, "MyAddon", "AceEvent-3.0") +function AceAddon:NewAddon(objectorname, ...) + local object,name + local i=1 + if type(objectorname)=="table" then + object=objectorname + name=... + i=2 + else + name=objectorname + end + if type(name)~="string" then + error(("Usage: NewAddon([object,] name, [lib, lib, lib, ...]): 'name' - string expected got '%s'."):format(type(name)), 2) + end + if self.addons[name] then + error(("Usage: NewAddon([object,] name, [lib, lib, lib, ...]): 'name' - Addon '%s' already exists."):format(name), 2) + end + + object = object or {} + object.name = name + + local addonmeta = {} + local oldmeta = getmetatable(object) + if oldmeta then + for k, v in pairs(oldmeta) do addonmeta[k] = v end + end + addonmeta.__tostring = addontostring + + setmetatable( object, addonmeta ) + self.addons[name] = object + object.modules = {} + object.orderedModules = {} + object.defaultModuleLibraries = {} + Embed( object ) -- embed NewModule, GetModule methods + self:EmbedLibraries(object, select(i,...)) + + -- add to queue of addons to be initialized upon ADDON_LOADED + tinsert(self.initializequeue, object) + return object +end + + +--- Get the addon object by its name from the internal AceAddon registry. +-- Throws an error if the addon object cannot be found (except if silent is set). +-- @param name unique name of the addon object +-- @param silent if true, the addon is optional, silently return nil if its not found +-- @usage +-- -- Get the Addon +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +function AceAddon:GetAddon(name, silent) + if not silent and not self.addons[name] then + error(("Usage: GetAddon(name): 'name' - Cannot find an AceAddon '%s'."):format(tostring(name)), 2) + end + return self.addons[name] +end + +-- - Embed a list of libraries into the specified addon. +-- This function will try to embed all of the listed libraries into the addon +-- and error if a single one fails. +-- +-- **Note:** This function is for internal use by :NewAddon/:NewModule +-- @paramsig addon, [lib, ...] +-- @param addon addon object to embed the libs in +-- @param lib List of libraries to embed into the addon +function AceAddon:EmbedLibraries(addon, ...) + for i=1,select("#", ... ) do + local libname = select(i, ...) + self:EmbedLibrary(addon, libname, false, 4) + end +end + +-- - Embed a library into the addon object. +-- This function will check if the specified library is registered with LibStub +-- and if it has a :Embed function to call. It'll error if any of those conditions +-- fails. +-- +-- **Note:** This function is for internal use by :EmbedLibraries +-- @paramsig addon, libname[, silent[, offset]] +-- @param addon addon object to embed the library in +-- @param libname name of the library to embed +-- @param silent marks an embed to fail silently if the library doesn't exist (optional) +-- @param offset will push the error messages back to said offset, defaults to 2 (optional) +function AceAddon:EmbedLibrary(addon, libname, silent, offset) + local lib = LibStub:GetLibrary(libname, true) + if not lib and not silent then + error(("Usage: EmbedLibrary(addon, libname, silent, offset): 'libname' - Cannot find a library instance of %q."):format(tostring(libname)), offset or 2) + elseif lib and type(lib.Embed) == "function" then + lib:Embed(addon) + tinsert(self.embeds[addon], libname) + return true + elseif lib then + error(("Usage: EmbedLibrary(addon, libname, silent, offset): 'libname' - Library '%s' is not Embed capable"):format(libname), offset or 2) + end +end + +--- Return the specified module from an addon object. +-- Throws an error if the addon object cannot be found (except if silent is set) +-- @name //addon//:GetModule +-- @paramsig name[, silent] +-- @param name unique name of the module +-- @param silent if true, the module is optional, silently return nil if its not found (optional) +-- @usage +-- -- Get the Addon +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- -- Get the Module +-- MyModule = MyAddon:GetModule("MyModule") +function GetModule(self, name, silent) + if not self.modules[name] and not silent then + error(("Usage: GetModule(name, silent): 'name' - Cannot find module '%s'."):format(tostring(name)), 2) + end + return self.modules[name] +end + +local function IsModuleTrue(self) return true end + +--- Create a new module for the addon. +-- The new module can have its own embeded libraries and/or use a module prototype to be mixed into the module.\\ +-- A module has the same functionality as a real addon, it can have modules of its own, and has the same API as +-- an addon object. +-- @name //addon//:NewModule +-- @paramsig name[, prototype|lib[, lib, ...]] +-- @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 lib List of libraries to embed into the addon +-- @usage +-- -- Create a module with some embeded libraries +-- MyModule = MyAddon:NewModule("MyModule", "AceEvent-3.0", "AceHook-3.0") +-- +-- -- Create a module with a prototype +-- local prototype = { OnEnable = function(self) print("OnEnable called!") end } +-- MyModule = MyAddon:NewModule("MyModule", prototype, "AceEvent-3.0", "AceHook-3.0") +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(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 + + -- 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. + local module = AceAddon:NewAddon(fmt("%s_%s", self.name or tostring(self), name)) + + module.IsModule = IsModuleTrue + module:SetEnabledState(self.defaultModuleState) + module.moduleName = name + + if type(prototype) == "string" then + AceAddon:EmbedLibraries(module, prototype, ...) + else + AceAddon:EmbedLibraries(module, ...) + end + AceAddon:EmbedLibraries(module, unpack(self.defaultModuleLibraries)) + + if not prototype or type(prototype) == "string" then + prototype = self.defaultModulePrototype or nil + end + + if type(prototype) == "table" then + local mt = getmetatable(module) + mt.__index = prototype + setmetatable(module, mt) -- More of a Base class type feel. + end + + safecall(self.OnModuleCreated, self, module) -- Was in Ace2 and I think it could be a cool thing to have handy. + self.modules[name] = module + tinsert(self.orderedModules, module) + + return module +end + +--- Returns the real name of the addon or module, without any prefix. +-- @name //addon//:GetName +-- @paramsig +-- @usage +-- print(MyAddon:GetName()) +-- -- prints "MyAddon" +function GetName(self) + return self.moduleName or self.name +end + +--- Enables the Addon, if possible, return true or false depending on success. +-- This internally calls AceAddon:EnableAddon(), thus dispatching a OnEnable callback +-- and enabling all modules of the addon (unless explicitly disabled).\\ +-- :Enable() also sets the internal `enableState` variable to true +-- @name //addon//:Enable +-- @paramsig +-- @usage +-- -- Enable MyModule +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- MyModule = MyAddon:GetModule("MyModule") +-- MyModule:Enable() +function Enable(self) + self:SetEnabledState(true) + + -- 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 + +--- Disables the Addon, if possible, return true or false depending on success. +-- This internally calls AceAddon:DisableAddon(), thus dispatching a OnDisable callback +-- and disabling all modules of the addon.\\ +-- :Disable() also sets the internal `enableState` variable to false +-- @name //addon//:Disable +-- @paramsig +-- @usage +-- -- Disable MyAddon +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- MyAddon:Disable() +function Disable(self) + self:SetEnabledState(false) + return AceAddon:DisableAddon(self) +end + +--- Enables the Module, if possible, return true or false depending on success. +-- Short-hand function that retrieves the module via `:GetModule` and calls `:Enable` on the module object. +-- @name //addon//:EnableModule +-- @paramsig name +-- @usage +-- -- Enable MyModule using :GetModule +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- MyModule = MyAddon:GetModule("MyModule") +-- MyModule:Enable() +-- +-- -- Enable MyModule using the short-hand +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- MyAddon:EnableModule("MyModule") +function EnableModule(self, name) + local module = self:GetModule( name ) + return module:Enable() +end + +--- Disables the Module, if possible, return true or false depending on success. +-- Short-hand function that retrieves the module via `:GetModule` and calls `:Disable` on the module object. +-- @name //addon//:DisableModule +-- @paramsig name +-- @usage +-- -- Disable MyModule using :GetModule +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- MyModule = MyAddon:GetModule("MyModule") +-- MyModule:Disable() +-- +-- -- Disable MyModule using the short-hand +-- MyAddon = LibStub("AceAddon-3.0"):GetAddon("MyAddon") +-- MyAddon:DisableModule("MyModule") +function DisableModule(self, name) + local module = self:GetModule( name ) + return module:Disable() +end + +--- Set the default libraries to be mixed into all modules created by this object. +-- Note that you can only change the default module libraries before any module is created. +-- @name //addon//:SetDefaultModuleLibraries +-- @paramsig lib[, lib, ...] +-- @param lib List of libraries to embed into the addon +-- @usage +-- -- Create the addon object +-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon") +-- -- Configure default libraries for modules (all modules need AceEvent-3.0) +-- MyAddon:SetDefaultModuleLibraries("AceEvent-3.0") +-- -- Create a module +-- MyModule = MyAddon:NewModule("MyModule") +function SetDefaultModuleLibraries(self, ...) + if next(self.modules) then + error("Usage: SetDefaultModuleLibraries(...): cannot change the module defaults after a module has been registered.", 2) + end + self.defaultModuleLibraries = {...} +end + +--- Set the default state in which new modules are being created. +-- Note that you can only change the default state before any module is created. +-- @name //addon//:SetDefaultModuleState +-- @paramsig state +-- @param state Default state for new modules, true for enabled, false for disabled +-- @usage +-- -- Create the addon object +-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon") +-- -- Set the default state to "disabled" +-- MyAddon:SetDefaultModuleState(false) +-- -- Create a module and explicilty enable it +-- MyModule = MyAddon:NewModule("MyModule") +-- MyModule:Enable() +function SetDefaultModuleState(self, state) + if next(self.modules) then + error("Usage: SetDefaultModuleState(state): cannot change the module defaults after a module has been registered.", 2) + end + self.defaultModuleState = state +end + +--- Set the default prototype to use for new modules on creation. +-- Note that you can only change the default prototype before any module is created. +-- @name //addon//:SetDefaultModulePrototype +-- @paramsig prototype +-- @param prototype Default prototype for the new modules (table) +-- @usage +-- -- Define a prototype +-- local prototype = { OnEnable = function(self) print("OnEnable called!") end } +-- -- Set the default prototype +-- MyAddon:SetDefaultModulePrototype(prototype) +-- -- Create a module and explicitly Enable it +-- MyModule = MyAddon:NewModule("MyModule") +-- MyModule:Enable() +-- -- should print "OnEnable called!" now +-- @see NewModule +function SetDefaultModulePrototype(self, prototype) + if next(self.modules) then + error("Usage: SetDefaultModulePrototype(prototype): cannot change the module defaults after a module has been registered.", 2) + end + if type(prototype) ~= "table" then + error(("Usage: SetDefaultModulePrototype(prototype): 'prototype' - table expected got '%s'."):format(type(prototype)), 2) + end + self.defaultModulePrototype = prototype +end + +--- Set the state of an addon or module +-- This should only be called before any enabling actually happend, e.g. in/before OnInitialize. +-- @name //addon//:SetEnabledState +-- @paramsig state +-- @param state the state of an addon or module (enabled=true, disabled=false) +function SetEnabledState(self, state) + self.enabledState = state +end + + +--- Return an iterator of all modules associated to the addon. +-- @name //addon//:IterateModules +-- @paramsig +-- @usage +-- -- Enable all modules +-- for name, module in MyAddon:IterateModules() do +-- module:Enable() +-- end +local function IterateModules(self) return pairs(self.modules) end + +-- Returns an iterator of all embeds in the addon +-- @name //addon//:IterateEmbeds +-- @paramsig +local function IterateEmbeds(self) return pairs(AceAddon.embeds[self]) end + +--- Query the enabledState of an addon. +-- @name //addon//:IsEnabled +-- @paramsig +-- @usage +-- if MyAddon:IsEnabled() then +-- MyAddon:Disable() +-- end +local function IsEnabled(self) return self.enabledState end +local mixins = { + NewModule = NewModule, + GetModule = GetModule, + Enable = Enable, + Disable = Disable, + EnableModule = EnableModule, + DisableModule = DisableModule, + IsEnabled = IsEnabled, + SetDefaultModuleLibraries = SetDefaultModuleLibraries, + SetDefaultModuleState = SetDefaultModuleState, + SetDefaultModulePrototype = SetDefaultModulePrototype, + SetEnabledState = SetEnabledState, + IterateModules = IterateModules, + IterateEmbeds = IterateEmbeds, + GetName = GetName, +} +local function IsModule(self) return false end +local pmixins = { + defaultModuleState = true, + enabledState = true, + IsModule = IsModule, +} +-- Embed( target ) +-- target (object) - target object to embed aceaddon in +-- +-- this is a local function specifically since it's meant to be only called internally +function Embed(target, skipPMixins) + for k, v in pairs(mixins) do + target[k] = v + end + if not skipPMixins then + for k, v in pairs(pmixins) do + target[k] = target[k] or v + end + end +end + + +-- - Initialize the addon after creation. +-- This function is only used internally during the ADDON_LOADED event +-- It will call the **OnInitialize** function on the addon object (if present), +-- 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. +-- @param addon addon object to intialize +function AceAddon:InitializeAddon(addon) + safecall(addon.OnInitialize, addon) + + local embeds = self.embeds[addon] + for i = 1, #embeds do + local lib = LibStub:GetLibrary(embeds[i], true) + if lib then safecall(lib.OnEmbedInitialize, lib, addon) end + end + + -- we don't call InitializeAddon on modules specifically, this is handled + -- from the event handler and only done _once_ +end + +-- - Enable the addon after creation. +-- 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. +-- It will call the **OnEnable** function on the addon object (if present), +-- 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. +-- +-- **Note:** Do not call this function manually, unless you're absolutely sure that you know what you are doing. +-- Use :Enable on the addon itself instead. +-- @param addon addon object to enable +function AceAddon:EnableAddon(addon) + if type(addon) == "string" then addon = AceAddon:GetAddon(addon) 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. + self.statuses[addon.name] = true + + safecall(addon.OnEnable, addon) + + -- make sure we're still enabled before continueing + if self.statuses[addon.name] then + local embeds = self.embeds[addon] + for i = 1, #embeds do + local lib = LibStub:GetLibrary(embeds[i], true) + if lib then safecall(lib.OnEmbedEnable, lib, addon) end + end + + -- enable possible modules. + local modules = addon.orderedModules + for i = 1, #modules do + self:EnableAddon(modules[i]) + end + end + return self.statuses[addon.name] -- return true if we're disabled +end + +-- - Disable the addon +-- Note: This function is only used internally. +-- It will call the **OnDisable** function on the addon object (if present), +-- 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. +-- +-- **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. +-- @param addon addon object to enable +function AceAddon:DisableAddon(addon) + if type(addon) == "string" then addon = AceAddon:GetAddon(addon) 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. + self.statuses[addon.name] = false + + safecall( addon.OnDisable, addon ) + + -- make sure we're still disabling... + if not self.statuses[addon.name] then + local embeds = self.embeds[addon] + for i = 1, #embeds do + local lib = LibStub:GetLibrary(embeds[i], true) + if lib then safecall(lib.OnEmbedDisable, lib, addon) end + end + -- disable possible modules. + local modules = addon.orderedModules + for i = 1, #modules do + self:DisableAddon(modules[i]) + end + end + + return not self.statuses[addon.name] -- return true if we're disabled +end + +--- Get an iterator over all registered addons. +-- @usage +-- -- Print a list of all installed AceAddon's +-- for name, addon in AceAddon:IterateAddons() do +-- print("Addon: " .. name) +-- end +function AceAddon:IterateAddons() return pairs(self.addons) end + +--- Get an iterator over the internal status registry. +-- @usage +-- -- Print a list of all enabled addons +-- for name, status in AceAddon:IterateAddonStatus() do +-- if status then +-- print("EnabledAddon: " .. name) +-- end +-- end +function AceAddon:IterateAddonStatus() return pairs(self.statuses) end + +-- Following Iterators are deprecated, and their addon specific versions should be used +-- e.g. addon:IterateEmbeds() instead of :IterateEmbedsOnAddon(addon) +function AceAddon:IterateEmbedsOnAddon(addon) return pairs(self.embeds[addon]) end +function AceAddon:IterateModulesOfAddon(addon) return pairs(addon.modules) end + +-- Event Handling +local function onEvent(this, event, arg1) + -- 2011-08-17 nevcairiel - ignore the load event of Blizzard_DebugTools, so a potential startup error isn't swallowed up + if (event == "ADDON_LOADED" and arg1 ~= "Blizzard_DebugTools") 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 + while(#AceAddon.initializequeue > 0) do + local addon = tremove(AceAddon.initializequeue, 1) + -- this might be an issue with recursion - TODO: validate + if event == "ADDON_LOADED" then addon.baseName = arg1 end + AceAddon:InitializeAddon(addon) + tinsert(AceAddon.enablequeue, addon) + end + + if IsLoggedIn() then + while(#AceAddon.enablequeue > 0) do + local addon = tremove(AceAddon.enablequeue, 1) + AceAddon:EnableAddon(addon) + end + end + end +end + +AceAddon.frame:RegisterEvent("ADDON_LOADED") +AceAddon.frame:RegisterEvent("PLAYER_LOGIN") +AceAddon.frame:SetScript("OnEvent", onEvent) + +-- upgrade embeded +for name, addon in pairs(AceAddon.addons) do + 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 diff --git a/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Libs/AceAddon-3.0/AceAddon-3.0.xml b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Libs/AceAddon-3.0/AceAddon-3.0.xml new file mode 100644 index 000000000..dcf24c707 --- /dev/null +++ b/Artemis/Artemis/Modules/Games/WoW/Resources/Addon/Libs/AceAddon-3.0/AceAddon-3.0.xml @@ -0,0 +1,4 @@ + +