rc.lua

-- 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.
pcall(require, 'luarocks.loader')

-- 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')

-- awesome-wm-widgets
local volume_widget = require('awesome-wm-widgets.pactl-widget.volume')
local volume_widget_instance = volume_widget({ widget_type = 'arc' })
local net_speed_widget = require('awesome-wm-widgets.net-speed-widget.net-speed')
local net_speed_widget_instance = net_speed_widget({ width = 60 })
local cpu_widget = require('awesome-wm-widgets.cpu-widget.cpu-widget')
local fs_widget = require('awesome-wm-widgets.fs-widget.fs-widget')
local ram_widget = require('awesome-wm-widgets.ram-widget.ram-widget')
local calendar_widget = require('awesome-wm-widgets.calendar-widget.calendar')
-- https://github.com/streetturtle/awesome-wm-widgets/issues/267
local translate = require('awesome-wm-widgets.translate-widget.translate')

-- {{{ 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)

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
-- Themes define colours, icons, font and wallpapers.
-- default themes in /usr/share/awesome/themes
local awesome_dir = string.format('%s/.config/awesome', os.getenv('HOME'))
beautiful.init(string.format('%s/themes/%s/theme.lua', awesome_dir, 'custom'))

-- This is used later as the default terminal and editor to run.
terminal = 'kitty'
editor = 'nvim' or os.getenv('EDITOR')
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.
modkey = 'Mod4'
-- }}}

-- {{{ Menu
-- Create a launcher widget and a main menu
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 },
}

mymainmenu = awful.menu({ items = { { 'awesome', myawesomemenu, beautiful.awesome_icon }, { 'open terminal', terminal } } })

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
-- 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.max,
    awful.layout.suit.fair,
    awful.layout.suit.tile,
    awful.layout.suit.tile.top,
    awful.layout.suit.magnifier,
    awful.layout.suit.max.fullscreen,
    awful.layout.suit.floating,
    -- awful.layout.suit.tile.left,
    -- awful.layout.suit.tile.bottom,
    -- awful.layout.suit.fair.horizontal,
    -- awful.layout.suit.spiral,
    -- awful.layout.suit.spiral.dwindle,
    -- awful.layout.suit.corner.nw,
  })
end)
-- }}}

-- {{{ 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
mykeyboardlayout = awful.widget.keyboardlayout()

-- Create a textclock widget
mytextclock = wibox.widget.textclock(' %a %b %d, %I:%M ')
local cw = calendar_widget({
  theme = 'nord',
  placement = 'top_right',
})
mytextclock:connect_signal('button::press', function(_, _, _, button)
  if button == 1 then
    cw.toggle()
  end
end)

screen.connect_signal('request::desktop_decoration', function(s)
  -- Each screen has its own tag table.
  awful.tag({ '  ', '   ', '   ', '   ', ' 󰵅 ' }, 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) t:view_only() end),
      awful.button({ modkey }, 1, function(t)
        if client.focus then
          client.focus:move_to_tag(t)
        end
      end),
      awful.button({}, 3, awful.tag.viewtoggle),
      awful.button({ modkey }, 3, function(t)
        if client.focus then
          client.focus:toggle_tag(t)
        end
      end),
      awful.button({}, 4, function(t) awful.tag.viewprev(t.screen) end),
      awful.button({}, 5, function(t) awful.tag.viewnext(t.screen) end),
    },
  })

  -- 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),
    },
    style = {
      shape_border_width = 0,
      shape_border_color = '#777777',
      -- shape = gears.shape.rounded_bar,
    },
    -- layout = {
    --   spacing = 10,
    --   spacing_widget = {
    --     {
    --       -- forced_width = 5,
    --       -- shape = gears.shape.circle,
    --       -- widget = wibox.widget.separator,
    --     },
    --     valign = 'center',
    --     halign = 'center',
    --     widget = wibox.container.place,
    --   },
    --   layout = wibox.layout.flex.horizontal,
    -- },
    widget_template = {
      {
        {
          {
            {
              {
                id = 'icon_role',
                widget = wibox.widget.imagebox,
              },
              margins = 2,
              widget = wibox.container.margin,
            },
            {
              id = 'text_role',
              widget = wibox.widget.textbox,
            },
            widget = wibox.layout.fixed.horizontal,
          },
          widget = wibox.container.place,
          valign = 'center',
          halign = 'center',
        },
        left = 10,
        right = 10,
        widget = wibox.container.margin,
      },
      id = 'background_role',
      widget = wibox.container.background,
    },
  })

  -- Create the wibox
  s.mywibox = awful.wibar({
    -- shape = function(cr, w, h) gears.shape.rounded_rect(cr, w, h, 15) end,
    margins = {
      top = 10,
      left = 10,
      right = 10,
      bottom = 0,
    },
    position = 'top',
    screen = s,
    bg = '#000000' .. '55',
    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,
        awful.widget.only_on_screen(volume_widget_instance, s.primary),
        awful.widget.only_on_screen(net_speed_widget_instance, s.primary),
        cpu_widget(),
        ram_widget(),
        fs_widget({
          mounts = {
            '/',
            '/home',
            '/win10',
          },
        }),
        mykeyboardlayout,
        wibox.widget.systray(),
        mytextclock,
        s.mylayoutbox,
      },
    },
  })
end)

-- }}}

-- {{{ Mouse bindings
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

-- 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, 'Shift' }, 'Return', function() awful.spawn(terminal .. ' -e tmux') end, { description = 'Open a terminal with new TMUX session', group = 'launcher' }),
  awful.key({ modkey }, 'r', function() awful.screen.focused().mypromptbox:run() end, { description = 'run prompt', group = 'launcher' }),
  awful.key({ modkey }, 'p', function() awful.spawn('rofi -show drun -show-icons') end, { description = 'show rofi menu', group = 'launcher' }),
})

-- Volume related keybindings
awful.keyboard.append_global_keybindings({
  awful.key({}, 'XF86AudioRaiseVolume', function() awful.util.spawn('pamixer -i 2', false) end, { description = 'volume up', group = 'multimedia' }),
  awful.key({}, 'XF86AudioLowerVolume', function() awful.util.spawn('pamixer -d 2', false) end, { description = 'volume down', group = 'multimedia' }),
  awful.key({}, 'XF86AudioMute', function() awful.util.spawn('pamixer -t', false) end, { description = 'volume mute', group = 'multimedia' }),
})

-- Translate plugin keybindings
awful.keyboard.append_global_keybindings({
  awful.key(
    { modkey },
    'c',
    function()
      translate.launch({
        api_key = 'v-UaSVw9KoXBHKbjQeiYWCFQUHgX7MRkboksQNdWse8I',
        url = 'https://api.us-south.language-translator.watson.cloud.ibm.com/instances/6a507eca-c419-46df-a451-0e72534ec0ac',
      })
    end,
    { description = 'run translate prompt', 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 previous', group = 'client' }),
  awful.key({ modkey }, 'k', function() awful.client.focus.byidx(1) end, { description = 'focus next', 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' }, 'k', function() awful.screen.focus_relative(-1) end, { description = 'focus previous screen', group = 'screen' }),
  awful.key({ modkey, 'Control' }, 'j', function() awful.screen.focus_relative(1) end, { description = 'focus next 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 previous client', group = 'client' }),
  awful.key({ modkey, 'Shift' }, 'k', function() awful.client.swap.byidx(1) end, { description = 'swap with next 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' }),
})

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,
  }),
})

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)

client.connect_signal('request::default_keybindings', function()
  awful.keyboard.append_client_keybindings({
    awful.key({ modkey }, 'f', function(c)
      c.fullscreen = not c.fullscreen
      c:raise()
    end, { description = 'toggle fullscreen', group = 'client' }),
    awful.key({ modkey, 'Shift' }, 'c', function(c) 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) c:swap(awful.client.getmaster()) end, { description = 'move to master', group = 'client' }),
    awful.key({ modkey }, 'i', function(c) c:move_to_screen() end, { description = 'move to next screen', group = 'client' }),
    awful.key({ modkey }, 'o', function(c) c:move_to_screen(c.screen.index - 1) end, { description = 'move to previous screen', group = 'client' }),
    awful.key({ modkey }, 't', function(c) c.ontop = not c.ontop end, { description = 'toggle keep on top', group = 'client' }),
    awful.key({ modkey }, 'n', function(c)
      -- 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)
      c.maximized = not c.maximized
      c:raise()
    end, { description = '(un)maximize', group = 'client' }),
    awful.key({ modkey, 'Control' }, 'm', function(c)
      c.maximized_vertical = not c.maximized_vertical
      c:raise()
    end, { description = '(un)maximize vertically', group = 'client' }),
    awful.key({ modkey, 'Shift' }, 'm', function(c)
      c.maximized_horizontal = not c.maximized_horizontal
      c:raise()
    end, { description = '(un)maximize horizontally', group = 'client' }),
  })
end)

-- }}}

-- {{{ Rules
-- Rules to apply to new clients.
ruled.client.connect_signal('request::rules', function()
  -- 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,
    },
  })

  -- 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 },
  })

  -- Add titlebars to normal clients and dialogs
  ruled.client.append_rule({
    id = 'titlebars',
    rule_any = { type = { 'normal', 'dialog' } },
    properties = { titlebars_enabled = false },
  })

  -- 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)
-- }}}

client.connect_signal('request::manage', function(c)
  -- round corners
  -- c.shape = function(cr, w, h) gears.shape.rounded_rect(cr, w, h, 9) end

  -- use custom icons for clients and tasklist, issue: https://github.com/awesomeWM/awesome/issues/3587
  awful.spawn.easy_async_with_shell('sleep 0.1', function()
    if c.valid then
      if c.instance ~= nil then
        local icon = menubar.utils.lookup_icon(c.instance)
        local lower_icon = menubar.utils.lookup_icon(c.instance:lower())
        if icon ~= nil then
          local new_icon = gears.surface(icon)
          c.icon = new_icon._native
        elseif lower_icon ~= nil then
          local new_icon = gears.surface(lower_icon)
          c.icon = new_icon._native
        elseif c.icon == nil then
          local new_icon = gears.surface(menubar.utils.lookup_icon('application-default-icon'))
          c.icon = new_icon._native
        end
      else
        local new_icon = gears.surface(menubar.utils.lookup_icon('application-default-icon'))
        c.icon = new_icon._native
      end
    end
  end)
end)

-- {{{ Titlebars
-- Add a titlebar if titlebars_enabled is set to true in the rules.
client.connect_signal('request::titlebars', function(c)
  -- 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) c:activate({ context = 'mouse_enter', raise = false }) end)

awful.spawn.with_shell(awesome_dir .. '/autorun.sh')

-- https://www.reddit.com/r/awesomewm/comments/jn6cvv/tag_change_both_monitors_at_once/?rdt=35708
tag.connect_signal('property::selected', function(t)
  if t.selected then
    local ts = t.screen
    local idx = t.index
    awful.screen.connect_for_each_screen(function(s)
      if s == ts then
        return nil
      end
      local tag = s.tags[idx]
      if tag then
        tag:view_only()
      end
    end)
  end
end)