|
adam@3
|
1 -- $Id: LibStub.lua 76 2007-09-03 01:50:17Z mikk $
|
|
adam@3
|
2 -- LibStub is a simple versioning stub meant for use in Libraries. http://www.wowace.com/wiki/LibStub for more info
|
|
adam@3
|
3 -- LibStub is hereby placed in the Public Domain
|
|
adam@3
|
4 -- Credits: Kaelten, Cladhaire, ckknight, Mikk, Ammo, Nevcairiel, joshborke
|
|
adam@3
|
5 local LIBSTUB_MAJOR, LIBSTUB_MINOR = "LibStub", 2 -- NEVER MAKE THIS AN SVN REVISION! IT NEEDS TO BE USABLE IN ALL REPOS!
|
|
adam@3
|
6 local LibStub = _G[LIBSTUB_MAJOR]
|
|
adam@3
|
7
|
|
adam@3
|
8 -- Check to see is this version of the stub is obsolete
|
|
adam@3
|
9 if not LibStub or LibStub.minor < LIBSTUB_MINOR then
|
|
adam@3
|
10 LibStub = LibStub or {libs = {}, minors = {} }
|
|
adam@3
|
11 _G[LIBSTUB_MAJOR] = LibStub
|
|
adam@3
|
12 LibStub.minor = LIBSTUB_MINOR
|
|
adam@3
|
13
|
|
adam@3
|
14 -- LibStub:NewLibrary(major, minor)
|
|
adam@3
|
15 -- major (string) - the major version of the library
|
|
adam@3
|
16 -- minor (string or number ) - the minor version of the library
|
|
adam@3
|
17 --
|
|
adam@3
|
18 -- returns nil if a newer or same version of the lib is already present
|
|
adam@3
|
19 -- returns empty library object or old library object if upgrade is needed
|
|
adam@3
|
20 function LibStub:NewLibrary(major, minor)
|
|
adam@3
|
21 assert(type(major) == "string", "Bad argument #2 to `NewLibrary' (string expected)")
|
|
adam@3
|
22 minor = assert(tonumber(strmatch(minor, "%d+")), "Minor version must either be a number or contain a number.")
|
|
adam@3
|
23
|
|
adam@3
|
24 local oldminor = self.minors[major]
|
|
adam@3
|
25 if oldminor and oldminor >= minor then return nil end
|
|
adam@3
|
26 self.minors[major], self.libs[major] = minor, self.libs[major] or {}
|
|
adam@3
|
27 return self.libs[major], oldminor
|
|
adam@3
|
28 end
|
|
adam@3
|
29
|
|
adam@3
|
30 -- LibStub:GetLibrary(major, [silent])
|
|
adam@3
|
31 -- major (string) - the major version of the library
|
|
adam@3
|
32 -- silent (boolean) - if true, library is optional, silently return nil if its not found
|
|
adam@3
|
33 --
|
|
adam@3
|
34 -- throws an error if the library can not be found (except silent is set)
|
|
adam@3
|
35 -- returns the library object if found
|
|
adam@3
|
36 function LibStub:GetLibrary(major, silent)
|
|
adam@3
|
37 if not self.libs[major] and not silent then
|
|
adam@3
|
38 error(("Cannot find a library instance of %q."):format(tostring(major)), 2)
|
|
adam@3
|
39 end
|
|
adam@3
|
40 return self.libs[major], self.minors[major]
|
|
adam@3
|
41 end
|
|
adam@3
|
42
|
|
adam@3
|
43 -- LibStub:IterateLibraries()
|
|
adam@3
|
44 --
|
|
adam@3
|
45 -- Returns an iterator for the currently registered libraries
|
|
adam@3
|
46 function LibStub:IterateLibraries()
|
|
adam@3
|
47 return pairs(self.libs)
|
|
adam@3
|
48 end
|
|
adam@3
|
49
|
|
adam@3
|
50 setmetatable(LibStub, { __call = LibStub.GetLibrary })
|
|
adam@3
|
51 end
|
