add `reload()` webview widget method & "r" reload binding
[luakit.git] / luah.c
blobd7ea785dfd2b8719b314aedb8f0b83372a08f9c1
1 /*
2 * luah.c - Lua helper functions
4 * Copyright (C) 2010 Mason Larobina <mason.larobina@gmail.com>
5 * Copyright (C) 2008-2009 Julien Danjou <julien@danjou.info>
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.
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.
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/>.
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"
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) {
36 #define MODKEY(key, name) \
37 if (state & GDK_##key##_MASK) { \
38 lua_pushstring(L, name); \
39 lua_rawseti(L, -2, i++); \
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");
51 #undef MODKEY
56 void
57 luaH_keystr_push(lua_State *L, guint keyval)
59 gchar ucs[7];
60 guint ulen;
61 guint32 ukval = gdk_keyval_to_unicode(keyval);
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);
69 /* sent keysym for non-printable characters */
70 else
71 lua_pushstring(L, gdk_keyval_name(keyval));
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)
79 const gchar *cmd = luaL_checkstring(L, 1);
80 lua_pushnumber(L, (ssize_t) g_utf8_strlen(NONULL(cmd), -1));
81 return 1;
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)
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);
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;
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)
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;
122 return 1;
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;
131 /* Generic pairs function.
132 * Returns the number of elements pushed on stack. */
133 static gint
134 luaH_generic_pairs(lua_State *L)
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;
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)
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);
152 luaL_checktype(L, 1, LUA_TTABLE);
153 return luaH_generic_pairs(L);
156 static gint
157 luaH_ipairs_aux(lua_State *L)
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;
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)
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);
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;
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.
188 static gint
189 luaHe_type(lua_State *L)
191 luaL_checkany(L, 1);
192 lua_pushstring(L, luaH_typename(L, 1));
193 return 1;
197 /* Fix up and add handy standard lib functions */
198 static void
199 luaH_fixups(lua_State *L)
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);
226 /* Look for an item: table, function, etc.
227 * \param L The Lua VM state.
228 * \param item The pointer item.
230 gboolean
231 luaH_hasitem(lua_State *L, gconstpointer item)
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;
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;
246 /* remove value */
247 lua_pop(L, 1);
249 return FALSE;
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.
258 static gboolean
259 luaH_isloop_check(lua_State *L, GPtrArray *elems)
261 if(lua_istable(L, -1)) {
262 gconstpointer object = lua_topointer(L, -1);
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;
269 /* push the table in the elements list */
270 g_ptr_array_add(elems, (gpointer) object);
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;
280 /* remove value, keep key for next iteration */
281 lua_pop(L, 1);
284 return TRUE;
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.
293 gboolean
294 luaH_isloop(lua_State *L, gint idx)
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();
300 /* push table on top */
301 lua_pushvalue(L, idx);
303 gboolean ret = luaH_isloop_check(L, elems);
305 /* remove pushed table */
306 lua_pop(L, 1);
308 g_ptr_array_free(elems, TRUE);
310 return !ret;
313 /* Returns a string from X selection.
314 * \param L The Lua VM state.
315 * \return The number of elements pushed on stack (1).
317 static gint
318 luaH_luakit_selection(lua_State *L)
320 int n = lua_gettop(L);
321 GdkAtom atom = GDK_SELECTION_PRIMARY;
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;
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;
347 static const struct special_dir_mapping_t {
348 const gchar *name;
349 GUserDirectory atom;
350 } special_dirs[] = {
351 { "DESKTOP", G_USER_DIRECTORY_DESKTOP, },
352 { "DOCUMENTS", G_USER_DIRECTORY_DOCUMENTS, },
353 { "DOWNLOAD", G_USER_DIRECTORY_DOWNLOAD, },
354 { "MUSIC", G_USER_DIRECTORY_MUSIC, },
355 { "PICTURES", G_USER_DIRECTORY_PICTURES, },
356 { "PUBLIC_SHARE", G_USER_DIRECTORY_PUBLIC_SHARE, },
357 { "TEMPLATES", G_USER_DIRECTORY_TEMPLATES, },
358 { "VIDEOS", G_USER_DIRECTORY_VIDEOS, },
359 { NULL, 0, },
362 static gint
363 luaH_luakit_get_special_dir(lua_State *L)
365 const gchar *name = luaL_checkstring(L, 1);
366 for (guint i = 0; i < LENGTH(special_dirs); i++) {
367 if (g_strcmp0(special_dirs[i].name, name))
368 continue;
369 lua_pushstring(L, g_get_user_special_dir(special_dirs[i].atom));
370 return 1;
372 luaL_argerror(L, 1, "unknown special directory name");
373 return 0;
376 /* luakit global table.
377 * \param L The Lua VM state.
378 * \return The number of elements pushed on stack.
379 * \luastack
380 * \lfield font The default font.
381 * \lfield font_height The default font height.
382 * \lfield conffile The configuration file which has been loaded.
384 static gint
385 luaH_luakit_index(lua_State *L)
387 if(luaH_usemetatable(L, 1, 2))
388 return 1;
390 size_t len;
391 widget_t *w;
392 const gchar *prop = luaL_checklstring(L, 2, &len);
393 luakit_token_t token = l_tokenize(prop, len);
395 switch(token)
397 case L_TK_WINDOWS:
398 lua_newtable(L);
399 for (guint i = 0; i < globalconf.windows->len; i++) {
400 w = globalconf.windows->pdata[i];
401 luaH_object_push(L, w->ref);
402 lua_rawseti(L, -2, i+1);
404 return 1;
406 case L_TK_SELECTION:
407 lua_pushcfunction(L, luaH_luakit_selection);
408 return 1;
410 case L_TK_INSTALL_PATH:
411 lua_pushliteral(L, LUAKIT_INSTALL_PATH);
412 return 1;
414 case L_TK_CONFIG_DIR:
415 lua_pushstring(L, globalconf.config_dir);
416 return 1;
418 case L_TK_DATA_DIR:
419 lua_pushstring(L, globalconf.data_dir);
420 return 1;
422 case L_TK_CACHE_DIR:
423 lua_pushstring(L, globalconf.cache_dir);
424 return 1;
426 case L_TK_VERBOSE:
427 lua_pushboolean(L, globalconf.verbose);
428 return 1;
430 case L_TK_GET_SPECIAL_DIR:
431 lua_pushcfunction(L, luaH_luakit_get_special_dir);
432 return 1;
434 default:
435 break;
437 return 0;
440 /* Newindex function for the luakit global table.
441 * \param L The Lua VM state.
442 * \return The number of elements pushed on stack.
444 static gint
445 luaH_luakit_newindex(lua_State *L)
447 if(luaH_usemetatable(L, 1, 2))
448 return 1;
450 size_t len;
451 const gchar *buf = luaL_checklstring(L, 2, &len);
453 debug("Luakit newindex %s", buf);
455 return 0;
458 /* Add a global signal.
459 * Returns the number of elements pushed on stack.
460 * \luastack
461 * \lparam A string with the event name.
462 * \lparam The function to call.
464 static gint
465 luaH_luakit_add_signal(lua_State *L)
467 const gchar *name = luaL_checkstring(L, 1);
468 luaH_checkfunction(L, 2);
469 signal_add(globalconf.signals, name, luaH_object_ref(L, 2));
470 return 0;
473 /* Remove a global signal.
474 * \param L The Lua VM state.
475 * \return The number of elements pushed on stack.
476 * \luastack
477 * \lparam A string with the event name.
478 * \lparam The function to call.
480 static gint
481 luaH_luakit_remove_signal(lua_State *L)
483 const gchar *name = luaL_checkstring(L, 1);
484 luaH_checkfunction(L, 2);
485 gpointer func = (gpointer) lua_topointer(L, 2);
486 signal_remove(globalconf.signals, name, func);
487 luaH_object_unref(L, (void *) func);
488 return 0;
491 /* Emit a global signal.
492 * \param L The Lua VM state.
493 * \return The number of elements pushed on stack.
494 * \luastack
495 * \lparam A string with the event name.
496 * \lparam The function to call.
498 static gint
499 luaH_luakit_emit_signal(lua_State *L)
501 signal_object_emit(L, globalconf.signals, luaL_checkstring(L, 1), lua_gettop(L) - 1);
502 return 0;
505 static gint
506 luaH_panic(lua_State *L)
508 warn("unprotected error in call to Lua API (%s)", lua_tostring(L, -1));
509 return 0;
512 static gint
513 luaH_quit(lua_State *L)
515 (void) L;
516 gtk_main_quit();
517 return 0;
520 static gint
521 luaH_dofunction_on_error(lua_State *L)
523 /* duplicate string error */
524 lua_pushvalue(L, -1);
525 /* emit error signal */
526 signal_object_emit(L, globalconf.signals, "debug::error", 1);
528 if(!luaL_dostring(L, "return debug.traceback(\"error while running function\", 3)"))
530 /* Move traceback before error */
531 lua_insert(L, -2);
532 /* Insert sentence */
533 lua_pushliteral(L, "\nerror: ");
534 /* Move it before error */
535 lua_insert(L, -2);
536 lua_concat(L, 3);
538 return 1;
541 void
542 luaH_init(void)
544 lua_State *L;
546 static const struct luaL_reg luakit_lib[] = {
547 { "quit", luaH_quit },
548 { "add_signal", luaH_luakit_add_signal },
549 { "remove_signal", luaH_luakit_remove_signal },
550 { "emit_signal", luaH_luakit_emit_signal },
551 { "__index", luaH_luakit_index },
552 { "__newindex", luaH_luakit_newindex },
553 { NULL, NULL }
556 /* Lua VM init */
557 L = globalconf.L = luaL_newstate();
559 /* Set panic fuction */
560 lua_atpanic(L, luaH_panic);
562 /* Set error handling function */
563 lualib_dofunction_on_error = luaH_dofunction_on_error;
565 luaL_openlibs(L);
567 luaH_fixups(L);
569 luaH_object_setup(L);
571 /* Export luakit lib */
572 luaH_openlib(L, "luakit", luakit_lib, luakit_lib);
574 /* Export widget */
575 widget_class_setup(L);
577 /* add Lua search paths */
578 lua_getglobal(L, "package");
579 if(LUA_TTABLE != lua_type(L, 1)) {
580 warn("package is not a table");
581 return;
583 lua_getfield(L, 1, "path");
584 if(LUA_TSTRING != lua_type(L, 2)) {
585 warn("package.path is not a string");
586 lua_pop(L, 1);
587 return;
590 /* compile list of package search paths */
591 GPtrArray *paths = g_ptr_array_new_with_free_func(g_free);
593 #if DEVELOPMENT_PATHS
594 /* allows for testing luakit in the project directory */
595 g_ptr_array_add(paths, g_strdup("./lib"));
596 #endif
598 /* add users config dir (see: XDG_CONFIG_DIR) */
599 g_ptr_array_add(paths, g_build_filename(globalconf.config_dir, "lib", NULL));
601 /* add system config dirs (see: XDG_CONFIG_DIRS) */
602 const gchar* const *config_dirs = g_get_system_config_dirs();
603 for (; *config_dirs; config_dirs++)
604 g_ptr_array_add(paths, g_build_filename(*config_dirs, "luakit", "lib", NULL));
606 /* add luakit install path */
607 g_ptr_array_add(paths, g_build_filename(LUAKIT_INSTALL_PATH, "lib", NULL));
609 for (gpointer *path = paths->pdata; *path; path++) {
610 lua_pushliteral(L, ";");
611 lua_pushstring(L, *path);
612 lua_pushliteral(L, "/?.lua");
613 lua_concat(L, 3);
615 lua_pushliteral(L, ";");
616 lua_pushstring(L, *path);
617 lua_pushliteral(L, "/?/init.lua");
618 lua_concat(L, 3);
620 /* concat with package.path */
621 lua_concat(L, 3);
624 g_ptr_array_free(paths, TRUE);
626 /* package.path = "concatenated string" */
627 lua_setfield(L, 1, "path");
630 gboolean
631 luaH_loadrc(const gchar *confpath, gboolean run)
633 debug("Loading rc: %s", confpath);
634 lua_State *L = globalconf.L;
635 if(!luaL_loadfile(L, confpath)) {
636 if(run) {
637 if(lua_pcall(L, 0, LUA_MULTRET, 0)) {
638 g_fprintf(stderr, "%s\n", lua_tostring(L, -1));
639 } else
640 return TRUE;
641 } else
642 lua_pop(L, 1);
643 return TRUE;
644 } else
645 g_fprintf(stderr, "%s\n", lua_tostring(L, -1));
646 return FALSE;
649 /* Load a configuration file. */
650 gboolean
651 luaH_parserc(const gchar *confpath, gboolean run)
653 const gchar* const *config_dirs = NULL;
654 gboolean ret = FALSE;
655 GPtrArray *paths = NULL;
657 /* try to load, return if it's ok */
658 if(confpath) {
659 if(luaH_loadrc(confpath, run))
660 ret = TRUE;
661 goto bailout;
664 /* compile list of config search paths */
665 paths = g_ptr_array_new_with_free_func(g_free);
667 #if DEVELOPMENT_PATHS
668 /* allows for testing luakit in the project directory */
669 g_ptr_array_add(paths, g_strdup("./rc.lua"));
670 #endif
672 /* search users config dir (see: XDG_CONFIG_HOME) */
673 g_ptr_array_add(paths, g_build_filename(globalconf.config_dir, "rc.lua", NULL));
675 /* search system config dirs (see: XDG_CONFIG_DIRS) */
676 config_dirs = g_get_system_config_dirs();
677 for(; *config_dirs; config_dirs++)
678 g_ptr_array_add(paths, g_build_filename(*config_dirs, "luakit", "rc.lua", NULL));
680 for (gpointer *path = paths->pdata; *path; path++) {
681 if (file_exists(*path)) {
682 if(luaH_loadrc(*path, run)) {
683 globalconf.confpath = g_strdup(*path);
684 ret = TRUE;
685 goto bailout;
686 } else if(!run)
687 goto bailout;
691 bailout:
693 if (paths) g_ptr_array_free(paths, TRUE);
694 return ret;
697 gint
698 luaH_class_index_miss_property(lua_State *L, lua_object_t *obj)
700 (void) obj;
701 signal_object_emit(L, globalconf.signals, "debug::index::miss", 2);
702 return 0;
705 gint
706 luaH_class_newindex_miss_property(lua_State *L, lua_object_t *obj)
708 (void) obj;
709 signal_object_emit(L, globalconf.signals, "debug::newindex::miss", 3);
710 return 0;
713 // vim: ft=c:et:sw=4:ts=8:sts=4:tw=80