Refactor line number implementation

+ Add relative line number support (see doom-line-numbers-style)
+ Update doom/toggle-line-numbers
+ New hook functions: doom|enable-line-numbers,
  doom|disable-line-numbers

Addresses #156

core/autoload/ui.el

@@ -14,11 +14,14 @@
   "Toggle `linum-mode'."
   (interactive "P")
   (cond ((boundp 'display-line-numbers)
-         (setq display-line-numbers (not display-line-numbers)))
+         (setq display-line-numbers
+               (pcase arg
+                 ('(4) 'relative)
+                 (1 t)
+                 (-1 nil)
+                 (_ (not display-line-numbers)))))
         ((featurep 'nlinum)
          (nlinum-mode (or arg (if nlinum-mode -1 +1))))
-        ((featurep 'linum)
-         (linum-mode (or arg (if linum-mode -1 +1))))
         (t
          (error "No line number plugin detected"))))
 

core/core-ui.el

@@ -25,21 +25,6 @@
 return a string). This changes the 'long' name of a major-mode, allowing for
 shorter major mode name in the mode-line. See `doom|set-mode-name'.")
 
-;; Line numbers
-(defvar doom-line-number-lpad 4
-  "How much padding to place before line numbers.")
-
-(defvar doom-line-number-rpad 1
-  "How much padding to place after line numbers.")
-
-(defvar doom-line-number-pad-char 32
-  "Character to use for padding line numbers.
-
-By default, this is a space key. If you use `whitespace-mode' with `space-mark',
-the whitespace in line numbers will be affected (this can look ugly). In this
-case, you can change this to ?\u2002, which is a unicode character that looks
-like a space that `whitespace-mode' won't affect.")
-
 
 ;; Hook(s)
 (defvar doom-init-ui-hook nil
@@ -73,6 +58,7 @@ like a space that `whitespace-mode' won't affect.")
  bidi-display-reordering nil ; disable bidirectional text for tiny performance boost
  blink-matching-paren nil    ; don't blink--too distracting
  cursor-in-non-selected-windows nil  ; hide cursors in other windows
+ display-line-numbers-width 3
  frame-inhibit-implied-resize t
  ;; remove continuation arrow on right fringe
  fringe-indicator-alist (delq (assq 'continuation fringe-indicator-alist)
@@ -256,13 +242,6 @@ local value, whether or not it's permanent-local. Therefore, we cycle
 (add-hook! '(doom-post-init-hook minibuffer-setup-hook)
   #'doom|no-fringes-in-minibuffer)
 
-;; line numbers in newer version of Emacs
-(when (boundp 'display-line-numbers)
-  (defun doom|init-line-numbers ()
-    (unless (eq major-mode 'org-mode)
-      (setq display-line-numbers t)))
-  (add-hook! (prog-mode text-mode) #'doom|init-line-numbers))
-
 
 ;;
 ;; Plugins
@@ -312,10 +291,6 @@ local value, whether or not it's permanent-local. Therefore, we cycle
   (setq hl-line-sticky-flag nil
         global-hl-line-sticky-flag nil)
 
-  ;; Fix lingering hl-line overlays
-  (add-hook! 'hl-line-mode-hook
-    (remove-overlays (point-min) (point-max) 'face 'hl-line))
-
   (after! evil
     ;; Disable `hl-line' in evil-visual mode (temporarily). `hl-line' can make
     ;; the selection region harder to see while in evil visual mode.
@@ -324,64 +299,6 @@ local value, whether or not it's permanent-local. Therefore, we cycle
     (add-hook 'evil-visual-state-entry-hook #'doom|turn-off-hl-line)
     (add-hook 'evil-visual-state-exit-hook #'hl-line-mode)))
 
-;; Line number column. A faster (or equivalent, in the worst case) line number
-;; plugin than the built-in `linum'. This will be ignored if you're using Emacs
-;; 26.1+, which has native line number support.
-(def-package! nlinum
-  :unless (boundp 'display-line-numbers)
-  :commands nlinum-mode
-  :init
-  (defun doom|init-nlinum-mode ()
-    "Turn on `nlinum-mode', except in org-mode"
-    (unless (eq major-mode 'org-mode)
-      (nlinum-mode +1)))
-  (add-hook! (prog-mode text-mode) #'doom|init-nlinum-mode)
-  :config
-  (setq nlinum-highlight-current-line t)
-
-  (defun doom-nlinum-format-fn (line _width)
-    "A more customizable `nlinum-format-function'. See `doom-line-number-lpad',
-`doom-line-number-rpad' and `doom-line-number-pad-char'. Allows a fix for
-`whitespace-mode' space-marks appearing inside the line number."
-    (let ((str (number-to-string line)))
-      (setq str (concat (make-string (max 0 (- doom-line-number-lpad (length str)))
-                                     doom-line-number-pad-char)
-                        str
-                        (make-string doom-line-number-rpad doom-line-number-pad-char)))
-      (put-text-property 0 (length str) 'face
-                         (if (and nlinum-highlight-current-line
-                                  (= line nlinum--current-line))
-                             'nlinum-current-line
-                           'linum)
-                         str)
-      str))
-  (setq nlinum-format-function #'doom-nlinum-format-fn)
-
-  (defun doom|init-nlinum-width ()
-    "Calculate line number column width beforehand (optimization)."
-    (setq nlinum--width
-          (length (save-excursion (goto-char (point-max))
-                                  (format-mode-line "%l")))))
-  (add-hook 'nlinum-mode-hook #'doom|init-nlinum-width))
-
-;; Fixes disappearing line numbers in nlinum and other quirks
-(def-package! nlinum-hl
-  :unless (boundp 'display-line-numbers)
-  :after nlinum
-  :config
-  ;; With `markdown-fontify-code-blocks-natively' enabled in `markdown-mode',
-  ;; line numbers tend to vanish next to code blocks.
-  (advice-add #'markdown-fontify-code-block-natively
-              :after #'nlinum-hl-do-markdown-fontify-region)
-
-  ;; When using `web-mode's code-folding an entire range of line numbers will
-  ;; vanish in the affected area.
-  (advice-add #'web-mode-fold-or-unfold :after #'nlinum-hl-do-generic-flush)
-
-  ;; Changing fonts can leave nlinum line numbers in their original size; this
-  ;; forces them to resize.
-  (advice-add #'set-frame-font :after #'nlinum-hl-flush-all-windows))
-
 ;; Helps us distinguish stacked delimiter pairs. Especially in parentheses-drunk
 ;; languages like Lisp.
 (def-package! rainbow-delimiters
@@ -403,6 +320,119 @@ local value, whether or not it's permanent-local. Therefore, we cycle
                 visual-fill-column-width fill-column))
 
 
+;;
+;; Line numbers
+;;
+
+(defvar doom-line-numbers-style t
+  "The style to use for the line number display.
+
+Accepts the same arguments as `display-line-numbers', which are:
+
+nil         No line numbers
+t           Ordinary line numbers
+'relative   Relative line numbers")
+
+(defun doom|enable-line-numbers (&optional arg)
+  "Enables the display of line numbers, using `display-line-numbers' (in Emacs
+26+) or `nlinum-mode'.
+
+See `doom-line-numbers-style' to control the style of line numbers to display."
+  (cond ((boundp 'display-line-numbers)
+         (setq display-line-numbers
+               (pcase arg
+                 (+1 doom-line-numbers-style)
+                 (-1 nil)
+                 (_ doom-line-numbers-style))))
+        ((eq doom-line-numbers-style 'relative)
+         (if (= arg -1)
+             (nlinum-relative-off)
+           (nlinum-relative-on)))
+        ((not (null doom-line-numbers-style))
+         (nlinum-mode (or arg +1)))))
+
+(defun doom|disable-line-numbers ()
+  "Disable the display of line numbers."
+  (doom|enable-line-numbers -1))
+
+(add-hook! (prog-mode text-mode conf-mode)
+  #'(doom|enable-line-numbers hl-line-mode))
+
+;; Emacs 26+ has native line number support.
+(unless (boundp 'display-line-numbers)
+  ;; Line number column. A faster (or equivalent, in the worst case) line number
+  ;; plugin than `linum-mode'.
+  (def-package! nlinum
+    :commands nlinum-mode
+    :init
+    (defvar doom-line-number-lpad 4
+      "How much padding to place before line numbers.")
+    (defvar doom-line-number-rpad 1
+      "How much padding to place after line numbers.")
+    (defvar doom-line-number-pad-char 32
+      "Character to use for padding line numbers.
+
+By default, this is a space character. If you use `whitespace-mode' with
+`space-mark', the whitespace in line numbers will be affected (this can look
+ugly). In this case, you can change this to ?\u2002, which is a unicode
+character that looks like a space that `whitespace-mode' won't affect.")
+
+    :config
+    (setq nlinum-highlight-current-line t)
+
+    ;; Fix lingering hl-line overlays (caused by nlinum)
+    (add-hook! 'hl-line-mode-hook
+      (remove-overlays (point-min) (point-max) 'face 'hl-line))
+
+    (defun doom-nlinum-format-fn (line _width)
+      "A more customizable `nlinum-format-function'. See `doom-line-number-lpad',
+`doom-line-number-rpad' and `doom-line-number-pad-char'. Allows a fix for
+`whitespace-mode' space-marks appearing inside the line number."
+      (let ((str (number-to-string line)))
+        (setq str (concat (make-string (max 0 (- doom-line-number-lpad (length str)))
+                                       doom-line-number-pad-char)
+                          str
+                          (make-string doom-line-number-rpad doom-line-number-pad-char)))
+        (put-text-property 0 (length str) 'face
+                           (if (and nlinum-highlight-current-line
+                                    (= line nlinum--current-line))
+                               'nlinum-current-line
+                             'linum)
+                           str)
+        str))
+    (setq nlinum-format-function #'doom-nlinum-format-fn)
+
+    (defun doom|init-nlinum-width ()
+      "Calculate line number column width beforehand (optimization)."
+      (setq nlinum--width
+            (length (save-excursion (goto-char (point-max))
+                                    (format-mode-line "%l")))))
+    (add-hook 'nlinum-mode-hook #'doom|init-nlinum-width))
+
+  ;; Fixes disappearing line numbers in nlinum and other quirks
+  (def-package! nlinum-hl
+    :after nlinum
+    :config
+    ;; With `markdown-fontify-code-blocks-natively' enabled in `markdown-mode',
+    ;; line numbers tend to vanish next to code blocks.
+    (advice-add #'markdown-fontify-code-block-natively
+                :after #'nlinum-hl-do-markdown-fontify-region)
+
+    ;; When using `web-mode's code-folding an entire range of line numbers will
+    ;; vanish in the affected area.
+    (advice-add #'web-mode-fold-or-unfold :after #'nlinum-hl-do-generic-flush)
+
+    ;; Changing fonts can leave nlinum line numbers in their original size; this
+    ;; forces them to resize.
+    (advice-add #'set-frame-font :after #'nlinum-hl-flush-all-windows))
+
+  (def-package! nlinum-relative
+    :commands nlinum-relative-mode
+    :config
+    (after! evil
+      (nlinum-relative-setup-evil))))
+
+
 ;;
 ;; Modeline
 ;;

core/packages.el

@@ -19,7 +19,8 @@
 (package! highlight-numbers)
 (unless (boundp 'display-line-numbers)
   (package! nlinum)
-  (package! nlinum-hl))
+  (package! nlinum-hl)
+  (package! nlinum-relative))
 (package! rainbow-delimiters)
 (package! vi-tilde-fringe)
 (package! visual-fill-column)

modules/org/org/config.el

@@ -45,6 +45,7 @@
 (defun +org|hook ()
   "Run everytime `org-mode' is enabled."
   (setq line-spacing 1)
+  (doom|disable-line-numbers)
 
   ;; show-paren-mode causes problems for org-indent-mode
   (make-local-variable 'show-paren-mode)