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