1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
|
--- Main window UI.
--
-- The window module builds the UI for each luakit window, and manages modes,
-- keybind state, and common functions like tab navigation and management.
--
-- @module window
-- @copyright 2017 Aidan Holm <aidanholm@gmail.com>
-- @copyright 2012 Mason Larobina <mason.larobina@gmail.com>
require "lfs"
local lousy = require("lousy")
local settings = require("settings")
local theme = lousy.theme.get()
local _M = {}
lousy.signal.setup(_M, true)
--- Map of `window` widgets to window class tables.
-- @type table
-- @readonly
_M.bywidget = setmetatable({}, { __mode = "k" })
-- Private data for windows
local w_priv = setmetatable({}, { __mode = "k" })
-- Widget construction aliases
local function entry() return widget{type="entry"} end
local function eventbox() return widget{type="eventbox"} end
local function hbox() return widget{type="hbox"} end
local function label() return widget{type="label"} end
local function notebook() return widget{type="notebook"} end
local function vbox() return widget{type="vbox"} end
local function overlay() return widget{type="overlay"} end
--- Construction function which will build and arrange the window's widgets.
-- @tparam table w The initial window class table.
function _M.build(w)
-- Create a table for widgets and state variables for a window
local ww = {
win = widget{type="window"},
ebox = eventbox(),
layout = vbox(),
tabs = notebook(),
-- Status bar widgets
sbar = {
layout = hbox(),
ebox = eventbox(),
-- Left aligned widgets
l = {
layout = hbox(),
ebox = eventbox(),
},
-- Fills space between the left and right aligned widgets
sep = eventbox(),
-- Right aligned widgets
r = {
layout = hbox(),
ebox = eventbox(),
},
},
-- Vertical menu window widget (completion results, bookmarks, qmarks, ..)
menu = lousy.widget.menu(),
menu_tabs = overlay(),
mbar = {
ebox = eventbox(),
label = label(),
},
-- Input bar widgets
ibar = {
layout = hbox(),
ebox = eventbox(),
prompt = label(),
input = entry(),
},
bar_layout = widget{type="stack"},
}
-- Replace values in w
for k, v in pairs(ww) do w[k] = v end
-- Tablist widget
w.tablist = lousy.widget.tablist(w.tabs, "horizontal")
w.ebox.child = w.layout
w.layout:pack(w.tablist.widget)
w.menu_tabs.child = w.tabs
w.win.child = w.ebox
w.layout:pack(w.menu_tabs, { expand = true, fill = true })
-- Pack left-aligned statusbar elements
local l = w.sbar.l
l.layout.homogeneous = false;
l.ebox.child = l.layout
-- Pack right-aligned statusbar elements
local r = w.sbar.r
r.layout.homogeneous = false;
r.ebox.child = r.layout
-- Pack status bar elements
local s = w.sbar
s.layout.homogeneous = false;
s.layout:pack(l.ebox)
s.layout:pack(s.sep, { expand = true, fill = true })
s.layout:pack(r.ebox)
s.ebox.child = s.layout
w.bar_layout:pack(s.ebox)
-- Pack message bar
local m = w.mbar
m.ebox.child = m.label
w.bar_layout:pack(m.ebox)
-- Pack menu widget
w.menu_tabs:pack(w.menu.widget, { halign = "fill", valign = "end" })
w.menu:hide()
-- Pack input bar
local i = w.ibar
i.layout.homogeneous = false;
i.layout:pack(i.prompt)
i.layout:pack(i.input, { expand = true, fill = true })
i.ebox.child = i.layout
w.bar_layout:pack(i.ebox)
i.input.css = "border: 0;"
i.layout.css = "transition: 0.0s ease-in-out;"
i.input.css = "transition: 0.0s ease-in-out;"
m.label.align = { v = "center" }
i.prompt.align = { v = "center" }
s.layout.align = { v = "center" }
w.bar_layout.homogeneous = true
w.layout:pack(w.bar_layout)
-- Other settings
i.input.show_frame = false
w.tabs.show_tabs = false
w.sbar.layout.margin_left = 3
w.sbar.layout.margin_right = 3
-- Allow error messages to be copied
-- TODO: *only* allow copying when showing an error
w.ibar.prompt.selectable = true
-- Allows indexing of window struct by window widget
_M.bywidget[w.win] = w
end
local function window_notebook_page_switch_cb (nb)
local w = _M.ancestor(nb)
if not w or w.tabs ~= nb then return end
w:set_mode()
w.view = nil
-- Update widgets after tab switch
luakit.idle_add(function ()
-- Cancel if window already destroyed
if not w.win then return end
w.view:emit_signal("switched-page")
w:update_win_title()
end)
end
local function set_window_notebook(w, nb)
assert(w_priv[w], "invalid window table")
assert(type(nb) == "widget" and nb.type, "invalid notebook widget")
local old_nb = w_priv[w].tabs
if old_nb then
old_nb:remove_signal("switch-page", window_notebook_page_switch_cb)
end
nb:add_signal("switch-page", window_notebook_page_switch_cb)
w_priv[w].tabs = nb
end
-- Table of functions to call on window creation. Normally used to add signal
-- handlers to the new windows widgets.
local init_funcs = {
last_win_check = function (w)
w.win:add_signal("destroy", function ()
-- call the quit function if this was the last window left
if #luakit.windows == 0 then luakit.quit() end
if w.close_win then w:close_win() end
end)
end,
key_press_match = function (w)
w.win:add_signal("key-press", function (_, mods, key, synthetic)
if synthetic and settings.get_setting("window.act_on_synthetic_keys") then
return false
end
-- Match & exec a bind
local success, match = xpcall(
function () return w:hit(mods, key) end,
function (err) w:error(debug.traceback(err, 3)) end)
if success and match then
return true
end
end)
end,
tablist_tab_click = function (w)
w.tablist:add_signal("tab-clicked", function (_, index, _, button)
if button == 1 then
w.tabs:switch(index)
return true
elseif button == 2 then
w:close_tab(w.tabs[index])
return true
end
end)
end,
apply_window_theme = function (w)
local s, m, i = w.sbar, w.mbar, w.ibar
-- Set foregrounds
for wi, v in pairs({
[i.prompt] = theme.prompt_ibar_fg,
[i.input] = theme.input_ibar_fg,
}) do wi.fg = v end
-- Set backgrounds
for wi, v in pairs({
[s.l.ebox] = theme.sbar_bg,
[s.r.ebox] = theme.sbar_bg,
[s.sep] = theme.sbar_bg,
[s.ebox] = theme.sbar_bg,
[i.ebox] = theme.ibar_bg,
[i.input] = theme.input_ibar_bg,
}) do wi.bg = v end
-- Set fonts
for wi, v in pairs({
[m.label] = theme.prompt_ibar_font,
[i.prompt] = theme.prompt_ibar_font,
[i.input] = theme.input_ibar_font,
}) do wi.font = v end
end,
set_default_size = function (w)
local size = settings.get_setting("window.new_window_size")
if string.match(size, "^%d+x%d+$") then
w.win:set_default_size(string.match(size, "^(%d+)x(%d+)$"))
else
msg.warn("invalid window size: %q", size)
end
end,
set_window_icon = function (w)
local path = (luakit.dev_paths and os.exists("./extras/luakit.png")) or
os.exists(luakit.install_paths.pixmap_dir .. "/luakit.png")
if path then w.win.icon = path end
end,
clear_urgency_hint = function (w)
w.win:add_signal("focus", function ()
w.win.urgency_hint = false
end)
end,
hide_ui_on_fullscreen = function (w)
w.win:add_signal("property::fullscreen", function (win)
w:update_sbar_visibility()
w.tablist.visible = not win.fullscreen
end)
end,
check_before_closing_last_window = function (w)
w.win:add_signal("can-close", function ()
return w:close_win() == nil and true or false
end)
end,
}
--- Helper functions which operate on the window widgets or structure.
-- @type {[string]=function}
-- @readwrite
_M.methods = {
-- Wrapper around the bind plugin's hit method
hit = function (w, mods, key, opts)
opts = lousy.util.table.join(opts or {}, {
enable_buffer = w:is_mode("normal"),
buffer = w.buffer,
})
local caught, newbuf = lousy.bind.hit(w, w.binds, mods, key, opts)
if w.win then -- Check binding didn't cause window to exit
w.buffer = newbuf
w:update_buf()
end
return caught
end,
-- Wrapper around the bind plugin's match_cmd method
match_cmd = function (w, buffer)
local get_mode = require("modes").get_mode
return lousy.bind.match_cmd(w, get_mode("command").binds, buffer)
end,
-- enter command or characters into command line
enter_cmd = function (w, cmd, opts)
w:set_mode("command")
w:set_input(cmd, opts)
end,
-- run command as if typed into the command line
run_cmd = function (w, cmd, opts)
cmd = cmd:find("^%:") and cmd or (":" .. cmd)
w:enter_cmd(cmd, opts)
-- Don't append to the mode's history
local mode, hist = w.mode, w.mode.history
w.mode.history = nil
w:activate()
mode.history = hist
end,
-- Emulates pressing the Return key in input field
activate = function (w)
w.ibar.input:emit_signal("activate")
end,
-- Shows a notification until the next keypress of the user.
notify = function (w, msg, set_mode)
if set_mode ~= false then w:set_mode() end
w:set_prompt(msg, { fg = theme.notif_fg, bg = theme.notif_bg })
end,
warning = function (w, msg, set_mode)
if set_mode ~= false then w:set_mode() end
w:set_prompt(msg, { fg = theme.warning_fg, bg = theme.warning_bg })
end,
error = function (w, msg, set_mode)
if set_mode ~= false then w:set_mode() end
w:set_prompt("Error: "..msg, { fg = theme.error_fg, bg = theme.error_bg })
end,
update_sbar_visibility = function (w)
if (not w.win.fullscreen) or w_priv[w].prompt_text or w_priv[w].input_text then
w.bar_layout.visible = true
else
w.bar_layout.visible = false
end
if w_priv[w].input_text then
w.bar_layout.visible_child = w.ibar.ebox
elseif w_priv[w].prompt_text then
w.bar_layout.visible_child = w.mbar.ebox
else
w.bar_layout.visible_child = w.sbar.ebox
end
end,
-- Set and display the prompt
set_prompt = function (w, text, opts)
opts = opts or {}
-- Set theme
local fg, bg = opts.fg or theme.ok.fg, opts.bg or theme.ok.bg
w.ibar.input.fg = fg
local function set_widget (prompt)
prompt.fg = fg
prompt.parent.bg = bg
-- Set text, or hide
if text then
prompt.text = opts.markup and text or lousy.util.escape(text)
prompt:show()
else
prompt:hide()
end
end
set_widget(w.ibar.prompt)
set_widget(w.mbar.label)
w_priv[w].prompt_text = text
w:update_sbar_visibility()
end,
-- Set display and focus the input bar
set_input = function (w, text, opts)
local input = w.ibar.input
opts = opts or {}
-- Set theme
local fg, bg = opts.fg or theme.ibar_fg, opts.bg or theme.ibar_bg
if input.fg ~= fg then input.fg = fg end
if input.bg ~= bg then input.bg = bg end
-- Set text or remain hidden
if text then
input.text = text
input:focus()
input.position = opts.pos or -1
end
w_priv[w].input_text = text
w:update_sbar_visibility()
end,
set_ibar_theme = function (w, name)
name = name or "ok"
local th = theme[name]
w.ibar.input.fg = th.fg
w.ibar.prompt.fg = th.fg
w.ibar.layout.bg = th.bg
end,
update_win_title = function (w)
local uri, title = w.view.uri, w.view.title
title = (title or "luakit") .. ((uri and " - " .. uri) or "")
local max = settings.get_setting("window.max_title_len")
if utf8.len(title) > max then
local suffix = "..."
title = title:sub(1, utf8.offset(title, max+1-#suffix)-1) .. suffix
assert(utf8.len(title) == max)
end
w.win.title = title
end,
update_buf = function () end,
update_binds = function (w, mode)
-- Generate the list of active key & buffer binds for this mode
local get_mode = require("modes").get_mode
w.binds = lousy.util.table.join((get_mode(mode) or {}).binds or {}, get_mode('all').binds or {})
-- Clear & hide buffer
w.buffer = nil
w:update_buf()
end,
new_tab = function (w, arg, opts)
assert(arg == nil or type(arg) == "string" or type(arg) == "table"
or (type(arg) == "widget" and arg.type == "webview"))
opts = opts or {}
assert(type(opts) == "table")
local switch, order = opts.switch, opts.order
-- Bit of a hack
local webview = require("webview")
local view
if type(arg) == "widget" and arg.type == "webview" then
view = arg
local ww = webview.window(view)
ww:detach_tab(view)
w:attach_tab(view, switch, order)
end
if not view and settings.get_setting("window.reuse_new_tab_pages") then
for _, tab in ipairs(w.tabs.children) do
if tab.uri == settings.get_setting("window.new_tab_page") then
msg.verbose("new_tab: using existing blank tab, %s", tab.uri)
view = tab
break
end
end
end
if not view then
-- Make new webview widget
view = webview.new({ private = opts.private })
w:attach_tab(view, switch, order)
end
if switch ~= false then w.tabs:switch(w.tabs:indexof(view)) end
if arg and not (type(arg) == "widget" and arg.type == "webview") then
w:search_open_navigate(view, arg)
end
return view
end,
-- close the current tab
close_tab = function (w, view, blank_last)
assert(view == nil or (type(view) == "widget" and view.type == "webview"))
view = view or w.view
w:emit_signal("close-tab", view)
w:detach_tab(view, blank_last)
view:destroy()
end,
attach_tab = function (w, view, switch, order)
assert(view == nil or (type(view) == "widget" and view.type == "webview"))
local taborder = package.loaded.taborder
-- Get tab order function
if not order and taborder then
order = (switch == false and taborder.default_bg)
or taborder.default
end
w.tabs:insert((order and order(w, view)) or -1, view)
end,
detach_tab = function (w, view, blank_last)
assert(view == nil or (type(view) == "widget" and view.type == "webview"))
view = view or w.view
w:emit_signal("detach-tab", view)
view.parent:remove(view)
if settings.get_setting("window.close_with_last_tab") == true and w.tabs:count() == 0 then
w:close_win()
end
-- Treat a blank last tab as an empty notebook (if blank_last=true)
if blank_last ~= false and w.tabs:count() == 0 then
w:new_tab(settings.get_setting("window.new_tab_page"), false)
end
end,
can_quit = function (w)
-- Ask plugins if it's OK to close last window
local emsg = luakit.emit_signal("can-close")
if emsg then
assert(type(emsg) == "string", "invalid exit error message")
w:error(string.format("Can't close luakit: %s (force close "
.. "with :q! or :wq!)", emsg))
return false
else
return true
end
end,
close_win = function (w, force)
if w_priv[w].closing then return end
if not force and (#luakit.windows == 1) and not w:can_quit() then
return false
end
w_priv[w].closing = true
w:emit_signal("close")
-- Close all tabs
while w.tabs:count() ~= 0 do
w:close_tab(nil, false)
end
-- Destroy tablist
w.tablist:destroy()
-- Remove from window index
_M.bywidget[w.win] = nil
w_priv[w] = nil
-- Clear window struct
w = setmetatable(w, {})
-- Recursively remove widgets from window
local children = lousy.util.recursive_remove(w.win)
-- Destroy all widgets
for _, c in ipairs(lousy.util.table.join(children, {w.win})) do
if c.hide then c:hide() end
c:destroy()
end
-- Remove all window table vars
for k, _ in pairs(w) do w[k] = nil end
-- Quit if closed last window
if #luakit.windows == 0 then luakit.quit() end
end,
-- Navigate current view or open new tab
navigate = function (w, arg, view)
assert(arg == nil or type(arg) == "string" or type(arg) == "table")
assert(view == nil or (type(view) == "widget" and view.type == "webview"))
if not view then view = w.view end
if view and arg then
w:search_open_navigate(view, arg)
else
w:new_tab(arg)
end
end,
-- Wrap @ref{set_location} to filter a string argument through @ref{search_open}
-- @tparam widget view The view whose location to modify.
-- @tparam table arg The new location. Can be a query to search, a URI,
-- a JavaScript URI, or a table with `session_state` and `uri` keys.
search_open_navigate = function (w, view, arg)
assert(type(view) == "widget" and view.type == "webview")
assert(type(arg) == "string" or type(arg) == "table" or type(arg) == "widget")
if type(arg) == "widget" then assert(arg.type == "webview") end
if type(arg) == "string" then arg = w:search_open(arg) end
require("webview").set_location(view, arg)
end,
-- Save, restart luakit and reload session.
restart = function (w, force)
if not force and not w:can_quit() then
return false
end
-- Generate luakit launch command.
local args = {({string.gsub(luakit.execpath, " ", "\\ ")})[1]}
for _, arg in ipairs(luakit.options) do
table.insert(args, arg)
end
-- Get new config path
local conf = assert(luakit.confpath)
-- Check config has valid syntax
local cmd = table.concat(args, " ")
if luakit.spawn_sync(cmd .. " -k -c " .. conf) ~= 0 then
return w:error("Cannot restart, syntax error in configuration file: "..conf)
end
-- Save session.
require("session").save()
-- Replace current process with new luakit instance.
luakit.exec(cmd)
end,
-- Intelligent open command which can detect a uri or search argument.
search_open = function (_, arg)
local lstring = lousy.util.string
local search_engines = settings.get_setting("window.search_engines")
-- Detect blank uris
if not arg or arg:match("^%s*$") then return settings.get_setting("window.new_tab_page") end
arg = lstring.strip(arg)
-- Handle JS and file URI before splitting arg
if arg:find("^javascript:") then return arg end
if settings.get_setting("window.check_filepath") then
local path = arg:gsub("^file://", "")
if lfs.attributes(path) then return "file://" .. path end
end
local args = lstring.split(arg)
-- Guess if single argument is an address, etc.
if #args == 1 and not search_engines[arg] and lousy.uri.is_uri(arg) then
return arg
end
-- Find search engine (or use default_search_engine)
local engine = settings.get_setting("window.default_search_engine")
if args[1] and search_engines[args[1]] then
engine = args[1]
table.remove(args, 1)
end
local e = search_engines[engine] or "%s"
local terms = table.concat(args, " ")
if type(e) == "string" then
if e:find("%%", 1, true) then
return string.format(e, luakit.uri_encode(terms))
end
terms = luakit.uri_encode(terms):gsub("%%", "%%%%")
return ({e:gsub("%%s", terms)})[1]
else
return e(terms)
end
end,
-- Increase (or decrease) the last found number in the current uri
inc_uri = function (w, arg)
local uri = string.gsub(w.view.uri, "(%d+)([^0-9]*)$", function (num, rest)
return string.format("%0"..#num.."d", tonumber(num) + (arg or 1)) .. rest
end)
return uri
end,
-- Tab traversing functions
next_tab = function (w, n)
w.tabs:switch((((n or 1) + w.tabs:current() -1) % w.tabs:count()) + 1)
end,
prev_tab = function (w, n)
w.tabs:switch(((w.tabs:current() - (n or 1) -1) % w.tabs:count()) + 1)
end,
goto_tab = function (w, n)
if n and (n == -1 or n > 0) then
return w.tabs:switch((n <= w.tabs:count() and n) or -1)
end
end,
-- For each tab, switches to that tab and calls the given function passing
-- it the view contained in the tab.
each_tab = function (w, fn)
for index = 1, w.tabs:count() do
w:goto_tab(index)
fn(w.tabs[index])
end
end,
-- If argument is form-active or root-active, emits signal. Ignores all
-- other signals.
emit_form_root_active_signal = function (w, s)
if s == "form-active" then
w.view:emit_signal("form-active")
elseif s == "root-active" then
w.view:emit_signal("root-active")
end
end,
}
--- Ordered list of class index functions. Other classes (E.g. webview) are able
-- to add their own index functions to this list.
-- @type {function}
-- @readwrite
_M.indexes = {
-- Find function in window.methods first
function (_, k) return _M.methods[k] end,
function (w, k) return k == "tabs" and w_priv[w].tabs or nil end,
}
_M.add_signal("build", _M.build)
--- Create a new window table instance.
-- @tparam table args Array of initial tab arguments.
-- @treturn table The newly-created window table.
function _M.new(args)
local w = {}
w_priv[w] = {}
-- Set window metatable
setmetatable(w, {
__index = function (_, k)
-- Call each window index function
for _, index in ipairs(_M.indexes) do
local v = index(w, k)
if v then return v end
end
end,
__newindex = function (_, k, v)
if k == "tabs" then return set_window_notebook(w, v) end
rawset(w, k, v)
end
})
-- Setup window widget for signals
lousy.signal.setup(w)
_M.emit_signal("build", w)
-- Call window init functions
for _, func in pairs(init_funcs) do
func(w)
end
_M.emit_signal("init", w)
-- Populate notebook with tabs
for _, arg in ipairs(args or {}) do
w:new_tab(arg)
end
-- Show window
w.win:show()
-- Set initial mode
w:set_mode()
-- Make sure something is loaded
if w.tabs:count() == 0 then
w:new_tab(settings.get_setting("window.home_page"), false)
end
return w
end
--- Get the window that contains the given widget.
-- @tparam widget w The widget whose ancestor to find.
-- @treturn table|nil The window class table for the window that contains `w`,
-- or `nil` if the given widget is not contained within a window.
function _M.ancestor(w)
repeat
w = w.parent
until w == nil or w.type == "window"
return w and _M.bywidget[w] or nil
end
settings.register_settings({
["window.act_on_synthetic_keys"] = {
type = "boolean",
default = false,
desc = [=[
Whether synthetic key events should activate key bindings.
Synthetic key events have been generated by a program rather than a physical key press,
such as those sent by keysym.send().
]=],
},
["window.new_window_size"] = {
type = "string",
default = "800x600",
validator = function (v)
local x, y = v:match("^(%d+)x(%d+)$")
if not x or not y then return false end
return tonumber(x) > 0 and tonumber(y) > 0
end,
desc = [=[
The size (in pixels) of newly-opened windows.
Must be in the form `WxY`, where `W` and `H` are the width and height respectively.
]=],
},
["window.home_page"] = {
type = "string",
default = "https://luakit.github.io/",
desc = "The URI of the home page.",
},
["window.new_tab_page"] = {
type = "string",
default = "about:blank",
desc = "The URI to open when opening a new tab.",
},
["window.reuse_new_tab_pages"] = {
type = "boolean",
default = false,
desc = [=[
Let w:new_tab use an existing view that is on `window.new_tab_page`.
Avoids unnecessarily creating new tabs, possibly multiple instances of `window.new_tab_page`.
]=],
},
["window.close_with_last_tab"] = {
type = "boolean",
default = false,
desc = "Luakit windows should close after all of their tabs are closed.",
},
["window.search_engines"] = {
type = "string:",
default = {
duckduckgo = "https://duckduckgo.com/?q=%s",
github = "https://github.com/search?q=%s",
google = "https://google.com/search?q=%s",
imdb = "https://www.imdb.com/find?s=all&q=%s",
wikipedia = "https://en.wikipedia.org/wiki/Special:Search?search=%s",
debbugs = "https://bugs.debian.org/%s",
default = "https://duckduckgo.com/?q=%s",
},
desc = "The set of search engine shortcuts.",
formatter = function (t, k)
local v
if type(t[k]) == "string" then
v = t[k]:gsub("%%s", [[<span style="color:#060;font-weight:bold;">%%s</span>]])
else
v = [[<span style="font-style:italic;color:#333;">function</span>]]
end
return {
key = [==[<span style="font-family:monospace;">]==]..k..[==[</span>]==],
value = [==[<span style="font-family:monospace;">]==]..v..[==[</span>]==],
}
end,
},
["window.default_search_engine"] = {
type = "string",
default = "default",
validator = function (v) return settings.get_setting("window.search_engines")[v] end,
desc = [=[
The default search engine alias.
Must be a key of `window.search_engines`.
]=],
},
["window.scroll_step"] = {
type = "number", min = 0,
default = 40,
desc = "The size (in pixels) of the scroll step.",
},
["window.zoom_step"] = {
type = "number", min = 0,
default = 0.1,
desc = "The size of the zoom step, expressed as a multiplicative factor.",
},
["window.load_etc_hosts"] = {
type = "boolean",
default = true,
desc = "Whether `/etc/hosts` should be used when parsing URIs.",
},
["window.check_filepath"] = {
type = "boolean",
default = true,
desc = "Whether opening a URI should check for local files.",
},
["window.max_title_len"] = {
type = "number",
default = 80,
desc = "The maximum length of the window title.",
},
})
settings.migrate_global("window.act_on_synthetic_keys", "act_on_synthetic_keys")
settings.migrate_global("window.new_window_size", "default_window_size")
settings.migrate_global("window.home_page", "homepage")
settings.migrate_global("window.scroll_step", "scroll_step")
settings.migrate_global("window.zoom_step", "zoom_step")
settings.migrate_global("window.load_etc_hosts", "load_etc_hosts")
settings.migrate_global("window.check_filepath", "check_filepath")
settings.migrate_global("window.max_title_len", "max_title_len")
local globals = package.loaded.globals
if globals then
settings.window.search_engines = globals.search_engines
end
local vulnerable_luakit = tonumber(luakit.webkit_version:match("^2%.(%d+)%.")) < 18
if vulnerable_luakit then
luakit.idle_add(function ()
msg.warn([[your version of WebKit (%s) is outdated and vulnerable!
See https://webkitgtk.org/security/WSA-2017-0009.html for details.]], luakit.webkit_version)
end)
end
return _M
-- vim: et:sw=4:ts=8:sts=4:tw=80
|