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 static int get_display(lua_State *L, void *v);
 553 /** Canvas {{{ */
 554
 555 PUSH_TYPE(canvas, struct canvas)
 556
 557 CHECK_TYPE(canvas, struct canvas)
 558
 559 static int
 560 get_canvas(lua_State *L, void *v)
 561 {
 562   push_canvas(L, (struct canvas **)v);
 563   return 1;
 564 }
 565
 566 static int
 567 canvas_select(lua_State *L)
 568 {
 569   struct canvas *c = check_canvas(L, 1);
 570   if (!display || D_forecv == c)
 571     return 0;
 572   /* FIXME: why do we need this? */
 573   SetCanvasWindow(c, Layer2Window(c->c_layer));
 574
 575   FocusCanvas(c);
 576   return 0;
 577 }
 578
 579 static int
 580 canvas_split(lua_State *L)
 581 {
 582   struct canvas *c = check_canvas(L, 1);
 583   int hori = lua_toboolean(L, 2);
 584   if (hori)
 585     AddCanvas(SLICE_HORI);
 586   else
 587     AddCanvas(SLICE_VERT);
 588   Activate(-1);
 589   return 0;
 590 }
 591
 592 static int
 593 canvas_showwin(lua_State *L)
 594 {
 595   struct canvas *c = check_canvas(L, 1);
 596   if (lua_isnil(L, 2))
 597     SetCanvasWindow(c, 0);
 598   else
 599     {
 600       struct win *w = check_window(L, 2);
 601       SetCanvasWindow(c, w);
 602     }
 603   return 0;
 604 }
 605
 606 static const luaL_reg canvas_methods[] = {
 607   {"select", canvas_select},
 608   {"split", canvas_split},
 609   {"showwin", canvas_showwin},
 610   {0, 0}
 611 };
 612
 613 static const luaL_reg canvas_metamethods[] = {
 614   {0, 0}
 615 };
 616
 617 extern struct mchar mchar_so;
 618 static int
 619 canvas_update_caption(lua_State *L)
 620 {
 621   struct canvas *cv = check_canvas(L, 1);
 622   unsigned int len;
 623   const char *caption = luaL_checklstring(L, 3, &len);
 624   int l, padlen;
 625   padlen = cv->c_xe - cv->c_xs +
 626     (display ? (cv->c_xe + 1 < D_width || D_CLP): 0);
 627   struct win *w = Layer2Window(cv->c_layer);
 628   char * buf = MakeWinMsgEv((char *)caption, w, '%', padlen, &cv->c_captev, 0);
 629   if (cv->c_captev.timeout.tv_sec)
 630     evenq(&cv->c_captev);
 631   l = strlen(buf);
 632
 633   GotoPos(cv->c_xs, cv->c_ye+1);
 634   /*XXX:what does this mean?*/
 635   SetRendition(&mchar_so);
 636   if (l > cv->c_xe - cv->c_xs + 1)
 637     l = cv->c_xe - cv->c_xs + 1;
 638   PutWinMsg(buf, cv->c_xs, l);
 639
 640   return 0;
 641 }
 642
 643 static const struct Xet_reg canvas_setters[] = {
 644   {"caption", 0, 0, canvas_update_caption/*absolute setter*/},
 645   {0, 0}
 646 };
 647
 648 static int
 649 canvas_get_window(lua_State *L)
 650 {
 651   struct canvas *c = check_canvas(L, 1);
 652   struct win *win = Layer2Window(c->c_layer);
 653   if (win)
 654     push_window(L, &win);
 655   else
 656     lua_pushnil(L);
 657   return 1;
 658 }
 659
 660 static const struct Xet_reg canvas_getters[] = {
 661   {"next", get_canvas, offsetof(struct canvas, c_next)},
 662   {"xoff", get_int, offsetof(struct canvas, c_xoff)},
 663   {"yoff", get_int, offsetof(struct canvas, c_yoff)},
 664   {"xs", get_int, offsetof(struct canvas, c_xs)},
 665   {"ys", get_int, offsetof(struct canvas, c_ys)},
 666   {"xe", get_int, offsetof(struct canvas, c_xe)},
 667   {"ye", get_int, offsetof(struct canvas, c_ye)},
 668   {"window", 0, 0, canvas_get_window},
 669   {"display", get_display, offsetof(struct canvas, c_display)},
 670   {0, 0}
 671 };
 672
 673 /** }}} */
 674
 675 /** Layout {{{ */
 676
 677 PUSH_TYPE(layout, struct layout)
 678 CHECK_TYPE(layout, struct layout)
 679
 680 static const struct Xet_reg layout_getters[] = {
 681   {"title", get_string, offsetof(struct layout, lay_title)},
 682   {"number", get_string, offsetof(struct layout, lay_title)},
 683   {"autosave", get_string, offsetof(struct layout, lay_autosave)},
 684   {0,0}
 685 };
 686
 687 int
 688 layout_change_title(lua_State *L)
 689 {
 690   struct layout *lay = check_layout(L, 1);
 691   unsigned int len;
 692   const char *title = luaL_checklstring(L, 3, &len);
 693   free(lay->lay_title);
 694   lay->lay_title= SaveStr(title);
 695   return 0;
 696 }
 697
 698 void LayoutChangeNumber(struct layout *lay, int newnum);
 699
 700 int
 701 layout_change_number(lua_State *L)
 702 {
 703   struct layout *lay = check_layout(L, 1);
 704   int newnum = luaL_checkint(L, 3);
 705   LayoutChangeNumber(lay, newnum);
 706   return 0;
 707 }
 708
 709 static const struct Xet_reg layout_setters[] = {
 710   {"title", 0, 0, layout_change_title/*absolute setter*/},
 711   {"number", 0, 0, layout_change_number/*absolute setter*/},
 712   {"autosave", get_string, offsetof(struct layout, lay_autosave)},
 713   {0, 0}
 714 };
 715
 716 int
 717 layout_select(lua_State *L)
 718 {
 719   struct layout *lay = check_layout(L, 1);
 720   if (!display) return;
 721   LoadLayout(lay, &D_canvas);
 722   Activate(0);
 723   return 0;
 724 }
 725
 726 static const luaL_reg layout_methods[] = {
 727   {"select", layout_select},
 728   {0, 0}
 729 };
 730
 731 static int
 732 get_layout(lua_State *L, void *v)
 733 {
 734   push_layout(L, (struct layout **)v);
 735   return 1;
 736 }
 737
 738 /** }}} */
 739
 740 /** Display {{{ */
 741
 742 PUSH_TYPE(display, struct display)
 743
 744 CHECK_TYPE(display, struct display)
 745
 746 static int
 747 get_display(lua_State *L, void *v)
 748 {
 749   push_display(L, (struct display **)v);
 750   return 1;
 751 }
 752
 753 static int
 754 display_get_canvases(lua_State *L)
 755 {
 756   struct display *d;
 757   struct canvas *iter;
 758   int count;
 759
 760   d = check_display(L, 1);
 761   lua_newtable(L);
 762   for (iter = d->d_cvlist, count = 0; iter; iter = iter->c_next, count++) {
 763     lua_pushinteger(L, count);
 764     push_canvas(L, &iter);
 765     lua_settable(L, -3);
 766   }
 767
 768   return 1;
 769 }
 770
 771 static const luaL_reg display_methods[] = {
 772   {"get_canvases", display_get_canvases},
 773   {0, 0}
 774 };
 775
 776 static int
 777 display_tostring(lua_State *L)
 778 {
 779   char str[128];
 780   struct display *d = check_display(L, 1);
 781   snprintf(str, sizeof(str), "{display: tty = '%s', term = '%s'}", d->d_usertty, d->d_termname);
 782   lua_pushstring(L, str);
 783   return 1;
 784 }
 785
 786 static const luaL_reg display_metamethods[] = {
 787   {"__tostring", display_tostring},
 788   {0, 0}
 789 };
 790
 791 static const struct Xet_reg display_setters[] = {
 792   {0, 0}
 793 };
 794
 795 static const struct Xet_reg display_getters[] = {
 796   {"tty", get_string, offsetof(struct display, d_usertty)},
 797   {"term", get_string, offsetof(struct display, d_termname)},
 798   {"fore", get_window, offsetof(struct display, d_fore)},
 799   {"other", get_window, offsetof(struct display, d_other)},
 800   {"width", get_int, offsetof(struct display, d_width)},
 801   {"height", get_int, offsetof(struct display, d_height)},
 802   {"user", get_user, offsetof(struct display, d_user)},
 803   {"layout", get_layout, offsetof(struct display, d_layout)},
 804   {0, 0}
 805 };
 806
 807 /** }}} */
 808
 809 /** Screen {{{ */
 810
 811 static int
 812 screen_get_windows(lua_State *L)
 813 {
 814   struct win *iter;
 815   int count;
 816
 817   lua_newtable(L);
 818   for (iter = windows, count = 0; iter; iter = iter->w_next, count++) {
 819     lua_pushinteger(L, iter->w_number);
 820     push_window(L, &iter);
 821     lua_settable(L, -3);
 822   }
 823
 824   return 1;
 825 }
 826
 827 static int
 828 screen_get_displays(lua_State *L)
 829 {
 830   struct display *iter;
 831   int count;
 832
 833   lua_newtable(L);
 834   for (iter = displays, count = 0; iter; iter = iter->d_next, count++) {
 835     lua_pushinteger(L, count);
 836     push_display(L, &iter);
 837     lua_settable(L, -3);
 838   }
 839
 840   return 1;
 841 }
 842
 843 extern struct layout *layouts;
 844 static int
 845 screen_get_layouts(lua_State *L)
 846 {
 847   struct layout *iter;
 848   int count;
 849
 850   lua_newtable(L);
 851   for (iter = layouts, count = 0; iter; iter = iter->lay_next, count++) {
 852     lua_pushinteger(L, iter->lay_number);
 853     push_layout(L, &iter);
 854     lua_settable(L, -3);
 855   }
 856
 857   return 1;
 858 }
 859
 860 static int
 861 screen_get_display(lua_State *L)
 862 {
 863   push_display(L, &display);
 864   return 1;
 865 }
 866
 867 static int
 868 screen_exec_command(lua_State *L)
 869 {
 870   const char *command;
 871   unsigned int len;
 872
 873   command = luaL_checklstring(L, 1, &len);
 874   if (command)
 875     RcLine((char *)command, len);
 876
 877   return 0;
 878 }
 879
 880 static int
 881 screen_append_msg(lua_State *L)
 882 {
 883   const char *msg, *color;
 884   unsigned int len;
 885   msg = luaL_checklstring(L, 1, &len);
 886   if (lua_isnil(L, 2))
 887     color = NULL;
 888   else
 889     color = luaL_checklstring(L, 2, &len);
 890   AppendWinMsgRend(msg, color);
 891   return 0;
 892 }
 893
 894 struct sinput_data
 895 {
 896   lua_State *L;
 897   lua_handler lh;
 898 };
 899
 900 void
 901 script_input_fn(char *buf, int len, char *priv)
 902 {
 903   struct sinput_data *sidata = (struct sinput_data *)priv;
 904   lua_handler lh = sidata->lh;
 905   lua_State *L = sidata->L;
 906
 907   LuaPushHandler(L, lh);
 908   lua_pushstring(L, buf);
 909   if (lua_pcall(L, 1, 0, 0) == LUA_ERRRUN)
 910     {
 911       if(lua_isstring(L, -1))
 912         {
 913           LuaShowErr(L);
 914         }
 915     }
 916   free(sidata);
 917   LuaFreeHandler(L, &lh);
 918 }
 919
 920 static int
 921 screen_input(lua_State *L)
 922 {
 923   char *ss;
 924   int n;
 925   const char * prompt = NULL, *prefill = NULL;
 926   lua_handler lh;
 927   struct sinput_data *sidata;
 928
 929   prompt = luaL_checkstring(L, 1);
 930   lh = LuaCheckHandler(L, 2, 1);
 931   if (!lh)
 932     luaL_error(L, "Out of Memory");
 933
 934   if (lua_gettop(L) >= 3)
 935     prefill = luaL_checkstring(L, 3);
 936
 937
 938   sidata = (struct sinput_data *)malloc(sizeof(struct sinput_data));
 939   if (!sidata)
 940     {
 941       LuaFreeHandler(L, &lh);
 942       luaL_error(L, "Out of Memory");
 943     }
 944
 945   sidata->L = L;
 946   sidata->lh = lh;
 947   Input((char *)prompt, 100, INP_COOKED, script_input_fn, (char *)sidata, 0);
 948
 949   if (!prefill)
 950     return 0;
 951   for (; *prefill; prefill++)
 952     {
 953       if ((*(unsigned char *)prefill & 0x7f) < 0x20 || *prefill == 0x7f)
 954         continue;
 955       ss = (char *)prefill;
 956       n = 1;
 957       LayProcess(&ss, &n);
 958     }
 959   return 0;
 960 }
 961
 962 static void
 963 sev_schedule_fn(struct event *ev, char *data)
 964 {
 965   struct sinput_data *si = (struct sinput_data *)data;
 966   lua_handler lh = si->lh;
 967   lua_State *L = si->L;
 968   free(si);
 969   evdeq(ev);
 970   Free(ev);
 971
 972   LuaPushHandler(L, lh);
 973   if (lua_pcall(L, 1, 0, 0) == LUA_ERRRUN)
 974     {
 975       if(lua_isstring(L, -1))
 976         {
 977           LuaShowErr(L);
 978         }
 979     }
 980   LuaFreeHandler(L, &lh);
 981 }
 982
 983 static int
 984 screen_schedule(lua_State *L)
 985 {
 986   int timeout = luaL_checkinteger(L, 1);
 987   lua_handler lh = LuaCheckHandler(L, 2, 1);
 988   struct sinput_data *si;
 989   struct event *ev;
 990   if (timeout <= 0)
 991     return 0;
 992
 993   ev = (struct event *) calloc(1, sizeof(struct event));
 994   if (!ev)
 995     {
 996       LuaFreeHandler(L, &lh);
 997       luaL_error(L, "Out of Memory");
 998     }
 999   si = (struct sinput_data *) malloc(sizeof(struct sinput_data));
1000   if (!si)
1001     {
1002       LuaFreeHandler(L, &lh);
1003       Free(ev);
1004       luaL_error(L, "Out of Memory");
1005     }
1006   si->lh = lh;
1007   si->L = L;
1008
1009   ev->type = EV_TIMEOUT;
1010   ev->data = (char *)si;
1011   ev->handler = sev_schedule_fn;
1012   evenq(ev);
1013   SetTimeout(ev, timeout * 1000);
1014   return 0;
1015 }
1016
1017 static const luaL_reg screen_methods[] = {
1018   {"windows", screen_get_windows},
1019   {"displays", screen_get_displays},
1020   {"layouts", screen_get_layouts},
1021   {"display", screen_get_display},
1022   {"command", screen_exec_command},
1023   {"append_msg", screen_append_msg},
1024   {"hook", LuaRegEvent},
1025   {"input", screen_input},
1026   {"schedule", screen_schedule},
1027   {0, 0}
1028 };
1029
1030 static const luaL_reg screen_metamethods[] = {
1031   {0, 0}
1032 };
1033
1034 static const struct Xet_reg screen_setters[] = {
1035   {0, 0}
1036 };
1037
1038 static const struct Xet_reg screen_getters[] = {
1039   {0, 0}
1040 };
1041
1042 /** }}} */
1043
1044 /** Public functions {{{ */
1045
1046 /* FIXME: This code only tracks one unhook ticket for a lua func.
1047  * So it does not work if one func is registered more than one times. */
1048 static void
1049 prepare_weak_table(lua_State *L, const char *name, const char *mode)
1050 {
1051   luaL_getmetatable(L, "screen");
1052
1053   lua_pushstring(L, name);
1054   lua_newtable(L);
1055
1056   /* prepare a metatable to indicate weak table */
1057   lua_newtable(L);
1058   lua_pushstring(L, "__mode");
1059   lua_pushstring(L, mode);
1060   lua_rawset(L, -3);
1061   /* Mark weak table */
1062   lua_setmetatable(L, -2);
1063   lua_rawset(L, -3);
1064   lua_pop(L, 1);
1065 }
1066
1067 static lua_State *L;
1068 int LuaInit(void)
1069 {
1070   L = luaL_newstate();
1071
1072   luaL_openlibs(L);
1073
1074 #define REGISTER(X) struct_register(L, #X , X ## _methods, X##_metamethods, X##_setters, X##_getters)
1075
1076   REGISTER(screen);
1077   REGISTER(window);
1078   REGISTER(display);
1079   REGISTER(user);
1080   REGISTER(canvas);
1081   REGISTER(callback);
1082
1083   /* To store handler funcs */
1084
1085   /*_two kinds of information are mantained:
1086    *
1087    * funcreg[key]->func
1088    * The 'func' part of the tables are weak. That means the registered funcs
1089    * will be collected once the func is no longer available (e.g. overwritten
1090    * by a new instance of the script)
1091    *
1092    * To make this process happens faster, GC is forced at the end of each
1093    * source.
1094    * TODO: What if some events are triggered within the sourcing
1095    * procedure?
1096    * */
1097   prepare_weak_table(L, "_funcreg", "v");
1098
1099   /* funcunhook[func]->listener
1100    * The listener is the unhook ticket of the hook. which should be collected
1101    * once the func is collected. The gc metamethod will be triggered
1102    * accordingly. */
1103   prepare_weak_table(L, "_funcunhook", "k");
1104
1105   return 0;
1106 }
1107
1108 /* An error message on top of the stack. */
1109 static void
1110 LuaShowErr(lua_State *L)
1111 {
1112   struct display *d = display;
1113   unsigned int len;
1114   const char *message = luaL_checklstring(L, -1, &len);
1115   LMsg(0, "%s", message ? message : "Unknown error");
1116   lua_pop(L, 1);
1117   display = d;
1118 }
1119
1120 struct fn_def
1121 {
1122   void (*push_fn)(lua_State *, void*);
1123   void *value;
1124 };
1125
1126 static int
1127 LuaCallProcess(const char *name, struct fn_def defs[])
1128 {
1129   int argc = 0;
1130
1131   lua_getfield(L, LUA_GLOBALSINDEX, name);
1132   if (lua_isnil(L, -1))
1133     {
1134       lua_pop(L,1);
1135       return 0;
1136     }
1137   for (argc = 0; defs[argc].push_fn; argc++)
1138     defs[argc].push_fn(L, defs[argc].value);
1139   if (lua_pcall(L, argc, 0, 0) == LUA_ERRRUN && lua_isstring(L, -1))
1140     {
1141       LuaShowErr(L);
1142       return 0;
1143     }
1144   return 1;
1145 }
1146
1147 /* FIXME: Think about this: will it affect the registered handlers?*/
1148 int LuaSource(const char *file, int async)
1149 {
1150   if (!L)
1151     return 0;
1152   struct stat st;
1153   if (stat(file, &st) == -1)
1154     Msg(errno, "Error loading lua script file '%s'", file);
1155   else
1156     {
1157       int len = strlen(file);
1158       if (len < 4 || strncmp(file + len - 4, ".lua", 4) != 0)
1159         return 0;
1160       if (luaL_dofile(L, file) && lua_isstring(L, -1))
1161         {
1162           LuaShowErr(L);
1163           return 0;
1164         }
1165       else
1166         {
1167           /* It seems that I need two GC passes to really collect the unhook
1168            * ticket, after changing the reference to ticket in the
1169            * 'funcunhook' table from weak to strong. This should not be
1170            * harmful, but how can I make sure that two passes is enough?
1171            *
1172            * Possible reason:
1173            * This seems reasonable, since the first pass will collect the func
1174            * itself and make the ticket garbage, and the second pass will
1175            * collect the ticket itself.
1176            *
1177            * TODO: check this out. maybe ask some lua gurus. */
1178           lua_gc(L, LUA_GCCOLLECT, 0);
1179           lua_gc(L, LUA_GCCOLLECT, 0);
1180         }
1181       return 1;
1182     }
1183   return 0;
1184 }
1185
1186 int LuaFinit(void)
1187 {
1188   if (!L)
1189     return 0;
1190   lua_close(L);
1191   L = (lua_State*)0;
1192   return 0;
1193 }
1194
1195 static void
1196 push_stringarray(lua_State *L, char **args)
1197 {
1198   int i;
1199   lua_newtable(L);
1200   for (i = 1; args && *args; i++) {
1201     lua_pushinteger(L, i);
1202     lua_pushstring(L, *args++);
1203     lua_settable(L, -3);
1204   }
1205 }
1206
1207 int
1208 LuaPushParams(lua_State *L, const char *params, va_list va)
1209 {
1210   int num = 0;
1211   while (*params)
1212     {
1213       switch (*params)
1214         {
1215         case 's':
1216           lua_pushstring(L, va_arg(va, char *));
1217           break;
1218         case 'S':
1219           push_stringarray(L, va_arg(va, char **));
1220           break;
1221         case 'i':
1222           lua_pushinteger(L, va_arg(va, int));
1223           break;
1224         case 'd':
1225           {
1226             struct display *d = va_arg(va, struct display *);
1227             push_display(L, &d);
1228             break;
1229           }
1230         case 'w':
1231           {
1232             struct win *w = va_arg(va, struct win *);
1233             push_window(L, &w);
1234             break;
1235           }
1236         case 'c':
1237           {
1238             struct canvas *c = va_arg(va, struct canvas *);
1239             push_canvas(L, &c);
1240             break;
1241           }
1242         }
1243       params++;
1244       num++;
1245     }
1246   return num;
1247 }
1248
1249 int LuaCall(const char *func, const char **argv)
1250 {
1251   int argc;
1252   if (!L)
1253     return 0;
1254
1255   StackDump(L, "Before LuaCall\n");
1256   lua_getfield(L, LUA_GLOBALSINDEX, func);
1257   if (lua_isnil(L, -1))
1258     {
1259       lua_pop(L, 1);
1260       lua_pushstring(L, "Could not find the script function\n");
1261       LuaShowErr(L);
1262       return 0;
1263     }
1264   for (argc = 0; *argv; argv++, argc++)
1265     {
1266       lua_pushstring(L, *argv);
1267     }
1268   if (lua_pcall(L, argc, 0, 0) == LUA_ERRRUN)
1269     {
1270       if(lua_isstring(L, -1))
1271         {
1272           StackDump(L, "After LuaCall\n");
1273           LuaShowErr(L);
1274           return 0;
1275         }
1276     }
1277   return 1;
1278 }
1279
1280 /*** Lua callback handler management {{{ */
1281
1282 int
1283 LuaPushHTable(lua_State *L, int screen, const char * t)
1284 {
1285   lua_pushstring(L, t);
1286   lua_rawget(L, screen);
1287   /* FIXME: Do we need to balance the stack here? */
1288   if (lua_isnil(L, -1))
1289     luaL_error(L, "Fatal! Fail to get function registeration table!");
1290   return lua_gettop(L);
1291 }
1292
1293 void
1294 LuaPushHandler(lua_State *L, lua_handler lh)
1295 {
1296   int funcreg;
1297   if (lh->type == LUA_HANDLER_TYPE_F)
1298     {
1299       luaL_getmetatable(L, "screen");
1300       funcreg = LuaPushHTable(L, lua_gettop(L), "_funcreg");
1301       lua_rawgeti(L, funcreg, lh->u.reference);
1302       lua_replace(L, -3);
1303       lua_pop(L, 1);
1304     }
1305   else
1306     {
1307       lua_getfield(L, LUA_GLOBALSINDEX, lh->u.name);
1308     }
1309 }
1310
1311 int
1312 LuaFuncKey(lua_State *L, int idx, int ref)
1313 {
1314   int key, funcreg, sc;
1315   luaL_getmetatable(L, "screen");
1316   sc = lua_gettop(L);
1317   funcreg = LuaPushHTable(L, sc, "_funcreg");
1318
1319   lua_pushvalue(L, idx);
1320   key = luaL_ref(L, funcreg);
1321   lua_pop(L, 2);
1322   return key;
1323 }
1324
1325 void
1326 LuaHUnRef(lua_State *L, int key)
1327 {
1328   int funcreg, sc;
1329   luaL_getmetatable(L, "screen");
1330   sc = lua_gettop(L);
1331   funcreg = LuaPushHTable(L, sc, "_funcreg");
1332   luaL_unref(L, funcreg, key);
1333 }
1334
1335 lua_handler
1336 LuaCheckHandler(lua_State *L, int idx, int ref)
1337 {
1338   int key;
1339   if (idx < 0)
1340     idx = lua_gettop(L) + 1 - idx;
1341
1342   if (lua_isstring(L, idx))
1343     {
1344       const char * handler;
1345       /* registered with func name.*/
1346       handler = luaL_checkstring(L, idx);
1347       lua_getfield(L, LUA_GLOBALSINDEX, handler);
1348       if (!lua_isfunction(L, -1))
1349         luaL_error(L, "The specified handler %s in param #%d is not a function", handler, idx);
1350       lua_pop(L, 1);
1351       return LuaAllocHandler(handler, 0);
1352     }
1353   else if (!lua_isfunction(L, idx))
1354     luaL_error(L, "Handler should be a function or the name of function");
1355
1356   key = LuaFuncKey(L, idx, ref);
1357   return LuaAllocHandler(NULL, key);
1358 }
1359
1360 /* }}} **/
1361
1362 static int
1363 LuaDispatch(void *handler, const char *params, va_list va)
1364 {
1365   lua_handler lh = (lua_handler)handler;
1366   int argc, retvalue;
1367
1368   StackDump(L, "before dispatch");
1369
1370   LuaPushHandler(L, lh);
1371   if (lua_isnil(L, -1))
1372     {
1373       lua_pop(L, 1);
1374       return 0;
1375     }
1376   argc = LuaPushParams(L, params, va);
1377
1378   if (lua_pcall(L, argc, 1, 0) == LUA_ERRRUN && lua_isstring(L, -1))
1379     {
1380       StackDump(L, "After LuaDispatch\n");
1381       LuaShowErr(L);
1382       return 0;
1383     }
1384   retvalue = lua_tonumber(L, -1);
1385   lua_pop(L, 1);
1386   return retvalue;
1387 }
1388
1389 /*FIXME: what if a func is registered twice or more? */
1390 void
1391 LuaRegAutoUnHook(lua_State *L, lua_handler lh, int ticket)
1392 {
1393   int sc, funcunhook;
1394   luaL_getmetatable(L, "screen");
1395   sc = lua_gettop(L);
1396   funcunhook = LuaPushHTable(L, sc, "_funcunhook");
1397   LuaPushHandler(L, lh);
1398   lua_pushvalue(L, ticket);
1399   lua_rawset(L, funcunhook);
1400   lua_pop(L, 2);
1401 }
1402
1403 #define SEVNAME_MAX 30
1404 static int
1405 LuaRegEvent(lua_State *L)
1406 {
1407   /* signature: hook(obj, event, handler, priv);
1408    *        or: hook(event, handler, priv)
1409    *   returns: A ticket for later unregister. */
1410   int idx = 1, argc = lua_gettop(L);
1411   unsigned int priv = 31; /* Default privilege */
1412   lua_handler lh;
1413
1414   char *obj = NULL;
1415   const char *objname = "global";
1416
1417   static char evbuf[SEVNAME_MAX];
1418   const char *event;
1419
1420   struct script_event *sev;
1421
1422   StackDump(L, "Before RegEvent\n");
1423
1424   /* Identify the object, if specified */
1425   if (luaL_getmetafield(L, 1, "_objname"))
1426     {
1427       objname = luaL_checkstring(L, -1);
1428       lua_pop(L, 1);
1429       if (!strcmp("screen", objname))
1430         objname = "global";
1431       else
1432         obj = *(char **)lua_touserdata(L, 1);
1433       idx++;
1434     }
1435
1436   event = luaL_checkstring(L, idx++);
1437   snprintf(evbuf, SEVNAME_MAX, "%s_%s", objname, event);
1438
1439   /* Check and get the handler */
1440   lh = LuaCheckHandler(L, idx++, 1);
1441   if (!lh)
1442     luaL_error(L, "Out of memory");
1443
1444   StackDump(L, "In RegEvent\n");
1445
1446   if (idx <= argc)
1447     priv = luaL_checkinteger(L, idx);
1448
1449   sev = object_get_event(obj, evbuf);
1450   if (sev)
1451     {
1452       struct listener *l;
1453       int ticket;
1454       l = (struct listener *)malloc(sizeof(struct listener));
1455       if (!l)
1456         return luaL_error(L, "Out of memory");
1457       l->priv = priv;
1458       l->bd = &lua_binding;
1459       l->handler = (void *)lh;
1460       register_listener(sev, l);
1461       /* Return the ticket for un-register */
1462       push_callback(L, &l);
1463       ticket = lua_gettop(L);
1464
1465       LuaRegAutoUnHook(L, lh, ticket);
1466     }
1467   else
1468     return luaL_error(L, "Invalid event specified: %s for object %s", event, objname);
1469
1470   StackDump(L, "After RegEvent\n");
1471   return 1;
1472 }
1473
1474 /** }}} */
1475
1476 struct binding lua_binding =
1477 {
1478     "lua", /*name*/
1479     0,     /*inited*/
1480     0,     /*registered*/
1481     LuaInit,
1482     LuaFinit,
1483     LuaCall,
1484     LuaSource,
1485     LuaDispatch,
1486     0,     /*b_next*/
1487 };
1488