emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Polish & move new modeline into :ui modeline

Browse source 
Removes modeline library out of core-ui and contains them in :ui
doom-modeline and :ui modeline.

:ui modeline will eventually replace :ui doom-modeline, but is still
considered experimental. This update provides makes it much more stable
and closer to being feature complete.
This commit is contained in:
Henrik Lissner 2018-07-29 02:50:16 +02:00
parent db8ed4aac6
commit 088480047c
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
10 changed files with 1429 additions and 1272 deletions
Download patch file Download diff file Expand all files Collapse all files

0
modules/ui/modeline/README.org Normal file
View file

19
modules/ui/modeline/autoload/modeline.el Normal file
View file

@ -0,0 +1,19 @@
;;; ui/modeline/autoload/modeline.el -*- lexical-binding: t; -*-
;; (defvar +modeline--old-bar-height nil)
;; ;;;###autoload
;; (defun +modeline|resize-for-big-font ()
;; "Adjust the modeline's height when `doom-big-font-mode' is enabled. This was
;; made to be added to `doom-big-font-mode-hook'."
;; (unless +modeline--old-bar-height
;; (setq +modeline--old-bar-height +doom-modeline-height))
;; (let ((default-height +modeline--old-bar-height))
;; (if doom-big-font-mode
;; (let* ((font-size (font-get doom-font :size))
;; (big-size (font-get doom-big-font :size))
;; (ratio (/ (float big-size) font-size)))
;; (setq +doom-modeline-height (ceiling (* default-height ratio 0.75))))
;; (setq +doom-modeline-height default-height))
;; ;; already has a variable watcher in Emacs 26+
;; (unless EMACS26+ (+doom-modeline|refresh-bars))))

92
modules/ui/modeline/autoload/settings.el Normal file
View file

@ -0,0 +1,92 @@
;;; ui/modeline/autoload/settings.el -*- lexical-binding: t; -*-
(defvar +modeline--alist nil)
;;;###autodef
(defun def-modeline-format! (name left &optional right)
"Define a preset modeline format by name.
NAME is a symbol. The convention is to use keywords for global formats, like
:main or :project, but to use regular symbols for buffer-local formats, like
'twitter and 'pdf.
LEFT and RIGHT are lists that assume the same structure as `mode-line-format',
and make up the mode-line in two parts, separated by variable-width space, to
keep them left and right aligned respectively."
(setf (alist-get name +modeline--alist) (list left right)))
;;;###autodef
(defmacro def-modeline-segment! (name &rest rest)
"TODO"
(declare (doc-string 2))
(let ((docstring (if (and (stringp (car rest)) (cdr rest)) (pop rest)))
body)
(macroexp-progn
(if (not (keywordp (car rest)))
`((defvar-local ,name nil ,docstring)
(setq-default
,name
,(if (or (stringp (car rest))
(memq (car (car-safe rest)) '(:eval :propertize)))
(car rest)
`(quote (:eval ,(macroexp-progn rest)))))
(put ',name 'risky-local-variable t))
;; isolate body
(setq body rest)
(while (keywordp (car body))
(setq body (cddr body)))
;;
(cl-destructuring-bind (&key init faces on-hooks on-set activate deactivate &allow-other-keys)
rest
(let ((realvar (if (and body faces)
(intern (format "+modeline--var-%s" name))
name)))
(append (when body
(if (or on-hooks on-set)
(let ((setterfn (intern (format "+modeline--set-%s" name)))
(varsetterfn (intern (format "+modeline--setvar-%s" name))))
(append `((fset ',setterfn
(lambda (&rest _)
(when (or (memq ',name +modeline-format-left)
(memq ',name +modeline-format-right))
(setq-local ,realvar ,(macroexp-progn body)))))
(byte-compile ',setterfn))
(mapcar (lambda (hook) `(add-hook ',hook #',setterfn))
on-hooks)
(when on-set
`((fset ',varsetterfn
(lambda (sym val op where)
(and (eq op 'set) where
(with-current-buffer where
(set sym val)
(,setterfn)))))
,@(mapcar (lambda (var) `(add-variable-watcher ',var #',varsetterfn))
on-set)))))
(setq init `(quote (:eval ,(macroexp-progn body))))
nil))
(if (eq realvar name)
`((defvar-local ,name nil ,docstring)
(setq-default ,name ,init))
`((defvar-local ,realvar nil)
(defvar-local ,name nil ,docstring)
(setq-default
,name '(:eval (cond ((active) ,realvar)
(,realvar (substring-no-properties ,realvar)))))))
`((put ',name 'risky-local-variable t)))))))))
;;;###autodef
(defun set-modeline! (name &optional default)
"Replace the current buffer's modeline with a preset mode-line format defined
with `def-modeline-format!'.
If DEFAULT is non-nil, make it the default mode-line for all buffers."
(cl-check-type name symbol)
(let ((modeline (cdr (assq name +modeline--alist))))
(unless modeline
(error "The %s modeline format does not exist" name))
(if default
(setq-default +modeline-format-left `("" ,@(car modeline))
+modeline-format-right `("" ,@(cadr modeline)))
(setq +modeline-format-left `("" ,@(car modeline))
+modeline-format-right `("" ,@(cadr modeline))))
(force-mode-line-update)))

532
modules/ui/modeline/config.el Normal file
View file

@ -0,0 +1,532 @@
;;; ui/modeline/config.el -*- lexical-binding: t; -*-
;; This mode-line is experimental, may have bugs and is likely to change. It
;; also doesn't have all the features of the old modeline (yet).
;;
;; However, it is at least twice as fast as the original modeline, and a little
;; more flexible, what with `+modeline-format-left' and
;; `+modeline-format-right'. It also exposes a more powerful API for defining
;; modelines and modeline segments that make use of variable watchers and hooks
;; to update them.
;;;; Benchmarks
;; (benchmark-run 1000 (format-mode-line mode-line-format))
;; Old system: ~0.198
;; New system: ~0.056
(defvar +modeline-height 21
"How tall the mode-line should be (only respected in GUI emacs).")
(defvar +modeline-buffer-path-function #'+modeline-file-path
"The function that returns the buffer name display for file-visiting
buffers.")
;;
(defvar-local +modeline-format-left () "TODO")
(defvar-local +modeline-format-right () "TODO")
(put '+modeline-format-left 'risky-local-variable t)
(put '+modeline-format-right 'risky-local-variable t)
;; Convenience aliases
(defvaralias 'mode-line-format-left '+modeline-format-left)
(defvaralias 'mode-line-format-right '+modeline-format-right)
;; externs
(defvar anzu--state nil)
(defvar evil-mode nil)
(defvar evil-state nil)
(defvar evil-visual-selection nil)
(defvar iedit-mode nil)
(defvar all-the-icons-scale-factor)
(defvar all-the-icons-default-adjust)
;;
;; Custom faces
;;
(defgroup +modeline nil
"TODO"
:group 'faces)
(defface doom-modeline-buffer-path
'((t (:inherit (mode-line-emphasis bold))))
"Face used for the dirname part of the buffer path."
:group '+modeline)
(defface doom-modeline-buffer-file
'((t (:inherit (mode-line-buffer-id bold))))
"Face used for the filename part of the mode-line buffer path."
:group '+modeline)
(defface doom-modeline-buffer-modified '((t (:inherit (error bold) :background nil)))
"Face used for the 'unsaved' symbol in the mode-line."
:group '+modeline)
(defface doom-modeline-buffer-major-mode '((t (:inherit (mode-line-emphasis bold))))
"Face used for the major-mode segment in the mode-line."
:group '+modeline)
(defface doom-modeline-highlight '((t (:inherit mode-line-emphasis)))
"Face for bright segments of the mode-line."
:group '+modeline)
(defface doom-modeline-panel '((t (:inherit mode-line-highlight)))
"Face for 'X out of Y' segments, such as `+modeline--anzu',
`+modeline--evil-substitute' and `iedit'"
:group '+modeline)
(defface doom-modeline-info `((t (:inherit (success bold))))
"Face for info-level messages in the modeline. Used by `*vc'."
:group '+modeline)
(defface doom-modeline-warning `((t (:inherit (warning bold))))
"Face for warnings in the modeline. Used by `*flycheck'"
:group '+modeline)
(defface doom-modeline-urgent `((t (:inherit (error bold))))
"Face for errors in the modeline. Used by `*flycheck'"
:group '+modeline)
(defface doom-modeline-bar '((t (:inherit highlight)))
"The face used for the left-most bar on the mode-line of an active window."
:group '+modeline)
;;
;; Plugins
;;
(def-package! anzu
:after-call isearch-mode
:config
(setq anzu-cons-mode-line-p nil
anzu-minimum-input-length 1
anzu-search-threshold 250)
(global-anzu-mode +1)
(defun +modeline*fix-anzu-count (positions here)
(cl-loop for (start . end) in positions
collect t into before
when (and (>= here start) (<= here end))
return (length before)
finally return 0))
(advice-add #'anzu--where-is-here :override #'+modeline*fix-anzu-count)
;; Avoid anzu conflicts across buffers
(mapc #'make-variable-buffer-local
'(anzu--total-matched anzu--current-position anzu--state
anzu--cached-count anzu--cached-positions anzu--last-command
anzu--last-isearch-string anzu--overflow-p))
;; Ensure anzu state is cleared when searches & iedit are done
(add-hook 'isearch-mode-end-hook #'anzu--reset-status t)
(add-hook 'doom-escape-hook #'anzu--reset-status t)
(add-hook 'iedit-mode-end-hook #'anzu--reset-status))
(def-package! evil-anzu
:when (featurep! :feature evil)
:after-call (evil-ex-start-search evil-ex-start-word-search))
;;
;; Hacks
;;
;; Keep `+modeline-current-window' up-to-date
(defvar +modeline-current-window (frame-selected-window))
(defun +modeline|set-selected-window (&rest _)
"Sets `+modeline-current-window' appropriately"
(when-let* ((win (frame-selected-window)))
(unless (minibuffer-window-active-p win)
(setq +modeline-current-window win)
(force-mode-line-update))))
(defun +modeline|unset-selected-window ()
(setq +modeline-current-window nil)
(force-mode-line-update))
(add-hook 'window-configuration-change-hook #'+modeline|set-selected-window)
(add-hook 'doom-enter-window-hook #'+modeline|set-selected-window)
(if (not (boundp 'after-focus-change-function))
(progn
(add-hook 'focus-in-hook #'+modeline|set-selected-window)
(add-hook 'focus-out-hook #'+modeline|unset-selected-window))
(defun +modeline|refresh-frame ()
(setq +modeline-current-window nil)
(cl-loop for frame in (frame-list)
if (eq (frame-focus-state frame) t)
return (setq +modeline-current-window (frame-selected-window frame)))
(force-mode-line-update t))
(add-function :after after-focus-change-function #'+modeline|refresh-frame))
(defsubst active ()
(eq (selected-window) +modeline-current-window))
;; Ensure modeline is inactive when Emacs is unfocused (and active otherwise)
(defvar +modeline-remap-face-cookie nil)
(defun +modeline|focus ()
(when +modeline-remap-face-cookie
(require 'face-remap)
(face-remap-remove-relative +modeline-remap-face-cookie)))
(add-hook 'focus-in-hook #'+modeline|focus)
(defun +modeline|unfocus ()
(setq +modeline-remap-face-cookie (face-remap-add-relative 'mode-line 'mode-line-inactive)))
(add-hook 'focus-out-hook #'+modeline|unfocus)
;;
;; Helpers
;;
(defun +modeline--make-xpm (width height &optional color)
"Create an XPM bitmap. Inspired by `powerline''s `pl/make-xpm'."
(propertize
" " 'display
(let ((data (make-list height (make-list width 1)))
(color (or color "None")))
(ignore-errors
(create-image
(concat
(format "/* XPM */\nstatic char * percent[] = {\n\"%i %i 2 1\",\n\". c %s\",\n\" c %s\","
(length (car data)) (length data) color color)
(cl-loop with idx = 0
with len = (length data)
for dl in data
do (cl-incf idx)
concat "\""
concat (cl-loop for d in dl
if (= d 0) collect (string-to-char " ")
else collect (string-to-char "."))
concat (if (eq idx len) "\"};" "\",\n")))
'xpm t :ascent 'center)))))
(defun +modeline-file-path (&optional path)
(let ((buffer-file-name (or path buffer-file-name))
(root (doom-project-root)))
(cond ((null root)
(propertize "%b" 'face 'doom-modeline-buffer-file))
((or (null buffer-file-name)
(directory-name-p buffer-file-name))
(propertize (abbreviate-file-name (or buffer-file-name default-directory))
'face 'doom-modeline-buffer-path))
((let* ((modified-faces (if (buffer-modified-p) 'doom-modeline-buffer-modified))
(true-filename (file-truename buffer-file-name))
(relative-dirs (file-relative-name (file-name-directory true-filename)
(concat root "../")))
(relative-faces (or modified-faces 'doom-modeline-buffer-path))
(file-faces (or modified-faces 'doom-modeline-buffer-file)))
(if (equal "./" relative-dirs) (setq relative-dirs ""))
(concat (propertize relative-dirs 'face (if relative-faces `(:inherit ,relative-faces)))
(propertize (file-name-nondirectory true-filename)
'face (if file-faces `(:inherit ,file-faces)))))))))
;; TODO Add shrink-path alternatives
;;
;; Bars
;;
(defvar +modeline-bar-active nil "TODO")
(defvar +modeline-bar-inactive nil "TODO")
(defun +modeline|setup-bars ()
(setq +modeline-bar-active
(+modeline--make-xpm 3 +modeline-height (face-background 'doom-modeline-bar))
+modeline-bar-inactive
(+modeline--make-xpm 3 +modeline-height)))
(add-hook 'doom-load-theme-hook #'+modeline|setup-bars)
(defun +modeline|setup-bars-after-change (_sym val op _where)
(when (eq op 'set)
(let ((+modeline-height val))
(+modeline|setup-bars))))
(add-variable-watcher '+modeline-height #'+modeline|setup-bars-after-change)
(def-modeline-segment! +modeline-bar
(if (active) +modeline-bar-active +modeline-bar-inactive))
;;
;; Segments
;;
(defun +modeline|update-on-change ()
(+modeline--set-+modeline-buffer-state)
(remove-hook 'post-command-hook #'+modeline|update-on-change t))
(defun +modeline|start-update-on-change ()
(add-hook 'post-command-hook #'+modeline|update-on-change nil t))
(add-hook 'first-change-hook #'+modeline|start-update-on-change)
(advice-add #'undo :after #'+modeline--set-+modeline-buffer-state)
(advice-add #'undo-tree-undo :after #'+modeline--set-+modeline-buffer-state)
(def-modeline-segment! +modeline-buffer-state
:on-hooks (find-file-hook
read-only-mode-hook
after-change-functions
after-save-hook
after-revert-hook)
(let ((icon (cond (buffer-read-only
(all-the-icons-octicon
"lock"
:face 'doom-modeline-warning
:v-adjust -0.05))
((buffer-modified-p)
(all-the-icons-faicon
"floppy-o"
:face 'doom-modeline-buffer-modified
:v-adjust -0.05))
((and buffer-file-name (not (file-exists-p buffer-file-name)))
(all-the-icons-octicon
"circle-slash"
:face 'doom-modeline-urgent
:v-adjust -0.05)))))
(if icon (concat icon " "))))
(def-modeline-segment! +modeline-buffer-id
:on-hooks (find-file-hook after-save-hook after-revert-hook)
:faces t
(if buffer-file-name
(funcall +modeline-buffer-path-function buffer-file-name)
"%b"))
(def-modeline-segment! +modeline-buffer-directory
(let ((face (if (active) 'doom-modeline-buffer-path)))
(concat (if (display-graphic-p) " ")
(all-the-icons-octicon
"file-directory"
:face face
:v-adjust -0.1
:height 1.25)
" "
(propertize (abbreviate-file-name default-directory)
'face face))))
(def-modeline-segment! +modeline-vcs
:on-set (vc-mode)
(when (and vc-mode buffer-file-name)
(let* ((backend (vc-backend buffer-file-name))
(state (vc-state buffer-file-name backend)))
(let ((face 'mode-line-inactive)
(active (active))
(all-the-icons-default-adjust -0.1))
(concat " "
(cond ((memq state '(edited added))
(if active (setq face 'doom-modeline-info))
(all-the-icons-octicon
"git-compare"
:face face
:v-adjust -0.05))
((eq state 'needs-merge)
(if active (setq face 'doom-modeline-info))
(all-the-icons-octicon "git-merge" :face face))
((eq state 'needs-update)
(if active (setq face 'doom-modeline-warning))
(all-the-icons-octicon "arrow-down" :face face))
((memq state '(removed conflict unregistered))
(if active (setq face 'doom-modeline-urgent))
(all-the-icons-octicon "alert" :face face))
(t
(if active (setq face 'font-lock-doc-face))
(all-the-icons-octicon
"git-compare"
:face face
:v-adjust -0.05)))
" "
(propertize (substring vc-mode (+ (if (eq backend 'Hg) 2 3) 2))
'face (if active face))
" ")))))
(def-modeline-segment! +modeline-encoding
:on-hooks (after-revert-hook after-save-hook find-file-hook)
:on-set (buffer-file-coding-system)
(concat (pcase (coding-system-eol-type buffer-file-coding-system)
(0 "LF ")
(1 "CRLF ")
(2 "CR "))
(let ((sys (coding-system-plist buffer-file-coding-system)))
(if (memq (plist-get sys :category) '(coding-category-undecided coding-category-utf-8))
"UTF-8"
(upcase (symbol-name (plist-get sys :name)))))
" "))
(def-modeline-segment! +modeline-major-mode
:on-set (mode-name)
:faces t
(propertize (format-mode-line mode-name)
'face 'doom-modeline-buffer-major-mode))
(defun +modeline--macro-recording ()
"Display current Emacs or evil macro being recorded."
(when (and (active) (or defining-kbd-macro executing-kbd-macro))
(let ((sep (propertize " " 'face 'doom-modeline-panel)))
(concat sep
(propertize (if (bound-and-true-p evil-this-macro)
(char-to-string evil-this-macro)
"Macro")
'face 'doom-modeline-panel)
sep
(all-the-icons-octicon "triangle-right"
:face 'doom-modeline-panel
:v-adjust -0.05)
sep))))
(defsubst +modeline--anzu ()
"Show the match index and total number thereof. Requires `anzu', also
`evil-anzu' if using `evil-mode' for compatibility with `evil-search'."
(when (and anzu--state (not iedit-mode))
(propertize
(let ((here anzu--current-position)
(total anzu--total-matched))
(cond ((eq anzu--state 'replace-query)
(format " %d replace " total))
((eq anzu--state 'replace)
(format " %d/%d " here total))
(anzu--overflow-p
(format " %s+ " total))
((format " %s/%d " here total))))
'face (if (active) 'doom-modeline-panel))))
(defsubst +modeline--evil-substitute ()
"Show number of matches for evil-ex substitutions and highlights in real time."
(when (and evil-mode
(or (assq 'evil-ex-substitute evil-ex-active-highlights-alist)
(assq 'evil-ex-global-match evil-ex-active-highlights-alist)
(assq 'evil-ex-buffer-match evil-ex-active-highlights-alist)))
(propertize
(let ((range (if evil-ex-range
(cons (car evil-ex-range) (cadr evil-ex-range))
(cons (line-beginning-position) (line-end-position))))
(pattern (car-safe (evil-delimited-arguments evil-ex-argument 2))))
(if pattern
(format " %s matches " (how-many pattern (car range) (cdr range)))
" - "))
'face (if (active) 'doom-modeline-panel))))
(defun doom-themes--overlay-sort (a b)
(< (overlay-start a) (overlay-start b)))
(defsubst +modeline--iedit ()
"Show the number of iedit regions matches + what match you're on."
(when (and iedit-mode iedit-occurrences-overlays)
(propertize
(let ((this-oc (or (let ((inhibit-message t))
(iedit-find-current-occurrence-overlay))
(progn (iedit-prev-occurrence)
(iedit-find-current-occurrence-overlay))))
(length (length iedit-occurrences-overlays)))
(format " %s/%d "
(if this-oc
(- length
(length (memq this-oc (sort (append iedit-occurrences-overlays nil)
#'doom-themes--overlay-sort)))
-1)
"-")
length))
'face (if (active) 'doom-modeline-panel))))
(def-modeline-segment! +modeline-matches
"Displays: 1. the currently recording macro, 2. A current/total for the
current search term (with anzu), 3. The number of substitutions being conducted
with `evil-ex-substitute', and/or 4. The number of active `iedit' regions."
(let ((meta (concat (+modeline--macro-recording)
(+modeline--anzu)
(+modeline--evil-substitute)
(+modeline--iedit)
" ")))
(or (and (not (equal meta " ")) meta)
(if buffer-file-name " %I "))))
;;
(defsubst doom-column (pos)
(save-excursion (goto-char pos)
(current-column)))
(defvar-local +modeline-enable-word-count nil
"If non-nil, a word count will be added to the selection-info modeline
segment.")
(defun +modeline|enable-word-count ()
(setq +modeline-enable-word-count t))
(add-hook 'text-mode-hook #'+modeline|enable-word-count)
(def-modeline-segment! +modeline-selection-info
(let ((beg (or evil-visual-beginning (region-beginning)))
(end (or evil-visual-end (region-end))))
(propertize
(let ((lines (count-lines beg (min end (point-max)))))
(concat (cond ((or (bound-and-true-p rectangle-mark-mode)
(eq 'block evil-visual-selection))
(let ((cols (abs (- (doom-column end)
(doom-column beg)))))
(format "%dx%dB" lines cols)))
((eq evil-visual-selection 'line)
(format "%dL" lines))
((> lines 1)
(format "%dC %dL" (- end beg) lines))
((format "%dC" (- end beg))))
(when +modeline-enable-word-count
(format " %dW" (count-words beg end)))))
'face 'doom-modeline-highlight)))
(defun +modeline|enable-selection-info ()
(add-to-list '+modeline-format-left '+modeline-selection-info t #'eq))
(defun +modeline|disable-selection-info ()
(setq +modeline-format-left (delq '+modeline-selection-info +modeline-format-left)))
(cond ((featurep 'evil)
(add-hook 'evil-visual-state-entry-hook #'+modeline|enable-selection-info)
(add-hook 'evil-visual-state-exit-hook #'+modeline|disable-selection-info))
((add-hook 'activate-mark-hook #'+modeline|enable-selection-info)
(add-hook 'deactivate-mark-hook #'+modeline|disable-selection-info)))
;;
;; Preset modeline formats
;;
(def-modeline-format! :main
'(+modeline-matches " "
+modeline-buffer-state
+modeline-buffer-id
" %2l:%c %p ")
'(+modeline-encoding
+modeline-major-mode
+modeline-vcs))
(def-modeline-format! :minimal
'(+modeline-matches " "
+modeline-buffer-state
+modeline-buffer-id)
'(+modeline-major-mode))
(def-modeline-format! :special
'(+modeline-matches +modeline-buffer-state " %b " +modeline-buffer-position)
'(+modeline-encoding +modeline-major-mode))
(def-modeline-format! :project
'(+modeline-buffer-directory)
'(+modeline-major-mode))
;;
;;
;;
(def-modeline-segment! +modeline--rest
(let ((rhs-str (format-mode-line +modeline-format-right)))
(list (propertize
" " 'display
`((space :align-to (- (+ right right-fringe right-margin)
,(1+ (string-width rhs-str))))))
rhs-str)))
(setq-default mode-line-format '("" +modeline-bar +modeline-format-left +modeline--rest))
;;
(set-modeline! :main t)
(add-hook! '+doom-dashboard-mode-hook (set-modeline! :project))
(add-hook! 'doom-scratch-buffer-hook (set-modeline! :special))

20
modules/ui/modeline/packages.el Normal file
View file

@ -0,0 +1,20 @@
;; -*- no-byte-compile: t; -*-
;;; ui/modeline/packages.el
;;; These are the invisible dependencies
;; Required
;;(require 'evil)
;;(require 'projectile)
;;(require 'all-the-icons)
;; Optional
;;(require 'flycheck)
;;(require 'iedit)
;;(require 'evil-multiedit)
(package! anzu)
(when (featurep! :feature evil)
(package! evil-anzu))
;; TODO (package! shrink-path)