1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
|
/* GuiLua - a GUI library that implements matrix-RAD style stuff.
Provides the skang and widget Lua packages.
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 -
Lua scripts do -
require 'widget' -> loads widget.c
Widget.c is a library like test_c.
It starts up GuiLua.c app, with stdin/stdout pipe.
Widget.c then acts as a proxy for all the widget stuff.
So Lua modules via C libraries can work with Elm code that has a special main and has to be an app.
Seems simplest.
Also -
Some of this gets shared with LuaSL, since it came from there anyway.
Finally -
Add a --gui command line option, that runs foo.skang.
Than change the hash bang to use it.
And if there's a matching module, load the module first, call gimmeSkin() on it.
So that any with an internal default skin get that instead.
Same if there's a module, but no skang file.
Making these packages all a sub package of skang seems like a great
idea. On the other hand, looks like most things are just getting folded
into skang anyway. See
http://www.inf.puc-rio.br/~roberto/pil2/chapter15.pdf part 15.5 for
package details.
See if I can use LuaJIT FFI here. Since this will be a library, and
skang apps could be written in C or Lua, perhaps writing this library to
be FFI friendly instead of the usual Lua C binding might be the way to
go? LuaJIT is not ready yet, since it needs include files copied into
Lua files, and does not support macros, which EFL uses a lot of.
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-)
The last half of http://passingcuriosity.com/2009/extending-lua-in-c/
might be of use.
*/
/* thing package
Currently this is in skang.lua, but should bring this in here later.
*/
/* skang package
Currently this is in skang.lua, but should bring this in here later.
*/
/* stuff & squeal packages
Currently Stuff is in skang.lua, but should bring this in here later.
*/
/* widget package
Currently widget design is in skang.lua, but should bring this in here later.
*/
/* 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.
*/
#include "GuiLua.h"
globals ourGlobals;
static const char *globName = "ourGlobals";
/* Sooo, how to do this -
widget has to be a light userdata
The rest can be Lua sub things? Each with a C function to update the widget.
win.quitter:colour(1,2,3,4) -> win.quitter.colour(win.quitter, 1,2,3,4) -> __call(win.quitter.colour, win.quitter, 1,2,3,4) -> skang.colour(win.quitter.colour, win.quitter, 1,2,3,4)
win.quitter.colour.r = 5 -> direct access to the table, well "direct" via Thing and Mum. We eventually want to call skang.colour() though.
*/
struct _Widget
{
char magic[8];
Evas_Object *obj;
Eina_Clist node;
char *label, *look, *action, *help;
// foreground / background colour
// thing
// types {}
// skangCoord x, y, w, h
};
// TODO - These functions should be able to deal with multiple windows.
// TODO - Should be able to open external and internal windows, and even switch between them on the fly.
static void _on_click(void *data, Evas_Object *obj, void *event_info EINA_UNUSED)
{
globals *ourGlobals;
lua_State *L = data;
struct _Widget *wid;
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
wid = evas_object_data_get(obj, "Widget");
if (wid)
{
PD("Doing action %s", wid->action);
if (0 != luaL_dostring(L, wid->action))
PE("Error running - %s", wid->action);
}
}
static void _on_done(void *data, Evas_Object *obj EINA_UNUSED, void *event_info EINA_UNUSED)
{
// globals *ourGlobals = data;
// Tell the main loop to stop, which it will, eventually.
elm_exit();
}
static int widget(lua_State *L)
{
globals *ourGlobals;
char *type = "label";
char *title = ":";
int x = 1, y = 1, w = WIDTH/3, h = HEIGHT/3;
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
pull_lua(L, 1, "$type $title %x %y %w %h", &type, &title, &x, &y, &w, &h);
// Poor mans introspection, until I write real introspection into EFL.
// TODO - The alternative is to just lookup the ELM_*_CLASS in a hash table?
if (strcmp(type, "button") == 0)
{
struct _Widget *wid;
wid = calloc(1, sizeof(struct _Widget));
strcpy(wid->magic, "Widget");
eina_clist_add_head(&ourGlobals->widgets, &wid->node);
wid->label = strdup(title);
// These two lines are likely the only ones that will be different for the different sorts of widgets.
wid->obj = eo_add(ELM_OBJ_BUTTON_CLASS, ourGlobals->win);
evas_object_smart_callback_add(wid->obj, "clicked", _on_click, L);
elm_object_part_text_set(wid->obj, NULL, wid->label);
eo_do(wid->obj,
// elm_obj_widget_part_text_set(NULL, wid->label),
evas_obj_size_set(w, h),
evas_obj_position_set(x, y),
evas_obj_visibility_set(EINA_TRUE),
eo_key_data_set("Widget", wid, NULL)
);
/* Evas_Object *bt isn't a real pointer it seems. At least Lua bitches about it -
PANIC: unprotected error in call to Lua API (bad light userdata pointer)
So we wrap the _Widget instead of the Evas_Object.
TODO - Might as well make _Widget a full userdata.
*/
lua_pushlightuserdata(L, (void *) wid);
return 1;
}
return 0;
}
static int action(lua_State *L)
{
globals *ourGlobals;
struct _Widget *wid = lua_touserdata(L, 1);
char *action = "nada";
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
pull_lua(L, 2, "$", &action);
if (wid && strcmp(wid->magic, "Widget") == 0)
{
PD("Setting action %s", action);
wid->action = strdup(action);
}
return 0;
}
static int colour(lua_State *L)
{
// TODO - This is just a stub for now.
return 0;
}
static int window(lua_State *L)
{
globals *ourGlobals;
char *name = "GuiLua";
char *title = "GuiLua test harness";
Evas_Object *obj;
int result = 0;
int w = WIDTH, h = HEIGHT;
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
pull_lua(L, 1, "%w %h $title $name", &w, &h, &title, &name);
// Set the engine to opengl_x11, then open the window.
elm_config_preferred_engine_set("opengl_x11");
if ((ourGlobals->win = elm_win_util_standard_add(name, title)))
{
eina_clist_init(&ourGlobals->widgets);
evas_object_smart_callback_add(ourGlobals->win, "delete,request", _on_done, ourGlobals);
evas_object_resize(ourGlobals->win, w, h);
evas_object_move(ourGlobals->win, 0, 0);
evas_object_show(ourGlobals->win);
// Get the Evas / canvas from the elm window (that the Evas_Object "lives on"), which is itself an Evas_Object created by Elm, so not sure if it was created internally with Ecore_Evas.
ourGlobals->evas = evas_object_evas_get(ourGlobals->win);
// Add a background image object.
obj = eo_add(ELM_OBJ_IMAGE_CLASS, ourGlobals->win);
eo_do(obj,
evas_obj_size_hint_weight_set(EVAS_HINT_EXPAND, EVAS_HINT_EXPAND),
elm_obj_image_fill_outside_set(EINA_TRUE),
elm_obj_image_file_set("../../media/sky_01.jpg", NULL),
evas_obj_visibility_set(EINA_TRUE)
);
elm_win_resize_object_add(ourGlobals->win, obj);
eo_unref(obj);
lua_pushlightuserdata(L, &ourGlobals->win);
result = 1;
}
// Set preferred engine back to default from config
elm_config_preferred_engine_set(NULL);
return result;
}
static int clear(lua_State *L)
{
// TODO - This is just a stub for now.
return 0;
}
static int loopWindow(lua_State *L)
{
globals *ourGlobals;
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
if (ourGlobals->win)
elm_run();
return 0;
}
static int quit(lua_State *L)
{
globals *ourGlobals;
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
_on_done(ourGlobals, NULL, NULL);
return 0;
}
static int closeWindow(lua_State *L)
{
globals *ourGlobals;
lua_getfield(L, LUA_REGISTRYINDEX, globName);
ourGlobals = lua_touserdata(L, -1);
lua_pop(L, 1);
if (ourGlobals->win)
{
struct _Widget *wid;
// Elm will delete our widgets, but if we are using eo, we need to unref them.
EINA_CLIST_FOR_EACH_ENTRY(wid, &ourGlobals->widgets, struct _Widget, node)
{
eo_unref(wid->obj);
}
evas_object_del(ourGlobals->win);
}
if (ourGlobals->logDom >= 0)
{
eina_log_domain_unregister(ourGlobals->logDom);
ourGlobals->logDom = -1;
}
// This shuts down Elementary, but keeps the main loop running until all ecore_evas are freed.
elm_shutdown();
return 0;
}
/* local widget = require 'libGuiLua'
Lua's require() function will strip any stuff from the front of the name
separated by a hyphen, so 'ClientHamr-GuiLua-libGuiLua' -> 'libGuiLua'. Then
it will search through a path, and eventually find this libGuiLua.so (or
libGuiLua.dll or whatever), then call luaopen_libGuiLua(), which should return
a table. The argument (only thing on the stack) for this function will
be 'libGuiLua'.
Normally luaL_register() creates a table of functions, that is the table
returned, but we want to do something different with skang.
*/
int luaopen_GuiLua(lua_State *L)
{
int skang;
// In theory this function only ever gets called once.
ourGlobals.logDom = loggingStartup("GuiLua", ourGlobals.logDom);
elm_policy_set(ELM_POLICY_EXIT, ELM_POLICY_EXIT_NONE);
elm_policy_set(ELM_POLICY_QUIT, ELM_POLICY_QUIT_NONE);
elm_policy_set(ELM_POLICY_THROTTLE, ELM_POLICY_THROTTLE_HIDDEN_ALWAYS);
// These are set via the elementary_config tool, which is hard to find.
elm_config_finger_size_set(0);
elm_config_scale_set(1.0);
// pseudo-indices, special tables that can be accessed like the stack -
// LUA_GLOBALSINDEX - thread environment, where globals are
// LUA_ENVIRONINDEX - C function environment, in this case luaopen_widget() is the C function
// LUA_REGISTRYINDEX - C registry, global, for unique keys use the module name as a string, or a lightuserdata address to a C object in our module.
// lua_upvalueindex(n) - C function upvalues
// Shove ourGlobals into the registry.
lua_pushlightuserdata(L, &ourGlobals);
lua_setfield(L, LUA_REGISTRYINDEX, globName);
// The skang module should have been loaded by now, so we can just grab it out of package.loaded[].
lua_getglobal(L, "package");
lua_getfield(L, lua_gettop(L), "loaded");
lua_remove(L, -2); // Removes "package"
lua_getfield(L, lua_gettop(L), SKANG);
lua_remove(L, -2); // Removes "loaded"
lua_setfield(L, LUA_REGISTRYINDEX, SKANG);
lua_getfield(L, LUA_REGISTRYINDEX, SKANG); // Puts the skang table back on the stack.
skang = lua_gettop(L);
// Define our functions.
//thingasm{'window', 'The size and title of the application Frame.', window, 'x,y,name', acl='GGG'}
push_lua(L, "@ ( { = $ $ & $ $acl } )", skang, THINGASM, skang, "Cwindow", "Opens our window.", window, "number,number,string", "GGG", 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "clear", "The current skin is cleared of all widgets.", clear, 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "widget", "Create a widget.", widget, 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "action", "Add an action to a widget.", action, 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "Colour", "Change widget colours.", colour, 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "loopWindow", "Run our windows main loop.", loopWindow, 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "quit", "Quit, exit, remove thyself.", quit, 0);
push_lua(L, "@ ( = $ $ & )", skang, THINGASM, skang, "closeWindow", "Closes our window.", closeWindow, 0);
// A test of the array building stuff.
push_lua(L, "@ ( { = $ $ % $widget !required } )", skang, THINGASM, skang, "wibble", "It's wibbly!", 1, "'edit', 'The wibblinator:', 1, 1, 10, 50", 1, 0);
// Makes no difference what we return, but it's expecting something.
return 1;
}
void GuiLuaDo(int argc, char **argv)
{
lua_State *L;
lua_Number i;
L = luaL_newstate();
if (L)
{
luaL_openlibs(L);
// Pass all our command line arguments to Lua.
i = 1;
lua_newtable(L);
while (--argc > 0 && *++argv != '\0')
{
lua_pushnumber(L, i++);
lua_pushstring(L, *argv);
lua_settable(L, -3);
}
lua_setfield(L, LUA_GLOBALSINDEX, "arg");
// When we do this, skang will process all the arguments passed to GuiLuaDo().
// This likely includes a module load, which likely opens a window.
lua_getglobal(L, "require");
lua_pushstring(L, SKANG);
lua_call(L, 1, 1);
lua_setfield(L, LUA_GLOBALSINDEX, SKANG);
// Run the main loop via a Lua call.
// This does nothing if no module opened a window.
if (0 != luaL_dostring(L, "skang.loopWindow()"))
PEm("Error running - skang.loopWindow()");
lua_pop(L, closeWindow(L));
lua_close(L);
}
else
fprintf(stderr, "Failed to start Lua!\n");
}
|