adam@0: -- $Id: LibStub.lua 76 2007-09-03 01:50:17Z mikk $
adam@0: -- LibStub is a simple versioning stub meant for use in Libraries.  http://www.wowace.com/wiki/LibStub for more info
adam@0: -- LibStub is hereby placed in the Public Domain
adam@0: -- Credits: Kaelten, Cladhaire, ckknight, Mikk, Ammo, Nevcairiel, joshborke
adam@0: local LIBSTUB_MAJOR, LIBSTUB_MINOR = "LibStub", 2  -- NEVER MAKE THIS AN SVN REVISION! IT NEEDS TO BE USABLE IN ALL REPOS!
adam@0: local LibStub = _G[LIBSTUB_MAJOR]
adam@0: 
adam@0: -- Check to see is this version of the stub is obsolete
adam@0: if not LibStub or LibStub.minor < LIBSTUB_MINOR then
adam@0: 	LibStub = LibStub or {libs = {}, minors = {} }
adam@0: 	_G[LIBSTUB_MAJOR] = LibStub
adam@0: 	LibStub.minor = LIBSTUB_MINOR
adam@0: 	
adam@0: 	-- LibStub:NewLibrary(major, minor)
adam@0: 	-- major (string) - the major version of the library
adam@0: 	-- minor (string or number ) - the minor version of the library
adam@0: 	-- 
adam@0: 	-- returns nil if a newer or same version of the lib is already present
adam@0: 	-- returns empty library object or old library object if upgrade is needed
adam@0: 	function LibStub:NewLibrary(major, minor)
adam@0: 		assert(type(major) == "string", "Bad argument #2 to `NewLibrary' (string expected)")
adam@0: 		minor = assert(tonumber(strmatch(minor, "%d+")), "Minor version must either be a number or contain a number.")
adam@0: 		
adam@0: 		local oldminor = self.minors[major]
adam@0: 		if oldminor and oldminor >= minor then return nil end
adam@0: 		self.minors[major], self.libs[major] = minor, self.libs[major] or {}
adam@0: 		return self.libs[major], oldminor
adam@0: 	end
adam@0: 	
adam@0: 	-- LibStub:GetLibrary(major, [silent])
adam@0: 	-- major (string) - the major version of the library
adam@0: 	-- silent (boolean) - if true, library is optional, silently return nil if its not found
adam@0: 	--
adam@0: 	-- throws an error if the library can not be found (except silent is set)
adam@0: 	-- returns the library object if found
adam@0: 	function LibStub:GetLibrary(major, silent)
adam@0: 		if not self.libs[major] and not silent then
adam@0: 			error(("Cannot find a library instance of %q."):format(tostring(major)), 2)
adam@0: 		end
adam@0: 		return self.libs[major], self.minors[major]
adam@0: 	end
adam@0: 	
adam@0: 	-- LibStub:IterateLibraries()
adam@0: 	-- 
adam@0: 	-- Returns an iterator for the currently registered libraries
adam@0: 	function LibStub:IterateLibraries() 
adam@0: 		return pairs(self.libs) 
adam@0: 	end
adam@0: 	
adam@0: 	setmetatable(LibStub, { __call = LibStub.GetLibrary })
adam@0: end