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