diff --git a/.gitignore b/.gitignore index e8da5cd..cc3ea1d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ lua_modules/ -generated/ +generated/* +!generated/awesomerc.tl +!generated/tlconfig.lua build/ luacov/ diff --git a/.vscode/settings.json b/.vscode/settings.json index 4a43426..fe95648 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -9,6 +9,7 @@ "aireone", "akorn", "ansicolors", + "awesomerc", "awesomewm", "awesomewmdtl", "buildx", @@ -45,6 +46,7 @@ "sublist", "tablex", "tbody", + "tlconfig", "tmpl", "wibox", "woodpeckerci", diff --git a/.woodpecker/build-and-run.yml b/.woodpecker/build-and-run.yml new file mode 100644 index 0000000..9059b87 --- /dev/null +++ b/.woodpecker/build-and-run.yml @@ -0,0 +1,15 @@ +variables: + - &cyan gitea.aireone.xyz/aire-one/awesomewm.d.tl/cyan:latest + +pipeline: + build-and-run: + image: *cyan + commands: + - luarocks make awesomewmdtl-dev-1.rockspec + - awesomewmdtl + - just validate + +branches: master + +depends_on: + - docker-build diff --git a/.woodpecker/build.yml b/.woodpecker/build.yml deleted file mode 100644 index 1bf3db0..0000000 --- a/.woodpecker/build.yml +++ /dev/null @@ -1,23 +0,0 @@ -variables: - - &cyan gitea.aireone.xyz/aire-one/awesomewm.d.tl/cyan:latest - -pipeline: - build: - image: *cyan - commands: - - just build - # run: - # image: akorn/luarocks:lua5.4-alpine - # commands: - # - apk add just - # - just run - # verify: - # image: alpine:3.16 - # commands: - # - apk add tree - # - tree generated - -branches: master - -depends_on: - - docker-build diff --git a/generated/awesomerc.tl b/generated/awesomerc.tl new file mode 100644 index 0000000..ae604fd --- /dev/null +++ b/generated/awesomerc.tl @@ -0,0 +1,675 @@ +-- awesome_mode: api-level=4:screen=on +-- If LuaRocks is installed, make sure that packages installed through it are +-- found (e.g. lgi). If LuaRocks is not installed, do nothing. +--- TODO : Write luarocks basic types definitions +-- pcall(require, "luarocks.loader") + +-- @DOC_REQUIRE_SECTION@ +-- Standard awesome library +local gears = require("gears") +local awful = require("awful") +require("awful.autofocus") +-- Widget and layout library +local wibox = require("wibox") +-- Theme handling library +local beautiful = require("beautiful") +-- Notification library +local naughty = require("naughty") +-- Declarative object management +local ruled = require("ruled") +local menubar = require("menubar") +local hotkeys_popup = require("awful.hotkeys_popup") +-- Enable hotkeys help widget for VIM and other apps +-- when client with a matching name is opened: +require("awful.hotkeys_popup.keys") + +-- {{{ Error handling +-- Check if awesome encountered an error during startup and fell back to +-- another config (This code will only ever execute for the fallback config) +-- @DOC_ERROR_HANDLING@ +naughty.connect_signal("request::display_error", function(message, startup) + naughty.notification { + urgency = "critical", + title = "Oops, an error happened" + .. (startup and " during startup!" or "!"), + message = message, + } +end) +-- }}} + +-- {{{ Variable definitions +-- @DOC_LOAD_THEME@ +-- Themes define colours, icons, font and wallpapers. +beautiful.init(gears.filesystem.get_themes_dir() .. "default/theme.lua") + +-- @DOC_DEFAULT_APPLICATIONS@ +-- This is used later as the default terminal and editor to run. +local terminal = "xterm" +local editor = os.getenv "EDITOR" or "nano" +local editor_cmd = terminal .. " -e " .. editor + +-- Default modkey. +-- Usually, Mod4 is the key with a logo between Control and Alt. +-- If you do not like this or do not have such a key, +-- I suggest you to remap Mod4 to another key using xmodmap or other tools. +-- However, you can use another modifier like Mod1, but it may interact with others. +local modkey = "Mod4" +-- }}} + +-- {{{ Menu +-- @DOC_MENU@ +-- Create a launcher widget and a main menu +local myawesomemenu = { + { + "hotkeys", + function() + hotkeys_popup.show_help(nil, awful.screen.focused()) + end, + }, + { "manual", terminal .. " -e man awesome" }, + { "edit config", editor_cmd .. " " .. awesome.conffile }, + { "restart", awesome.restart }, + { + "quit", + function() + awesome.quit() + end, + }, +} + +local mymainmenu = awful.menu { + items = { + { "awesome", myawesomemenu, beautiful.awesome_icon }, + { "open terminal", terminal }, + }, +} + +local mylauncher = awful.widget.launcher { + image = beautiful.awesome_icon, + menu = mymainmenu, +} + +-- Menubar configuration +menubar.utils.terminal = terminal -- Set the terminal for applications that require it +-- }}} + +-- {{{ Tag layout +-- @DOC_LAYOUT@ +-- Table of layouts to cover with awful.layout.inc, order matters. +tag.connect_signal("request::default_layouts", function() + awful.layout.append_default_layouts { + awful.layout.suit.floating, + awful.layout.suit.tile, + awful.layout.suit.tile.left, + awful.layout.suit.tile.bottom, + awful.layout.suit.tile.top, + awful.layout.suit.fair, + awful.layout.suit.fair.horizontal, + awful.layout.suit.spiral, + awful.layout.suit.spiral.dwindle, + awful.layout.suit.max, + awful.layout.suit.max.fullscreen, + awful.layout.suit.magnifier, + awful.layout.suit.corner.nw, + } +end) +-- }}} + +-- {{{ Wallpaper +-- @DOC_WALLPAPER@ +screen.connect_signal("request::wallpaper", function(s) + awful.wallpaper { + screen = s, + widget = { + { + image = beautiful.wallpaper, + upscale = true, + downscale = true, + widget = wibox.widget.imagebox, + }, + valign = "center", + halign = "center", + tiled = false, + widget = wibox.container.tile, + }, + } +end) +-- }}} + +-- {{{ Wibar + +-- Keyboard map indicator and switcher +local mykeyboardlayout = awful.widget.keyboardlayout() + +-- Create a textclock widget +local mytextclock = wibox.widget.textclock() + +-- @DOC_FOR_EACH_SCREEN@ +screen.connect_signal("request::desktop_decoration", function(s: screen) + -- Each screen has its own tag table. + awful.tag( + { "1", "2", "3", "4", "5", "6", "7", "8", "9" }, + s, + awful.layout.layouts[1] + ) + + -- Create a promptbox for each screen + s.mypromptbox = awful.widget.prompt() + + -- Create an imagebox widget which will contain an icon indicating which layout we're using. + -- We need one layoutbox per screen. + s.mylayoutbox = awful.widget.layoutbox { + screen = s, + buttons = { + awful.button({}, 1, function() + awful.layout.inc(1) + end), + awful.button({}, 3, function() + awful.layout.inc(-1) + end), + awful.button({}, 4, function() + awful.layout.inc(-1) + end), + awful.button({}, 5, function() + awful.layout.inc(1) + end), + }, + } + + -- Create a taglist widget + s.mytaglist = awful.widget.taglist { + screen = s, + filter = awful.widget.taglist.filter.all, + buttons = { + awful.button({}, 1, function(t: tag) + t:view_only() + end), + awful.button({ modkey }, 1, function(t: tag) + if client.focus then + client.focus:move_to_tag(t) + end + end), + awful.button({}, 3, awful.tag.viewtoggle), + awful.button({ modkey }, 3, function(t: tag) + if client.focus then + client.focus:toggle_tag(t) + end + end), + awful.button({}, 4, function(t: tag) + awful.tag.viewprev(t.screen) + end), + awful.button({}, 5, function(t: tag) + awful.tag.viewnext(t.screen) + end), + }, + } + + -- @TASKLIST_BUTTON@ + -- Create a tasklist widget + s.mytasklist = awful.widget.tasklist { + screen = s, + filter = awful.widget.tasklist.filter.currenttags, + buttons = { + awful.button({}, 1, function(c) + c:activate { context = "tasklist", action = "toggle_minimization" } + end), + awful.button({}, 3, function() + awful.menu.client_list { theme = { width = 250 } } + end), + awful.button({}, 4, function() + awful.client.focus.byidx(-1) + end), + awful.button({}, 5, function() + awful.client.focus.byidx(1) + end), + }, + } + + -- @DOC_WIBAR@ + -- Create the wibox + s.mywibox = awful.wibar { + position = "top", + screen = s, + -- @DOC_SETUP_WIDGETS@ + widget = { + layout = wibox.layout.align.horizontal, + { -- Left widgets + layout = wibox.layout.fixed.horizontal, + mylauncher, + s.mytaglist, + s.mypromptbox, + }, + s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + mykeyboardlayout, + wibox.widget.systray(), + mytextclock, + s.mylayoutbox, + }, + }, + } +end) + +-- }}} + +-- {{{ Mouse bindings +-- @DOC_ROOT_BUTTONS@ +awful.mouse.append_global_mousebindings { + awful.button({}, 3, function() + mymainmenu:toggle() + end), + awful.button({}, 4, awful.tag.viewprev), + awful.button({}, 5, awful.tag.viewnext), +} +-- }}} + +-- {{{ Key bindings +-- @DOC_GLOBAL_KEYBINDINGS@ + +-- General Awesome keys +awful.keyboard.append_global_keybindings { + awful.key( + { modkey }, + "s", + hotkeys_popup.show_help, + { description = "show help", group = "awesome" } + ), + awful.key({ modkey }, "w", function() + mymainmenu:show() + end, { description = "show main menu", group = "awesome" }), + awful.key( + { modkey, "Control" }, + "r", + awesome.restart, + { description = "reload awesome", group = "awesome" } + ), + awful.key( + { modkey, "Shift" }, + "q", + awesome.quit, + { description = "quit awesome", group = "awesome" } + ), + awful.key({ modkey }, "x", function() + awful.prompt.run { + prompt = "Run Lua code: ", + textbox = awful.screen.focused().mypromptbox.widget, + exe_callback = awful.util.eval, + history_path = awful.util.get_cache_dir() .. "/history_eval", + } + end, { description = "lua execute prompt", group = "awesome" }), + awful.key({ modkey }, "Return", function() + awful.spawn(terminal) + end, { description = "open a terminal", group = "launcher" }), + awful.key({ modkey }, "r", function() + awful.screen.focused().mypromptbox:run() + end, { description = "run prompt", group = "launcher" }), + awful.key({ modkey }, "p", function() + menubar.show() + end, { description = "show the menubar", group = "launcher" }), +} + +-- Tags related keybindings +awful.keyboard.append_global_keybindings { + awful.key( + { modkey }, + "Left", + awful.tag.viewprev, + { description = "view previous", group = "tag" } + ), + awful.key( + { modkey }, + "Right", + awful.tag.viewnext, + { description = "view next", group = "tag" } + ), + awful.key( + { modkey }, + "Escape", + awful.tag.history.restore, + { description = "go back", group = "tag" } + ), +} + +-- Focus related keybindings +awful.keyboard.append_global_keybindings { + awful.key({ modkey }, "j", function() + awful.client.focus.byidx(1) + end, { description = "focus next by index", group = "client" }), + awful.key({ modkey }, "k", function() + awful.client.focus.byidx(-1) + end, { description = "focus previous by index", group = "client" }), + awful.key({ modkey }, "Tab", function() + awful.client.focus.history.previous() + if client.focus then + client.focus:raise() + end + end, { description = "go back", group = "client" }), + awful.key({ modkey, "Control" }, "j", function() + awful.screen.focus_relative(1) + end, { description = "focus the next screen", group = "screen" }), + awful.key({ modkey, "Control" }, "k", function() + awful.screen.focus_relative(-1) + end, { description = "focus the previous screen", group = "screen" }), + awful.key({ modkey, "Control" }, "n", function() + local c = awful.client.restore() + -- Focus restored client + if c then + c:activate { raise = true, context = "key.unminimize" } + end + end, { description = "restore minimized", group = "client" }), +} + +-- Layout related keybindings +awful.keyboard.append_global_keybindings { + awful.key({ modkey, "Shift" }, "j", function() + awful.client.swap.byidx(1) + end, { description = "swap with next client by index", group = "client" }), + awful.key( + { modkey, "Shift" }, + "k", + function() + awful.client.swap.byidx(-1) + end, + { description = "swap with previous client by index", group = "client" } + ), + awful.key( + { modkey }, + "u", + awful.client.urgent.jumpto, + { description = "jump to urgent client", group = "client" } + ), + awful.key({ modkey }, "l", function() + awful.tag.incmwfact(0.05) + end, { description = "increase master width factor", group = "layout" }), + awful.key({ modkey }, "h", function() + awful.tag.incmwfact(-0.05) + end, { description = "decrease master width factor", group = "layout" }), + awful.key({ modkey, "Shift" }, "h", function() + awful.tag.incnmaster(1, nil, true) + end, { + description = "increase the number of master clients", + group = "layout", + }), + awful.key({ modkey, "Shift" }, "l", function() + awful.tag.incnmaster(-1, nil, true) + end, { + description = "decrease the number of master clients", + group = "layout", + }), + awful.key({ modkey, "Control" }, "h", function() + awful.tag.incncol(1, nil, true) + end, { description = "increase the number of columns", group = "layout" }), + awful.key({ modkey, "Control" }, "l", function() + awful.tag.incncol(-1, nil, true) + end, { description = "decrease the number of columns", group = "layout" }), + awful.key({ modkey }, "space", function() + awful.layout.inc(1) + end, { description = "select next", group = "layout" }), + awful.key({ modkey, "Shift" }, "space", function() + awful.layout.inc(-1) + end, { description = "select previous", group = "layout" }), +} + +-- @DOC_NUMBER_KEYBINDINGS@ + +awful.keyboard.append_global_keybindings { + awful.key { + modifiers = { modkey }, + keygroup = "numrow", + description = "only view tag", + group = "tag", + on_press = function(index) + local screen = awful.screen.focused() + local tag = screen.tags[index] + if tag then + tag:view_only() + end + end, + }, + awful.key { + modifiers = { modkey, "Control" }, + keygroup = "numrow", + description = "toggle tag", + group = "tag", + on_press = function(index) + local screen = awful.screen.focused() + local tag = screen.tags[index] + if tag then + awful.tag.viewtoggle(tag) + end + end, + }, + awful.key { + modifiers = { modkey, "Shift" }, + keygroup = "numrow", + description = "move focused client to tag", + group = "tag", + on_press = function(index) + if client.focus then + local tag = client.focus.screen.tags[index] + if tag then + client.focus:move_to_tag(tag) + end + end + end, + }, + awful.key { + modifiers = { modkey, "Control", "Shift" }, + keygroup = "numrow", + description = "toggle focused client on tag", + group = "tag", + on_press = function(index) + if client.focus then + local tag = client.focus.screen.tags[index] + if tag then + client.focus:toggle_tag(tag) + end + end + end, + }, + awful.key { + modifiers = { modkey }, + keygroup = "numpad", + description = "select layout directly", + group = "layout", + on_press = function(index) + local t = awful.screen.focused().selected_tag + if t then + t.layout = t.layouts[index] or t.layout + end + end, + }, +} + +-- @DOC_CLIENT_BUTTONS@ +client.connect_signal("request::default_mousebindings", function() + awful.mouse.append_client_mousebindings { + awful.button({}, 1, function(c) + c:activate { context = "mouse_click" } + end), + awful.button({ modkey }, 1, function(c) + c:activate { context = "mouse_click", action = "mouse_move" } + end), + awful.button({ modkey }, 3, function(c) + c:activate { context = "mouse_click", action = "mouse_resize" } + end), + } +end) + +-- @DOC_CLIENT_KEYBINDINGS@ +client.connect_signal("request::default_keybindings", function() + awful.keyboard.append_client_keybindings { + awful.key({ modkey }, "f", function(c: client) + c.fullscreen = not c.fullscreen + c:raise() + end, { description = "toggle fullscreen", group = "client" }), + awful.key({ modkey, "Shift" }, "c", function(c: client) + c:kill() + end, { description = "close", group = "client" }), + awful.key( + { modkey, "Control" }, + "space", + awful.client.floating.toggle, + { description = "toggle floating", group = "client" } + ), + awful.key({ modkey, "Control" }, "Return", function(c: client) + c:swap(awful.client.getmaster()) + end, { description = "move to master", group = "client" }), + awful.key({ modkey }, "o", function(c: client) + c:move_to_screen() + end, { description = "move to screen", group = "client" }), + awful.key({ modkey }, "t", function(c: client) + c.ontop = not c.ontop + end, { description = "toggle keep on top", group = "client" }), + awful.key({ modkey }, "n", function(c: client) + -- The client currently has the input focus, so it cannot be + -- minimized, since minimized clients can't have the focus. + c.minimized = true + end, { description = "minimize", group = "client" }), + awful.key({ modkey }, "m", function(c: client) + c.maximized = not c.maximized + c:raise() + end, { description = "(un)maximize", group = "client" }), + awful.key({ modkey, "Control" }, "m", function(c: client) + c.maximized_vertical = not c.maximized_vertical + c:raise() + end, { description = "(un)maximize vertically", group = "client" }), + awful.key({ modkey, "Shift" }, "m", function(c: client) + c.maximized_horizontal = not c.maximized_horizontal + c:raise() + end, { description = "(un)maximize horizontally", group = "client" }), + } +end) + +-- }}} + +-- {{{ Rules +-- Rules to apply to new clients. +-- @DOC_RULES@ +ruled.client.connect_signal("request::rules", function() + -- @DOC_GLOBAL_RULE@ + -- All clients will match this rule. + ruled.client.append_rule { + id = "global", + rule = {}, + properties = { + focus = awful.client.focus.filter, + raise = true, + screen = awful.screen.preferred, + placement = awful.placement.no_overlap + awful.placement.no_offscreen, + }, + } + + -- @DOC_FLOATING_RULE@ + -- Floating clients. + ruled.client.append_rule { + id = "floating", + rule_any = { + instance = { "copyq", "pinentry" }, + class = { + "Arandr", + "Blueman-manager", + "Gpick", + "Kruler", + "Sxiv", + "Tor Browser", + "Wpa_gui", + "veromix", + "xtightvncviewer", + }, + -- Note that the name property shown in xprop might be set slightly after creation of the client + -- and the name shown there might not match defined rules here. + name = { + "Event Tester", -- xev. + }, + role = { + "AlarmWindow", -- Thunderbird's calendar. + "ConfigManager", -- Thunderbird's about:config. + "pop-up", -- e.g. Google Chrome's (detached) Developer Tools. + }, + }, + properties = { floating = true }, + } + + -- @DOC_DIALOG_RULE@ + -- Add titlebars to normal clients and dialogs + ruled.client.append_rule { + -- @DOC_CSD_TITLEBARS@ + id = "titlebars", + rule_any = { type = { "normal", "dialog" } }, + properties = { titlebars_enabled = true }, + } + + -- Set Firefox to always map on the tag named "2" on screen 1. + -- ruled.client.append_rule { + -- rule = { class = "Firefox" }, + -- properties = { screen = 1, tag = "2" } + -- } +end) +-- }}} + +-- {{{ Titlebars +-- @DOC_TITLEBARS@ +-- Add a titlebar if titlebars_enabled is set to true in the rules. +client.connect_signal("request::titlebars", function(c: client) + -- buttons for the titlebar + local buttons = { + awful.button({}, 1, function() + c:activate { context = "titlebar", action = "mouse_move" } + end), + awful.button({}, 3, function() + c:activate { context = "titlebar", action = "mouse_resize" } + end), + } + + awful.titlebar(c).widget = { + { -- Left + awful.titlebar.widget.iconwidget(c), + buttons = buttons, + layout = wibox.layout.fixed.horizontal, + }, + { -- Middle + { -- Title + halign = "center", + widget = awful.titlebar.widget.titlewidget(c), + }, + buttons = buttons, + layout = wibox.layout.flex.horizontal, + }, + { -- Right + awful.titlebar.widget.floatingbutton(c), + awful.titlebar.widget.maximizedbutton(c), + awful.titlebar.widget.stickybutton(c), + awful.titlebar.widget.ontopbutton(c), + awful.titlebar.widget.closebutton(c), + layout = wibox.layout.fixed.horizontal(), + }, + layout = wibox.layout.align.horizontal, + } +end) +-- }}} + +-- {{{ Notifications + +ruled.notification.connect_signal("request::rules", function() + -- All notifications will match this rule. + ruled.notification.append_rule { + rule = {}, + properties = { + screen = awful.screen.preferred, + implicit_timeout = 5, + }, + } +end) + +naughty.connect_signal("request::display", function(n) + naughty.layout.box { notification = n } +end) + +-- }}} + +-- Enable sloppy focus, so that focus follows mouse. +client.connect_signal("mouse::enter", function(c: client) + c:activate { context = "mouse_enter", raise = false } +end) diff --git a/generated/tlconfig.lua b/generated/tlconfig.lua new file mode 100644 index 0000000..ee9f573 --- /dev/null +++ b/generated/tlconfig.lua @@ -0,0 +1,3 @@ +return { + source_dir = ".", +} diff --git a/justfile b/justfile index 6fdfa40..5fbf8d6 100644 --- a/justfile +++ b/justfile @@ -62,9 +62,7 @@ run: validate: cd generated && cyan \ check \ - --global-env-def "global_env" \ awesomerc.tl -# `find . -type f -iname '*.d.tl' | xargs` test PATTERN="_spec": luarocks \ diff --git a/src/awesomewmdtl/property.tl b/src/awesomewmdtl/property.tl index 8cbd797..099748f 100644 --- a/src/awesomewmdtl/property.tl +++ b/src/awesomewmdtl/property.tl @@ -18,9 +18,8 @@ local record Property end local property: Property = { - -- base_url = "https://awesomewm.org/apidoc", + base_url = "https://awesomewm.org/apidoc", -- base_url = "file:///usr/share/doc/awesome/doc", - base_url = "file:///home/aireone/documents/prog/awesome/build/doc", index_uri = "/index.html", out_directory = "generated", capi_modules = {