mckenziemc@0: --	Addon
mckenziemc@0: --	Represents individual addon modules
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: local addonName, addonTable = ...
mckenziemc@0: 
mckenziemc@0: print("running Addon.lua")
mckenziemc@0: 
mckenziemc@0: --	NOTE: I assume that the API addon functions are 
mckenziemc@0: --	slightly quicker with an index than with a number.
mckenziemc@0: 
mckenziemc@0: --	TODO: modify the dependency stuff to use the Errata module if available
mckenziemc@0: 
mckenziemc@0: local Addon, addon = addonTable:NewClass("Addon")
mckenziemc@0: 
mckenziemc@0: function Addon:New(id)
mckenziemc@0: 	assert(type(id) == "number" or type(id) == "string")
mckenziemc@0: 
mckenziemc@0: 	local instance = {}
mckenziemc@0: 	
mckenziemc@0: 	setmetatable(instance, self.instanceMetatable)
mckenziemc@0: 	
mckenziemc@0: 	if type(id) == "number" then
mckenziemc@0: 		--	TODO: make sure it's in range
mckenziemc@0: 		instance.index = id
mckenziemc@0: 		instance.name = GetAddOnInfo(id)
mckenziemc@0: 	else
mckenziemc@0: 		--	FIXME: allow blizzard addons?
mckenziemc@0: 		local index
mckenziemc@0: 		
mckenziemc@0: 		for i=1,GetNumAddOns() do
mckenziemc@0: 			if GetAddOnInfo(i) == id then
mckenziemc@0: 				index = i
mckenziemc@0: 				break
mckenziemc@0: 			end
mckenziemc@0: 		end
mckenziemc@0: 		
mckenziemc@0: 		if index then
mckenziemc@0: 			instance.name = GetAddOnInfo(id)
mckenziemc@0: 			instance.index = index
mckenziemc@0: 		else
mckenziemc@0: 			error("Addon not found")
mckenziemc@0: 		end
mckenziemc@0: 	end
mckenziemc@0: 	
mckenziemc@0: 	return instance
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: --	Checks if an addon exists with the specified name.
mckenziemc@0: --	@param	addon	Name of the addon.
mckenziemc@0: --	@return			True if the addon is present, false otherwise.
mckenziemc@0: function Addon:Exists(addon)
mckenziemc@0: 	if type(addon) == "number" then
mckenziemc@0: 		if addon >= 1 and addon <= GetNumAddOns() then
mckenziemc@0: 			return true
mckenziemc@0: 		else
mckenziemc@0: 			return false
mckenziemc@0: 		end
mckenziemc@0: 	elseif type(addon) == "string" then
mckenziemc@0: 		local status = select(6, GetAddOnInfo(addon))
mckenziemc@0: 		
mckenziemc@0: 		if status == "MISSING" then
mckenziemc@0: 			return false
mckenziemc@0: 		else
mckenziemc@0: 			return true
mckenziemc@0: 		end
mckenziemc@0: 	else
mckenziemc@0: 		error()
mckenziemc@0: 	end
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: function addon:GetName()
mckenziemc@0: 	return self.name
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: function addon:GetIndex()
mckenziemc@0: 	return self.index
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: function addon:IsEnabled()
mckenziemc@0: 	--	FIXME: written while tired; review later
mckenziemc@0: 	local status = select(6, GetAddOnInfo(self.index))
mckenziemc@0: 	
mckenziemc@0: 	if status == "DISABLED"	then
mckenziemc@0: 		return false
mckenziemc@0: 	else
mckenziemc@0: 		return true
mckenziemc@0: 	end
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: --	FIXME: an addon may be present but unloadable if loading out of date addons is disabled.
mckenziemc@0: --	NOTE: CanForceLoad and CanLoD don't check the status of dependencies
mckenziemc@0: 
mckenziemc@0: function addon:CanForceLoad()
mckenziemc@0: 	return true		--	TODO: check if there's any reason addons can't be forceloaded
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: function addon:CanLoD()
mckenziemc@0: 	--	FIXME: what will the client say about addons using LoadManagers if the LM was force-loaded?
mckenziemc@0: 	if IsAddOnLoadOnDemand(self.name) then
mckenziemc@0: 		return true
mckenziemc@0: 	else
mckenziemc@0: 		return false
mckenziemc@0: 	end
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: --	NOTE: only call for LoD, not force-loading
mckenziemc@0: function addon:Load()
mckenziemc@0: 	assert(self:CanLoD())
mckenziemc@0: 	
mckenziemc@0: 	EnableAddOn(self.name)
mckenziemc@0: 	LoadAddOn(self.name)
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: function addon:ForceLoad()
mckenziemc@0: 	assert(self:CanForceLoad())
mckenziemc@0: 	--	TODO: make sure force-loading is available at this time
mckenziemc@0: 	
mckenziemc@0: 	EnableAddOn(self.name)	--	This should cause the game to also load this addon
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: function addon:GetDependencies()
mckenziemc@0: 	return GetAddOnDependencies(self.index)
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: 
mckenziemc@0: function addon:GetEmbeds()
mckenziemc@0: 	local embeds = {}
mckenziemc@0: 	
mckenziemc@0: 	local embedString = GetAddOnMetadata(self.name, "X-Embeds")
mckenziemc@0: 	
mckenziemc@0: 	if embedString then
mckenziemc@0: 		for match in string.gmatch(embedString, "[^,%s]+") do
mckenziemc@0: 			table.insert(embeds, match)
mckenziemc@0: 		end
mckenziemc@0: 	end
mckenziemc@0: 	
mckenziemc@0: 	return unpack(embeds)
mckenziemc@0: end
mckenziemc@0: 
mckenziemc@0: function addon:IsLoaded()
mckenziemc@0: 	if IsAddOnLoaded(self.index) then
mckenziemc@0: 		return true
mckenziemc@0: 	else
mckenziemc@0: 		return false
mckenziemc@0: 	end
mckenziemc@0: end