603 lines
22 KiB
Lua
603 lines
22 KiB
Lua
---------------------------------------------------------------------------
|
|
--- Popup widget which shows current hotkeys and their descriptions.
|
|
--
|
|
-- @author Yauheni Kirylau <yawghen@gmail.com>
|
|
-- @copyright 2014-2015 Yauheni Kirylau
|
|
-- @module awful.hotkeys_popup.widget
|
|
---------------------------------------------------------------------------
|
|
|
|
local capi = {
|
|
screen = screen,
|
|
client = client,
|
|
keygrabber = keygrabber,
|
|
}
|
|
local awful = require("awful")
|
|
local gtable = require("gears.table")
|
|
local gstring = require("gears.string")
|
|
local wibox = require("wibox")
|
|
local beautiful = require("beautiful")
|
|
local dpi = beautiful.xresources.apply_dpi
|
|
|
|
|
|
-- Stripped copy of this module https://github.com/copycat-killer/lain/blob/master/util/markup.lua:
|
|
local markup = {}
|
|
-- Set the font.
|
|
function markup.font(font, text)
|
|
return '<span font="' .. tostring(font) .. '">' .. tostring(text) ..'</span>'
|
|
end
|
|
-- Set the foreground.
|
|
function markup.fg(color, text)
|
|
return '<span foreground="' .. tostring(color) .. '">' .. tostring(text) .. '</span>'
|
|
end
|
|
-- Set the background.
|
|
function markup.bg(color, text)
|
|
return '<span background="' .. tostring(color) .. '">' .. tostring(text) .. '</span>'
|
|
end
|
|
|
|
local function join_plus_sort(modifiers)
|
|
if #modifiers<1 then return "none" end
|
|
table.sort(modifiers)
|
|
return table.concat(modifiers, '+')
|
|
end
|
|
|
|
local function get_screen(s)
|
|
return s and capi.screen[s]
|
|
end
|
|
|
|
|
|
local widget = {
|
|
group_rules = {},
|
|
}
|
|
|
|
--- Don't show hotkeys without descriptions.
|
|
widget.hide_without_description = true
|
|
|
|
--- Merge hotkey records into one if they have the same modifiers and
|
|
-- description.
|
|
widget.merge_duplicates = true
|
|
|
|
|
|
--- Hotkeys widget background color.
|
|
-- @beautiful beautiful.hotkeys_bg
|
|
-- @tparam color hotkeys_bg
|
|
|
|
--- Hotkeys widget foreground color.
|
|
-- @beautiful beautiful.hotkeys_fg
|
|
-- @tparam color hotkeys_fg
|
|
|
|
--- Hotkeys widget border width.
|
|
-- @beautiful beautiful.hotkeys_border_width
|
|
-- @tparam int hotkeys_border_width
|
|
|
|
--- Hotkeys widget border color.
|
|
-- @beautiful beautiful.hotkeys_border_color
|
|
-- @tparam color hotkeys_border_color
|
|
|
|
--- Hotkeys widget shape.
|
|
-- @beautiful beautiful.hotkeys_shape
|
|
-- @tparam[opt] gears.shape hotkeys_shape
|
|
-- @see gears.shape
|
|
|
|
--- Foreground color used for hotkey modifiers (Ctrl, Alt, Super, etc).
|
|
-- @beautiful beautiful.hotkeys_modifiers_fg
|
|
-- @tparam color hotkeys_modifiers_fg
|
|
|
|
--- Background color used for miscellaneous labels of hotkeys widget.
|
|
-- @beautiful beautiful.hotkeys_label_bg
|
|
-- @tparam color hotkeys_label_bg
|
|
|
|
--- Foreground color used for hotkey groups and other labels.
|
|
-- @beautiful beautiful.hotkeys_label_fg
|
|
-- @tparam color hotkeys_label_fg
|
|
|
|
--- Main hotkeys widget font.
|
|
-- @beautiful beautiful.hotkeys_font
|
|
-- @tparam string|lgi.Pango.FontDescription hotkeys_font
|
|
|
|
--- Font used for hotkeys' descriptions.
|
|
-- @beautiful beautiful.hotkeys_description_font
|
|
-- @tparam string|lgi.Pango.FontDescription hotkeys_description_font
|
|
|
|
--- Margin between hotkeys groups.
|
|
-- @beautiful beautiful.hotkeys_group_margin
|
|
-- @tparam int hotkeys_group_margin
|
|
|
|
|
|
--- Create an instance of widget with hotkeys help.
|
|
-- @tparam[opt] table args Configuration options for the widget.
|
|
-- @tparam[opt] boolean args.hide_without_description Don't show hotkeys without descriptions.
|
|
-- @tparam[opt] boolean args.merge_duplicates Merge hotkey records into one if
|
|
-- they have the same modifiers and description.
|
|
-- @tparam[opt] int args.width Widget width.
|
|
-- @tparam[opt] int args.height Widget height.
|
|
-- @tparam[opt] color args.bg Widget background color.
|
|
-- @tparam[opt] color args.fg Widget foreground color.
|
|
-- @tparam[opt] int args.border_width Border width.
|
|
-- @tparam[opt] color args.border_color Border color.
|
|
-- @tparam[opt] gears.shape args.shape Widget shape.
|
|
-- @tparam[opt] string|lgi.Pango.FontDescription args.font Main widget font.
|
|
-- @tparam[opt] string|lgi.Pango.FontDescription args.description_font Font used for hotkeys' descriptions.
|
|
-- @tparam[opt] color args.modifiers_fg Foreground color used for hotkey
|
|
-- modifiers (Ctrl, Alt, Super, etc).
|
|
-- @tparam[opt] color args.label_bg Background color used for miscellaneous labels.
|
|
-- @tparam[opt] color args.label_fg Foreground color used for group and other
|
|
-- labels.
|
|
-- @tparam[opt] int args.group_margin Margin between hotkeys groups.
|
|
-- @tparam[opt] table args.labels Labels used for displaying human-readable keynames.
|
|
-- @tparam[opt] table args.group_rules Rules for showing 3rd-party hotkeys. @see `awful.hotkeys_popup.keys.vim`.
|
|
-- @return Widget instance.
|
|
function widget.new(args)
|
|
args = args or {}
|
|
local widget_instance = {
|
|
hide_without_description = (
|
|
args.hide_without_description == nil
|
|
) and widget.hide_without_description or args.hide_without_description,
|
|
merge_duplicates = (
|
|
args.merge_duplicates == nil
|
|
) and widget.merge_duplicates or args.merge_duplicates,
|
|
group_rules = args.group_rules or gtable.clone(widget.group_rules),
|
|
labels = args.labels or {
|
|
Mod4="Super",
|
|
Mod1="Alt",
|
|
Escape="Esc",
|
|
Insert="Ins",
|
|
Delete="Del",
|
|
Backspace="BackSpc",
|
|
Return="Enter",
|
|
Next="PgDn",
|
|
Prior="PgUp",
|
|
['#108']="Alt Gr",
|
|
Left='←',
|
|
Up='↑',
|
|
Right='→',
|
|
Down='↓',
|
|
['#67']="F1",
|
|
['#68']="F2",
|
|
['#69']="F3",
|
|
['#70']="F4",
|
|
['#71']="F5",
|
|
['#72']="F6",
|
|
['#73']="F7",
|
|
['#74']="F8",
|
|
['#75']="F9",
|
|
['#76']="F10",
|
|
['#95']="F11",
|
|
['#96']="F12",
|
|
['#10']="1",
|
|
['#11']="2",
|
|
['#12']="3",
|
|
['#13']="4",
|
|
['#14']="5",
|
|
['#15']="6",
|
|
['#16']="7",
|
|
['#17']="8",
|
|
['#18']="9",
|
|
['#19']="0",
|
|
['#20']="-",
|
|
['#21']="=",
|
|
Control="Ctrl"
|
|
},
|
|
_additional_hotkeys = {},
|
|
_cached_wiboxes = {},
|
|
_cached_awful_keys = nil,
|
|
_colors_counter = {},
|
|
_group_list = {},
|
|
_widget_settings_loaded = false,
|
|
}
|
|
|
|
|
|
function widget_instance:_load_widget_settings()
|
|
if self._widget_settings_loaded then return end
|
|
self.width = args.width or dpi(1200)
|
|
self.height = args.height or dpi(800)
|
|
self.bg = args.bg or
|
|
beautiful.hotkeys_bg or beautiful.bg_normal
|
|
self.fg = args.fg or
|
|
beautiful.hotkeys_fg or beautiful.fg_normal
|
|
self.border_width = args.border_width or
|
|
beautiful.hotkeys_border_width or beautiful.border_width
|
|
self.border_color = args.border_color or
|
|
beautiful.hotkeys_border_color or self.fg
|
|
self.shape = args.shape or beautiful.hotkeys_shape
|
|
self.modifiers_fg = args.modifiers_fg or
|
|
beautiful.hotkeys_modifiers_fg or beautiful.bg_minimize or "#555555"
|
|
self.label_bg = args.label_bg or
|
|
beautiful.hotkeys_label_bg or self.fg
|
|
self.label_fg = args.label_fg or
|
|
beautiful.hotkeys_label_fg or self.bg
|
|
self.opacity = args.opacity or
|
|
beautiful.hotkeys_opacity or 1
|
|
self.font = args.font or
|
|
beautiful.hotkeys_font or "Monospace Bold 9"
|
|
self.description_font = args.description_font or
|
|
beautiful.hotkeys_description_font or "Monospace 8"
|
|
self.group_margin = args.group_margin or
|
|
beautiful.hotkeys_group_margin or dpi(6)
|
|
self.label_colors = beautiful.xresources.get_current_theme()
|
|
self._widget_settings_loaded = true
|
|
end
|
|
|
|
|
|
function widget_instance:_get_next_color(id)
|
|
id = id or "default"
|
|
if self._colors_counter[id] then
|
|
self._colors_counter[id] = math.fmod(self._colors_counter[id] + 1, 15) + 1
|
|
else
|
|
self._colors_counter[id] = 1
|
|
end
|
|
return self.label_colors["color"..tostring(self._colors_counter[id], 15)]
|
|
end
|
|
|
|
|
|
function widget_instance:_add_hotkey(key, data, target)
|
|
if self.hide_without_description and not data.description then return end
|
|
|
|
local readable_mods = {}
|
|
for _, mod in ipairs(data.mod) do
|
|
table.insert(readable_mods, self.labels[mod] or mod)
|
|
end
|
|
local joined_mods = join_plus_sort(readable_mods)
|
|
|
|
local group = data.group or "none"
|
|
self._group_list[group] = true
|
|
if not target[group] then target[group] = {} end
|
|
local new_key = {
|
|
key = (self.labels[key] or key),
|
|
mod = joined_mods,
|
|
description = data.description
|
|
}
|
|
local index = data.description or "none" -- or use its hash?
|
|
if not target[group][index] then
|
|
target[group][index] = new_key
|
|
else
|
|
if self.merge_duplicates and joined_mods == target[group][index].mod then
|
|
target[group][index].key = target[group][index].key .. "/" .. new_key.key
|
|
else
|
|
while target[group][index] do
|
|
index = index .. " "
|
|
end
|
|
target[group][index] = new_key
|
|
end
|
|
end
|
|
end
|
|
|
|
|
|
function widget_instance:_sort_hotkeys(target)
|
|
for group, _ in pairs(self._group_list) do
|
|
if target[group] then
|
|
local sorted_table = {}
|
|
for _, key in pairs(target[group]) do
|
|
table.insert(sorted_table, key)
|
|
end
|
|
table.sort(
|
|
sorted_table,
|
|
function(a,b) return (a.mod or '')..a.key<(b.mod or '')..b.key end
|
|
)
|
|
target[group] = sorted_table
|
|
end
|
|
end
|
|
end
|
|
|
|
|
|
function widget_instance:_import_awful_keys()
|
|
if self._cached_awful_keys then
|
|
return
|
|
end
|
|
self._cached_awful_keys = {}
|
|
for _, data in pairs(awful.key.hotkeys) do
|
|
self:_add_hotkey(data.key, data, self._cached_awful_keys)
|
|
end
|
|
self:_sort_hotkeys(self._cached_awful_keys)
|
|
end
|
|
|
|
|
|
function widget_instance:_group_label(group, color)
|
|
local textbox = wibox.widget.textbox(
|
|
markup.font(self.font,
|
|
markup.bg(
|
|
color or (self.group_rules[group] and
|
|
self.group_rules[group].color or self:_get_next_color("group_title")
|
|
),
|
|
markup.fg(self.label_fg, " "..group.." ")
|
|
)
|
|
)
|
|
)
|
|
local margin = wibox.container.margin()
|
|
margin:set_widget(textbox)
|
|
margin:set_top(self.group_margin)
|
|
return margin
|
|
end
|
|
|
|
|
|
function widget_instance:_create_wibox(s, available_groups)
|
|
s = get_screen(s)
|
|
local wa = s.workarea
|
|
local height = (self.height < wa.height) and self.height or
|
|
(wa.height - self.border_width * 2)
|
|
local width = (self.width < wa.width) and self.width or
|
|
(wa.width - self.border_width * 2)
|
|
|
|
-- arrange hotkey groups into columns
|
|
local line_height = beautiful.get_font_height(self.font)
|
|
local group_label_height = line_height + self.group_margin
|
|
-- -1 for possible pagination:
|
|
local max_height_px = height - group_label_height
|
|
local column_layouts = {}
|
|
for _, group in ipairs(available_groups) do
|
|
local keys = gtable.join(self._cached_awful_keys[group], self._additional_hotkeys[group])
|
|
local joined_descriptions = ""
|
|
for i, key in ipairs(keys) do
|
|
joined_descriptions = joined_descriptions .. key.description .. (i~=#keys and "\n" or "")
|
|
end
|
|
-- +1 for group label:
|
|
local items_height = gstring.linecount(joined_descriptions) * line_height + group_label_height
|
|
local current_column
|
|
local available_height_px = max_height_px
|
|
local add_new_column = true
|
|
for i, column in ipairs(column_layouts) do
|
|
if ((column.height_px + items_height) < max_height_px) or
|
|
(i == #column_layouts and column.height_px < max_height_px / 2)
|
|
then
|
|
current_column = column
|
|
add_new_column = false
|
|
available_height_px = max_height_px - current_column.height_px
|
|
break
|
|
end
|
|
end
|
|
local overlap_leftovers
|
|
if items_height > available_height_px then
|
|
local new_keys = {}
|
|
overlap_leftovers = {}
|
|
-- +1 for group title and +1 for possible hyphen (v):
|
|
local available_height_items = (available_height_px - group_label_height*2) / line_height
|
|
for i=1,#keys do
|
|
table.insert(((i<available_height_items) and new_keys or overlap_leftovers), keys[i])
|
|
end
|
|
keys = new_keys
|
|
table.insert(keys, {key=markup.fg(self.modifiers_fg, "▽"), description=""})
|
|
end
|
|
if not current_column then
|
|
current_column = {layout=wibox.layout.fixed.vertical()}
|
|
end
|
|
current_column.layout:add(self:_group_label(group))
|
|
|
|
local function insert_keys(_keys, _add_new_column)
|
|
local max_label_width = 0
|
|
local max_label_content = ""
|
|
local joined_labels = ""
|
|
for i, key in ipairs(_keys) do
|
|
local length = string.len(key.key or '') + string.len(key.description or '')
|
|
local modifiers = key.mod
|
|
if not modifiers or modifiers == "none" then
|
|
modifiers = ""
|
|
else
|
|
length = length + string.len(modifiers) + 1 -- +1 for "+" character
|
|
modifiers = markup.fg(self.modifiers_fg, modifiers.."+")
|
|
end
|
|
local rendered_hotkey = markup.font(self.font,
|
|
modifiers .. (key.key or "") .. " "
|
|
) .. markup.font(self.description_font,
|
|
key.description or ""
|
|
)
|
|
if length > max_label_width then
|
|
max_label_width = length
|
|
max_label_content = rendered_hotkey
|
|
end
|
|
joined_labels = joined_labels .. rendered_hotkey .. (i~=#_keys and "\n" or "")
|
|
end
|
|
current_column.layout:add(wibox.widget.textbox(joined_labels))
|
|
local max_width, _ = wibox.widget.textbox(max_label_content):get_preferred_size(s)
|
|
max_width = max_width + self.group_margin
|
|
if not current_column.max_width or max_width > current_column.max_width then
|
|
current_column.max_width = max_width
|
|
end
|
|
-- +1 for group label:
|
|
current_column.height_px = (current_column.height_px or 0) +
|
|
gstring.linecount(joined_labels)*line_height + group_label_height
|
|
if _add_new_column then
|
|
table.insert(column_layouts, current_column)
|
|
end
|
|
end
|
|
|
|
insert_keys(keys, add_new_column)
|
|
if overlap_leftovers then
|
|
current_column = {layout=wibox.layout.fixed.vertical()}
|
|
insert_keys(overlap_leftovers, true)
|
|
end
|
|
end
|
|
|
|
-- arrange columns into pages
|
|
local available_width_px = width
|
|
local pages = {}
|
|
local columns = wibox.layout.fixed.horizontal()
|
|
local previous_page_last_layout
|
|
for _, item in ipairs(column_layouts) do
|
|
if item.max_width > available_width_px then
|
|
previous_page_last_layout:add(
|
|
self:_group_label("PgDn - Next Page", self.label_bg)
|
|
)
|
|
table.insert(pages, columns)
|
|
columns = wibox.layout.fixed.horizontal()
|
|
available_width_px = width - item.max_width
|
|
item.layout:insert(
|
|
1, self:_group_label("PgUp - Prev Page", self.label_bg)
|
|
)
|
|
else
|
|
available_width_px = available_width_px - item.max_width
|
|
end
|
|
local column_margin = wibox.container.margin()
|
|
column_margin:set_widget(item.layout)
|
|
column_margin:set_left(self.group_margin)
|
|
columns:add(column_margin)
|
|
previous_page_last_layout = item.layout
|
|
end
|
|
table.insert(pages, columns)
|
|
|
|
local mywibox = wibox({
|
|
ontop = true,
|
|
bg=self.bg,
|
|
fg=self.fg,
|
|
opacity = self.opacity,
|
|
border_width = self.border_width,
|
|
border_color = self.border_color,
|
|
shape = self.shape,
|
|
})
|
|
mywibox:geometry({
|
|
x = wa.x + math.floor((wa.width - width - self.border_width*2) / 2),
|
|
y = wa.y + math.floor((wa.height - height - self.border_width*2) / 2),
|
|
width = width,
|
|
height = height,
|
|
})
|
|
mywibox:set_widget(pages[1])
|
|
mywibox:buttons(gtable.join(
|
|
awful.button({ }, 1, function () mywibox.visible=false end),
|
|
awful.button({ }, 3, function () mywibox.visible=false end)
|
|
))
|
|
|
|
local widget_obj = {}
|
|
widget_obj.current_page = 1
|
|
widget_obj.wibox = mywibox
|
|
function widget_obj.page_next(_self)
|
|
if _self.current_page == #pages then return end
|
|
_self.current_page = _self.current_page + 1
|
|
_self.wibox:set_widget(pages[_self.current_page])
|
|
end
|
|
function widget_obj.page_prev(_self)
|
|
if _self.current_page == 1 then return end
|
|
_self.current_page = _self.current_page - 1
|
|
_self.wibox:set_widget(pages[_self.current_page])
|
|
end
|
|
function widget_obj.show(_self)
|
|
_self.wibox.visible = true
|
|
end
|
|
function widget_obj.hide(_self)
|
|
_self.wibox.visible = false
|
|
end
|
|
|
|
return widget_obj
|
|
end
|
|
|
|
|
|
--- Show popup with hotkeys help.
|
|
-- @tparam[opt] client c Client.
|
|
-- @tparam[opt] screen s Screen.
|
|
function widget_instance:show_help(c, s)
|
|
self:_import_awful_keys()
|
|
self:_load_widget_settings()
|
|
|
|
c = c or capi.client.focus
|
|
s = s or (c and c.screen or awful.screen.focused())
|
|
|
|
local available_groups = {}
|
|
for group, _ in pairs(self._group_list) do
|
|
local need_match
|
|
for group_name, data in pairs(self.group_rules) do
|
|
if group_name==group and (
|
|
data.rule or data.rule_any or data.except or data.except_any
|
|
) then
|
|
if not c or not awful.rules.matches(c, {
|
|
rule=data.rule,
|
|
rule_any=data.rule_any,
|
|
except=data.except,
|
|
except_any=data.except_any
|
|
}) then
|
|
need_match = true
|
|
break
|
|
end
|
|
end
|
|
end
|
|
if not need_match then table.insert(available_groups, group) end
|
|
end
|
|
|
|
local joined_groups = join_plus_sort(available_groups)
|
|
if not self._cached_wiboxes[s] then
|
|
self._cached_wiboxes[s] = {}
|
|
end
|
|
if not self._cached_wiboxes[s][joined_groups] then
|
|
self._cached_wiboxes[s][joined_groups] = self:_create_wibox(s, available_groups)
|
|
end
|
|
local help_wibox = self._cached_wiboxes[s][joined_groups]
|
|
help_wibox:show()
|
|
|
|
return capi.keygrabber.run(function(_, key, event)
|
|
if event == "release" then return end
|
|
if key then
|
|
if key == "Next" then
|
|
help_wibox:page_next()
|
|
elseif key == "Prior" then
|
|
help_wibox:page_prev()
|
|
else
|
|
capi.keygrabber.stop()
|
|
help_wibox:hide()
|
|
end
|
|
end
|
|
end)
|
|
end
|
|
|
|
--- Add hotkey descriptions for third-party applications.
|
|
-- @tparam table hotkeys Table with bindings,
|
|
-- see `awful.hotkeys_popup.key.vim` as an example.
|
|
function widget_instance:add_hotkeys(hotkeys)
|
|
for group, bindings in pairs(hotkeys) do
|
|
for _, binding in ipairs(bindings) do
|
|
local modifiers = binding.modifiers
|
|
local keys = binding.keys
|
|
for key, description in pairs(keys) do
|
|
self:_add_hotkey(key, {
|
|
mod=modifiers,
|
|
description=description,
|
|
group=group},
|
|
self._additional_hotkeys
|
|
)
|
|
end
|
|
end
|
|
end
|
|
self:_sort_hotkeys(self._additional_hotkeys)
|
|
end
|
|
|
|
--- Add hotkey group rules for third-party applications.
|
|
-- @tparam string group hotkeys group name,
|
|
-- @tparam table data rule data for the group
|
|
-- see `awful.hotkeys_popup.key.vim` as an example.
|
|
function widget_instance:add_group_rules(group, data)
|
|
self.group_rules[group] = data
|
|
end
|
|
|
|
return widget_instance
|
|
end
|
|
|
|
local function get_default_widget()
|
|
if not widget.default_widget then
|
|
widget.default_widget = widget.new()
|
|
end
|
|
return widget.default_widget
|
|
end
|
|
|
|
--- Show popup with hotkeys help (default widget instance will be used).
|
|
-- @tparam[opt] client c Client.
|
|
-- @tparam[opt] screen s Screen.
|
|
function widget.show_help(...)
|
|
return get_default_widget():show_help(...)
|
|
end
|
|
|
|
--- Add hotkey descriptions for third-party applications
|
|
-- (default widget instance will be used).
|
|
-- @tparam table hotkeys Table with bindings,
|
|
-- see `awful.hotkeys_popup.key.vim` as an example.
|
|
function widget.add_hotkeys(...)
|
|
return get_default_widget():add_hotkeys(...)
|
|
end
|
|
|
|
--- Add hotkey group rules for third-party applications
|
|
-- (default widget instance will be used).
|
|
-- @tparam string group rule group name,
|
|
-- @tparam table data rule data for the group
|
|
-- see `awful.hotkeys_popup.key.vim` as an example.
|
|
function widget.add_group_rules(group, data)
|
|
return get_default_widget():add_group_rules(group, data)
|
|
end
|
|
|
|
return widget
|
|
|
|
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|