src/lua.c

   1 /* Lua scripting support
   2  *
   3  * Copyright (c) 2008 Sadrul Habib Chowdhury (sadrul@users.sf.net)
   4  * Copyright (c) 2009
   5  *      Sadrul Habib Chowdhury (sadrul@users.sf.net)
   6  *      Rui Guo (firemeteor.guo@gmail.com)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program (see the file COPYING); if not, write to the
  20  * Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  22  *
  23  ****************************************************************
  24  */
  25 #include <sys/types.h>
  26 #include "config.h"
  27 #include "screen.h"
  28 #include <sys/stat.h>
  29 #include <unistd.h>
  30
  31 #include <stdio.h>
  32 #include <string.h>
  33 #include <stdlib.h>
  34
  35 #include "extern.h"
  36 #include "logfile.h"
  37
  38 #include <lua.h>
  39 #include <lauxlib.h>
  40 #include <lualib.h>
  41
  42 static int StackDump(lua_State *L, const char *message)
  43 {
  44   FILE *f = fopen("/tmp/debug/stack", "ab");
  45   int i = lua_gettop(L);
  46   if (message)
  47     fprintf(f, "%s", message);
  48   while (i)
  49     {
  50       int t = lua_type(L, i);
  51       switch (t)
  52         {
  53           case LUA_TSTRING:
  54             fprintf(f, "String: %s\n", lua_tostring(L, i));
  55             break;
  56
  57           case LUA_TBOOLEAN:
  58             fprintf(f, "Boolean: %s\n", lua_toboolean(L, i) ? "true" : "false");
  59             break;
  60
  61           case LUA_TNUMBER:
  62             fprintf(f, "Number: %g\n", lua_tonumber(L, i));
  63             break;
  64
  65           default:
  66             fprintf(f, "Type: %s\n", lua_typename(L, t));
  67         }
  68       i--;
  69     }
  70   if (message)
  71     fprintf(f, "----\n");
  72   fclose(f);
  73   return 0;
  74 }
  75
  76 extern struct win *windows, *fore;
  77 extern struct display *displays, *display;
  78 extern struct LayFuncs WinLf;
  79 extern struct layer *flayer;
  80 extern void AppendWinMsgRend(const char *str, const char *color);
  81 extern void FocusCanvas(struct canvas *cv);
  82
  83 static int LuaDispatch(void *handler, const char *params, va_list va);
  84 static int LuaRegEvent(lua_State *L);
  85 static void LuaShowErr(lua_State *L);
  86 struct binding lua_binding;
  87
  88 enum
  89 {
  90   LUA_HANDLER_TYPE_N = 1,
  91   LUA_HANDLER_TYPE_F
  92 };
  93
  94 struct lua_handler
  95 {
  96   int type;
  97   union
  98   {
  99     const char *name;
 100     int reference;
 101   } u;
 102 };
 103
 104 typedef struct lua_handler *lua_handler;
 105 void LuaPushHandler(lua_State *L, lua_handler lh);
 106 void LuaHUnRef(lua_State *L, int key);
 107 lua_handler LuaCheckHandler(lua_State *L, int idx, int ref);
 108
 109 lua_handler
 110 LuaAllocHandler(const char *name, int ref)
 111 {
 112   struct lua_handler *lh;
 113   lh = (struct lua_handler*) malloc(sizeof(struct lua_handler));
 114   if (!lh)
 115     return NULL;
 116
 117   if (name)
 118     {
 119       lh->type = LUA_HANDLER_TYPE_N;
 120       lh->u.name = SaveStr(name);
 121     }
 122   else
 123     {
 124       lh->type = LUA_HANDLER_TYPE_F;
 125       lh->u.reference = ref;
 126     }
 127
 128   return lh;
 129 }
 130
 131 void
 132 LuaFreeHandler(lua_State *L, struct lua_handler **lh)
 133 {
 134   if ((*lh)->type == LUA_HANDLER_TYPE_N)
 135     Free((*lh)->u.name)
 136   else
 137     {
 138       LuaHUnRef(L, (*lh)->u.reference);
 139       (*lh)->u.reference = 0;
 140     }
 141   Free(*lh);
 142 }
 143 /** Template {{{ */
 144
 145 #define CHECK_TYPE(name, type) \
 146 static type * \
 147 check_##name(lua_State *L, int index) \
 148 { \
 149   type **var; \
 150   luaL_checktype(L, index, LUA_TUSERDATA); \
 151   var = (type **) luaL_checkudata(L, index, #name); \
 152   if (!var || !*var) \
 153     luaL_typerror(L, index, #name); \
 154   return *var; \
 155 }
 156
 157 #define PUSH_TYPE(name, type) \
 158 static void \
 159 push_##name(lua_State *L, type **t) \
 160 { \
 161   if (!t || !*t) \
 162     lua_pushnil(L); \
 163   else \
 164     { \
 165       type **r; \
 166       r = (type **)lua_newuserdata(L, sizeof(type *)); \
 167       *r = *t; \
 168       luaL_getmetatable(L, #name); \
 169       lua_setmetatable(L,-2); \
 170     } \
 171 }
 172
 173 /* Much of the following template comes from:
 174  *      http://lua-users.org/wiki/BindingWithMembersAndMethods
 175  */
 176
 177 static int get_int (lua_State *L, void *v)
 178 {
 179   lua_pushinteger (L, *(int*)v);
 180   return 1;
 181 }
 182
 183 static int set_int (lua_State *L, void *v)
 184 {
 185   *(int*)v = luaL_checkint(L, 3);
 186   return 0;
 187 }
 188
 189 static int get_number (lua_State *L, void *v)
 190 {
 191   lua_pushnumber(L, *(lua_Number*)v);
 192   return 1;
 193 }
 194
 195 static int set_number (lua_State *L, void *v)
 196 {
 197   *(lua_Number*)v = luaL_checknumber(L, 3);
 198   return 0;
 199 }
 200
 201 static int get_string (lua_State *L, void *v)
 202 {
 203   lua_pushstring(L, (char*)v );
 204   return 1;
 205 }
 206
 207 static int set_string (lua_State *L, void *v)
 208 {
 209   *(const char**)v = luaL_checkstring(L, 3);
 210   return 0;
 211 }
 212
 213 typedef int (*Xet_func) (lua_State *L, void *v);
 214
 215 /* member info for get and set handlers */
 216 struct Xet_reg
 217 {
 218   const char *name;  /* member name */
 219   Xet_func func;     /* get or set function for type of member */
 220   size_t offset;     /* offset of member within the struct */
 221   int (*absolute)(lua_State *);
 222 };
 223
 224 static void Xet_add (lua_State *L, const struct Xet_reg *l)
 225 {
 226   if (!l)
 227     return;
 228   for (; l->name; l++)
 229     {
 230       lua_pushstring(L, l->name);
 231       lua_pushlightuserdata(L, (void*)l);
 232       lua_settable(L, -3);
 233     }
 234 }
 235
 236 static int Xet_call (lua_State *L)
 237 {
 238   /* for get: stack has userdata, index, lightuserdata */
 239   /* for set: stack has userdata, index, value, lightuserdata */
 240   const struct Xet_reg *m = (const struct Xet_reg *)lua_touserdata(L, -1);  /* member info */
 241   lua_pop(L, 1);                               /* drop lightuserdata */
 242   luaL_checktype(L, 1, LUA_TUSERDATA);
 243   if (m->absolute)
 244     return m->absolute(L);
 245   return m->func(L, *(char**)lua_touserdata(L, 1) + m->offset);
 246 }
 247
 248 static int index_handler (lua_State *L)
 249 {
 250   /* stack has userdata, index */
 251   lua_pushvalue(L, 2);                     /* dup index */
 252   lua_rawget(L, lua_upvalueindex(1));      /* lookup member by name */
 253   if (!lua_islightuserdata(L, -1))
 254     {
 255       lua_pop(L, 1);                         /* drop value */
 256       lua_pushvalue(L, 2);                   /* dup index */
 257       lua_gettable(L, lua_upvalueindex(2));  /* else try methods */
 258       if (lua_isnil(L, -1))                  /* invalid member */
 259         luaL_error(L, "cannot get member '%s'", lua_tostring(L, 2));
 260       return 1;
 261     }
 262   return Xet_call(L);                      /* call get function */
 263 }
 264
 265 static int newindex_handler (lua_State *L)
 266 {
 267   /* stack has userdata, index, value */
 268   lua_pushvalue(L, 2);                     /* dup index */
 269   lua_rawget(L, lua_upvalueindex(1));      /* lookup member by name */
 270   if (!lua_islightuserdata(L, -1))         /* invalid member */
 271     luaL_error(L, "cannot set member '%s'", lua_tostring(L, 2));
 272   return Xet_call(L);                      /* call set function */
 273 }
 274
 275 static int
 276 struct_register(lua_State *L, const char *name, const luaL_reg fn_methods[], const luaL_reg meta_methods[],
 277     const struct Xet_reg setters[], const struct Xet_reg getters[])
 278 {
 279   int metatable, methods;
 280
 281   /* create methods table & add it to the table of globals */
 282   luaL_register(L, name, fn_methods);
 283   methods = lua_gettop(L);
 284
 285   /* create metatable & add it to the registry */
 286   luaL_newmetatable(L, name);
 287   luaL_register(L, 0, meta_methods);  /* fill metatable */
 288
 289   /* To identify the type of object */
 290   lua_pushstring(L, "_objname");
 291   lua_pushstring(L, name);
 292   lua_rawset(L, -3);
 293
 294   metatable = lua_gettop(L);
 295
 296   lua_pushliteral(L, "__metatable");
 297   lua_pushvalue(L, methods);    /* dup methods table*/
 298   lua_rawset(L, metatable);     /* hide metatable:
 299                                    metatable.__metatable = methods */
 300
 301   lua_pushliteral(L, "__index");
 302   lua_pushvalue(L, metatable);  /* upvalue index 1 */
 303   Xet_add(L, getters);     /* fill metatable with getters */
 304   lua_pushvalue(L, methods);    /* upvalue index 2 */
 305   lua_pushcclosure(L, index_handler, 2);
 306   lua_rawset(L, metatable);     /* metatable.__index = index_handler */
 307
 308   lua_pushliteral(L, "__newindex");
 309   lua_newtable(L);              /* table for members you can set */
 310   Xet_add(L, setters);     /* fill with setters */
 311   lua_pushcclosure(L, newindex_handler, 1);
 312   lua_rawset(L, metatable);     /* metatable.__newindex = newindex_handler */
 313
 314   /* FIXME: Why do we leave an element on the stack? */
 315   lua_pop(L, 1);                /* drop metatable */
 316   return 1;                     /* return methods on the stack */
 317 }
 318
 319 /** }}} */
 320
 321 /** Callback {{{ */
 322 PUSH_TYPE(callback, struct listener)
 323
 324 static int
 325 internal_unhook(lua_State *L, int warn)
 326 {
 327   /*Emulate check_callback() */
 328   struct listener **ppl;
 329   luaL_checktype(L, 1, LUA_TUSERDATA);
 330   ppl = (struct listener **) luaL_checkudata(L, 1, "callback");
 331
 332   if (!ppl)
 333     luaL_typerror(L, 1, "callback");
 334
 335   if (!*ppl)
 336     {
 337       if (warn)
 338         {
 339           lua_pushboolean(L, 0);
 340           lua_pushstring(L, "Callback already unhooked.");
 341           LuaShowErr(L);
 342         }
 343     }
 344   else
 345     {
 346       LuaFreeHandler(L, (lua_handler *)&(*ppl)->handler);
 347       unregister_listener(*ppl);
 348       *ppl = 0;
 349       if (warn)
 350         lua_pushboolean(L, 1);
 351     }
 352   return warn != 0;
 353 }
 354 static int
 355 callback_unhook(lua_State *L)
 356 {
 357   return internal_unhook(L, 1);
 358 }
 359
 360 static const luaL_reg callback_methods[] = {
 361   {"unhook", callback_unhook},
 362   {0, 0}
 363 };
 364
 365 int
 366 callback_collect(lua_State *L)
 367 {
 368   return internal_unhook(L, 0);
 369 }
 370
 371 static const luaL_reg callback_metamethods[] = {
 372   {"__gc", callback_collect},
 373   {0, 0}
 374 };
 375
 376 static const struct Xet_reg callback_setters[] = {
 377   {0, 0}
 378 };
 379
 380 static const struct Xet_reg callback_getters[] = {
 381   {0, 0}
 382 };
 383
 384
 385 /** }}} */
 386
 387 /** Window {{{ */
 388
 389 PUSH_TYPE(window, struct win)
 390
 391 CHECK_TYPE(window, struct win)
 392
 393 static int get_window(lua_State *L, void *v)
 394 {
 395   push_window(L, (struct win **)v);
 396   return 1;
 397 }
 398
 399 static int
 400 window_change_title(lua_State *L)
 401 {
 402   struct win *w = check_window(L, 1);
 403   unsigned int len;
 404   const char *title = luaL_checklstring(L, 3, &len);
 405   ChangeAKA(w, (char *)title, len);
 406   return 0;
 407 }
 408
 409 static int
 410 window_change_number(lua_State *L)
 411 {
 412   struct win *w = check_window(L, 1);
 413   int newnum = luaL_checkint(L, 3);
 414   ChangeWinNum(w->w_number, newnum);
 415   return 0;
 416 }
 417
 418 static int
 419 window_get_monitor_status(lua_State *L)
 420 {
 421   struct win *w = check_window(L, 1);
 422   int activity = luaL_checkint(L, 2);
 423   if (activity)
 424     /*monitor*/
 425     lua_pushinteger(L, w->w_monitor != MON_OFF);
 426   else
 427     /*silence*/
 428     lua_pushinteger(L, w->w_silence == SILENCE_ON ? w->w_silencewait: 0);
 429
 430   return 1;
 431 }
 432
 433 static int
 434 window_stuff(lua_State *L)
 435 {
 436   unsigned int len;
 437   struct layer *oldflayer = flayer;
 438   struct win *w = check_window(L, 1);
 439   const char *str = luaL_checklstring(L, 2, &len);
 440
 441   flayer = &w->w_layer;
 442   while(len)
 443     LayProcess((char **)&str, (int *) &len);
 444   flayer = oldflayer;
 445   return 0;
 446 }
 447
 448 static int
 449 window_activate(lua_State *L)
 450 {
 451   struct win *w = check_window(L, 1);
 452   SetForeWindow(w);
 453   return 0;
 454 }
 455
 456 static const luaL_reg window_methods[] = {
 457   {"get_monitor_status", window_get_monitor_status},
 458   {"stuff", window_stuff},
 459   {"activate", window_activate},
 460   {"hook", LuaRegEvent},
 461   {0, 0}
 462 };
 463
 464 static int
 465 window_tostring(lua_State *L)
 466 {
 467   char str[128];
 468   struct win *w = check_window(L, 1);
 469   snprintf(str, sizeof(str), "{window #%d: '%s'}", w->w_number, w->w_title);
 470   lua_pushstring(L, str);
 471   return 1;
 472 }
 473
 474 static int
 475 window_equality(lua_State *L)
 476 {
 477   struct win *w1 = check_window(L, 1), *w2 = check_window(L, 2);
 478   lua_pushboolean(L, (w1 == w2 || (w1 && w2 && w1->w_number == w2->w_number)));
 479   return 1;
 480 }
 481
 482 static const luaL_reg window_metamethods[] = {
 483   {"__tostring", window_tostring},
 484   {"__eq", window_equality},
 485   {0, 0}
 486 };
 487
 488 static const struct Xet_reg window_setters[] = {
 489   {"title", 0, 0, window_change_title/*absolute setter*/},
 490   {"number", 0, 0, window_change_number/*absolute setter*/},
 491   {0, 0}
 492 };
 493
 494 static const struct Xet_reg window_getters[] = {
 495   {"title", get_string, offsetof(struct win, w_title) + 8},
 496   {"number", get_int, offsetof(struct win, w_number)},
 497   {"dir", get_string, offsetof(struct win, w_dir)},
 498   {"tty", get_string, offsetof(struct win, w_tty)},
 499   {"pid", get_int, offsetof(struct win, w_pid)},
 500   {"group", get_window, offsetof(struct win, w_group)},
 501   {"bell", get_int, offsetof(struct win, w_bell)},
 502   {0, 0}
 503 };
 504
 505
 506 /** }}} */
 507
 508 /** AclUser {{{ */
 509
 510 PUSH_TYPE(user, struct acluser)
 511
 512 CHECK_TYPE(user, struct acluser)
 513
 514 static int
 515 get_user(lua_State *L, void *v)
 516 {
 517   push_user(L, (struct acluser **)v);
 518   return 1;
 519 }
 520
 521 static const luaL_reg user_methods[] = {
 522   {0, 0}
 523 };
 524
 525 static int
 526 user_tostring(lua_State *L)
 527 {
 528   char str[128];
 529   struct acluser *u = check_user(L, 1);
 530   snprintf(str, sizeof(str), "{user '%s'}", u->u_name);
 531   lua_pushstring(L, str);
 532   return 1;
 533 }
 534
 535 static const luaL_reg user_metamethods[] = {
 536   {"__tostring", user_tostring},
 537   {0, 0}
 538 };
 539
 540 static const struct Xet_reg user_setters[] = {
 541   {0, 0}
 542 };
 543
 544 static const struct Xet_reg user_getters[] = {
 545   {"name", get_string, offsetof(struct acluser, u_name)},
 546   {"password", get_string, offsetof(struct acluser, u_password)},
 547   {0, 0}
 548 };
 549
 550 /** }}} */
 551
 552 /** Canvas {{{ */
 553
 554 PUSH_TYPE(canvas, struct canvas)
 555
 556 CHECK_TYPE(canvas, struct canvas)
 557
 558 static int
 559 get_canvas(lua_State *L, void *v)
 560 {
 561   push_canvas(L, (struct canvas **)v);
 562   return 1;
 563 }
 564
 565 static int
 566 canvas_select(lua_State *L)
 567 {
 568   struct canvas *c = check_canvas(L, 1);
 569   if (!display || D_forecv == c)
 570     return 0;
 571   /* FIXME: why do we need this? */
 572   SetCanvasWindow(c, Layer2Window(c->c_layer));
 573
 574   FocusCanvas(c);
 575   return 0;
 576 }
 577
 578 static int
 579 canvas_showwin(lua_State *L)
 580 {
 581   struct canvas *c = check_canvas(L, 1);
 582   if (lua_isnil(L, 2))
 583     SetCanvasWindow(c, 0);
 584   else
 585     {
 586       struct win *w = check_window(L, 2);
 587       SetCanvasWindow(c, w);
 588     }
 589   return 0;
 590 }
 591
 592 static const luaL_reg canvas_methods[] = {
 593   {"select", canvas_select},
 594   {"showwin", canvas_showwin},
 595   {0, 0}
 596 };
 597
 598 static const luaL_reg canvas_metamethods[] = {
 599   {0, 0}
 600 };
 601
 602 static const struct Xet_reg canvas_setters[] = {
 603   {0, 0}
 604 };
 605
 606 static int
 607 canvas_get_window(lua_State *L)
 608 {
 609   struct canvas *c = check_canvas(L, 1);
 610   struct win *win = Layer2Window(c->c_layer);
 611   if (win)
 612     push_window(L, &win);
 613   else
 614     lua_pushnil(L);
 615   return 1;
 616 }
 617
 618 static const struct Xet_reg canvas_getters[] = {
 619   {"next", get_canvas, offsetof(struct canvas, c_next)},
 620   {"xoff", get_int, offsetof(struct canvas, c_xoff)},
 621   {"yoff", get_int, offsetof(struct canvas, c_yoff)},
 622   {"xs", get_int, offsetof(struct canvas, c_xs)},
 623   {"ys", get_int, offsetof(struct canvas, c_ys)},
 624   {"xe", get_int, offsetof(struct canvas, c_xe)},
 625   {"ye", get_int, offsetof(struct canvas, c_ye)},
 626   {"window", 0, 0, canvas_get_window},
 627   {0, 0}
 628 };
 629
 630 /** }}} */
 631
 632 /** Layout {{{ */
 633
 634 PUSH_TYPE(layout, struct layout)
 635 CHECK_TYPE(layout, struct layout)
 636
 637 static const struct Xet_reg layout_getters[] = {
 638       {0,0}
 639 };
 640
 641 static int
 642 get_layout(lua_State *L, void *v)
 643 {
 644   push_layout(L, (struct layout **)v);
 645   return 1;
 646 }
 647
 648 /** }}} */
 649
 650 /** Display {{{ */
 651
 652 PUSH_TYPE(display, struct display)
 653
 654 CHECK_TYPE(display, struct display)
 655
 656 static int
 657 display_get_canvases(lua_State *L)
 658 {
 659   struct display *d;
 660   struct canvas *iter;
 661   int count;
 662
 663   d = check_display(L, 1);
 664   lua_newtable(L);
 665   for (iter = d->d_cvlist, count = 0; iter; iter = iter->c_next, count++) {
 666     lua_pushinteger(L, count);
 667     push_canvas(L, &iter);
 668     lua_settable(L, -3);
 669   }
 670
 671   return 1;
 672 }
 673
 674 static const luaL_reg display_methods[] = {
 675   {"get_canvases", display_get_canvases},
 676   {0, 0}
 677 };
 678
 679 static int
 680 display_tostring(lua_State *L)
 681 {
 682   char str[128];
 683   struct display *d = check_display(L, 1);
 684   snprintf(str, sizeof(str), "{display: tty = '%s', term = '%s'}", d->d_usertty, d->d_termname);
 685   lua_pushstring(L, str);
 686   return 1;
 687 }
 688
 689 static const luaL_reg display_metamethods[] = {
 690   {"__tostring", display_tostring},
 691   {0, 0}
 692 };
 693
 694 static const struct Xet_reg display_setters[] = {
 695   {0, 0}
 696 };
 697
 698 static const struct Xet_reg display_getters[] = {
 699   {"tty", get_string, offsetof(struct display, d_usertty)},
 700   {"term", get_string, offsetof(struct display, d_termname)},
 701   {"fore", get_window, offsetof(struct display, d_fore)},
 702   {"other", get_window, offsetof(struct display, d_other)},
 703   {"width", get_int, offsetof(struct display, d_width)},
 704   {"height", get_int, offsetof(struct display, d_height)},
 705   {"user", get_user, offsetof(struct display, d_user)},
 706   {"layout", get_layout, offsetof(struct display, d_layout)},
 707   {0, 0}
 708 };
 709
 710 /** }}} */
 711
 712 /** Screen {{{ */
 713
 714 static int
 715 screen_get_windows(lua_State *L)
 716 {
 717   struct win *iter;
 718   int count;
 719
 720   lua_newtable(L);
 721   for (iter = windows, count = 0; iter; iter = iter->w_next, count++) {
 722     lua_pushinteger(L, iter->w_number);
 723     push_window(L, &iter);
 724     lua_settable(L, -3);
 725   }
 726
 727   return 1;
 728 }
 729
 730 static int
 731 screen_get_displays(lua_State *L)
 732 {
 733   struct display *iter;
 734   int count;
 735
 736   lua_newtable(L);
 737   for (iter = displays, count = 0; iter; iter = iter->d_next, count++) {
 738     lua_pushinteger(L, count);
 739     push_display(L, &iter);
 740     lua_settable(L, -3);
 741   }
 742
 743   return 1;
 744 }
 745
 746 static int
 747 screen_get_display(lua_State *L)
 748 {
 749   push_display(L, &display);
 750   return 1;
 751 }
 752
 753 static int
 754 screen_exec_command(lua_State *L)
 755 {
 756   const char *command;
 757   unsigned int len;
 758
 759   command = luaL_checklstring(L, 1, &len);
 760   if (command)
 761     RcLine((char *)command, len);
 762
 763   return 0;
 764 }
 765
 766 static int
 767 screen_append_msg(lua_State *L)
 768 {
 769   const char *msg, *color;
 770   unsigned int len;
 771   msg = luaL_checklstring(L, 1, &len);
 772   if (lua_isnil(L, 2))
 773     color = NULL;
 774   else
 775     color = luaL_checklstring(L, 2, &len);
 776   AppendWinMsgRend(msg, color);
 777   return 0;
 778 }
 779
 780 struct sinput_data
 781 {
 782   lua_State *L;
 783   lua_handler lh;
 784 };
 785
 786 void
 787 script_input_fn(char *buf, int len, char *priv)
 788 {
 789   struct sinput_data *sidata = (struct sinput_data *)priv;
 790   lua_handler lh = sidata->lh;
 791   lua_State *L = sidata->L;
 792
 793   LuaPushHandler(L, lh);
 794   lua_pushstring(L, buf);
 795   if (lua_pcall(L, 1, 0, 0) == LUA_ERRRUN)
 796     {
 797       if(lua_isstring(L, -1))
 798         {
 799           LuaShowErr(L);
 800         }
 801     }
 802   free(sidata);
 803   LuaFreeHandler(L, &lh);
 804 }
 805
 806 static int
 807 screen_input(lua_State *L)
 808 {
 809   char *ss;
 810   int n;
 811   const char * prompt = NULL, *prefill = NULL;
 812   lua_handler lh;
 813   struct sinput_data *sidata;
 814
 815   prompt = luaL_checkstring(L, 1);
 816   lh = LuaCheckHandler(L, 2, 1);
 817   if (!lh)
 818     luaL_error(L, "Out of Memory");
 819
 820   if (lua_gettop(L) >= 3)
 821     prefill = luaL_checkstring(L, 3);
 822
 823
 824   sidata = (struct sinput_data *)malloc(sizeof(struct sinput_data));
 825   if (!sidata)
 826     {
 827       Free(lh);
 828       luaL_error(L, "Out of Memory");
 829     }
 830
 831   sidata->L = L;
 832   sidata->lh = lh;
 833   Input((char *)prompt, 100, INP_COOKED, script_input_fn, (char *)sidata, 0);
 834
 835   if (!prefill)
 836     return 0;
 837   for (; *prefill; prefill++)
 838     {
 839       if ((*(unsigned char *)prefill & 0x7f) < 0x20 || *prefill == 0x7f)
 840         continue;
 841       ss = (char *)prefill;
 842       n = 1;
 843       LayProcess(&ss, &n);
 844     }
 845   return 0;
 846 }
 847
 848 static const luaL_reg screen_methods[] = {
 849   {"windows", screen_get_windows},
 850   {"displays", screen_get_displays},
 851   {"display", screen_get_display},
 852   {"command", screen_exec_command},
 853   {"append_msg", screen_append_msg},
 854   {"hook", LuaRegEvent},
 855   {"input", screen_input},
 856   {0, 0}
 857 };
 858
 859 static const luaL_reg screen_metamethods[] = {
 860   {0, 0}
 861 };
 862
 863 static const struct Xet_reg screen_setters[] = {
 864   {0, 0}
 865 };
 866
 867 static const struct Xet_reg screen_getters[] = {
 868   {0, 0}
 869 };
 870
 871 /** }}} */
 872
 873 /** Public functions {{{ */
 874
 875 /* FIXME: This code only tracks one unhook ticket for a lua func.
 876  * So it does not work if one func is registered more than one times. */
 877 static void
 878 prepare_weak_table(lua_State *L, const char *name, const char *mode)
 879 {
 880   luaL_getmetatable(L, "screen");
 881
 882   lua_pushstring(L, name);
 883   lua_newtable(L);
 884
 885   /* prepare a metatable to indicate weak table */
 886   lua_newtable(L);
 887   lua_pushstring(L, "__mode");
 888   lua_pushstring(L, mode);
 889   lua_rawset(L, -3);
 890   /* Mark weak table */
 891   lua_setmetatable(L, -2);
 892   lua_rawset(L, -3);
 893   lua_pop(L, 1);
 894 }
 895
 896 static lua_State *L;
 897 int LuaInit(void)
 898 {
 899   L = luaL_newstate();
 900
 901   luaL_openlibs(L);
 902
 903 #define REGISTER(X) struct_register(L, #X , X ## _methods, X##_metamethods, X##_setters, X##_getters)
 904
 905   REGISTER(screen);
 906   REGISTER(window);
 907   REGISTER(display);
 908   REGISTER(user);
 909   REGISTER(canvas);
 910   REGISTER(callback);
 911
 912   /* To store handler funcs */
 913
 914   /*_two kinds of information are mantained:
 915    *
 916    * funcreg[key]->func
 917    * The 'func' part of the tables are weak. That means the registered funcs
 918    * will be collected once the func is no longer available (e.g. overwritten
 919    * by a new instance of the script)
 920    *
 921    * To make this process happens faster, GC is forced at the end of each
 922    * source.
 923    * TODO: What if some events are triggered within the sourcing
 924    * procedure?
 925    * */
 926   prepare_weak_table(L, "_funcreg", "v");
 927
 928   /* funcunhook[func]->listener
 929    * The listener is the unhook ticket of the hook. which should be collected
 930    * once the func is collected. The gc metamethod will be triggered
 931    * accordingly. */
 932   prepare_weak_table(L, "_funcunhook", "k");
 933
 934   return 0;
 935 }
 936
 937 /* An error message on top of the stack. */
 938 static void
 939 LuaShowErr(lua_State *L)
 940 {
 941   struct display *d = display;
 942   unsigned int len;
 943   const char *message = luaL_checklstring(L, -1, &len);
 944   LMsg(0, "%s", message ? message : "Unknown error");
 945   lua_pop(L, 1);
 946   display = d;
 947 }
 948
 949 struct fn_def
 950 {
 951   void (*push_fn)(lua_State *, void*);
 952   void *value;
 953 };
 954
 955 static int
 956 LuaCallProcess(const char *name, struct fn_def defs[])
 957 {
 958   int argc = 0;
 959
 960   lua_getfield(L, LUA_GLOBALSINDEX, name);
 961   if (lua_isnil(L, -1))
 962     {
 963       lua_pop(L,1);
 964       return 0;
 965     }
 966   for (argc = 0; defs[argc].push_fn; argc++)
 967     defs[argc].push_fn(L, defs[argc].value);
 968   if (lua_pcall(L, argc, 0, 0) == LUA_ERRRUN && lua_isstring(L, -1))
 969     {
 970       LuaShowErr(L);
 971       return 0;
 972     }
 973   return 1;
 974 }
 975
 976 /* FIXME: Think about this: will it affect the registered handlers?*/
 977 int LuaSource(const char *file, int async)
 978 {
 979   if (!L)
 980     return 0;
 981   struct stat st;
 982   if (stat(file, &st) == -1)
 983     Msg(errno, "Error loading lua script file '%s'", file);
 984   else
 985     {
 986       int len = strlen(file);
 987       if (len < 4 || strncmp(file + len - 4, ".lua", 4) != 0)
 988         return 0;
 989       if (luaL_dofile(L, file) && lua_isstring(L, -1))
 990         {
 991           LuaShowErr(L);
 992           return 0;
 993         }
 994       else
 995         {
 996           /* It seems that I need two GC passes to really collect the unhook
 997            * ticket, after changing the reference to ticket in the
 998            * 'funcunhook' table from weak to strong. This should not be
 999            * harmful, but how can I make sure that two passes is enough?
1000            *
1001            * Possible reason:
1002            * This seems reasonable, since the first pass will collect the func
1003            * itself and make the ticket garbage, and the second pass will
1004            * collect the ticket itself.
1005            *
1006            * TODO: check this out. maybe ask some lua gurus. */
1007           lua_gc(L, LUA_GCCOLLECT, 0);
1008           lua_gc(L, LUA_GCCOLLECT, 0);
1009         }
1010       return 1;
1011     }
1012   return 0;
1013 }
1014
1015 int LuaFinit(void)
1016 {
1017   if (!L)
1018     return 0;
1019   lua_close(L);
1020   L = (lua_State*)0;
1021   return 0;
1022 }
1023
1024 int
1025 LuaProcessCaption(const char *caption, struct win *win, int len)
1026 {
1027   if (!L)
1028     return 0;
1029   struct fn_def params[] = {
1030     {lua_pushstring, caption},
1031     {push_window, &win},
1032     {lua_pushinteger, len},
1033     {NULL, NULL}
1034   };
1035   return LuaCallProcess("process_caption", params);
1036 }
1037
1038 static void
1039 push_stringarray(lua_State *L, char **args)
1040 {
1041   int i;
1042   lua_newtable(L);
1043   for (i = 1; args && *args; i++) {
1044     lua_pushinteger(L, i);
1045     lua_pushstring(L, *args++);
1046     lua_settable(L, -3);
1047   }
1048 }
1049
1050 int
1051 LuaPushParams(lua_State *L, const char *params, va_list va)
1052 {
1053   int num = 0;
1054   while (*params)
1055     {
1056       switch (*params)
1057         {
1058         case 's':
1059           lua_pushstring(L, va_arg(va, char *));
1060           break;
1061         case 'S':
1062           push_stringarray(L, va_arg(va, char **));
1063           break;
1064         case 'i':
1065           lua_pushinteger(L, va_arg(va, int));
1066           break;
1067         case 'd':
1068           {
1069             struct display *d = va_arg(va, struct display *);
1070             push_display(L, &d);
1071             break;
1072           }
1073         case 'w':
1074           {
1075             struct win *w = va_arg(va, struct win *);
1076             push_window(L, &w);
1077             break;
1078           }
1079         }
1080       params++;
1081       num++;
1082     }
1083   return num;
1084 }
1085
1086 int LuaCall(const char *func, const char **argv)
1087 {
1088   int argc;
1089   if (!L)
1090     return 0;
1091
1092   StackDump(L, "Before LuaCall\n");
1093   lua_getfield(L, LUA_GLOBALSINDEX, func);
1094   if (lua_isnil(L, -1))
1095     {
1096       lua_pop(L, 1);
1097       lua_pushstring(L, "Could not find the script function\n");
1098       LuaShowErr(L);
1099       return 0;
1100     }
1101   for (argc = 0; *argv; argv++, argc++)
1102     {
1103       lua_pushstring(L, *argv);
1104     }
1105   if (lua_pcall(L, argc, 0, 0) == LUA_ERRRUN)
1106     {
1107       if(lua_isstring(L, -1))
1108         {
1109           StackDump(L, "After LuaCall\n");
1110           LuaShowErr(L);
1111           return 0;
1112         }
1113     }
1114   return 1;
1115 }
1116
1117 /*** Lua callback handler management {{{ */
1118
1119 int
1120 LuaPushHTable(lua_State *L, int screen, const char * t)
1121 {
1122   lua_pushstring(L, t);
1123   lua_rawget(L, screen);
1124   /* FIXME: Do we need to balance the stack here? */
1125   if (lua_isnil(L, -1))
1126     luaL_error(L, "Fatal! Fail to get function registeration table!");
1127   return lua_gettop(L);
1128 }
1129
1130 void
1131 LuaPushHandler(lua_State *L, lua_handler lh)
1132 {
1133   int funcreg;
1134   if (lh->type == LUA_HANDLER_TYPE_F)
1135     {
1136       luaL_getmetatable(L, "screen");
1137       funcreg = LuaPushHTable(L, lua_gettop(L), "_funcreg");
1138       lua_rawgeti(L, funcreg, lh->u.reference);
1139       lua_replace(L, -3);
1140       lua_pop(L, 1);
1141     }
1142   else
1143     {
1144       lua_getfield(L, LUA_GLOBALSINDEX, lh->u.name);
1145     }
1146 }
1147
1148 int
1149 LuaFuncKey(lua_State *L, int idx, int ref)
1150 {
1151   int key, funcreg, sc;
1152   luaL_getmetatable(L, "screen");
1153   sc = lua_gettop(L);
1154   funcreg = LuaPushHTable(L, sc, "_funcreg");
1155
1156   lua_pushvalue(L, idx);
1157   key = luaL_ref(L, funcreg);
1158   lua_pop(L, 2);
1159   return key;
1160 }
1161
1162 void
1163 LuaHUnRef(lua_State *L, int key)
1164 {
1165   int funcreg, sc;
1166   luaL_getmetatable(L, "screen");
1167   sc = lua_gettop(L);
1168   funcreg = LuaPushHTable(L, sc, "_funcreg");
1169   luaL_unref(L, funcreg, key);
1170 }
1171
1172 lua_handler
1173 LuaCheckHandler(lua_State *L, int idx, int ref)
1174 {
1175   int key;
1176   if (idx < 0)
1177     idx = lua_gettop(L) + 1 - idx;
1178
1179   if (lua_isstring(L, idx))
1180     {
1181       const char * handler;
1182       /* registered with func name.*/
1183       handler = luaL_checkstring(L, idx);
1184       lua_getfield(L, LUA_GLOBALSINDEX, handler);
1185       if (!lua_isfunction(L, -1))
1186         luaL_error(L, "The specified handler %s in param #%d is not a function", handler, idx);
1187       lua_pop(L, 1);
1188       return LuaAllocHandler(handler, 0);
1189     }
1190   else if (!lua_isfunction(L, idx))
1191     luaL_error(L, "Handler should be a function or the name of function");
1192
1193   key = LuaFuncKey(L, idx, ref);
1194   return LuaAllocHandler(NULL, key);
1195 }
1196
1197 /* }}} **/
1198
1199 static int
1200 LuaDispatch(void *handler, const char *params, va_list va)
1201 {
1202   lua_handler lh = (lua_handler)handler;
1203   int argc, retvalue;
1204
1205   StackDump(L, "before dispatch");
1206
1207   LuaPushHandler(L, lh);
1208   if (lua_isnil(L, -1))
1209     {
1210       lua_pop(L, 1);
1211       return 0;
1212     }
1213   argc = LuaPushParams(L, params, va);
1214
1215   if (lua_pcall(L, argc, 1, 0) == LUA_ERRRUN && lua_isstring(L, -1))
1216     {
1217       StackDump(L, "After LuaDispatch\n");
1218       LuaShowErr(L);
1219       return 0;
1220     }
1221   retvalue = lua_tonumber(L, -1);
1222   lua_pop(L, 1);
1223   return retvalue;
1224 }
1225
1226 /*FIXME: what if a func is registered twice or more? */
1227 void
1228 LuaRegAutoUnHook(lua_State *L, lua_handler lh, int ticket)
1229 {
1230   int sc, funcunhook;
1231   luaL_getmetatable(L, "screen");
1232   sc = lua_gettop(L);
1233   funcunhook = LuaPushHTable(L, sc, "_funcunhook");
1234   LuaPushHandler(L, lh);
1235   lua_pushvalue(L, ticket);
1236   lua_rawset(L, funcunhook);
1237   lua_pop(L, 2);
1238 }
1239
1240 #define SEVNAME_MAX 30
1241 static int
1242 LuaRegEvent(lua_State *L)
1243 {
1244   /* signature: hook(obj, event, handler, priv);
1245    *        or: hook(event, handler, priv)
1246    *   returns: A ticket for later unregister. */
1247   int idx = 1, argc = lua_gettop(L);
1248   unsigned int priv = 31; /* Default privilege */
1249   lua_handler lh;
1250
1251   char *obj = NULL;
1252   const char *objname = "global";
1253
1254   static char evbuf[SEVNAME_MAX];
1255   const char *event;
1256
1257   struct script_event *sev;
1258
1259   StackDump(L, "Before RegEvent\n");
1260
1261   /* Identify the object, if specified */
1262   if (luaL_getmetafield(L, 1, "_objname"))
1263     {
1264       objname = luaL_checkstring(L, -1);
1265       lua_pop(L, 1);
1266       if (!strcmp("screen", objname))
1267         objname = "global";
1268       else
1269         obj = *(char **)lua_touserdata(L, 1);
1270       idx++;
1271     }
1272
1273   event = luaL_checkstring(L, idx++);
1274   snprintf(evbuf, SEVNAME_MAX, "%s_%s", objname, event);
1275
1276   /* Check and get the handler */
1277   lh = LuaCheckHandler(L, idx++, 1);
1278   if (!lh)
1279     luaL_error(L, "Out of memory");
1280
1281   StackDump(L, "In RegEvent\n");
1282
1283   if (idx <= argc)
1284     priv = luaL_checkinteger(L, idx);
1285
1286   sev = object_get_event(obj, evbuf);
1287   if (sev)
1288     {
1289       struct listener *l;
1290       int ticket;
1291       l = (struct listener *)malloc(sizeof(struct listener));
1292       if (!l)
1293         return luaL_error(L, "Out of memory");
1294       l->priv = priv;
1295       l->bd = &lua_binding;
1296       l->handler = (void *)lh;
1297       register_listener(sev, l);
1298       /* Return the ticket for un-register */
1299       push_callback(L, &l);
1300       ticket = lua_gettop(L);
1301
1302       LuaRegAutoUnHook(L, lh, ticket);
1303     }
1304   else
1305     return luaL_error(L, "Invalid event specified: %s for object %s", event, objname);
1306
1307   StackDump(L, "After RegEvent\n");
1308   return 1;
1309 }
1310
1311 /** }}} */
1312
1313 struct ScriptFuncs LuaFuncs =
1314 {
1315   LuaProcessCaption
1316 };
1317
1318 struct binding lua_binding =
1319 {
1320     "lua", /*name*/
1321     0,     /*inited*/
1322     0,     /*registered*/
1323     LuaInit,
1324     LuaFinit,
1325     LuaCall,
1326     LuaSource,
1327     LuaDispatch,
1328     0,     /*b_next*/
1329     &LuaFuncs
1330 };
1331