This repository has been archived by the owner on Jan 1, 2022. It is now read-only.
forked from mclear-tools/bespoke-themes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bespoke-modeline.el
585 lines (508 loc) · 23.5 KB
/
bespoke-modeline.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
;;; bespoke-modeline.el -- custom mode line for bespoke theme ;; -*- lexical-binding: t -*-
;; Copyright (C) 2020 Colin McLear
;; -------------------------------------------------------------------
;; Authors: Colin McLear
;; -------------------------------------------------------------------
;; URL: https://github.com/mclear-tools/bespoke-themes
;; -------------------------------------------------------------------
;; Version: 1
;; Package-Requires: ((emacs "25.1"))
;; -------------------------------------------------------------------
;; This file is not part of GNU Emacs.
;;
;; This program is free software: you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;; General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>
;; -------------------------------------------------------------------
;; Commentary:
;; A custom mode line for bespoke-theme
;; This mode line originated as a fork of nano-emacs modeline.
;; See https://github.com/rougier/nano-emacs
;; https://github.com/rougier/nano-modeline
;; -------------------------------------------------------------------
;;
;; Bespoke mode line format:
;;
;; [ status | name (primary) secondary | item1 | item2 ]
;;
;; -------------------------------------------------------------------
;;; Requirements
(eval-when-compile
(require 'subr-x)
(require 'cl-lib))
;;; Visual bell for mode line
;; See https://github.com/hlissner/emacs-doom-themes for the idea
(require 'face-remap)
(defface bespoke-visual-bell '((t (:underline "red3")))
"Face to use for the mode-line when `bespoke-themes-visual-bell-config' is used."
:group 'bespoke-themes)
;;;###autoload
(defun bespoke-themes-visual-bell-fn ()
"Blink the mode-line red briefly. Set `ring-bell-function' to this to use it."
(let ((bespoke-themes--bell-cookie (face-remap-add-relative 'mode-line 'bespoke-visual-bell)))
(force-mode-line-update)
(run-with-timer 0.15 nil
(lambda (cookie buf)
(with-current-buffer buf
(face-remap-remove-relative cookie)
(force-mode-line-update)))
bespoke-themes--bell-cookie
(current-buffer))))
;;;###autoload
(defun bespoke-themes-visual-bell-config ()
"Enable flashing the mode-line on error."
(setq ring-bell-function #'bespoke-themes-visual-bell-fn
visible-bell t))
(when bespoke-set-visual-bell
(bespoke-themes-visual-bell-config))
;;; Inactive Modeline
;; See https://emacs.stackexchange.com/a/26345/11934
;; https://github.com/rougier/nano-modeline
;; Set variable to define inactive faces
(defvar bespoke-modeline--selected-window nil
"Currently selected window")
;;; Clean mode line
;; https://www.masteringemacs.org/article/hiding-replacing-modeline-strings
;; NOTE: this is only for minor and major modes
(defvar mode-line-cleaner-alist
`((auto-complete-mode . " α")
(yas/minor-mode . " υ")
(paredit-mode . " π")
(eldoc-mode . "")
(abbrev-mode . "")
;; Major modes
(dired-mode . "Dir")
(lisp-interaction-mode . "λ")
(hi-lock-mode . "")
(python-mode . "Py")
(emacs-lisp-mode . "EL")
(nxhtml-mode . "nx")
(markdown-mode . "MD")
(fundamental-mode . "FL"))
"Alist for `clean-mode-line'.
When you add a new element to the alist, keep in mind that you
must pass the correct minor/major mode symbol and a string you
want to use in the modeline *in lieu of* the original.")
(defun clean-mode-line ()
(interactive)
(cl-loop for cleaner in mode-line-cleaner-alist
do (let* ((mode (car cleaner))
(mode-str (cdr cleaner))
(old-mode-str (cdr (assq mode minor-mode-alist))))
(when old-mode-str
(setcar old-mode-str mode-str))
;; major mode
(when (eq mode major-mode)
(setq mode-name mode-str)))))
(add-hook 'after-change-major-mode-hook 'clean-mode-line)
;;; Mode line functions
;;;; Branch display
;; -------------------------------------------------------------------
(defun vc-project-branch ()
;; Show project name
(when buffer-file-name
(concat
;; Divider
(when (vc-registered (buffer-file-name))
(propertize " •" 'face `(:inherit fringe)))
(when (bound-and-true-p projectile-mode)
(let ((project-name (projectile-project-name)))
(unless (string= "-" project-name)
(format " %s" project-name))))
;; Show branch
(if vc-mode
(let ((backend (vc-backend buffer-file-name)))
(concat "" (substring-no-properties vc-mode
(+ (if (eq backend 'Hg) 2 3) 2)))) nil))))
;;;; Dir display
;; From https://amitp.blogspot.com/2011/08/emacs-custom-mode-line.html
;; ---------------------------------------------------------------------
(defun shorten-directory (dir max-length)
"Show up to `max-length' characters of a directory name `dir'."
(let ((path (reverse (split-string (abbreviate-file-name dir) "/")))
(output ""))
(when (and path (equal "" (car path)))
(setq path (cdr path)))
(while (and path (< (length output) (- max-length 4)))
(setq output (concat (car path) "/" output))
(setq path (cdr path)))
(when path
(setq output (concat "…/" output)))
output))
;;;; Compose mode line
;; -------------------------------------------------------------------
(defun bespoke-modeline-compose (status name primary secondary)
"Compose a string with provided information"
(let* ((char-width (window-font-width nil 'header-line))
(window (get-buffer-window (current-buffer)))
(active (eq window bespoke-modeline--selected-window))
(space-up +0.20)
(space-down -0.25)
;; Use status letters for TTY display
(prefix (if (display-graphic-p)
(cond ((string= status "⨂")
(propertize (if (window-dedicated-p)" –– " " ⨂ ") 'face (if active 'bespoke-modeline-ro-face 'bespoke-modeline-inactive-face)))
((string= status "⨀")
(propertize (if (window-dedicated-p)" –– " " ⨀ ") 'face (if active 'bespoke-modeline-mod-face 'bespoke-modeline-inactive-face)))
((string= status "◯")
(propertize (if (window-dedicated-p)" –– " " ◯ ") 'face (if active 'bespoke-modeline-default-face 'bespoke-modeline-inactive-face)))
(t (propertize status 'face 'bespoke-modeline-ro-face)))
(cond ((string= status "RO")
(propertize (if (window-dedicated-p)" -- " " RO ") 'face (if active 'bespoke-modeline-ro-face 'bespoke-modeline-inactive-face)))
((string= status "**")
(propertize (if (window-dedicated-p)" -- " " ** ") 'face (if active 'bespoke-modeline-mod-face 'bespoke-modeline-inactive-face)))
((string= status "RW")
(propertize (if (window-dedicated-p)" -- " " RW ") 'face (if active 'bespoke-modeline-default-face 'bespoke-modeline-inactive-face)))
(t (propertize status 'face 'bespoke-modeline-ro-face)))))
(left (concat
(propertize " " 'face (if active 'header-line 'fringe)
'display `(raise ,space-up))
(propertize name 'face (if active 'header-line 'fringe))
(propertize " " 'face (if active 'header-line 'fringe)
'display `(raise ,space-down))
(if (derived-mode-p 'deft-mode)
(propertize primary 'face 'match)
(propertize primary 'face 'fringe))))
(right (concat secondary " "))
(available-width (- (window-total-width)
(length prefix) (length left) (length right)
(/ (window-right-divider-width) char-width)))
(available-width (max 1 available-width)))
(concat prefix
left
(propertize (make-string available-width ?\ )
'face (if active 'header-line 'fringe))
(propertize right 'face (if active 'header-line 'fringe)))))
;;;; Mode line status
;; ---------------------------------------------------------------------
(defun bespoke-modeline-status ()
"Return buffer status: read-only (⨂), modified (⨀) or read-write (◯)"
(let ((read-only buffer-read-only)
(modified (and buffer-file-name (buffer-modified-p))))
;; Use status letters for TTY display
(cond (modified (if (display-graphic-p) "⨀" "**")) (read-only (if (display-graphic-p) "⨂" "RO")) (t (if (display-graphic-p) "◯" "RW")))))
;;;; Default display
(defun bespoke-modeline-default-mode ()
(let ((buffer-name (format-mode-line (if buffer-file-name (file-name-nondirectory (buffer-file-name)) "%b")))
(mode-name (format-mode-line 'mode-name))
(branch (vc-project-branch))
(position (format-mode-line "%l:%c ")))
(bespoke-modeline-compose (bespoke-modeline-status)
buffer-name
(concat "(" mode-name
(when branch
branch)
")")
(concat
;; Narrowed buffer
(when (buffer-narrowed-p)
(propertize "⇥ " 'face `(:inherit fringe)))
position))))
;;;; Prog & Text Modes
;; ---------------------------------------------------------------------
(defun bespoke-modeline-prog-mode-p ()
(derived-mode-p 'prog-mode))
(defun bespoke-modeline-elisp-mode-p ()
(derived-mode-p 'lisp-data-mode))
(defun bespoke-modeline-text-mode-p ()
(derived-mode-p 'text-mode))
;;;; Info Display
;; ---------------------------------------------------------------------
(setq Info-use-header-line nil)
(defun bespoke-modeline-info-breadcrumbs ()
(let ((nodes (Info-toc-nodes Info-current-file))
(cnode Info-current-node)
(node Info-current-node)
(crumbs ())
(depth Info-breadcrumbs-depth)
line)
(while (> depth 0)
(setq node (nth 1 (assoc node nodes)))
(if node (push node crumbs))
(setq depth (1- depth)))
(setq crumbs (cons "Top" (if (member (pop crumbs) '(nil "Top"))
crumbs (cons nil crumbs))))
(forward-line 1)
(dolist (node crumbs)
(let ((text
(if (not (equal node "Top")) node
(format "%s"
(if (stringp Info-current-file)
(file-name-sans-extension
(file-name-nondirectory Info-current-file))
Info-current-file)))))
(setq line (concat line (if (null line) "" " > ")
(if (null node) "..." text)))))
(if (and cnode (not (equal cnode "Top")))
(setq line (concat line (if (null line) "" " > ") cnode)))
line))
(defun bespoke-modeline-info-mode-p ()
(derived-mode-p 'Info-mode))
(defun bespoke-modeline-info-mode ()
(bespoke-modeline-compose (bespoke-modeline-status)
"Info"
(concat "("
(bespoke-modeline-info-breadcrumbs)
")")
""))
;;;; Term & Vterm
;; ---------------------------------------------------------------------
(defun bespoke-modeline-term-mode-p ()
(derived-mode-p 'term-mode))
(defun bespoke-modeline-term-mode ()
(bespoke-modeline-compose " >_ "
"Terminal"
(concat "(" shell-file-name ")")
(shorten-directory default-directory 32)))
;; ---------------------------------------------------------------------
;; vterm
(defun bespoke-modeline-vterm-mode-p ()
(derived-mode-p 'vterm-mode))
(defun bespoke-modeline-get-ssh-host (str)
(let ((split-defdir (split-string default-directory)))
(if (equal (length split-defdir) 1)
(car (split-string (shell-command-to-string "hostname") "\n"))
(cadr split-defdir))))
(defun bespoke-modeline-vterm-mode ()
(bespoke-modeline-compose " >_ "
"vterm"
(concat "(" (bespoke-modeline-get-ssh-host default-directory) ")")
(shorten-directory (car (last (split-string default-directory ":"))) 32)))
;;;; Message Mode
;; ---------------------------------------------------------------------
(defun bespoke-modeline-message-mode-p ()
(derived-mode-p 'message-mode))
(defun bespoke-modeline-message-mode ()
(bespoke-modeline-compose (bespoke-modeline-status)
"Message" "(draft)" ""))
;;;; Docview Mode
;;---------------------------------------------------------------------
(defun bespoke-modeline-docview-mode-p ()
(derived-mode-p 'doc-view-mode))
(defun bespoke-modeline-docview-mode ()
(let ((buffer-name (format-mode-line "%b"))
(mode-name (format-mode-line 'mode-name))
(branch (vc-project-branch))
(page-number (concat
(number-to-string (doc-view-current-page)) "/"
(or (ignore-errors
(number-to-string (doc-view-last-page-number)))
"???"))))
(bespoke-modeline-compose
(bespoke-modeline-status)
buffer-name
(concat "(" mode-name
(if branch (concat ", "
(propertize branch 'face 'italic)))
")" )
page-number)))
;;;; PDF View Mode
;; ---------------------------------------------------------------------
(defun bespoke-modeline-pdf-view-mode-p ()
(derived-mode-p 'pdf-view-mode))
(defun bespoke-modeline-pdf-view-mode ()
(let ((buffer-name (format-mode-line "%b"))
(mode-name (format-mode-line 'mode-name))
(branch (vc-project-branch))
(page-number (concat
(number-to-string (pdf-view-current-page)) "/"
(or (ignore-errors
(number-to-string (pdf-cache-number-of-pages)))
"???"))))
(bespoke-modeline-compose
(bespoke-modeline-status)
buffer-name
(concat "(" mode-name
(if branch (concat ", "
(propertize branch 'face 'italic)))
")" )
(concat page-number " "))))
;;;; MenuMode
;; ---------------------------------------------------------------------
(defun buffer-menu-mode-header-line ()
(face-remap-add-relative
'header-line `(:background ,(face-background 'bespoke-subtle))))
(add-hook 'Buffer-menu-mode-hook
#'buffer-menu-mode-header-line)
;;;; Completion
;; ---------------------------------------------------------------------
(defun bespoke-modeline-completion-list-mode-p ()
(derived-mode-p 'completion-list-mode))
(defun bespoke-modeline-completion-list-mode ()
(let ((buffer-name (format-mode-line "%b"))
(mode-name (format-mode-line 'mode-name))
(position (format-mode-line "%l:%c")))
(bespoke-modeline-compose (bespoke-modeline-status)
buffer-name "" position)))
;;;; Deft Mode
;; ---------------------------------------------------------------------
(with-eval-after-load 'deft
(defun deft-print-header ()
(force-mode-line-update)
(widget-insert "\n")))
(defun bespoke-modeline-deft-mode-p ()
(derived-mode-p 'deft-mode))
(defun bespoke-modeline-deft-mode ()
(let ((prefix " DEFT ")
(primary "Search:")
(filter (if deft-filter-regexp
(deft-whole-filter-regexp) "<filter>"))
(matches (if deft-filter-regexp
(format "%d matches" (length deft-current-files))
(format "%d notes" (length deft-all-files)))))
(bespoke-modeline-compose " DEFT "
primary filter matches)))
;;;; Calendar Mode
;; ---------------------------------------------------------------------
(defun bespoke-modeline-calendar-mode-p ()
(derived-mode-p 'calendar-mode))
(defun bespoke-modeline-calendar-mode () "")
;; Calendar (no header, only overline)
(with-eval-after-load 'calendar
(defun calendar-setup-header ()
(setq header-line-format "")
(face-remap-add-relative
'header-line `(:overline ,(face-foreground 'default)
:height 0.5
:background ,(face-background 'default))))
(add-hook 'calendar-initial-window-hook #'calendar-setup-header)
;; From https://emacs.stackexchange.com/questions/45650
(add-to-list 'display-buffer-alist
`(,(rx string-start "*Calendar*" string-end)
(display-buffer-below-selected))))
;;;; Org Capture
;; ---------------------------------------------------------------------
(defun bespoke-modeline-org-capture-mode-p ()
(bound-and-true-p org-capture-mode))
(defun bespoke-modeline-org-capture-mode ()
(bespoke-modeline-compose (bespoke-modeline-status)
"Capture"
"(org)"
""))
(with-eval-after-load 'org-capture
(defun org-capture-turn-off-header-line ()
(setq-local header-line-format (default-value 'header-line-format))
;; (fit-window-to-buffer nil nil 8)
;; (face-remap-add-relative 'header-line '(:background "#ffffff"))
(message nil))
(add-hook 'org-capture-mode-hook
#'org-capture-turn-off-header-line))
;;;; Org Agenda
;; ---------------------------------------------------------------------
(defun bespoke-modeline-org-agenda-mode-p ()
(derived-mode-p 'org-agenda-mode))
(defun bespoke-modeline-org-agenda-mode ()
(let* ((space-up +0.06)
(space-down -0.20))
(bespoke-modeline-compose (bespoke-modeline-status)
"Agenda"
""
(concat (propertize "◴" 'face 'default 'display `(raise ,space-up)) (format-time-string "%H:%M ")))))
;;;; Org Clock
;; ---------------------------------------------------------------------
(setq org-mode-line-string nil)
(with-eval-after-load 'org-clock
(add-hook 'org-clock-out-hook
#'(lambda () (setq org-mode-line-string nil)
(force-mode-line-update))))
(defun bespoke-modeline-org-clock-mode-p ()
org-mode-line-string)
(defun bespoke-modeline-org-clock-mode ()
(let ((buffer-name (format-mode-line "%b"))
(mode-name (format-mode-line 'mode-name))
(branch (vc-project-branch))
(position (format-mode-line "%l:%c")))
(bespoke-modeline-compose (bespoke-modeline-status)
buffer-name
(concat "(" mode-name
(if branch (concat ", "
(propertize branch 'face 'italic)))
")" )
org-mode-line-string)))
;;; Set Mode line
;;;; Set content for mode/header line
(setq-default bespoke--mode-line
'((:eval
(cond ((bespoke-modeline-prog-mode-p) (bespoke-modeline-default-mode))
((bespoke-modeline-deft-mode-p) (bespoke-modeline-deft-mode))
((bespoke-modeline-info-mode-p) (bespoke-modeline-info-mode))
((bespoke-modeline-term-mode-p) (bespoke-modeline-term-mode))
((bespoke-modeline-vterm-mode-p) (bespoke-modeline-vterm-mode))
((bespoke-modeline-text-mode-p) (bespoke-modeline-default-mode))
((bespoke-modeline-pdf-view-mode-p) (bespoke-modeline-pdf-view-mode))
((bespoke-modeline-docview-mode-p) (bespoke-modeline-docview-mode))
((bespoke-modeline-completion-list-mode-p) (bespoke-modeline-completion-list-mode))
((bespoke-modeline-calendar-mode-p) (bespoke-modeline-calendar-mode))
((bespoke-modeline-org-capture-mode-p) (bespoke-modeline-org-capture-mode))
((bespoke-modeline-org-agenda-mode-p) (bespoke-modeline-org-agenda-mode))
((bespoke-modeline-org-clock-mode-p) (bespoke-modeline-org-clock-mode))
((bespoke-modeline-elisp-mode-p) (bespoke-modeline-default-mode))
((bespoke-modeline-message-mode-p) (bespoke-modeline-message-mode))
(t (bespoke-modeline-default-mode))))))
;;;; Mode line header function
;; ---------------------------------------------------------------------
(defun bespoke/header-line ()
"Install a header line whose content depends on the major mode"
(interactive)
;; Update selected window
(setq bespoke-modeline--selected-window (selected-window))
(setq-default header-line-format bespoke--mode-line)
(setq-default mode-line-format (list "%-"))
(force-mode-line-update))
(defun bespoke/mode-line ()
"Install mode line whose content depends on the major mode"
(interactive)
;; Update selected window
(setq bespoke-modeline--selected-window (selected-window))
(setq-default header-line-format nil)
(setq-default mode-line-format bespoke--mode-line)
(force-mode-line-update))
;;;; Update Window Display
;; ---------------------------------------------------------------------
(defun bespoke-modeline-update-windows ()
"Modify the mode line depending on the presence of a window below. Use this only with the mode line set to header line."
(dolist (window (window-list))
(with-selected-window window
(if (or (one-window-p t)
(eq (window-in-direction 'below) (minibuffer-window))
(not (window-in-direction 'below)))
(with-current-buffer (window-buffer window)
(setq mode-line-format (list "")))
;; (setq mode-line-format (list "")))
(with-current-buffer (window-buffer window)
(setq mode-line-format nil)))
;; (if (window-in-direction 'above)
;; (face-remap-add-relative 'header-line '(:overline "#777777"))
;; (face-remap-add-relative 'header-line '(:overline nil)))
)))
;;;; Load Mode or Header line
(cond ((eq bespoke-set-mode-line 'header)
(progn
(setq eshell-status-in-modeline nil)
(bespoke/header-line)
(add-hook 'window-configuration-change-hook 'bespoke-modeline-update-windows)
))
((eq bespoke-set-mode-line 'footer)
(progn
(setq eshell-status-in-modeline nil)
(bespoke/mode-line)
))
((eq bespoke-set-mode-line nil)))
;;;; Inactive window hook
;; This hook is necessary to register selected window so when the window corresponding
;; to the evaluated modeline is evaluated is always selected.
(when bespoke-set-mode-line t
(add-hook 'post-command-hook
(lambda () (setq bespoke-modeline--selected-window (selected-window)))))
;;; Provide Bespoke Modeline
(provide 'bespoke-modeline)
;;; End bespoke-modeline.el