luah.c

   1 /*
   2  * luah.c - Lua helper functions
   3  *
   4  * Copyright (C) 2010 Mason Larobina <mason.larobina@gmail.com>
   5  * Copyright (C) 2008-2009 Julien Danjou <julien@danjou.info>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 #include <gtk/gtk.h>
  23 #include <basedir_fs.h>
  24 #include <stdlib.h>
  25 #include "common/util.h"
  26 #include "common/lualib.h"
  27 #include "luakit.h"
  28 #include "widget.h"
  29 #include "luah.h"
  30
  31 void
  32 luaH_modifier_table_push(lua_State *L, guint state) {
  33     gint i = 1;
  34     lua_newtable(L);
  35     if (state & GDK_MODIFIER_MASK) {
  36
  37 #define MODKEY(key, name)           \
  38     if (state & GDK_##key##_MASK) { \
  39         lua_pushstring(L, name);    \
  40         lua_rawseti(L, -2, i++);    \
  41     }
  42
  43         MODKEY(SHIFT, "Shift");
  44         MODKEY(LOCK, "Lock");
  45         MODKEY(CONTROL, "Control");
  46         MODKEY(MOD1, "Mod1");
  47         MODKEY(MOD2, "Mod2");
  48         MODKEY(MOD3, "Mod3");
  49         MODKEY(MOD4, "Mod4");
  50         MODKEY(MOD5, "Mod5");
  51
  52 #undef MODKEY
  53
  54     }
  55 }
  56
  57 void
  58 luaH_keystr_push(lua_State *L, guint keyval)
  59 {
  60     gchar ucs[7];
  61     guint ulen;
  62     guint32 ukval = gdk_keyval_to_unicode(keyval);
  63
  64     /* check for printable unicode character */
  65     if (g_unichar_isgraph(ukval)) {
  66         ulen = g_unichar_to_utf8(ukval, ucs);
  67         ucs[ulen] = 0;
  68         lua_pushstring(L, ucs);
  69     }
  70     /* sent keysym for non-printable characters */
  71     else
  72         lua_pushstring(L, gdk_keyval_name(keyval));
  73 }
  74
  75 /* UTF-8 aware string length computing.
  76  * Returns the number of elements pushed on the stack. */
  77 static gint
  78 luaH_utf8_strlen(lua_State *L)
  79 {
  80     const gchar *cmd  = luaL_checkstring(L, 1);
  81     lua_pushnumber(L, (ssize_t) g_utf8_strlen(NONULL(cmd), -1));
  82     return 1;
  83 }
  84
  85 /* Overload standard Lua next function to use __next key on metatable.
  86  * Returns the number of elements pushed on stack. */
  87 static gint
  88 luaHe_next(lua_State *L)
  89 {
  90     if(luaL_getmetafield(L, 1, "__next")) {
  91         lua_insert(L, 1);
  92         lua_call(L, lua_gettop(L) - 1, LUA_MULTRET);
  93         return lua_gettop(L);
  94     }
  95     luaL_checktype(L, 1, LUA_TTABLE);
  96     lua_settop(L, 2);
  97     if(lua_next(L, 1))
  98         return 2;
  99     lua_pushnil(L);
 100     return 1;
 101 }
 102
 103 /* Overload lua_next() function by using __next metatable field to get
 104  * next elements. `idx` is the index number of elements in stack.
 105  * Returns 1 if more elements to come, 0 otherwise. */
 106 gint
 107 luaH_next(lua_State *L, gint idx)
 108 {
 109     if(luaL_getmetafield(L, idx, "__next")) {
 110         /* if idx is relative, reduce it since we got __next */
 111         if(idx < 0) idx--;
 112         /* copy table and then move key */
 113         lua_pushvalue(L, idx);
 114         lua_pushvalue(L, -3);
 115         lua_remove(L, -4);
 116         lua_pcall(L, 2, 2, 0);
 117         /* next returned nil, it's the end */
 118         if(lua_isnil(L, -1)) {
 119             /* remove nil */
 120             lua_pop(L, 2);
 121             return 0;
 122         }
 123         return 1;
 124     }
 125     else if(lua_istable(L, idx))
 126         return lua_next(L, idx);
 127     /* remove the key */
 128     lua_pop(L, 1);
 129     return 0;
 130 }
 131
 132 /* Generic pairs function.
 133  * Returns the number of elements pushed on stack. */
 134 static gint
 135 luaH_generic_pairs(lua_State *L)
 136 {
 137     lua_pushvalue(L, lua_upvalueindex(1));  /* return generator, */
 138     lua_pushvalue(L, 1);  /* state, */
 139     lua_pushnil(L);  /* and initial value */
 140     return 3;
 141 }
 142
 143 /* Overload standard pairs function to use __pairs field of metatables.
 144  * Returns the number of elements pushed on stack. */
 145 static gint
 146 luaHe_pairs(lua_State *L)
 147 {
 148     if(luaL_getmetafield(L, 1, "__pairs")) {
 149         lua_insert(L, 1);
 150         lua_call(L, lua_gettop(L) - 1, LUA_MULTRET);
 151         return lua_gettop(L);
 152     }
 153     luaL_checktype(L, 1, LUA_TTABLE);
 154     return luaH_generic_pairs(L);
 155 }
 156
 157 static gint
 158 luaH_ipairs_aux(lua_State *L)
 159 {
 160     gint i = luaL_checkint(L, 2) + 1;
 161     luaL_checktype(L, 1, LUA_TTABLE);
 162     lua_pushinteger(L, i);
 163     lua_rawgeti(L, 1, i);
 164     return (lua_isnil(L, -1)) ? 0 : 2;
 165 }
 166
 167 /* Overload standard ipairs function to use __ipairs field of metatables.
 168  * Returns the number of elements pushed on stack. */
 169 static gint
 170 luaHe_ipairs(lua_State *L)
 171 {
 172     if(luaL_getmetafield(L, 1, "__ipairs")) {
 173         lua_insert(L, 1);
 174         lua_call(L, lua_gettop(L) - 1, LUA_MULTRET);
 175         return lua_gettop(L);
 176     }
 177
 178     luaL_checktype(L, 1, LUA_TTABLE);
 179     lua_pushvalue(L, lua_upvalueindex(1));
 180     lua_pushvalue(L, 1);
 181     lua_pushinteger(L, 0);  /* and initial value */
 182     return 3;
 183 }
 184
 185 /* Enhanced type() function which recognize luakit objects.
 186  * \param L The Lua VM state.
 187  * \return The number of arguments pushed on the stack.
 188  */
 189 static gint
 190 luaHe_type(lua_State *L)
 191 {
 192     luaL_checkany(L, 1);
 193     lua_pushstring(L, luaH_typename(L, 1));
 194     return 1;
 195 }
 196
 197
 198 /* Fix up and add handy standard lib functions */
 199 static void
 200 luaH_fixups(lua_State *L)
 201 {
 202     /* export string.wlen */
 203     lua_getglobal(L, "string");
 204     lua_pushcfunction(L, &luaH_utf8_strlen);
 205     lua_setfield(L, -2, "wlen");
 206     lua_pop(L, 1);
 207     /* replace next */
 208     lua_pushliteral(L, "next");
 209     lua_pushcfunction(L, luaHe_next);
 210     lua_settable(L, LUA_GLOBALSINDEX);
 211     /* replace pairs */
 212     lua_pushliteral(L, "pairs");
 213     lua_pushcfunction(L, luaHe_next);
 214     lua_pushcclosure(L, luaHe_pairs, 1); /* pairs get next as upvalue */
 215     lua_settable(L, LUA_GLOBALSINDEX);
 216     /* replace ipairs */
 217     lua_pushliteral(L, "ipairs");
 218     lua_pushcfunction(L, luaH_ipairs_aux);
 219     lua_pushcclosure(L, luaHe_ipairs, 1);
 220     lua_settable(L, LUA_GLOBALSINDEX);
 221     /* replace type */
 222     lua_pushliteral(L, "type");
 223     lua_pushcfunction(L, luaHe_type);
 224     lua_settable(L, LUA_GLOBALSINDEX);
 225 }
 226
 227 /* Look for an item: table, function, etc.
 228  * \param L The Lua VM state.
 229  * \param item The pointer item.
 230  */
 231 gboolean
 232 luaH_hasitem(lua_State *L, gconstpointer item)
 233 {
 234     lua_pushnil(L);
 235     while(luaH_next(L, -2)) {
 236         if(lua_topointer(L, -1) == item) {
 237             /* remove value and key */
 238             lua_pop(L, 2);
 239             return TRUE;
 240         }
 241         if(lua_istable(L, -1))
 242             if(luaH_hasitem(L, item)) {
 243                 /* remove key and value */
 244                 lua_pop(L, 2);
 245                 return TRUE;
 246             }
 247         /* remove value */
 248         lua_pop(L, 1);
 249     }
 250     return FALSE;
 251 }
 252
 253 /* Browse a table pushed on top of the index, and put all its table and
 254  * sub-table ginto an array.
 255  * \param L The Lua VM state.
 256  * \param elems The elements array.
 257  * \return False if we encounter an elements already in list.
 258  */
 259 static gboolean
 260 luaH_isloop_check(lua_State *L, GPtrArray *elems)
 261 {
 262     if(lua_istable(L, -1)) {
 263         gconstpointer object = lua_topointer(L, -1);
 264
 265         /* Check that the object table is not already in the list */
 266         for(guint i = 0; i < elems->len; i++)
 267             if(elems->pdata[i] == object)
 268                 return FALSE;
 269
 270         /* push the table in the elements list */
 271         g_ptr_array_add(elems, (gpointer) object);
 272
 273         /* look every object in the "table" */
 274         lua_pushnil(L);
 275         while(luaH_next(L, -2)) {
 276             if(!luaH_isloop_check(L, elems)) {
 277                 /* remove key and value */
 278                 lua_pop(L, 2);
 279                 return FALSE;
 280             }
 281             /* remove value, keep key for next iteration */
 282             lua_pop(L, 1);
 283         }
 284     }
 285     return TRUE;
 286 }
 287
 288 /* Check if a table is a loop. When using tables as direct acyclic digram,
 289  * this is useful.
 290  * \param L The Lua VM state.
 291  * \param idx The index of the table in the stack
 292  * \return True if the table loops.
 293  */
 294 gboolean
 295 luaH_isloop(lua_State *L, gint idx)
 296 {
 297     /* elems is an elements array that we will fill with all array we
 298      * encounter while browsing the tables */
 299     GPtrArray *elems = g_ptr_array_new();
 300
 301     /* push table on top */
 302     lua_pushvalue(L, idx);
 303
 304     gboolean ret = luaH_isloop_check(L, elems);
 305
 306     /* remove pushed table */
 307     lua_pop(L, 1);
 308
 309     g_ptr_array_free(elems, TRUE);
 310
 311     return !ret;
 312 }
 313
 314 /* luakit global table.
 315  * \param L The Lua VM state.
 316  * \return The number of elements pushed on stack.
 317  * \luastack
 318  * \lfield font The default font.
 319  * \lfield font_height The default font height.
 320  * \lfield conffile The configuration file which has been loaded.
 321  */
 322 static gint
 323 luaH_luakit_index(lua_State *L)
 324 {
 325     if(luaH_usemetatable(L, 1, 2))
 326         return 1;
 327
 328     size_t len;
 329     widget_t *w;
 330     const gchar *prop = luaL_checklstring(L, 2, &len);
 331     luakit_token_t token = l_tokenize(prop, len);
 332
 333     switch(token)
 334     {
 335       case L_TK_WINDOWS:
 336         lua_newtable(L);
 337         for (guint i = 0; i < globalconf.windows->len; i++) {
 338             w = globalconf.windows->pdata[i];
 339             luaH_object_push(L, w->ref);
 340             lua_rawseti(L, -2, i+1);
 341         }
 342         return 1;
 343
 344       default:
 345         break;
 346     }
 347     return 0;
 348 }
 349
 350 /* Newindex function for the luakit global table.
 351  * \param L The Lua VM state.
 352  * \return The number of elements pushed on stack.
 353  */
 354 static gint
 355 luaH_luakit_newindex(lua_State *L)
 356 {
 357     if(luaH_usemetatable(L, 1, 2))
 358         return 1;
 359
 360     size_t len;
 361     const gchar *buf = luaL_checklstring(L, 2, &len);
 362
 363     debug("Luakit newindex %s", buf);
 364
 365     return 0;
 366 }
 367
 368 /* Add a global signal.
 369  * Returns the number of elements pushed on stack.
 370  * \luastack
 371  * \lparam A string with the event name.
 372  * \lparam The function to call.
 373  */
 374 static gint
 375 luaH_luakit_add_signal(lua_State *L)
 376 {
 377     const gchar *name = luaL_checkstring(L, 1);
 378     luaH_checkfunction(L, 2);
 379     signal_add(globalconf.signals, name, luaH_object_ref(L, 2));
 380     return 0;
 381 }
 382
 383 /* Remove a global signal.
 384  * \param L The Lua VM state.
 385  * \return The number of elements pushed on stack.
 386  * \luastack
 387  * \lparam A string with the event name.
 388  * \lparam The function to call.
 389  */
 390 static gint
 391 luaH_luakit_remove_signal(lua_State *L)
 392 {
 393     const gchar *name = luaL_checkstring(L, 1);
 394     luaH_checkfunction(L, 2);
 395     gpointer func = (gpointer) lua_topointer(L, 2);
 396     signal_remove(globalconf.signals, name, func);
 397     luaH_object_unref(L, (void *) func);
 398     return 0;
 399 }
 400
 401 /* Emit a global signal.
 402  * \param L The Lua VM state.
 403  * \return The number of elements pushed on stack.
 404  * \luastack
 405  * \lparam A string with the event name.
 406  * \lparam The function to call.
 407  */
 408 static gint
 409 luaH_luakit_emit_signal(lua_State *L)
 410 {
 411     signal_object_emit(L, globalconf.signals, luaL_checkstring(L, 1), lua_gettop(L) - 1);
 412     return 0;
 413 }
 414
 415 static gint
 416 luaH_panic(lua_State *L)
 417 {
 418     warn("unprotected error in call to Lua API (%s)", lua_tostring(L, -1));
 419     return 0;
 420 }
 421
 422 static gint
 423 luaH_quit(lua_State *L)
 424 {
 425     (void) L;
 426     gtk_main_quit();
 427     return 0;
 428 }
 429
 430 static gint
 431 luaH_dofunction_on_error(lua_State *L)
 432 {
 433     /* duplicate string error */
 434     lua_pushvalue(L, -1);
 435     /* emit error signal */
 436     signal_object_emit(L, globalconf.signals, "debug::error", 1);
 437
 438     if(!luaL_dostring(L, "return debug.traceback(\"error while running function\", 3)"))
 439     {
 440         /* Move traceback before error */
 441         lua_insert(L, -2);
 442         /* Insert sentence */
 443         lua_pushliteral(L, "\nerror: ");
 444         /* Move it before error */
 445         lua_insert(L, -2);
 446         lua_concat(L, 3);
 447     }
 448     return 1;
 449 }
 450
 451 void
 452 luaH_init(xdgHandle *xdg)
 453 {
 454     lua_State *L;
 455
 456     static const struct luaL_reg luakit_lib[] = {
 457         { "quit", luaH_quit },
 458         { "add_signal", luaH_luakit_add_signal },
 459         { "remove_signal", luaH_luakit_remove_signal },
 460         { "emit_signal", luaH_luakit_emit_signal },
 461         { "__index", luaH_luakit_index },
 462         { "__newindex", luaH_luakit_newindex },
 463         { NULL, NULL }
 464     };
 465
 466     /* Lua VM init */
 467     L = globalconf.L = luaL_newstate();
 468
 469     /* Set panic fuction */
 470     lua_atpanic(L, luaH_panic);
 471
 472     /* Set error handling function */
 473     lualib_dofunction_on_error = luaH_dofunction_on_error;
 474
 475     luaL_openlibs(L);
 476
 477     luaH_fixups(L);
 478
 479     luaH_object_setup(L);
 480
 481     /* Export luakit lib */
 482     luaH_openlib(L, "luakit", luakit_lib, luakit_lib);
 483
 484     /* Export widget */
 485     widget_class_setup(L);
 486
 487     /* add Lua search paths */
 488     lua_getglobal(L, "package");
 489     if(LUA_TTABLE != lua_type(L, 1)) {
 490         warn("package is not a table");
 491         return;
 492     }
 493     lua_getfield(L, 1, "path");
 494     if(LUA_TSTRING != lua_type(L, 2)) {
 495         warn("package.path is not a string");
 496         lua_pop(L, 1);
 497         return;
 498     }
 499
 500     /* add XDG_CONFIG_DIR as an include path */
 501     const gchar * const *xdgconfigdirs = xdgSearchableConfigDirectories(xdg);
 502     for(; *xdgconfigdirs; xdgconfigdirs++)
 503     {
 504         size_t len = l_strlen(*xdgconfigdirs);
 505         lua_pushliteral(L, ";");
 506         lua_pushlstring(L, *xdgconfigdirs, len);
 507         lua_pushliteral(L, "/luakit/?.lua");
 508         lua_concat(L, 3);
 509
 510         lua_pushliteral(L, ";");
 511         lua_pushlstring(L, *xdgconfigdirs, len);
 512         lua_pushliteral(L, "/luakit/?/init.lua");
 513         lua_concat(L, 3);
 514
 515         lua_concat(L, 3); /* concatenate with package.path */
 516     }
 517
 518     /* add Lua lib path (/usr/share/luakit/lib by default) */
 519     lua_pushliteral(L, ";" LUAKIT_LUA_LIB_PATH "/?.lua");
 520     lua_pushliteral(L, ";" LUAKIT_LUA_LIB_PATH "/?/init.lua");
 521     lua_concat(L, 3); /* concatenate with package.path */
 522     lua_setfield(L, 1, "path"); /* package.path = "concatenated string" */
 523 }
 524
 525 gboolean
 526 luaH_loadrc(const gchar *confpath, gboolean run)
 527 {
 528     lua_State *L = globalconf.L;
 529
 530     if(!luaL_loadfile(L, confpath)) {
 531         if(run) {
 532             if(lua_pcall(L, 0, LUA_MULTRET, 0)) {
 533                 g_fprintf(stderr, "%s\n", lua_tostring(L, -1));
 534             } else
 535                 return TRUE;
 536         } else
 537             lua_pop(L, 1);
 538         return TRUE;
 539     } else
 540         g_fprintf(stderr, "%s\n", lua_tostring(L, -1));
 541     return FALSE;
 542 }
 543
 544 /* Load a configuration file.
 545  *
 546  * param xdg An xdg handle to use to get XDG basedir.
 547  * param confpatharg The configuration file to load.
 548  * param run Run the configuration file.
 549  */
 550 gboolean
 551 luaH_parserc(xdgHandle* xdg, const gchar *confpatharg, gboolean run)
 552 {
 553     gchar *confpath = NULL;
 554     gboolean ret = FALSE;
 555
 556     /* try to load, return if it's ok */
 557     if(confpatharg) {
 558         debug("Attempting to load rc file: %s", confpatharg);
 559         if(luaH_loadrc(confpatharg, run))
 560             ret = TRUE;
 561         goto bailout;
 562     }
 563     confpath = xdgConfigFind("luakit/rc.lua", xdg);
 564     gchar *tmp = confpath;
 565
 566     /* confpath is "string1\0string2\0string3\0\0" */
 567     while(*tmp) {
 568         debug("Loading rc file: %s", tmp);
 569         if(luaH_loadrc(tmp, run)) {
 570             globalconf.confpath = g_strdup(tmp);
 571             ret = TRUE;
 572             goto bailout;
 573         } else if(!run)
 574             goto bailout;
 575         tmp += l_strlen(tmp) + 1;
 576     }
 577
 578 bailout:
 579
 580     if (confpath) g_free(confpath);
 581     return ret;
 582 }
 583
 584 gint
 585 luaH_class_index_miss_property(lua_State *L, lua_object_t *obj)
 586 {
 587     (void) obj;
 588     signal_object_emit(L, globalconf.signals, "debug::index::miss", 2);
 589     return 0;
 590 }
 591
 592 gint
 593 luaH_class_newindex_miss_property(lua_State *L, lua_object_t *obj)
 594 {
 595     (void) obj;
 596     signal_object_emit(L, globalconf.signals, "debug::newindex::miss", 3);
 597     return 0;
 598 }
 599
 600 // vim: ft=c:et:sw=4:ts=8:sts=4:enc=utf-8:tw=80