src/lua.c

   1 /* Lua scripting support
   2  *
   3  * Copyright (c) 2008 Sadrul Habib Chowdhury (sadrul@users.sf.net)
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program (see the file COPYING); if not, write to the
  17  * Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  19  *
  20  ****************************************************************
  21  */
  22 #include <sys/types.h>
  23 #include "config.h"
  24 #include "screen.h"
  25 #include <sys/stat.h>
  26 #include <unistd.h>
  27
  28 #include <stdio.h>
  29 #include <string.h>
  30 #include <stdlib.h>
  31
  32 #include "extern.h"
  33 #include "logfile.h"
  34
  35 #include <lua.h>
  36 #include <lauxlib.h>
  37 #include <lualib.h>
  38
  39 extern struct win *windows, *fore;
  40 extern struct display *displays, *display;
  41 extern struct LayFuncs WinLf;
  42 extern struct layer *flayer;
  43
  44 /** Template {{{ */
  45
  46 #define CHECK_TYPE(name, type) \
  47 static type * \
  48 check_##name(lua_State *L, int index) \
  49 { \
  50   type **var; \
  51   luaL_checktype(L, index, LUA_TUSERDATA); \
  52   var = (type **) luaL_checkudata(L, index, #name); \
  53   if (!var || !*var) \
  54     luaL_typerror(L, index, #name); \
  55   return *var; \
  56 }
  57
  58 #define PUSH_TYPE(name, type) \
  59 static void \
  60 push_##name(lua_State *L, type **t) \
  61 { \
  62   if (!t || !*t) \
  63     lua_pushnil(L); \
  64   else \
  65     { \
  66       type **r; \
  67       r = (type **)lua_newuserdata(L, sizeof(type *)); \
  68       *r = *t; \
  69       luaL_getmetatable(L, #name); \
  70       lua_setmetatable(L,-2); \
  71     } \
  72 }
  73
  74 /* Much of the following template comes from:
  75  *      http://lua-users.org/wiki/BindingWithMembersAndMethods
  76  */
  77
  78 static int get_int (lua_State *L, void *v)
  79 {
  80   lua_pushinteger (L, *(int*)v);
  81   return 1;
  82 }
  83
  84 static int set_int (lua_State *L, void *v)
  85 {
  86   *(int*)v = luaL_checkint(L, 3);
  87   return 0;
  88 }
  89
  90 static int get_number (lua_State *L, void *v)
  91 {
  92   lua_pushnumber(L, *(lua_Number*)v);
  93   return 1;
  94 }
  95
  96 static int set_number (lua_State *L, void *v)
  97 {
  98   *(lua_Number*)v = luaL_checknumber(L, 3);
  99   return 0;
 100 }
 101
 102 static int get_string (lua_State *L, void *v)
 103 {
 104   lua_pushstring(L, (char*)v );
 105   return 1;
 106 }
 107
 108 static int set_string (lua_State *L, void *v)
 109 {
 110   *(const char**)v = luaL_checkstring(L, 3);
 111   return 0;
 112 }
 113
 114 typedef int (*Xet_func) (lua_State *L, void *v);
 115
 116 /* member info for get and set handlers */
 117 struct Xet_reg
 118 {
 119   const char *name;  /* member name */
 120   Xet_func func;     /* get or set function for type of member */
 121   size_t offset;     /* offset of member within the struct */
 122   int (*absolute)(lua_State *);
 123 };
 124
 125 static void Xet_add (lua_State *L, const struct Xet_reg *l)
 126 {
 127   if (!l)
 128     return;
 129   for (; l->name; l++)
 130     {
 131       lua_pushstring(L, l->name);
 132       lua_pushlightuserdata(L, (void*)l);
 133       lua_settable(L, -3);
 134     }
 135 }
 136
 137 static int Xet_call (lua_State *L)
 138 {
 139   /* for get: stack has userdata, index, lightuserdata */
 140   /* for set: stack has userdata, index, value, lightuserdata */
 141   const struct Xet_reg *m = (const struct Xet_reg *)lua_touserdata(L, -1);  /* member info */
 142   lua_pop(L, 1);                               /* drop lightuserdata */
 143   luaL_checktype(L, 1, LUA_TUSERDATA);
 144   if (m->absolute)
 145     return m->absolute(L);
 146   return m->func(L, *(char**)lua_touserdata(L, 1) + m->offset);
 147 }
 148
 149 static int index_handler (lua_State *L)
 150 {
 151   /* stack has userdata, index */
 152   lua_pushvalue(L, 2);                     /* dup index */
 153   lua_rawget(L, lua_upvalueindex(1));      /* lookup member by name */
 154   if (!lua_islightuserdata(L, -1))
 155     {
 156       lua_pop(L, 1);                         /* drop value */
 157       lua_pushvalue(L, 2);                   /* dup index */
 158       lua_gettable(L, lua_upvalueindex(2));  /* else try methods */
 159       if (lua_isnil(L, -1))                  /* invalid member */
 160         luaL_error(L, "cannot get member '%s'", lua_tostring(L, 2));
 161       return 1;
 162     }
 163   return Xet_call(L);                      /* call get function */
 164 }
 165
 166 static int newindex_handler (lua_State *L)
 167 {
 168   /* stack has userdata, index, value */
 169   lua_pushvalue(L, 2);                     /* dup index */
 170   lua_rawget(L, lua_upvalueindex(1));      /* lookup member by name */
 171   if (!lua_islightuserdata(L, -1))         /* invalid member */
 172     luaL_error(L, "cannot set member '%s'", lua_tostring(L, 2));
 173   return Xet_call(L);                      /* call set function */
 174 }
 175
 176 static int
 177 struct_register(lua_State *L, const char *name, const luaL_reg fn_methods[], const luaL_reg meta_methods[],
 178     const struct Xet_reg setters[], const struct Xet_reg getters[])
 179 {
 180   int metatable, methods;
 181
 182   /* create methods table & add it to the table of globals */
 183   luaL_register(L, name, fn_methods);
 184   methods = lua_gettop(L);
 185
 186   /* create metatable & add it to the registry */
 187   luaL_newmetatable(L, name);
 188   luaL_register(L, 0, meta_methods);  /* fill metatable */
 189   metatable = lua_gettop(L);
 190
 191   lua_pushliteral(L, "__metatable");
 192   lua_pushvalue(L, methods);    /* dup methods table*/
 193   lua_rawset(L, metatable);     /* hide metatable:
 194                                    metatable.__metatable = methods */
 195
 196   lua_pushliteral(L, "__index");
 197   lua_pushvalue(L, metatable);  /* upvalue index 1 */
 198   Xet_add(L, getters);     /* fill metatable with getters */
 199   lua_pushvalue(L, methods);    /* upvalue index 2 */
 200   lua_pushcclosure(L, index_handler, 2);
 201   lua_rawset(L, metatable);     /* metatable.__index = index_handler */
 202
 203   lua_pushliteral(L, "__newindex");
 204   lua_newtable(L);              /* table for members you can set */
 205   Xet_add(L, setters);     /* fill with setters */
 206   lua_pushcclosure(L, newindex_handler, 1);
 207   lua_rawset(L, metatable);     /* metatable.__newindex = newindex_handler */
 208
 209   lua_pop(L, 1);                /* drop metatable */
 210   return 1;                     /* return methods on the stack */
 211 }
 212
 213 /** }}} */
 214
 215 /** Window {{{ */
 216
 217 PUSH_TYPE(window, struct win)
 218
 219 CHECK_TYPE(window, struct win)
 220
 221 static int get_window(lua_State *L, void *v)
 222 {
 223   push_window(L, (struct win **)v);
 224   return 1;
 225 }
 226
 227 static int
 228 window_change_title(lua_State *L)
 229 {
 230   struct win *w = check_window(L, 1);
 231   unsigned int len;
 232   const char *title = luaL_checklstring(L, 2, &len);
 233   ChangeAKA(w, title, len);
 234   return 0;
 235 }
 236
 237 static const luaL_reg window_methods[] = {
 238   {"change_title", window_change_title},
 239   {0, 0}
 240 };
 241
 242 static int
 243 window_tostring(lua_State *L)
 244 {
 245   char str[128];
 246   struct win *w = check_window(L, 1);
 247   snprintf(str, sizeof(str), "{window #%d: '%s'}", w->w_number, w->w_title);
 248   lua_pushstring(L, str);
 249   return 1;
 250 }
 251
 252 static int
 253 window_equality(lua_State *L)
 254 {
 255   struct win *w1 = check_window(L, 1), *w2 = check_window(L, 2);
 256   lua_pushboolean(L, (w1 == w2 || (w1 && w2 && w1->w_number == w2->w_number)));
 257   return 1;
 258 }
 259
 260 static const luaL_reg window_metamethods[] = {
 261   {"__tostring", window_tostring},
 262   {"__eq", window_equality},
 263   {0, 0}
 264 };
 265
 266 static const struct Xet_reg window_setters[] = {
 267   {0, 0}
 268 };
 269
 270 static const struct Xet_reg window_getters[] = {
 271   {"title", get_string, offsetof(struct win, w_title) + 8},
 272   {"number", get_int, offsetof(struct win, w_number)},
 273   {"dir", get_string, offsetof(struct win, w_dir)},
 274   {"tty", get_string, offsetof(struct win, w_tty)},
 275   {"pid", get_int, offsetof(struct win, w_pid)},
 276   {"group", get_window, offsetof(struct win, w_group)},
 277   {"bell", get_int, offsetof(struct win, w_bell)},
 278   {"monitor", get_int, offsetof(struct win, w_monitor)},
 279   {0, 0}
 280 };
 281
 282
 283 /** }}} */
 284
 285 /** AclUser {{{ */
 286
 287 PUSH_TYPE(user, struct acluser)
 288
 289 CHECK_TYPE(user, struct acluser)
 290
 291 static int
 292 get_user(lua_State *L, void *v)
 293 {
 294   push_user(L, (struct acluser **)v);
 295   return 1;
 296 }
 297
 298 static const luaL_reg user_methods[] = {
 299   {0, 0}
 300 };
 301
 302 static int
 303 user_tostring(lua_State *L)
 304 {
 305   char str[128];
 306   struct acluser *u = check_user(L, 1);
 307   snprintf(str, sizeof(str), "{user '%s'}", u->u_name);
 308   lua_pushstring(L, str);
 309   return 1;
 310 }
 311
 312 static const luaL_reg user_metamethods[] = {
 313   {"__tostring", user_tostring},
 314   {0, 0}
 315 };
 316
 317 static const struct Xet_reg user_setters[] = {
 318   {0, 0}
 319 };
 320
 321 static const struct Xet_reg user_getters[] = {
 322   {"name", get_string, offsetof(struct acluser, u_name)},
 323   {"password", get_string, offsetof(struct acluser, u_password)},
 324   {0, 0}
 325 };
 326
 327 /** }}} */
 328
 329 /** Canvas {{{ */
 330
 331 PUSH_TYPE(canvas, struct canvas)
 332
 333 CHECK_TYPE(canvas, struct canvas)
 334
 335 static int
 336 get_canvas(lua_State *L, void *v)
 337 {
 338   push_canvas(L, (struct canvas **)v);
 339   return 1;
 340 }
 341
 342 static int
 343 canvas_select(lua_State *L)
 344 {
 345   struct canvas *c = check_canvas(L, 1);
 346   if (!display || D_forecv == c)
 347     return 0;
 348   SetCanvasWindow(c, Layer2Window(c->c_layer));
 349   D_forecv = c;
 350
 351   /* XXX: the following all is duplicated from process.c:DoAction.
 352    * Should these be in some better place?
 353    */
 354   ResizeCanvas(&D_canvas);
 355   RecreateCanvasChain();
 356   RethinkDisplayViewports();
 357   ResizeLayersToCanvases();     /* redisplays */
 358   fore = D_fore = Layer2Window(D_forecv->c_layer);
 359   flayer = D_forecv->c_layer;
 360 #ifdef RXVT_OSC
 361   if (D_xtermosc[2] || D_xtermosc[3])
 362     {
 363       Activate(-1);
 364       break;
 365     }
 366 #endif
 367   RefreshHStatus();
 368 #ifdef RXVT_OSC
 369   RefreshXtermOSC();
 370 #endif
 371   flayer = D_forecv->c_layer;
 372   CV_CALL(D_forecv, LayRestore();LaySetCursor());
 373   WindowChanged(0, 'F');
 374   return 1;
 375 }
 376
 377 static const luaL_reg canvas_methods[] = {
 378   {"select", canvas_select},
 379   {0, 0}
 380 };
 381
 382 static const luaL_reg canvas_metamethods[] = {
 383   {0, 0}
 384 };
 385
 386 static const struct Xet_reg canvas_setters[] = {
 387   {0, 0}
 388 };
 389
 390 static int
 391 canvas_get_window(lua_State *L)
 392 {
 393   struct canvas *c = check_canvas(L, 1);
 394   struct win *win = Layer2Window(c->c_layer);
 395   if (win)
 396     push_window(L, &win);
 397   else
 398     lua_pushnil(L);
 399   return 1;
 400 }
 401
 402 static const struct Xet_reg canvas_getters[] = {
 403   {"next", get_canvas, offsetof(struct canvas, c_next)},
 404   {"xoff", get_int, offsetof(struct canvas, c_xoff)},
 405   {"yoff", get_int, offsetof(struct canvas, c_yoff)},
 406   {"xs", get_int, offsetof(struct canvas, c_xs)},
 407   {"ys", get_int, offsetof(struct canvas, c_ys)},
 408   {"xe", get_int, offsetof(struct canvas, c_xe)},
 409   {"ye", get_int, offsetof(struct canvas, c_ye)},
 410   {"window", 0, 0, canvas_get_window},
 411   {0, 0}
 412 };
 413
 414 /** }}} */
 415
 416 /** Display {{{ */
 417
 418 PUSH_TYPE(display, struct display)
 419
 420 CHECK_TYPE(display, struct display)
 421
 422 static int
 423 display_get_canvases(lua_State *L)
 424 {
 425   struct display *d;
 426   struct canvas *iter;
 427   int count;
 428
 429   d = check_display(L, 1);
 430   for (iter = d->d_cvlist, count = 0; iter; iter = iter->c_next, count++)
 431     push_canvas(L, &iter);
 432
 433   return count;
 434 }
 435
 436 static const luaL_reg display_methods[] = {
 437   {"get_canvases", display_get_canvases},
 438   {0, 0}
 439 };
 440
 441 static int
 442 display_tostring(lua_State *L)
 443 {
 444   char str[128];
 445   struct display *d = check_display(L, 1);
 446   snprintf(str, sizeof(str), "{display: tty = '%s', term = '%s'}", d->d_usertty, d->d_termname);
 447   lua_pushstring(L, str);
 448   return 1;
 449 }
 450
 451 static const luaL_reg display_metamethods[] = {
 452   {"__tostring", display_tostring},
 453   {0, 0}
 454 };
 455
 456 static const struct Xet_reg display_setters[] = {
 457   {0, 0}
 458 };
 459
 460 static const struct Xet_reg display_getters[] = {
 461   {"tty", get_string, offsetof(struct display, d_usertty)},
 462   {"term", get_string, offsetof(struct display, d_termname)},
 463   {"fore", get_window, offsetof(struct display, d_fore)},
 464   {"other", get_window, offsetof(struct display, d_other)},
 465   {"width", get_int, offsetof(struct display, d_width)},
 466   {"height", get_int, offsetof(struct display, d_height)},
 467   {"user", get_user, offsetof(struct display, d_user)},
 468   {0, 0}
 469 };
 470
 471 /** }}} */
 472
 473 /** Screen {{{ */
 474
 475 static int
 476 screen_get_windows(lua_State *L)
 477 {
 478   struct win *iter;
 479   int count;
 480
 481   for (iter = windows, count = 0; iter; iter = iter->w_next, count++)
 482     push_window(L, &iter);
 483
 484   return count;
 485 }
 486
 487 static int
 488 screen_get_displays(lua_State *L)
 489 {
 490   struct display *iter;
 491   int count;
 492
 493   for (iter = displays, count = 0; iter; iter = iter->d_next, count++)
 494     push_display(L, &iter);
 495
 496   return count;
 497 }
 498
 499 static int
 500 screen_get_display(lua_State *L)
 501 {
 502   push_display(L, &display);
 503   return 1;
 504 }
 505
 506 static int
 507 screen_exec_command(lua_State *L)
 508 {
 509   const char *command;
 510   unsigned int len;
 511
 512   command = luaL_checklstring(L, 1, &len);
 513   if (command)
 514     RcLine(command, len);
 515
 516   return 0;
 517 }
 518
 519 static int
 520 screen_append_msg(lua_State *L)
 521 {
 522   const char *msg, *color;
 523   int len;
 524   msg = luaL_checklstring(L, 1, &len);
 525   if (lua_isnil(L, 2))
 526     color = NULL;
 527   else
 528     color = luaL_checklstring(L, 2, &len);
 529   AppendWinMsgRend(msg, color);
 530   return 0;
 531 }
 532
 533 static const luaL_reg screen_methods[] = {
 534   {"windows", screen_get_windows},
 535   {"displays", screen_get_displays},
 536   {"display", screen_get_display},
 537   {"command", screen_exec_command},
 538   {"append_msg", screen_append_msg},
 539   {0, 0}
 540 };
 541
 542 static const luaL_reg screen_metamethods[] = {
 543   {0, 0}
 544 };
 545
 546 static const struct Xet_reg screen_setters[] = {
 547   {0, 0}
 548 };
 549
 550 static const struct Xet_reg screen_getters[] = {
 551   {0, 0}
 552 };
 553
 554 /** }}} */
 555
 556 /** Public functions {{{ */
 557 static lua_State *L;
 558 int LuaInit(void)
 559 {
 560   L = luaL_newstate();
 561
 562   luaL_openlibs(L);
 563
 564 #define REGISTER(X) struct_register(L, #X , X ## _methods, X##_metamethods, X##_setters, X##_getters)
 565
 566   REGISTER(screen);
 567   REGISTER(window);
 568   REGISTER(display);
 569   REGISTER(user);
 570   REGISTER(canvas);
 571
 572   return 0;
 573 }
 574
 575 struct fn_def
 576 {
 577   void (*push_fn)(lua_State *, void*);
 578   void *value;
 579 };
 580
 581 static int
 582 LuaCallProcess(const char *name, struct fn_def defs[])
 583 {
 584   int argc = 0;
 585
 586   lua_settop(L, 0);
 587   lua_getfield(L, LUA_GLOBALSINDEX, name);
 588   if (lua_isnil(L, -1))
 589     return 0;
 590   for (argc = 0; defs[argc].push_fn; argc++)
 591     defs[argc].push_fn(L, defs[argc].value);
 592   if (lua_pcall(L, argc, 0, 0) == LUA_ERRRUN && lua_isstring(L, -1))
 593     {
 594       struct display *d = display;
 595       unsigned int len;
 596       char *message = luaL_checklstring(L, -1, &len);
 597       LMsg(1, "%s", message ? message : "Unknown error");
 598       lua_pop(L, 1);
 599       display = d;
 600       return 0;
 601     }
 602   return 1;
 603 }
 604
 605 int LuaForeWindowChanged(void)
 606 {
 607   if (!L)
 608     return 0;
 609   lua_getfield(L, LUA_GLOBALSINDEX, "fore_changed");
 610   if (lua_isnil(L, -1))
 611     return 0;
 612   push_display(L, &display);
 613   push_window(L, display ? &D_fore : &fore);
 614   if (lua_pcall(L, 2, 0, 0) == LUA_ERRRUN)
 615     {
 616       if(lua_isstring(L, -1))
 617         {
 618           unsigned int len;
 619           char *message = luaL_checklstring(L, -1, &len);
 620           LMsg(1, "%s", message ? message : "Unknown error");
 621           lua_pop(L, 1);
 622         }
 623     }
 624   return 0;
 625 }
 626
 627 int LuaSource(const char *file)
 628 {
 629   if (!L)
 630     return 0;
 631   struct stat st;
 632   if (stat(file, &st) == -1)
 633     Msg(errno, "Error loading lua script file '%s'", file);
 634   else
 635     {
 636       int len = strlen(file);
 637       if (len < 4 || strncmp(file + len - 4, ".lua", 4) != 0)
 638         return 0;
 639       luaL_dofile(L, file);
 640       return 1;
 641     }
 642   return 0;
 643 }
 644
 645 int LuaFinit(void)
 646 {
 647   if (!L)
 648     return 0;
 649   lua_close(L);
 650   L = (lua_State*)0;
 651   return 0;
 652 }
 653
 654 int LuaCall(char **argv)
 655 {
 656   int argc;
 657   if (!L)
 658     return 0;
 659
 660   lua_getfield(L, LUA_GLOBALSINDEX, *argv);
 661   for (argc = 0, argv++; *argv; argv++, argc++)
 662     {
 663       lua_pushstring(L, *argv);
 664     }
 665   if (lua_pcall(L, argc, 0, 0) == LUA_ERRRUN)
 666     {
 667       if(lua_isstring(L, -1))
 668         {
 669           unsigned int len;
 670           char *message = luaL_checklstring(L, -1, &len);
 671           LMsg(1, "%s", message ? message : "Unknown error");
 672           lua_pop(L, 1);
 673           return 0;
 674         }
 675     }
 676   return 1;
 677 }
 678
 679 int
 680 LuaProcessCaption(const char *caption, struct win *win, int len)
 681 {
 682   if (!L)
 683     return 0;
 684   struct fn_def params[] = {
 685     {lua_pushstring, caption},
 686     {push_window, &win},
 687     {lua_pushinteger, len},
 688     {NULL, NULL}
 689   };
 690   return LuaCallProcess("process_caption", params);
 691 }
 692
 693 static void
 694 push_stringarray(lua_State *L, void *data)
 695 {
 696   char **args = (char **)data;
 697   int i;
 698   lua_newtable(L);
 699   for (i = 1; args && *args; i++) {
 700     lua_pushinteger(L, i);
 701     lua_pushstring(L, *args++);
 702     lua_settable(L, -3);
 703   }
 704 }
 705
 706 int
 707 LuaCommandExecuted(const char *command, const char **args, int argc)
 708 {
 709   if (!L)
 710     return 0;
 711   struct fn_def params[] = {
 712       {lua_pushstring, command},
 713       {push_stringarray, args},
 714       {NULL, NULL}
 715   };
 716   return LuaCallProcess("command_executed", params);
 717 }
 718
 719 /** }}} */
 720
 721 struct ScriptFuncs LuaFuncs =
 722 {
 723   LuaInit,
 724   LuaFinit,
 725   LuaForeWindowChanged,
 726   LuaSource,
 727   LuaProcessCaption,
 728   LuaCommandExecuted
 729 };
 730