git.shemshak.org - ~bandali/configs/blob - init.org

   1 #+title: =aminb='s Literate Emacs Configuration
   2 #+author: Amin Bandali
   3 #+babel: :cache yes
   4 #+property: header-args :tangle yes
   5
   6 * About
   7 :PROPERTIES:
   8 :CUSTOM_ID: about
   9 :END:
  10
  11 This org file is my literate configuration for GNU Emacs, and is
  12 tangled to [[./init.el][init.el]]. Packages are installed and managed using
  13 [[https://github.com/emacscollective/borg][Borg]]. Over the years, I've taken inspiration from configurations of
  14 many different people. Some of the configurations that I can remember
  15 off the top of my head are:
  16
  17 - [[https://github.com/dieggsy/dotfiles][dieggsy/dotfiles]]: literate Emacs and dotfiles configuration, uses
  18   straight.el for managing packages
  19 - [[https://github.com/dakra/dmacs][dakra/dmacs]]: literate Emacs configuration, using Borg for managing
  20   packages
  21 - [[http://pages.sachachua.com/.emacs.d/Sacha.html][Sacha Chua's literate Emacs configuration]]
  22 - [[https://github.com/dakrone/eos][dakrone/eos]]
  23 - Ryan Rix's [[http://doc.rix.si/cce/cce.html][Complete Computing Environment]] ([[http://doc.rix.si/projects/fsem.html][about cce]])
  24 - [[https://github.com/jwiegley/dot-emacs][jwiegley/dot-emacs]]: nix-based configuration
  25 - [[https://github.com/wasamasa/dotemacs][wasamasa/dotemacs]]
  26 - [[https://github.com/hlissner/doom-emacs][Doom Emacs]]
  27
  28 I'd like to have a fully reproducible Emacs setup (part of the reason
  29 why I store my configuration in this repository) but unfortunately out
  30 of the box, that's not achievable with =package.el=, not currently
  31 anyway. So, I've opted to use Borg. For what it's worth, I briefly
  32 experimented with [[https://github.com/raxod502/straight.el][straight.el]], but found that it added about 2 seconds
  33 to my init time; which is unacceptable for me: I use Emacs as my
  34 window manager (via EXWM) and coming from bspwm, I'm too used to
  35 having fast startup times.
  36
  37 ** Installation
  38
  39 To use this config for your Emacs, first you need to clone this repo,
  40 then bootstrap Borg, tell Borg to retrieve package submodules, and
  41 byte-compiled the packages. Something along these lines should work:
  42
  43 #+begin_src sh :tangle no
  44 git clone https://github.com/aminb/dotfiles ~/.emacs.d
  45 cd ~/.emacs.d
  46 make bootstrap-borg
  47 make bootstrap
  48 make build
  49 #+end_src
  50
  51 * Contents                                                   :toc_1:noexport:
  52
  53 - [[#about][About]]
  54 - [[#header][Header]]
  55 - [[#initial-setup][Initial setup]]
  56 - [[#core][Core]]
  57 - [[#post-initialization][Post initialization]]
  58 - [[#footer][Footer]]
  59
  60 * Header
  61 :PROPERTIES:
  62 :CUSTOM_ID: header
  63 :END:
  64
  65 ** First line
  66
  67 #+begin_src emacs-lisp :comments none
  68 ;;; init.el --- Amin Bandali's Emacs config -*- lexical-binding: t ; eval: (view-mode 1)-*-
  69 #+end_src
  70
  71 Enable =view-mode=, which both makes the file read-only (as a reminder
  72 that =init.el= is an auto-generated file, not supposed to be edited),
  73 and provides some convenient key bindings for browsing through the
  74 file.
  75
  76 ** License
  77
  78 #+begin_src emacs-lisp :comments none
  79 ;; Copyright (C) 2018  Amin Bandali <amin@aminb.org>
  80
  81 ;; This program is free software: you can redistribute it and/or modify
  82 ;; it under the terms of the GNU General Public License as published by
  83 ;; the Free Software Foundation, either version 3 of the License, or
  84 ;; (at your option) any later version.
  85
  86 ;; This program is distributed in the hope that it will be useful,
  87 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  88 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  89 ;; GNU General Public License for more details.
  90
  91 ;; You should have received a copy of the GNU General Public License
  92 ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
  93 #+end_src
  94
  95 ** Commentary
  96
  97 #+begin_src emacs-lisp :comments none
  98 ;;; Commentary:
  99
 100 ;; Emacs configuration of Amin Bandali, computer scientist and functional
 101 ;; programmer.
 102
 103 ;; THIS FILE IS AUTO-GENERATED FROM `init.org'.
 104 #+end_src
 105
 106 ** Naming conventions
 107
 108 The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s conventions, found
 109 [[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. Naturally, I use my initials, =ab=, instead of =doom=.
 110
 111 #+begin_src emacs-lisp :comments none
 112 ;; Naming conventions:
 113 ;;
 114 ;;   ab-...   public variables or non-interactive functions
 115 ;;   ab--...  private anything (non-interactive), not safe for direct use
 116 ;;   ab/...   an interactive function; safe for M-x or keybinding
 117 ;;   ab:...   an evil operator, motion, or command
 118 ;;   ab|...   a hook function
 119 ;;   ab*...   an advising function
 120 ;;   ab@...   a hydra command
 121 ;;   ...!     a macro
 122 #+end_src
 123
 124 * Initial setup
 125 :PROPERTIES:
 126 :CUSTOM_ID: initial-setup
 127 :END:
 128
 129 #+begin_src emacs-lisp :comments none
 130 ;;; Code:
 131 #+end_src
 132
 133 ** Emacs initialization
 134
 135 I'd like to do a couple of measurements of Emacs' startup time. First,
 136 let's see how long Emacs takes to start up, before even loading
 137 =init.el=, i.e. =user-init-file=:
 138
 139 #+begin_src emacs-lisp
 140 (defvar ab--before-user-init-time (current-time)
 141   "Value of `current-time' when Emacs begins loading `user-init-file'.")
 142 (message "Loading Emacs...done (%.3fs)"
 143          (float-time (time-subtract ab--before-user-init-time
 144                                     before-init-time)))
 145 #+end_src
 146
 147 Also, temporarily increase ~gc-cons-threshhold~ and
 148 ~gc-cons-percentage~ during startup to reduce garbage collection
 149 frequency. Clearing the ~file-name-handler-alist~ seems to help reduce
 150 startup time as well.
 151
 152 #+begin_src emacs-lisp
 153 (defvar ab--gc-cons-threshold gc-cons-threshold)
 154 (defvar ab--gc-cons-percentage gc-cons-percentage)
 155 (defvar ab--file-name-handler-alist file-name-handler-alist)
 156 (setq gc-cons-threshold (* 400 1024 1024)  ; 400 MiB
 157       gc-cons-percentage 0.6
 158       file-name-handler-alist nil
 159       ;; sidesteps a bug when profiling with esup
 160       esup-child-profile-require-level 0)
 161 #+end_src
 162
 163 Of course, we'd like to set them back to their defaults once we're
 164 done initializing.
 165
 166 #+begin_src emacs-lisp
 167 (add-hook
 168  'after-init-hook
 169  (lambda ()
 170    (setq gc-cons-threshold ab--gc-cons-threshold
 171          gc-cons-percentage ab--gc-cons-percentage
 172          file-name-handler-alist ab--file-name-handler-alist)))
 173 #+end_src
 174
 175 Increase the number of lines kept in message logs (the =*Messages*=
 176 buffer).
 177
 178 #+begin_src emacs-lisp
 179 (setq message-log-max 20000)
 180 #+end_src
 181
 182 Optionally, we could suppress some byte compiler warnings like below,
 183 but for now I've decided to keep them enabled. See documentation for
 184 ~byte-compile-warnings~ for more details.
 185
 186 #+begin_src emacs-lisp
 187 ;; (setq byte-compile-warnings
 188 ;;       '(not free-vars unresolved noruntime lexical make-local))
 189 #+end_src
 190
 191 ** Package management
 192
 193 *** No =package.el=
 194
 195 I can do all my package management things with Borg, and don't need
 196 Emacs' built-in =package.el=. Emacs 27 lets us disable =package.el= in
 197 the =early-init-file= (see [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=24acb31c04b4048b85311d794e600ecd7ce60d3b][here]]).
 198
 199 #+begin_src emacs-lisp :tangle early-init.el
 200 (setq package-enable-at-startup nil)
 201 #+end_src
 202
 203 But since Emacs 27 isn't out yet (Emacs 26 is just around the corner
 204 right now), and even when released it'll be long before most distros
 205 ship in their repos, I'll still put the old workaround with the
 206 commented call to ~package-initialize~ here anyway.
 207
 208 #+begin_src emacs-lisp
 209 (setq package-enable-at-startup nil)
 210 ;; (package-initialize)
 211 #+end_src
 212
 213 *** Borg
 214
 215 #+begin_quote
 216 Assimilate Emacs packages as Git submodules
 217 #+end_quote
 218
 219 [[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In
 220 short, it creates a git submodule in =lib/= for each package, which
 221 can then be managed with the help of Magit or other tools.
 222
 223 #+begin_src emacs-lisp
 224 (setq user-init-file (or load-file-name buffer-file-name)
 225       user-emacs-directory (file-name-directory user-init-file))
 226 (add-to-list 'load-path
 227              (expand-file-name "lib/borg" user-emacs-directory))
 228 (require 'borg)
 229 (borg-initialize)
 230 #+end_src
 231
 232 *** =use-package=
 233
 234 #+begin_quote
 235 A use-package declaration for simplifying your .emacs
 236 #+end_quote
 237
 238 [[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
 239 packages (in our case especially the latter) in a neatly organized way
 240 and without compromising on performance.
 241
 242 #+begin_src emacs-lisp
 243 (require 'use-package)
 244 (if nil                             ; set to t when need to debug init
 245     (setq use-package-verbose t
 246           use-package-expand-minimally nil
 247           use-package-compute-statistics t
 248           debug-on-error t)
 249   (setq use-package-verbose nil
 250         use-package-expand-minimally t))
 251 #+end_src
 252
 253 *** Epkg
 254
 255 #+begin_quote
 256 Browse the Emacsmirror package database
 257 #+end_quote
 258
 259 Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
 260 database, low-level functions for querying the database, and a
 261 =package.el=-like user interface for browsing the available packages.
 262
 263 #+begin_src emacs-lisp
 264 (use-package epkg
 265   :defer t)
 266 #+end_src
 267
 268 ** No littering in =~/.emacs.d=
 269
 270 #+begin_quote
 271 Help keeping ~/.emacs.d clean
 272 #+end_quote
 273
 274 By default, even for Emacs' built-in packages, the configuration files
 275 and persistent data are all over the place. Use =no-littering= to help
 276 contain the mess.
 277
 278 #+begin_src emacs-lisp
 279 (use-package no-littering
 280   :demand t
 281   :config
 282   (savehist-mode 1)
 283   (add-to-list 'savehist-additional-variables 'kill-ring)
 284   (save-place-mode 1)
 285   (setq auto-save-file-name-transforms
 286         `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
 287 #+end_src
 288
 289 ** Custom file (=custom.el=)
 290
 291 I'm not planning on using the custom file much, but even so, I
 292 definitely don't want it mixing with =init.el=. So, here; let's give
 293 it it's own file. While at it, treat themes as safe.
 294
 295 #+begin_src emacs-lisp
 296 (use-package custom
 297   :no-require t
 298   :config
 299   (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
 300   (when (file-exists-p custom-file)
 301     (load custom-file))
 302   (setf custom-safe-themes t))
 303 #+end_src
 304
 305 ** Better =$PATH= handling
 306
 307 Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
 308 in my shell.
 309
 310 #+begin_src emacs-lisp
 311 (use-package exec-path-from-shell
 312   :defer 1
 313   :init
 314   (setq exec-path-from-shell-check-startup-files nil)
 315   :config
 316   (exec-path-from-shell-initialize)
 317   ;; while we're at it, let's fix access to our running ssh-agent
 318   (exec-path-from-shell-copy-env "SSH_AGENT_PID")
 319   (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
 320 #+end_src
 321
 322 ** Server
 323
 324 Start server if not already running. Alternatively, can be done by
 325 issuing =emacs --daemon= in the terminal, which can be automated with
 326 a systemd service or using =brew services start emacs= on macOS. I use
 327 Emacs as my window manager (via EXWM), so I always start Emacs on
 328 login; so starting the server from inside Emacs is good enough for me.
 329
 330 See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
 331
 332 #+begin_src emacs-lisp
 333 (use-package server
 334   :config (or (server-running-p) (server-mode)))
 335 #+end_src
 336
 337 ** Unicode support
 338
 339 Font stack with better unicode support, around =Ubuntu Mono= and
 340 =Hack=.
 341
 342 #+begin_src emacs-lisp
 343 (dolist (ft (fontset-list))
 344   (set-fontset-font
 345    ft
 346    'unicode
 347    (font-spec :name "Ubuntu Mono"))
 348   (set-fontset-font
 349    ft
 350    'unicode
 351    (font-spec :name "DejaVu Sans Mono")
 352    nil
 353    'append)
 354   ;; (set-fontset-font
 355   ;;  ft
 356   ;;  'unicode
 357   ;;  (font-spec
 358   ;;   :name "Symbola monospacified for DejaVu Sans Mono")
 359   ;;  nil
 360   ;;  'append)
 361   ;; (set-fontset-font
 362   ;;  ft
 363   ;;  #x2115  ; ℕ
 364   ;;  (font-spec :name "DejaVu Sans Mono")
 365   ;;  nil
 366   ;;  'append)
 367   (set-fontset-font
 368    ft
 369    (cons ?Α ?ω)
 370    (font-spec :name "DejaVu Sans Mono" :size 14)
 371    nil
 372    'prepend))
 373 #+end_src
 374
 375 * Core
 376 :PROPERTIES:
 377 :CUSTOM_ID: core
 378 :END:
 379
 380 ** Defaults
 381
 382 *** Time and battery in mode-line
 383
 384 Enable displaying time and battery in the mode-line, since I'm not
 385 using the Xfce panel anymore. Also, I don't need to see the load
 386 average on a regular basis, so disable that.
 387
 388 #+begin_src emacs-lisp
 389 (use-package time
 390   :ensure nil
 391   :init
 392   (setq display-time-default-load-average nil)
 393   :config
 394   (display-time-mode))
 395
 396 (use-package battery
 397   :ensure nil
 398   :config
 399   (display-battery-mode))
 400 #+end_src
 401
 402 *** Smaller fringe
 403
 404 Might want to set the fringe to a smaller value, especially if using
 405 EXWM. I'm fine with the default for now.
 406
 407 #+begin_src emacs-lisp
 408 ;; (fringe-mode '(3 . 1))
 409 (fringe-mode nil)
 410 #+end_src
 411
 412 *** Disable disabled commands
 413
 414 Emacs disables some commands by default that could persumably be
 415 confusing for novice users. Let's disable that.
 416
 417 #+begin_src emacs-lisp
 418 (setq disabled-command-function nil)
 419 #+end_src
 420
 421 *** Kill-ring
 422
 423 Save what I copy into clipboard from other applications into Emacs'
 424 kill-ring, which would allow me to still be able to easily access it
 425 in case I kill (cut or copy) something else inside Emacs before
 426 yanking (pasting) what I'd originally intended to.
 427
 428 #+begin_src emacs-lisp
 429 (setq save-interprogram-paste-before-kill t)
 430 #+end_src
 431
 432 *** Minibuffer
 433
 434 #+begin_src emacs-lisp
 435 (setq enable-recursive-minibuffers t
 436       resize-mini-windows t)
 437 #+end_src
 438
 439 *** Lazy-person-friendly yes/no prompts
 440
 441 Lazy people would prefer to type fewer keystrokes, especially for yes
 442 or no questions. I'm lazy.
 443
 444 #+begin_src emacs-lisp
 445 (defalias 'yes-or-no-p #'y-or-n-p)
 446 #+end_src
 447
 448 *** Startup screen and =*scratch*=
 449
 450 Firstly, let Emacs know that I'd like to have =*scratch*= as my
 451 startup buffer.
 452
 453 #+begin_src emacs-lisp
 454 (setq initial-buffer-choice t)
 455 #+end_src
 456
 457 Now let's customize the =*scratch*= buffer a bit. First off, I don't
 458 need the default hint.
 459
 460 #+begin_src emacs-lisp
 461 (setq initial-scratch-message nil)
 462 #+end_src
 463
 464 Also, let's use Text mode as the major mode, in case I want to
 465 customize it (=*scratch*='s default major mode, Fundamental mode,
 466 can't really be customized).
 467
 468 #+begin_src emacs-lisp
 469 (setq initial-major-mode 'text-mode)
 470 #+end_src
 471
 472 Inhibit the buffer list when more than 2 files are loaded.
 473
 474 #+begin_src emacs-lisp
 475 (setq inhibit-startup-buffer-menu t)
 476 #+end_src
 477
 478 I don't really need to see the startup screen or echo area message
 479 either.
 480
 481 #+begin_src emacs-lisp
 482 (advice-add #'display-startup-echo-area-message :override #'ignore)
 483 (setq inhibit-startup-screen t
 484       inhibit-startup-echo-area-message user-login-name)
 485 #+end_src
 486
 487 *** More useful frame titles
 488
 489 Show either the file name or the buffer name (in case the buffer isn't
 490 visiting a file). Borrowed from Emacs Prelude.
 491
 492 #+begin_src emacs-lisp
 493 (setq frame-title-format
 494       '("" invocation-name " - "
 495         (:eval (if (buffer-file-name)
 496                    (abbreviate-file-name (buffer-file-name))
 497                  "%b"))))
 498 #+end_src
 499
 500 *** Backups
 501
 502 Emacs' default backup settings aren't that great. Let's use more
 503 sensible options. See documentation for the ~make-backup-file~
 504 variable.
 505
 506 #+begin_src emacs-lisp
 507 (setq backup-by-copying t
 508       version-control t)
 509 #+end_src
 510
 511 ** Packages
 512
 513 The packages in this section are absolutely essential to my everyday
 514 workflow, and they play key roles in how I do my computing. They
 515 immensely enhance the Emacs experience for me; both using Emacs, and
 516 customizing it.
 517
 518 *** [[https://github.com/emacscollective/auto-compile][auto-compile]]
 519
 520 #+begin_src emacs-lisp
 521 (use-package auto-compile
 522   :demand t
 523   :config
 524   (auto-compile-on-load-mode)
 525   (auto-compile-on-save-mode)
 526   (setq auto-compile-display-buffer               nil
 527         auto-compile-mode-line-counter            t
 528         auto-compile-source-recreate-deletes-dest t
 529         auto-compile-toggle-deletes-nonlib-dest   t
 530         auto-compile-update-autoloads             t)
 531   (add-hook 'auto-compile-inhibit-compile-hook
 532             'auto-compile-inhibit-compile-detached-git-head))
 533 #+end_src
 534
 535 *** TODO [[https://github.com/Kungsgeten/ryo-modal][ryo-modal]]
 536
 537 #+begin_quote
 538 Roll your own modal mode
 539 #+end_quote
 540
 541 *** [[https://github.com/ch11ng/exwm][EXWM]] (window manager)
 542
 543 #+begin_src emacs-lisp :tangle no
 544 (use-package exwm
 545   :demand t
 546   :config
 547   (require 'exwm-config)
 548
 549   ;; Set the initial workspace number.
 550   (setq exwm-workspace-number 4)
 551
 552   ;; Make class name the buffer name, truncating beyond 50 characters
 553   (defun exwm-rename-buffer ()
 554     (interactive)
 555     (exwm-workspace-rename-buffer
 556      (concat exwm-class-name ":"
 557              (if (<= (length exwm-title) 50) exwm-title
 558                (concat (substring exwm-title 0 49) "...")))))
 559   (add-hook 'exwm-update-class-hook 'exwm-rename-buffer)
 560   (add-hook 'exwm-update-title-hook 'exwm-rename-buffer)
 561
 562   ;; 's-R': Reset
 563   (exwm-input-set-key (kbd "s-R") #'exwm-reset)
 564   ;; 's-\': Switch workspace
 565   (exwm-input-set-key (kbd "s-\\") #'exwm-workspace-switch)
 566   ;; 's-N': Switch to certain workspace
 567   (dotimes (i 10)
 568     (exwm-input-set-key (kbd (format "s-%d" i))
 569                         (lambda ()
 570                           (interactive)
 571                           (exwm-workspace-switch-create i))))
 572   ;; 's-SPC': Launch application
 573   ;; (exwm-input-set-key
 574   ;;  (kbd "s-SPC")
 575   ;;  (lambda (command)
 576   ;;    (interactive (list (read-shell-command "➜ ")))
 577   ;;    (start-process-shell-command command nil command)))
 578
 579   (exwm-input-set-key (kbd "M-s-SPC") #'counsel-linux-app)
 580
 581   ;; Shorten 'C-c C-q' to 'C-q'
 582   (define-key exwm-mode-map [?\C-q] #'exwm-input-send-next-key)
 583
 584   ;; Line-editing shortcuts
 585   (setq exwm-input-simulation-keys
 586         '(;; movement
 587           ([?\C-b] . [left])
 588           ([?\M-b] . [C-left])
 589           ([?\C-f] . [right])
 590           ([?\M-f] . [C-right])
 591           ([?\C-p] . [up])
 592           ([?\C-n] . [down])
 593           ([?\C-a] . [home])
 594           ([?\C-e] . [end])
 595           ([?\M-v] . [prior])
 596           ([?\C-v] . [next])
 597           ([?\C-d] . [delete])
 598           ([?\C-k] . [S-end delete])
 599           ;; cut/copy/paste
 600           ;; ([?\C-w] . [?\C-x])
 601           ([?\M-w] . [?\C-c])
 602           ([?\C-y] . [?\C-v])
 603           ;; search
 604           ([?\C-s] . [?\C-f])))
 605
 606   ;; Enable EXWM
 607   (exwm-enable)
 608
 609   (add-hook 'exwm-init-hook #'exwm-config--fix/ido-buffer-window-other-frame)
 610
 611   (require 'exwm-systemtray)
 612   (exwm-systemtray-enable)
 613
 614   (require 'exwm-randr)
 615   (exwm-randr-enable)
 616
 617   ;; (exwm-input-set-key
 618   ;;  (kbd "s-<return>")
 619   ;;  (lambda ()
 620   ;;    (interactive)
 621   ;;    (start-process "urxvt" nil "urxvt")))
 622
 623   ;; (exwm-input-set-key
 624   ;;  (kbd "s-SPC")  ;; rofi doesn't properly launch programs when started from emacs
 625   ;;  (lambda ()
 626   ;;    (interactive)
 627   ;;    (start-process-shell-command "rofi-run" nil "rofi -show run -display-run '> ' -display-window ' 🗔 '")))
 628
 629   ;; (exwm-input-set-key
 630   ;;  (kbd "s-/")
 631   ;;  (lambda ()
 632   ;;    (interactive)
 633   ;;    (start-process-shell-command "rofi-win" nil "rofi -show window  -display-run '> ' -display-window ' 🗔 '")))
 634
 635   ;; (exwm-input-set-key
 636   ;;  (kbd "M-SPC")
 637   ;;  (lambda ()
 638   ;;    (interactive)
 639   ;;    (start-process "rofi-pass" nil "rofi-pass")))
 640
 641   ;; (exwm-input-set-key
 642   ;;  (kbd "<XF86AudioMute>")
 643   ;;  (lambda ()
 644   ;;    (interactive)
 645   ;;    (start-process-shell-command "pamixer" nil "pamixer --toggle-mute")))
 646
 647   ;; (exwm-input-set-key
 648   ;;  (kbd "<XF86AudioLowerVolume>")
 649   ;;  (lambda ()
 650   ;;    (interactive)
 651   ;;    (start-process-shell-command "pamixer" nil "pamixer --allow-boost --decrease 5")))
 652
 653   ;; (exwm-input-set-key
 654   ;;  (kbd "<XF86AudioRaiseVolume>")
 655   ;;  (lambda ()
 656   ;;    (interactive)
 657   ;;    (start-process-shell-command "pamixer" nil "pamixer --allow-boost --increase 5")))
 658
 659   ;; (exwm-input-set-key
 660   ;;  (kbd "<XF86AudioPlay>")
 661   ;;  (lambda ()
 662   ;;    (interactive)
 663   ;;    (start-process-shell-command "mpc" nil "mpc toggle")))
 664
 665   ;; (exwm-input-set-key
 666   ;;  (kbd "<XF86AudioPrev>")
 667   ;;  (lambda ()
 668   ;;    (interactive)
 669   ;;    (start-process-shell-command "mpc" nil "mpc prev")))
 670
 671   ;; (exwm-input-set-key
 672   ;;  (kbd "<XF86AudioNext>")
 673   ;;  (lambda ()
 674   ;;    (interactive)
 675   ;;    (start-process-shell-command "mpc" nil "mpv next")))
 676
 677   (defun ab--exwm-pasystray ()
 678     "A command used to start pasystray."
 679     (interactive)
 680     (if (executable-find "pasystray")
 681         (progn
 682           (message "EXWM: starting pasystray ...")
 683           (start-process-shell-command "pasystray" nil "pasystray --notify=all"))
 684       (message "EXWM: pasystray is not installed, abort!")))
 685
 686   (add-hook 'exwm-init-hook #'ab--exwm-pasystray)
 687
 688   (exwm-input-set-key
 689    (kbd "s-t")
 690    (lambda ()
 691      (interactive)
 692      (exwm-floating-toggle-floating)))
 693
 694   (exwm-input-set-key
 695    (kbd "s-f")
 696    (lambda ()
 697      (interactive)
 698      (exwm-layout-toggle-fullscreen)))
 699
 700   (exwm-input-set-key
 701    (kbd "s-w")
 702    (lambda ()
 703      (interactive)
 704      (kill-buffer (current-buffer))))
 705
 706   (exwm-input-set-key
 707    (kbd "s-q")
 708    (lambda ()
 709      (interactive)
 710      (exwm-manage--kill-client))))
 711 #+end_src
 712
 713 **** sxhkdrc
 714 :PROPERTIES:
 715 :header-args+: :tangle ~/.config/sxhkd/sxhkdrc :mkdirp yes
 716 :END:
 717
 718 #+begin_src conf :tangle no
 719 # terminal emulator
 720 super + Return
 721         urxvt
 722
 723 # program launcher
 724 super + space
 725         rofi -show run -display-run '> ' -display-window ' 🗔 '
 726
 727 # window finder
 728 super + slash
 729         rofi -show window  -display-run '> ' -display-window ' 🗔 '
 730
 731 # password manager
 732 alt + space
 733         rofi-pass
 734
 735 # make sxhkd reload its configuration files:
 736 super + Escape
 737         pkill -USR1 -x sxhkd
 738
 739 # volume {up,down}
 740 XF86Audio{Raise,Lower}Volume
 741         pamixer --allow-boost --{in,de}crease 5
 742
 743 # mute
 744 XF86AudioMute
 745         pamixer --toggle-mute
 746
 747 # playback control
 748 XF86Audio{Play,Prev,Next}
 749         mpc {toggle,prev,next}
 750
 751 # Toggle keyboard layout
 752 # super + F7
 753 #       toggle-layout
 754
 755 # Toggle Xfce presentation mode
 756 # XF86LaunchB
 757 #       toggle-presentation-mode
 758
 759 # monitor brightness
 760 XF86MonBrightness{Up,Down}
 761         light -{A,U} 5
 762
 763 super + apostrophe
 764         rofi-light
 765 #+end_src
 766
 767 *** [[https://orgmode.org/][Org mode]]
 768
 769 #+begin_quote
 770 Org mode is for keeping notes, maintaining TODO lists, planning
 771 projects, and authoring documents with a fast and effective plain-text
 772 system.
 773 #+end_quote
 774
 775 In short, my favourite way of life.
 776
 777 #+begin_src emacs-lisp
 778 (setq org-src-tab-acts-natively t
 779       org-src-preserve-indentation nil
 780       org-edit-src-content-indentation 0)
 781 #+end_src
 782
 783 *** [[https://magit.vc/][Magit]]
 784
 785 #+begin_quote
 786 It's Magit! A Git porcelain inside Emacs.
 787 #+end_quote
 788
 789 Not just how I do git, but /the/ way to do git.
 790
 791 #+begin_src emacs-lisp
 792 (use-package magit
 793   :defer t
 794   :bind (("s-g"     . magit-status)
 795          ("C-x g"   . magit-status)
 796          ("C-x M-g" . magit-dispatch-popup))
 797   :config
 798   (magit-add-section-hook 'magit-status-sections-hook
 799                           'magit-insert-modules
 800                           'magit-insert-stashes
 801                           'append))
 802 #+end_src
 803
 804 *** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
 805
 806 #+begin_quote
 807 Ivy - a generic completion frontend for Emacs, Swiper - isearch with
 808 an overview, and more. Oh, man!
 809 #+end_quote
 810
 811 There's no way I could top that, so I won't attempt to.
 812
 813 **** Ivy
 814
 815 #+begin_src emacs-lisp
 816 (use-package ivy
 817   :bind
 818   (:map ivy-minibuffer-map
 819         ([escape] . keyboard-escape-quit)
 820         ;; ("C-j"    . ivy-next-line)
 821         ;; ("C-k"    . ivy-previous-line)
 822         ([S-up]   . ivy-previous-history-element)
 823         ([S-down] . ivy-next-history-element)
 824         ("DEL"    . ivy-backward-delete-char))
 825   :config
 826   (setq ivy-wrap t)
 827   (ivy-mode 1))
 828 #+end_src
 829
 830 **** Swiper
 831
 832 #+begin_src emacs-lisp
 833 (use-package swiper
 834   :bind (([remap isearch-forward]  . swiper)
 835          ([remap isearch-backward] . swiper)))
 836 #+end_src
 837
 838 **** Counsel
 839
 840 #+begin_src emacs-lisp
 841 (use-package counsel
 842   :defer 1
 843   :bind (([remap execute-extended-command] . counsel-M-x)
 844          ([remap find-file] . counsel-find-file)
 845          ("s-r"     . counsel-recentf)
 846          :map minibuffer-local-map
 847          ("C-r" . counsel-minibuffer-history))
 848   :config
 849   (counsel-mode 1)
 850   (defalias 'locate #'counsel-locate))
 851 #+end_src
 852
 853 * Borg's =layer/essentials=
 854
 855 TODO: break this giant source block down into individual org sections.
 856
 857 #+begin_src emacs-lisp
 858 (use-package dash
 859   :config (dash-enable-font-lock))
 860
 861 (use-package diff-hl
 862   :config
 863   (setq diff-hl-draw-borders nil)
 864   (global-diff-hl-mode)
 865   (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
 866
 867 (use-package dired
 868   :defer t
 869   :config (setq dired-listing-switches "-alh"))
 870
 871 (use-package eldoc
 872   :when (version< "25" emacs-version)
 873   :config (global-eldoc-mode))
 874
 875 (use-package help
 876   :defer t
 877   :config (temp-buffer-resize-mode))
 878
 879 (progn ;    `isearch'
 880   (setq isearch-allow-scroll t))
 881
 882 (use-package lisp-mode
 883   :config
 884   (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
 885   (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
 886   (defun indent-spaces-mode ()
 887     (setq indent-tabs-mode nil))
 888   (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
 889
 890 (use-package man
 891   :defer t
 892   :config (setq Man-width 80))
 893
 894 (use-package paren
 895   :config (show-paren-mode))
 896
 897 (use-package prog-mode
 898   :config (global-prettify-symbols-mode)
 899   (defun indicate-buffer-boundaries-left ()
 900     (setq indicate-buffer-boundaries 'left))
 901   (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
 902
 903 (use-package recentf
 904   :demand t
 905   :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
 906
 907 (use-package savehist
 908   :config (savehist-mode))
 909
 910 (use-package saveplace
 911   :when (version< "25" emacs-version)
 912   :config (save-place-mode))
 913
 914 (use-package simple
 915   :config (column-number-mode))
 916
 917 (progn ;    `text-mode'
 918   (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
 919
 920 (use-package tramp
 921   :defer t
 922   :config
 923   (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
 924   (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
 925   (add-to-list 'tramp-default-proxies-alist
 926                (list (regexp-quote (system-name)) nil nil)))
 927
 928 (use-package undo-tree
 929   :config
 930   (global-undo-tree-mode)
 931   (setq undo-tree-mode-lighter ""))
 932 #+end_src
 933
 934 * Syntax and spell checking
 935 #+begin_src emacs-lisp
 936 (use-package flycheck
 937   :hook (prog-mode . flycheck-mode)
 938   :config
 939   ;; Use the load-path from running Emacs when checking elisp files
 940   (setq flycheck-emacs-lisp-load-path 'inherit)
 941
 942   ;; Only flycheck when I actually save the buffer
 943   (setq flycheck-check-syntax-automatically '(mode-enabled save)))
 944 #+end_src
 945 * Programming modes
 946
 947 ** [[https://github.com/leanprover/lean-mode][Lean]]
 948
 949 #+begin_src emacs-lisp
 950 (use-package lean-mode
 951   :bind (:map lean-mode-map
 952               ("S-SPC" . company-complete)))
 953 #+end_src
 954
 955 ** Haskell
 956
 957 *** [[https://github.com/haskell/haskell-mode][haskell-mode]]
 958
 959 #+begin_src emacs-lisp
 960 (use-package haskell-mode
 961   :config
 962   (setq haskell-indentation-layout-offset 4
 963         haskell-indentation-left-offset 4
 964         flycheck-checker 'haskell-hlint
 965         flycheck-disabled-checkers '(haskell-stack-ghc haskell-ghc)))
 966 #+end_src
 967
 968 *** [[https://github.com/mpickering/hlint-refactor-mode][hlint-refactor]]
 969
 970 Emacs bindings for [[https://github.com/ndmitchell/hlint][hlint]]'s refactor option. This requires the refact
 971 executable from [[https://github.com/mpickering/apply-refact][apply-refact]].
 972
 973 #+begin_src emacs-lisp
 974 (use-package hlint-refactor
 975   :bind (:map hlint-refactor-mode-map
 976               ("C-c l b" . hlint-refactor-refactor-buffer)
 977               ("C-c l r" . hlint-refactor-refactor-at-point))
 978   :hook (haskell-mode . hlint-refactor-mode))
 979 #+end_src
 980
 981 *** [[https://github.com/flycheck/flycheck-haskell][flycheck-haskell]]
 982
 983 #+begin_src emacs-lisp
 984 (use-package flycheck-haskell)
 985 #+end_src
 986
 987 *** [[https://github.com/ndmitchell/hlint/blob/20e116a043f2073c57b17b24ae6364b5e433ba7e/data/hs-lint.el][hs-lint.el]]
 988 :PROPERTIES:
 989 :header-args+: :tangle lisp/hs-lint.el :mkdirp yes
 990 :END:
 991
 992 Currently using =flycheck-haskell= with the =haskell-hlint= checker
 993 instead.
 994
 995 #+begin_src emacs-lisp :tangle no
 996 ;;; hs-lint.el --- minor mode for HLint code checking
 997
 998 ;; Copyright 2009 (C) Alex Ott
 999 ;;
1000 ;; Author: Alex Ott <alexott@gmail.com>
1001 ;; Keywords: haskell, lint, HLint
1002 ;; Requirements:
1003 ;; Status: distributed under terms of GPL2 or above
1004
1005 ;; Typical message from HLint looks like:
1006 ;;
1007 ;; /Users/ott/projects/lang-exp/haskell/test.hs:52:1: Eta reduce
1008 ;; Found:
1009 ;;   count1 p l = length (filter p l)
1010 ;; Why not:
1011 ;;   count1 p = length . filter p
1012
1013
1014 (require 'compile)
1015
1016 (defgroup hs-lint nil
1017   "Run HLint as inferior of Emacs, parse error messages."
1018   :group 'tools
1019   :group 'haskell)
1020
1021 (defcustom hs-lint-command "hlint"
1022   "The default hs-lint command for \\[hlint]."
1023   :type 'string
1024   :group 'hs-lint)
1025
1026 (defcustom hs-lint-save-files t
1027   "Save modified files when run HLint or no (ask user)"
1028   :type 'boolean
1029   :group 'hs-lint)
1030
1031 (defcustom hs-lint-replace-with-suggestions nil
1032   "Replace user's code with suggested replacements"
1033   :type 'boolean
1034   :group 'hs-lint)
1035
1036 (defcustom hs-lint-replace-without-ask nil
1037   "Replace user's code with suggested replacements automatically"
1038   :type 'boolean
1039   :group 'hs-lint)
1040
1041 (defun hs-lint-process-setup ()
1042   "Setup compilation variables and buffer for `hlint'."
1043   (run-hooks 'hs-lint-setup-hook))
1044
1045 ;; regex for replace suggestions
1046 ;;
1047 ;; ^\(.*?\):\([0-9]+\):\([0-9]+\): .*
1048 ;; Found:
1049 ;; \s +\(.*\)
1050 ;; Why not:
1051 ;; \s +\(.*\)
1052
1053 (defvar hs-lint-regex
1054   "^\\(.*?\\):\\([0-9]+\\):\\([0-9]+\\): .*[\n\C-m]Found:[\n\C-m]\\s +\\(.*\\)[\n\C-m]Why not:[\n\C-m]\\s +\\(.*\\)[\n\C-m]"
1055   "Regex for HLint messages")
1056
1057 (defun make-short-string (str maxlen)
1058   (if (< (length str) maxlen)
1059       str
1060     (concat (substring str 0 (- maxlen 3)) "...")))
1061
1062 (defun hs-lint-replace-suggestions ()
1063   "Perform actual replacement of suggestions"
1064   (goto-char (point-min))
1065   (while (re-search-forward hs-lint-regex nil t)
1066     (let* ((fname (match-string 1))
1067           (fline (string-to-number (match-string 2)))
1068           (old-code (match-string 4))
1069           (new-code (match-string 5))
1070           (msg (concat "Replace '" (make-short-string old-code 30)
1071                        "' with '" (make-short-string new-code 30) "'"))
1072           (bline 0)
1073           (eline 0)
1074           (spos 0)
1075           (new-old-code ""))
1076       (save-excursion
1077         (switch-to-buffer (get-file-buffer fname))
1078         (goto-char (point-min))
1079         (forward-line (1- fline))
1080         (beginning-of-line)
1081         (setf bline (point))
1082         (when (or hs-lint-replace-without-ask
1083                   (yes-or-no-p msg))
1084           (end-of-line)
1085           (setf eline (point))
1086           (beginning-of-line)
1087           (setf old-code (regexp-quote old-code))
1088           (while (string-match "\\\\ " old-code spos)
1089             (setf new-old-code (concat new-old-code
1090                                  (substring old-code spos (match-beginning 0))
1091                                  "\\ *"))
1092             (setf spos (match-end 0)))
1093           (setf new-old-code (concat new-old-code (substring old-code spos)))
1094           (remove-text-properties bline eline '(composition nil))
1095           (when (re-search-forward new-old-code eline t)
1096             (replace-match new-code nil t)))))))
1097
1098 (defun hs-lint-finish-hook (buf msg)
1099   "Function, that is executed at the end of HLint execution"
1100   (if hs-lint-replace-with-suggestions
1101       (hs-lint-replace-suggestions)
1102       (next-error 1 t)))
1103
1104 (define-compilation-mode hs-lint-mode "HLint"
1105   "Mode for check Haskell source code."
1106   (set (make-local-variable 'compilation-process-setup-function)
1107        'hs-lint-process-setup)
1108   (set (make-local-variable 'compilation-disable-input) t)
1109   (set (make-local-variable 'compilation-scroll-output) nil)
1110   (set (make-local-variable 'compilation-finish-functions)
1111        (list 'hs-lint-finish-hook))
1112   )
1113
1114 (defun hs-lint ()
1115   "Run HLint for current buffer with haskell source"
1116   (interactive)
1117   (save-some-buffers hs-lint-save-files)
1118   (compilation-start (concat hs-lint-command " \"" buffer-file-name "\"")
1119                      'hs-lint-mode))
1120
1121 (provide 'hs-lint)
1122 ;;; hs-lint.el ends here
1123 #+end_src
1124
1125 #+begin_src emacs-lisp :tangle no
1126 (use-package hs-lint
1127   :load-path "lisp/"
1128   :bind (:map haskell-mode-map
1129               ("C-c l l" . hs-lint)))
1130 #+end_src
1131 * Emacs Enhancements
1132
1133 ** [[https://github.com/justbur/emacs-which-key][which-key]]
1134
1135 #+begin_quote
1136 Emacs package that displays available keybindings in popup
1137 #+end_quote
1138
1139 #+begin_src emacs-lisp
1140 (use-package which-key
1141   :defer 1
1142   :config (which-key-mode))
1143 #+end_src
1144
1145 * Post initialization
1146 :PROPERTIES:
1147 :CUSTOM_ID: post-initialization
1148 :END:
1149
1150 Display how long it took to load the init file.
1151
1152 #+begin_src emacs-lisp
1153 (message "Loading %s...done (%.3fs)" user-init-file
1154          (float-time (time-subtract (current-time)
1155                                     ab--before-user-init-time)))
1156 #+end_src
1157
1158 * Footer
1159 :PROPERTIES:
1160 :CUSTOM_ID: footer
1161 :END:
1162
1163 #+begin_src emacs-lisp :comments none
1164 ;;; init.el ends here
1165 #+end_src