LibCoreAPI

[nightcracker]

Hi all!
I'm making a library to add some more functions to the WoW API and widget API. Mainly to make your life easier, and to shorten up your code. I'm asking YOU what you want added in it, so post here! This is what I have currently(I will be editing this post):

local metatables = {}
local dummy = function() end
 
for key, val in pairs(_G) do 
    if type(val)=="table" and val.GetObjectType then
        obj = val:GetObjectType()
        if not metatables[obj] then
            metatables[obj] = getmetatable(val).__index
        end
    end
end
 
local function destroy(self)
    self.Show = dummy
    self:Hide()
    if self.UnregisterAllEvents then
        self:UnregisterAllEvents()
    end
end
 
local function fireevent(self, event, ...)
    local handler = self:GetScript("OnEvent")
    if handler then
        handler(self, event, ...)
        return true
    end
    return false
end
 
local function fire(self, script, ...)
    local handler = self:GetScript(script)
    if handler then
        handler(self, ...)
        return true
    end
    return false
end
 
local function lock(self)
    self.ClearAllPoints = dummy
    self.SetPoint = dummy
    self.SetAllPoints = dummy
end
 
local function unlock(self)
    self.ClearAllPoints = nil
    self.SetPoint = nil
    self.SetAllPoints = nil
end
 
local function setsize(self, w, h)
    self:SetWidth(w)
    self:SetHeight(h or w)
end
 
local function getclassbycolor(r, g, b)
    r, g, b = floor(r*100+.5)/100, floor(g*100+.5)/100, floor(b*100+.5)/100
    for class, color in pairs(RAID_CLASS_COLORS) do
        if color.r==r and color.g==g and color.b==b then
            return class
        end
    end
    return false
end
 
local function getsize(self)
    return self:GetWidth(), self:GetHeight()
end
 
local function setclassicon(self, class)
    self:SetTexture("Interface\\WorldStateFrame\\Icons-Classes")
    if class then
        local classcoords = CLASS_BUTTONS[class]
        if classcoords then
            self:SetTexCoord(unpack(classcoords))
            return true
        else
            self:SetTexCoord(.5, .75, .5, .75)
            return false
        end
    end
    return false
end
 
local function islocked(self)
    if self.ClearAllPoints==dummy and self.SetPoint==dummy and self.SetAllPoints==dummy then
        return true
    end
    return false
end
 
local function isdestroyed(self)
    if self.Show==dummy and not self:IsShown() then
        return true
    end
    return false
end
 
local function toggle(self)
    if self:IsShown() then
        self:Hide()
        return false
    end
    self:Show()
    return true
end
 
local function setshown(self, show)
    if show then
        self:Show()
    else
        self:Hide()
    end
end
 
for key, val in pairs(metatables) do
    if val.Hide then -- Region object
        val.Destroy = destroy
        val.IsDestroyed = isdestroyed
        val.SetSize = setsize
        val.GetSize = getsize
        val.Lock = lock
        val.Unlock = unlock
        val.IsLocked = islocked
        val.Toggle = toggle
        val.SetShown = setshown
    end
    if val.RegisterEvent then -- Frame object
        val.FireEvent = fireevent
    end
    if val.GetScript then -- Any object with scripts
        val.Fire = fire
    end
    if val.SetTexture then -- Texture object
        val.SetClassIcon = setclassicon
    end
end
 
GetClassByColor = getclassbycolor

This adds the following API functions:

GetClassByColor(red, green, blue)
Returns the class associated with the color.

And the following API Widget functions:

Region:Destroy()
Permanently hides the region and unregisters events if associated.

Region:IsDestroyed()
Returns true if the region is destroyed, otherwise false.

Region:Lock()
Blocks all attempts of moving this region until it's unlocked.

Region:Unlock()
Unlocks the frame from the above function.

Region:IsLocked()
Returns true if the region is locked, otherwise false.

Region:SetSize(width, [height])
Sets the width and height of this region, if only one parameter is given both width and height will be set to the same value. Example: Region:SetSize(10, 15) sets the width to 10 and height to 15 while Region:SetSize(15) sets the width and height to 15.

Region:GetSize()
Returns the width and height of the region. Example: local width, height = Region:GetSize()

Region:Toggle()
Hides the region if shown, shows the region if hidden. Returns true if the region is now shown, false if the region is now hidden.

Region:SetShown(show)
If show is a true value(any value except nil and false) then the region is shown, else the region is hidden.

Frame:FireEvent(event, ...)
Fires the event handler of the frame with the parameter "event" as the event, and ... the parameters. The ... variable means there could be as many parameters as you want. You must not give the "self" variable in the parameters(this is done automaticly). Returns true if the handler has been executed, false if not.

Frame:Fire(script, ...)
Fires the event handler of the frame for the script "script" with parameters "...". For example, Frame:Fire("OnUpdate", 2) will run the OnUpdate handler for the frame as if 2 seconds have elapsed. Don't give the "self" variable in the parameters, this is done automaticly. Returns true if the handler has been executed, false if not.

Texture:SetClassIcon(class)
Set's the texture of this texture object to the class icon of the parameter given. The class parameter MUST be in the english version capitalized, not the localized version! If an invalid class is given the texture will be set to transparent. Example: Texture:SetClassIcon("WARRIOR") will set the texture of the object to the class icon of a warrior. No textures except blizzard's have been used for this function. Returns true if the class icon was found and set, false if not.

[nightcracker]

Woops, this should be in Pre-Beta Interfaces/Scripts, can someone move it please?

[xConStruct]

Region:SetShown(shown)
    if shown then
        self:Show()
    else
       self:Hide()
    end
end

This often bothered me

And I would suggest to make getter-functions for your new Set() ones:
- destroyed = Region:IsDestroyed()
- locked = Region:IsLocked()
- width, height = Region:GetSize()

And try to provide return values as often as possible to show if it was successful or not.
- success = Frame:FireEvent()
- success = Frame:Fire()
- success = Texture:SetClassIcon()

[nightcracker]

Originally Posted by Cargor Region:SetShown(shown) if shown then self:Show() else self:Hide() end end This often bothered me And I would suggest to make getter-functions for your new Set() ones: - destroyed = Region:IsDestroyed() - locked = Region:IsLocked() - width, height = Region:GetSize() And try to provide return values as often as possible to show if it was successful or not. - success = Frame:FireEvent() - success = Frame:Fire() - success = Texture:SetClassIcon()

Nice to see some interest, adding those! Also I'm adding a :Toggle() script.

EDIT: Added!

[nightcracker]

Should I loop _G like this for gathering all metatables, or should I run this once, write the names down, and always use these(subject to changes/deletion of frames by blizzard)?

local metatables = {}
for key, val in pairs(_G) do 
    if type(val)=="table" and val.GetObjectType then
        obj = val:GetObjectType()
        if not metatables[obj] then
            metatables[obj] = getmetatable(val).__index
        end
    end
end

[Slakah]

Originally Posted by nightcracker Should I loop _G like this for gathering all metatables, or should I run this once, write the names down, and always use these(subject to changes/deletion of frames by blizzard)? local metatables = {} for key, val in pairs(_G) do     if type(val)=="table" and val.GetObjectType then         obj = val:GetObjectType()         if not metatables[obj] then             metatables[obj] = getmetatable(val).__index         end     end end

You don't need to at all, all frames of the same type share the same metatable so muck about with one and you'll muck about with all of them (although there might be some frames which don't i.e. the ChatFrames)

But really imo a library shouldn't add methods to addons frames which don't use it.

[nightcracker]

Originally Posted by Slakah You don't need to at all, all frames of the same type share the same metatable so muck about with one and you'll muck about with all of them (although there might be some frames which don't i.e. the ChatFrames) But really imo a library shouldn't add methods to addons frames which don't use it.

Wrong, every frame type("Frame", "Button", "Texture", etc) uses a different metatable.

And about the second thing, it doesn't matter, because if they have their own function on that function name, it will override it for that frame(that's the idea of metatable.__index). If I make this library opt-in, it will be more resource heavy AND more work for the lib user. I think this is the best way.

[Shadowed]

Originally Posted by nightcracker Wrong, every frame type("Frame", "Button", "Texture", etc) uses a different metatable. And about the second thing, it doesn't matter, because if they have their own function on that function name, it will override it for that frame(that's the idea of metatable.__index). If I make this library opt-in, it will be more resource heavy AND more work for the lib user. I think this is the best way.

That's a terrible idea. Don't overwrite every single UIObject's function without the author being able to control which. Saying it's more resource heavy is silly. Looping over _G and checking type + pulling metatables is far far far far far far far far far far far far far far far far far far (far) more inefficient than just letting the frame be registered.

[Saiket]

SetSize and GetSize are already part of the default widget API, although SetSize always requires both dimensions.
____
Edit: Perhaps rather than adding these methods to the shared metatables, you could expose something like LibCore:ExtendFrame to modify individual frames after they're made like Shadowed suggests. Then, a sort of LibCore:CreateFrame API could accept all the usual CreateFrame args but then extend the created frame and all its (templated) children.

[Slakah]

Originally Posted by nightcracker Wrong, every frame type("Frame", "Button", "Texture", etc) uses a different metatable.

I know for a fact "Cooldown" and "StatusBar" share at least the same __index table between frames of the same typeor else OmniCC and StatusQuo wouldn't work and iirc the only ones I found didn't share them were ChatFrames so you could probably end up doing:

local frametypes = {"Frame", "StatusBar", etc....}
 
for i, v in pairs(frametypes) do
    DoStuff(getmetatable(CreateFrame(v)).__index)
end

but annnnnyway mucking about with frames in this way is imo a very very very very bad idea i.e. if blizz were to add these methods to frames then your library would just overwrite them leaving mods which were to not use your library in a sticky situation.

[nightcracker]

Originally Posted by Slakah I know for a fact "Cooldown" and "StatusBar" share at least the same __index table or else OmniCC and StatusQuo wouldn't work and iirc the only ones I found didn't share them were ChatFrames, but annnnnyway mucking about with frames in this way is imo a very very very very bad idea.

Again wrong, "Cooldown" and "StatusBar" have shared functions, but aren't the same metatable.

Run the following snippet:

local metatables = {}

for key, val in pairs(_G) do 
	if type(val)=="table" and val.GetObjectType then
		obj = val:GetObjectType()
		if not metatables[obj] then
			metatables[obj] = getmetatable(val).__index
		end
	end
end

for key, val in pairs(metatables) do
	print(key," = ",val)
end

Originally Posted by Shadowed That's a terrible idea. Don't overwrite every single UIObject's function without the author being able to control which. Saying it's more resource heavy is silly. Looping over _G and checking type + pulling metatables is far far far far far far far far far far far far far far far far far far (far) more inefficient than just letting the frame be registered.

I don't OVERWRITE any single function, I add them. I'm just going to generate a static table with metatables, so no looping is required. And finally, using metatables is far far far far far far far far far (far) more efficient then having to set the custom functions on every registered frame.

Since I add functions, there shouldn't be a problem, because if an other author uses a function from my lib without him knowing, he would've gotten a nil error anyway.

About the blizz API change, I admit that it will go wrong, but a simple update should fix that. And it's the responsibility of addon authors to use updated libs.

Please stop argueing about the metatables system, I think it's the best way to affect all frames without having to do a lot as author. That's the reason metatables' __index is awesome after all.

For the people not knowing, __index works like this:
1. Request for the value of the key "key" in table "table".
2. table[key] is not found, Lua will look in the metatable.
3. metatable[key] is found, returns metatable[key].

Now the author makes a function frame:Destroy() on a frame. It will work now like this:
1. Request for the value of the key "Destroy" in table "frame".
2. frame.Destroy is found, Lua will return the function found.
3. (this step will never be executed because frame.Destroy is already found) metatable.Destroy is found, returns metatable.Destroy.

[sigg]

VFL is the framework of RDX.

-------------------------------------------------------------------------
The framework contains an engine of pool objects :

The acquire function try to get a frame object from the pool, if there is no more frame in the pool, create it and execute a function OnAcquire.

local newframe = VFLUI.AcquireFrame("Frame");

The function Destroy execute all cleanup layout, unregisterd any event and release the frame in the pool, to be reused.

newframe:Destroy();

You can replace Frame by Button, checkbutton, SecureGroupHeader etc... You can see all the pool objects, the number created, the number of use and the number available from the VFL profiler.

We have extended some functions, for example the show and hide
newframe:Show(0.2, true);

that mean execute a smooth alpha show, base on time and update every 0.2. the second argument say to also use scale smooth.

RDX is based on this engine, that mean we are able to create and destroy a whole UI without doing a ReloadUI.

-------------------------------------------------------------------------
The event engine of RDX

WoWEvents:Bind(event, obj, function, id)

Example :
WoWEvents:Bind("PLAYER_ENTERING_WORLD", nil, UpdateNewAction, "mainactionButtonStance" .. self.id);

You can also use the internal event RDX :

RDXEvents:Bind
BossmodEvents:Bind etc

And so more functions available

-------------------------------------------------------------------------
You can start by looking into existing framework if it can fit your need.

[Shadowed]

Originally Posted by nightcracker Again wrong, "Cooldown" and "StatusBar" have shared functions, but aren't the same metatable. Run the following snippet: local metatables = {} for key, val in pairs(_G) do if type(val)=="table" and val.GetObjectType then obj = val:GetObjectType() if not metatables[obj] then metatables[obj] = getmetatable(val).__index end end end for key, val in pairs(metatables) do print(key," = ",val) end I don't OVERWRITE any single function, I add them. I'm just going to generate a static table with metatables, so no looping is required. And finally, using metatables is far far far far far far far far far (far) more efficient then having to set the custom functions on every registered frame. Since I add functions, there shouldn't be a problem, because if an other author uses a function from my lib without him knowing, he would've gotten a nil error anyway. About the blizz API change, I admit that it will go wrong, but a simple update should fix that. And it's the responsibility of addon authors to use updated libs. Please stop argueing about the metatables system, I think it's the best way to affect all frames without having to do a lot as author. That's the reason metatables' __index is awesome after all. For the people not knowing, __index works like this: 1. Request for the value of the key "key" in table "table". 2. table[key] is not found, Lua will look in the metatable. 3. metatable[key] is found, returns metatable[key]. Now the author makes a function frameestroy() on a frame. It will work now like this: 1. Request for the value of the key "Destroy" in table "frame". 2. frame.Destroy is found, Lua will return the function found. 3. (this step will never be executed because frame.Destroy is already found) metatable.Destroy is found, returns metatable.Destroy.

I assure you, we both know how metatables work. I'm trying to be nice, but since you don't understand I'll be blunt. You're being delusional.

The performance loss from having people call RegisterObject(frame) and manually setting them is trivial, when I say trivial I mean it's something no sane person worries about. On top of that, because UIObjects aren't created often (or if they are, it's in bursts), the "performance loss" is one shot, and 99% of it is out of combat.

If there is one thing you should learn about programming, it's when to optimize. This isn't one of those times.

RDX is based on this engine, that mean we are able to create and destroy a whole UI without doing a ReloadUI.

On a nit picky note, you aren't destroying the UI. You are recycling the widgets into a pool, it's a release not a destroy

[nightcracker]

Originally Posted by Shadowed I assure you, we both know how metatables work. I'm trying to be nice, but since you don't understand I'll be blunt. You're being delusional. The performance loss from having people call RegisterObject(frame) and manually setting them is trivial, when I say trivial I mean it's something no sane person worries about. On top of that, because UIObjects aren't created often (or if they are, it's in bursts), the "performance loss" is one shot, and 99% of it is out of combat. If there is one thing you should learn about programming, it's when to optimize. This isn't one of those times. On a nit picky note, you aren't destroying an UI. You are recycling the widgets into a pool, it's a release not a destroy

I prefer bluntness then being nice but vague. I'm blunt myself, but don't see it as if I hate you or something, it's my way of discussion.

The performance loss of setting the metatables is also one shot, and I don't see any disadvantages of metatables, only advantages.

@sigg - Looking at RDX now!

[Shadowed]

Originally Posted by nightcracker I prefer bluntness then being nice but vague. I'm blunt myself, but don't see it as if I hate you or something, it's my way of discussion. The performance loss of setting the metatables is also one shot, and I don't see any disadvantages of metatables, only advantages. @sigg - Looking at RDX now!

It's the equivalent to breaking down a door with C4 compared to picking the lock.

[nightcracker]

Originally Posted by Shadowed It's the equivalent to breaking down a door with C4 compared to picking the lock.

So be it.

Just give some good arguments why I SHOULDN'T use metatables.

[sigg]

On a nit picky note, you aren't destroying the UI. You are recycling the widgets into a pool, it's a release not a destroy

Yes, in fact that's true, but we really no more need any ReloadUI

A old video of RDX :

http://www.youtube.com/watch?v=qQscDzXY2Cg

[Saiket]

Originally Posted by nightcracker So be it. Just give some good arguments why I SHOULDN'T use metatables.

An author might see those methods in a frame's metatable and assume they were added to the default UI. After reading this thread, I had to double check the WoW Programming site to make sure SetSize and GetSize were real and not added by a mod.

Some mods might use keys like ".Toggle" as flags, and turning them on for all frames could break the mods' assumption that the key defaults to nil.

[Slakah]

Originally Posted by nightcracker Again wrong, "Cooldown" and "StatusBar" have shared functions, but aren't the same metatable. Run the following snippet: local metatables = {} for key, val in pairs(_G) do if type(val)=="table" and val.GetObjectType then obj = val:GetObjectType() if not metatables[obj] then metatables[obj] = getmetatable(val).__index end end end for key, val in pairs(metatables) do print(key," = ",val) end

Gah discussions like this make me wish I still had an active wow subscription.
If your right then I have no idea how statusquo/OmniCC work.

A stupidly quick test would be to do:

local function go()
    local f = CreateFrame("Frame")
    getmetatable(f).__index.p = true
    return f.p
end
if go() == go() then
    print("Frames share same metatable")
else
    print("Slakah fails and is special")
end

[Cralor]

Originally Posted by Slakah Gah discussions like this make me wish I still had an active wow subscription. If your right then I have no idea how statusquo/OmniCC work. A stupidly quick test would be to do: local function go()     local f = CreateFrame("Frame")     getmetatable(f).__index.p = true     return f.p end if go() == go() then     print("Frames share same metatable") else     print("Slakah fails and is special") end

I don't know much about metatables, but trusting your knowledge with them, the above does print "Frames share same metatable".