Added some GuiLua test source files, and lots of comments in GuiLua.c.

4 files changed, 318 insertions, 0 deletions

diff --git a/ClientHamr/GuiLua/GuiLua.c b/ClientHamr/GuiLua/GuiLua.c
new file mode 100644
index 0000000..3086889
--- /dev/null
+++ b/ClientHamr/GuiLua/GuiLua.c
@@ -0,0 +1,272 @@
+/*  GuiLua - a GUI library that implements matrix-RAD style stuff.
+
+Provides the skang and widget Lua packages.
+
+This should be a library in the end, but for now it's just an
+application that is a test bed for what goes into the library.  In the
+initial intended use case, several applications will be using this all at
+once, with one central app hosting all the GUIs.
+
+Basically this should deal with "windows" and their contents.  A
+"window" in this case is hosted in the central app as some sort of
+internal window, but the user can "tear off" those windows, then they
+get their own OS hosted window.  This could be done by the hosting app
+sending the current window contents to the original app as a skang file.
+
+Between the actual GUI and the app might be a socket, or a stdin/out
+pipe.  Just like matrix-RAD, this should be transparent to the app. 
+Also just like matrix-RAD, widgets can be connected to variable /
+functions (C or Lua), and any twiddlings with those widgets runs the
+function / changes the variable, again transparent to the app, except
+for any registered get/set methods.
+
+This interface between the GUI and the app is "skang" files, which are
+basically Lua scripts.  The GUI and the app can send skang files back
+and forth, usually the app sends actual GUI stuff, and usually the GUI
+sends variable twiddles or action calls.  Usually.
+
+To start with, this will be used to support multiple apps hosting their
+windows in extantz, allowing the big viewer blob to be split up into
+modules.  At some point converting LL XML based UI shit into skang could
+be done.  Also, this should be an exntension to LuaSL, so in-world
+scripts can have a poper GUI for a change.
+
+
+NOTES and TODOs -
+
+See if I can use LuaJIT FFI here.  Since this will be a library, and
+skang apps could be writte nin C or Lua, perhaps writing this library to
+be FFI friendly instead of the usual Lua C binding might be the way to
+go?
+
+For the "GUI hosted in another app" case, we will need some sort of
+internal window manager running in that other app.
+
+This might end up running dozens of Lua scripts, and could use the LuaSL
+Lua script running system.  Moving that into this library might be a
+sane idea I think?  Or prehaps a separate library that both LuaSL and
+GuiLua use?
+
+Raster wants a method of sending Lua tables around as edje messages. 
+Between C, Edje, Edje Lua, and Lua.  Sending between threads, and across
+sockets.  Using a new edje message type, or eet for sockets, was
+suggested, but perhaps Lua skang is a better choice?
+
+Somehow access to the edje_lua2.c bindings should be provided.  And
+bindings to the rest of EFL when they are done.  Assuming the other EFL
+developers do proper introspection stuff, or let me do it.
+
+The generic Lua binding helper functions I wrote for edje?lua2.c could
+be used here as well, and expanded as discussed on the E devs mailing
+list.  This would include the thread safe Lua function stuff copied
+into the README.
+
+There will eventually be a built in editor, like the zen editor from
+matrix-RAD.  It might be a separate app.
+
+NAWS should probably live in here to.  If I ever get around to writing
+it.  lol
+
+The pre tokenized widget structure thingy I had planned in the
+matrix-RAD TODO just wont work, as it uses symbols.  On the other hand,
+we will be using Lua tables anyway.  B-)
+
+*/
+
+
+/* coordinates and sizes
+
+Originally skang differentiated between pixels and character cells,
+using plain integers to represent pixels, and _123 to represent
+character cells.  The skang TODO wanted to expand that to percentages
+and relative numbers.  We can't use _123 in Lua, so some other method
+needs to be used.  Should include those TODO items in this new design.
+
+Specifying character cells should be done as strings - "123"
+
+Percentages can be done as small floating point numbers between 0 and 1,
+which is similar to Edje.  Since Lua only has a floating point number
+type, both 0 and 1 should still represent pixels / character cells -
+
+0.1, 0.5, "0.2", "0.9"
+
+Relative numbers could be done as strings, with the widget to be
+relative to, a + or -, then the number.  This still leaves the problem
+of telling if the number is pixels or character cells.  Also, relative
+to what part of the other widget?  Some more thought needs to be put
+into this.
+
+*/
+
+
+/* thing package
+
+matrix-RAD had Thing as the base class of everything.  Lua doesn't have
+inheritance as such, but an inheritance structure can be built using
+Lua's meta language capabilities.  I think we still need this sort of
+thing.  Java inheritance and interfaces where used.  There's quite a few
+variations of OO support has been written for Lua, maybe some of that
+could be used?  http://lua-users.org/wiki/ObjectOrientedProgramming
+
+Each "users session" (matrix-RAD term that came from Java
+applets/servlets) has a ThingSpace, which is a tree that holds
+everything else.  It holds the class cache, commands, loaded modules,
+variables and their values, widgets and their states.  In matrix-RAD I
+built BonsiaTree and LeafLike, for the old FDO system I built dumbtrees. 
+Perhaps some combination of the two will work here?
+
+Get/set variables would be done here, though the widget package, for
+instance, would override this to deal with the UI side, and call the
+parents function to deal with the variable side -
+
+foo:set('stuff')
+bar = foo:get()
+
+Also, since skang Lua scripts should be defined as modules, we can use
+module semantics -
+
+local other = require('otherPackageName')
+other.foo = 'stuff'
+bar = other.foo
+
+*/
+
+
+/* stuff & squeal packages
+
+In matrix-RAD Stuff took care of multi value Things, like database rows. 
+I'm not sure this is needed here, since Lua has nice tables.  B-)
+
+Squeal was the database driver interface for SquealStuff, the database
+version of Stuff.  Maybe we could wrap esskyuehl?  Not really in need of
+database stuff for now, but should keep it in mind.
+
+*/
+
+
+/* skang package
+
+In here should live all the internals of matrix-RAD that don't
+specifically relate to widgets.  This would include the "window" though.
+
+skang.module(Evas)
+skang.module(Elementary)
+skang.load('some/skang/file.skang')
+
+This package is also what "apps" that use the system should "inherit"
+from, in the same way matrix-RAD apps did.  Skang "apps" could be Lua
+modules.  They could also be C code, like the extantz modules are likely
+to be.  Skang "apps" would automatically be associated with skang files
+of the same name.  So a Lua skang "app" could look like this -
+
+local skang = require('skang')
+local result = {};
+result.author = 'onefang'
+result.version = '0.72 alpha 2004-11-19 16:28:00'
+local bar
+-- The first argument would be the name of a local variable / method.  Which could be accessed via _G?
+-- Not sure if we could use a global bar, AND use it directly.
+result.bar = skang.newParam('bar', "Required", "Shortcut", "Default", "Help text")
+result.func = skang.newCommand('arg1_type,arg2_type', 'Help Text', function (arg1, arg2)
+... do something here ...
+end)
+
+... do something here ...
+
+return result;
+
+
+A basic skang file could look like this -
+
+#!skang myApp.skang
+-- There's an implied local this = require('myApp')
+-- There's an implied local skang = require('skang')
+local widget = require('EvasWidgets')
+local other = require('otherPackageName')
+skang.clear
+skang.window(200, 200, "G'day planet.")
+quitter = widget.button('Quit', 0.5, 0.5, 0.5, 0.5)
+quitter:action('quit')   -- 'quit' is looked up in ThingSpcae.commands, and translated into the Lua 'skang.quit()'.
+other.foo = 'stuff'
+this.bar = other.foo
+this.func(1, 'two')
+
+The skang command (written in C) would strip off the first line, add the
+two implied lines, then run it as Lua.  The skang.load() command would
+do the same.  So that skang C comand would just pass the file name to
+skang.load() in this library.  B-)
+
+
+The old skang argument types are -
+
+                {"name",   "java.lang.String"},
+                {"action", "java.lang.String"},
+                {"type",   "java.lang.String"},
+                {"data",   "java.lang.String"},
+                {"URL",    "java.lang.String"},
+                {"file",   "java.lang.String"},
+                {"method", "java.lang.String"},
+                {"lx",     "java.lang.String"},
+                {"ly",     "java.lang.String"},
+                {"lw",     "java.lang.String"},
+                {"lh",     "java.lang.String"},
+                {"normal", "java.lang.String"},
+                {"ghost",  "java.lang.String"},
+                {"active", "java.lang.String"},
+                {"toggle", "java.lang.String"},
+                {"boolean","java.lang.Boolean"},
+                {"number", "java.lang.Integer"},
+                {"int",    "java.lang.Integer"},
+                {"x",      "java.lang.Integer"},
+                {"y",      "java.lang.Integer"},
+                {"w",      "java.lang.Integer"},
+                {"h",      "java.lang.Integer"},
+                {"r",      "java.lang.Integer"},
+                {"g",      "java.lang.Integer"},
+                {"b",      "java.lang.Integer"},
+                {"alpha",  "java.lang.Integer"},
+                {"acl",    "net.matrix_rad.security.ACL"},
+
+*/
+
+
+/* widget package
+
+Should include functions for actually dealing with widgets, plus a way
+of creating widgets via introspection.  Should also allow access to
+widget internals via table access.  Lua code could look like this -
+
+foo = widget.label(0, "0.1", 0.5, 0, 'Text goes here :")
+-- Method style.
+foo:colour(255, 255, 255, 0, 0, 100, 255, 0)
+foo:hide()
+foo:action("skang.load(some/skang/file.skang)")
+-- Table style.
+foo.action = "skang.load('some/skang/file.skang')"
+foo.colour.r = 123
+foo.look('some/edje/file/somewhere.edj')
+foo.help = 'This is a widget for labelling some foo.'
+
+For widgets with "rows", which was handled by Stuff in skang, we could
+maybe use the Lua concat operator via metatable.  I think that works by
+having the widget (a table) on one side of the concat or the other, and
+the metatable function gets passed left and right sides, then must
+return the result.  Needs some experimentation, but this might look like
+this -
+
+this.bar = this.bar .. 'new choice'
+this.bar = 'new first choice' .. this.bar
+
+*/
+
+
+
+/* introspection
+
+As detailed in README, EFL introspection doesn't seem to really be on
+the radar, but I might get lucky, or I might have to write it myself. 
+For quick and dirty early testing, I'll probably write a widget package
+that has hard coded mappings between some basic "label", "button", etc.
+and ordinary elementary widgets.  Proper introspection can come later.
+
+*/
diff --git a/ClientHamr/GuiLua/test.c b/ClientHamr/GuiLua/test.c
new file mode 100644
index 0000000..12b5901
--- /dev/null
+++ b/ClientHamr/GuiLua/test.c
@@ -0,0 +1,19 @@
+/* Should be a Lua module, roughly the same as -
+
+local skang = require('skang')
+local result = {};
+result.author = 'onefang'
+result.version = '0.72 alpha 2004-11-19 16:28:00'
+local bar
+-- The first argument would be the name of a local variable / method.  Which could be accessed via _G?
+-- Not sure if we could use a global bar, AND use it directly.
+result.bar = skang.newParam('bar', "Required", "Shortcut", "Default", "Help text")
+result.func = skang.newCommand('number,data', 'Help Text', function (arg1, arg2)
+-- do something here
+end)
+
+-- do something here
+
+return result;
+
+*/
diff --git a/ClientHamr/GuiLua/test.lua b/ClientHamr/GuiLua/test.lua
new file mode 100644
index 0000000..7e668d2
--- /dev/null
+++ b/ClientHamr/GuiLua/test.lua
@@ -0,0 +1,15 @@
+local skang = require('skang')
+local result = {};
+result.author = 'onefang'
+result.version = '0.72 alpha 2004-11-19 16:28:00'
+local bar
+-- The first argument would be the name of a local variable / method.  Which could be accessed via _G?
+-- Not sure if we could use a global bar, AND use it directly.
+result.bar = skang.newParam('bar', "Required", "Shortcut", "Default", "Help text")
+result.func = skang.newCommand('number,data', 'Help Text', function (arg1, arg2)
+-- do something here
+end)
+
+-- do something here
+
+return result;
diff --git a/ClientHamr/GuiLua/test.skang b/ClientHamr/GuiLua/test.skang
new file mode 100644
index 0000000..ba40f1f
--- /dev/null
+++ b/ClientHamr/GuiLua/test.skang
@@ -0,0 +1,12 @@
+#!skang test.skang     -- This is Lua, so this might not work.
+-- There's an implied local this = require('test')
+-- There's an implied local skang = require('skang')
+local widget = require('widget')
+-- local other = require('otherPackageName')
+skang.clear
+skang.window(200, 200, "G'day planet.")
+quitter = widget.button('Quit', 0.5, 0.5, 0.5, 0.5)
+quitter:action('quit')   -- 'quit' is looked up in ThingSpcae.commands, and translated into the Lua 'skang.quit()'.
+--other.foo = 'stuff'
+this.bar = 'things'
+this.func(1, 'two')