summaryrefslogtreecommitdiff
path: root/modeline.el
blob: 2d95adfda7307d55e1e49b3dc642c1f893ba9c96 (plain)
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
;;; -*- lexical-binding: t; -*-

;;;###autoload
(defun modeline-format-main ()
  "The main mode line format."
  (let* ((left (modeline-format-left))
         (right (modeline-format-right))
         (left-len (modeline-length left))
         (right-len (modeline-length right))
         (middle (propertize " " 'display
                             (make-string
                              (max (- (window-total-width)
                                      left-len
                                      right-len)
                                   0)
                              32))))
    (concat left middle right)))

(setq-default mode-line-format '("%e" (:eval (modeline-format-main))))

;;;###autoload
(defun modeline-format-dashboard ()
  "The mode line format for the dashboard."
  (let* ((left (modeline-dashboard-format-left))
         (right (modeline-dashboard-format-right))
         (left-len (length left))
         (right-len (length right))
         (middle (propertize " " 'display
                             (make-string
                              (max (- (window-total-width)
                                      left-len
                                      right-len)
                                   0)
                              32))))
    (concat left middle right)))

;;;###autoload
(defun modeline-dashboard-format-left ()
  "The left / main part of the mode line for the dashboard."
  (concat
   (modeline-spc)
   (modeline-format-directory)
   (modeline-spc)
   (modeline-format-minor-modes)))

;;;###autoload
(defun modeline-dashboard-format-right ()
  "The right part of the mode line for the dashboard."
  (declare (side-effect-free t) (pure t))
  (let ((face (cond ((modeline-active-window-p) 'doom-modeline-buffer-major-mode)
                    ('mode-line-inactive))))
    (concat
     (modeline-propertize
      (format-mode-line global-mode-string face))
     (modeline-spc))))

;;;###autoload
(defun modeline-format-left ()
  "The left mode line format."
  (concat
   (modeline-spc)
   (modeline-format-buffer-status)
   (modeline-spc)
   (modeline-format-buffer-name)
   (modeline-spc)
   (modeline-format-position)
   (modeline-spc)
   (modeline-format-buffer-size)
   (modeline-spc)
   (modeline-format-minor-modes)))

;;;###autoload
(defun modeline-format-right ()
  "The right mode line format."
  (concat
   (modeline-format-input-method)
   (modeline-format-major-mode)
   (modeline-format-vc-mode)))

;;; Calculate the correct lengths of characters

;;;###autoload
(defun modeline-length (str)
  "Return the length of STR.
Characters that take up more than one column will be counted with
1.7 columns."
  (declare (side-effect-free t) (pure t))
  (let ((len 0))
    (mapc (lambda (char)
            (let ((name (get-char-code-property char 'name))
                  (decomposition (get-char-code-property char 'decomposition)))
              (cond
               ((or (and
                     (stringp name)
                     (string-match (rx-to-string '(seq bos "CJK"))
                                   name))
                    (eq (car decomposition) 'wide))
                (setq len (+ len 1.7)))
               ((setq len (1+ len))))))
          str)
    (floor len)))

;;; Conveniently add text properties

;;;###autoload
(defmacro modeline-propertize (str &optional mouse-face help-echo map)
  "Give STR appropriate text properties.
MOUSE-FACE is used when the mouse is over the text.
HELP-ECHO is the additional information displayed when the mouse is over the text.
MAP is the local keymap of the text."
  (let ((mouse-face (or mouse-face 'mode-line-highlight))
        (help-echo-form (cond (help-echo (list (quote 'help-echo) help-echo))))
        (map-form (cond (map (list (quote 'local-map) map)))))
    (append
     `(propertize ,str
       'mouse-face ',mouse-face)
     help-echo-form
     map-form)))

;;; Determination of the active mode-line

;; NOTE: I tried to avoid this, but it turns out that this is the most
;; reliable way to do so.

;;;###autoload
(defun modeline-get-active-window (&optional frame)
  "The active window excluding the child windows."
  (if (and (fboundp 'frame-parent) (frame-parent frame))
      (frame-selected-window (frame-parent frame))
    (frame-selected-window frame)))

;;;###autoload
(defvar modeline-active-window (modeline-get-active-window)
  "The active window excluding the child windows.")

;;;###autoload
(defun modeline-active-window-p ()
  "Whether we are in the active window."
  (and modeline-active-window
       (eq modeline-active-window (selected-window))))

;;;###autoload
(defun modeline-set-active-window (&rest _)
  "Update `modeline-active-window'."
  (let ((active-wn (modeline-get-active-window)))
    (cond
     ((minibuffer-window-active-p active-wn))
     (t (setq modeline-active-window active-wn))))
  (force-mode-line-update t))

;;;###autoload
(defsubst modeline-unset-active-window (&rest _)
  "Set `modeline-active-window' to `nil'."
  (setq modeline-active-window nil))

;;;###autoload
(defun modeline-refresh-modeline ()
  "Refresh the focus state of the mode line."
  (setq modeline-active-window nil)
  (mapc (lambda (frame)
          (cond ((eq (frame-focus-state frame) t)
                 (setq modeline-active-window (modeline-get-active-window frame)))))
        (frame-list)))

(add-hook 'window-configuration-change-hook #'modeline-set-active-window)
(add-hook 'buffer-list-update-hook #'modeline-set-active-window)
(add-hook 'after-make-frame-functions #'modeline-set-active-window)
(add-hook 'delete-frame-functions #'modeline-set-active-window)
(advice-add #'handle-switch-frame :after #'modeline-set-active-window)
(add-function :after after-focus-change-function #'modeline-refresh-modeline)

;;; Faces

;; NOTE: These faces are not actually defined here.
;;       They are found here simply because they need to have a formal declaration to work.

;;;###autoload
(defface doom-modeline-buffer-modified nil
  "The face for mode line buffer identification.")

;;;###autoload
(defface doom-modeline-warning nil
  "The face for mode line warning.")

;;;###autoload
(defface doom-modeline-urgent nil
  "The face for mode line urgent.")

;;;###autoload
(defface doom-modeline-info nil
  "The face for mode line info.")

;;;###autoload
(defface doom-modeline-buffer-major-mode nil
  "The face for mode line major mode.")

;;;###autoload
(defface doom-modeline-input-method nil
  "The face for mode line input method.")

;;;###autoload
(defface doom-modeline-input-method-alt nil
  "The alternative face for mode line input method.")

;;; Various sections of the mode line

;;;###autoload
(defun modeline-format-directory ()
  "Display the default directory on the mode line."
  (modeline-propertize
   (propertize
    default-directory
    'face (cond ((modeline-active-window-p) 'mode-line)
                (t 'mode-line-inactive)))
   nil "The current directory\nmouse-1: Open that directory"
   (let ((map '(keymap)))
     (define-key map (vector 'mode-line 'down-mouse-1)
       (lambda () (interactive) (dired default-directory)))
     map)))

;;;###autoload
(defun modeline-spc ()
  "A space with the appropriate face."
  (format-mode-line " "
                    (cond ((modeline-active-window-p)
                           'mode-line)
                          (t 'mode-line-inactive))))

;;;###autoload
(defun modeline-format-buffer-status ()
  "The status of the buffer displayed on the mode-line."
  (let ((active-p (modeline-active-window-p)))
    (concat
     ;; modified or not
     (cond ((and buffer-file-name (buffer-modified-p))
            (format-mode-line "M" (cond
                                   (active-p
                                    'doom-modeline-buffer-modified)
                                   (t 'mode-line-inactive)))))
     ;; read-only?
     (cond
      (buffer-read-only
       (format-mode-line "R" (cond
                              (active-p
                               'doom-modeline-urgent)
                              (t 'mode-line-inactive)))))
     ;; narrow?
     (cond
      ((buffer-narrowed-p)
       (format-mode-line "N" (cond
                              (active-p
                               'doom-modeline-warning)
                              (t 'mode-line-inactive))))))))

;;;###autoload
(defun modeline-format-position ()
  "The position of the cursor to be displayed in the mode line."
  (cond
   ((derived-mode-p 'pdf-view-mode)
    (concat
     (modeline-propertize
      (propertize
       (let* ((current (pdf-view-current-page))
              (total (pdf-info-number-of-pages))
              )
         (concat
          "P."
          (number-to-string current)
          "/"
          (number-to-string total)))
       'face (cond
              ((modeline-active-window-p) 'mode-line)
              (t 'mode-line-inactive)))
      nil "Current page / Total pages")))
   (t
    (modeline-propertize
     (propertize
      (let* ((lc (format-mode-line "%l:%C "))
	     (percent (format-mode-line "%p")))
        (concat
         lc
         (cond
	  ((eq (aref percent 0) 32)
	   (concat (substring percent 1) "%"))
	  ((memq (aref percent 0) (number-sequence 48 57))
	   (concat percent "%"))
	  ((> (length percent) 3)
	   (substring percent 0 3))
	  (t  percent))))
      'face (cond
	     ((modeline-active-window-p) 'mode-line)
	     (t 'mode-line-inactive)))
     nil
     "Buffer position\nmouse-1: Display Line and Column Mode Menu"
     mode-line-column-line-number-mode-map))))

;;;###autoload
(defun modeline-format-buffer-size ()
  "The size of the buffer to be displayed in the mode line."
  (modeline-propertize
   (format-mode-line
    (file-size-human-readable (string-to-number (format-mode-line "%i")))
    (cond
     ((modeline-active-window-p) 'mode-line)
     (t 'mode-line-inactive)))
   nil
   "Buffer size\nmouse-1: Display Line and Column Mode Menu"
   mode-line-column-line-number-mode-map))

;;;###autoload
(defvar modeline-minor-modes-name-len-max 150
  "The maximal length for the display of minor modes in the mode line.")

;;;###autoload
(defun modeline-format-minor-modes ()
  "Display some minor modes information."
  (declare (pure t) (side-effect-free t))
  (modeline-propertize
   (let* ((raw
           (format-mode-line
            minor-mode-alist
            (cond
             ((modeline-active-window-p) 'mode-line)
             ('mode-line-inactive))))
          (orig (cond
                 ((and (not (string= raw ""))
                       (= (aref raw 0) 32))
                  (substring raw 1))
                 (raw))))
     (cond
      ((<= (length orig) modeline-minor-modes-name-len-max)
       orig)
      ((concat
        (substring orig 0 (- modeline-minor-modes-name-len-max
                             3))
        "..."))))
   nil
   "Minor mode
mouse-1: Display minor mode menu
mouse-2: Show help for minor mode
mouse-3: Toggle minor modes"
   mode-line-minor-mode-keymap))

;;; NOTE: The minor mode menu does not work with my custom mode line.

;;;###autoload
(defun durand-mouse-minor-mode-menu (event)
  "Show minor-mode menu for EVENT on minor modes area of the mode line.
Modified for my custom mode line."
  (interactive "@e")
  (let* ((string-obj (nth 4 (car (cdr event))))
         (str (car string-obj))
         (str-pos (cdr string-obj))
         invalid indicator)
    (cond
     ((string= str "") (setq invalid t))
     ((= (aref str str-pos) 32) (setq str-pos (1+ str-pos))))
    (cond
     (invalid)
     ((= (aref str str-pos) 32))
     (t
      (let* ((orig str-pos)
             (start str-pos)
             (end str-pos))
        (while (and (>= start 0)
                   (/= (aref str start) 32))
          (setq start (1- start)))
        (while (and (< end (length str))
                   (/= (aref str end) 32))
          (setq end (1+ end)))
        (setq indicator (substring-no-properties str (1+ start) end))
        (minor-mode-menu-from-indicator indicator))))))

(advice-add 'mouse-minor-mode-menu :override #'durand-mouse-minor-mode-menu)

;;;###autoload
(defvar modeline-buffer-name-len-max 40
  "The maximal length of the name of the buffer to be displayed in the mode line.")

(let ((map (make-sparse-keymap)))
  (define-key map [mode-line mouse-1] #'ibuffer)
  (setq mode-line-buffer-identification-keymap
        map))

;;;###autoload
(defun modeline-format-buffer-name ()
  "The name of the buffer truncated to `modeline-buffer-name-len-max'.
This will be displayed in the mode line."
  (declare (pure t) (side-effect-free t))
  (modeline-propertize
   (let* ((face (cond ((modeline-active-window-p) 'mode-line-buffer-id)
		      (t 'mode-line-inactive)))
          (name-max (min modeline-buffer-name-len-max
                         (floor (window-width) 2)))
	  (orig (format-mode-line "%b" face)))
     (concat
      (format-mode-line "%[" face)
      (cond
       ((> (length orig) name-max)
	(concat
         (substring orig 0 (max (- name-max 3) 1))
         "..."))
       (t orig))
      (format-mode-line "%]" face)))
   nil
   (concat (buffer-file-name)
           "\n"
           "mouse-1: ibuffer")
   mode-line-buffer-identification-keymap))

;;;###autoload
(defun modeline-format-major-mode ()
  "The major mode to display in the mode line."
  (declare (pure t) (side-effect-free t))
  (let ((face (cond ((modeline-active-window-p) 'doom-modeline-buffer-major-mode)
                    ('mode-line-inactive))))
    (concat
     (modeline-propertize
      (format-mode-line '("%m") face)
      nil
      "Major mode\nmouse-1: Display major mode menu\nmouse-2: Show help for major mode\nmouse-3: Toggle minor modes"
      mode-line-major-mode-keymap)
     (modeline-spc)
     (modeline-propertize
      (format-mode-line global-mode-string face))
     (modeline-spc))))

;;;###autoload
(defvar-local modeline-vcs-str ""
  "Display the version control system information on the mode line.")
;;;###autoload
(defvar modeline-vcs-length-max 12
  "The maximum displayed length of the branch name of version control.")

;;;###autoload
(defun modeline-update-vcs-str (&rest _)
  "Update the version control system information to be displayed on the mode line."
  (let ((bfn (buffer-file-name)))
    (setq
     modeline-vcs-str
     (cond
      ((and vc-mode bfn)
       (let* ((backend (vc-backend bfn))
              (state (vc-state bfn backend))
              (indicator (cond
                          ((memq state '(added edited))
                           (format-mode-line
                            "* " 'doom-modeline-info))
                          ((eq state 'needs-merge)
                           (format-mode-line
                            "? " 'doom-modeline-info))
                          ((eq state 'needs-update)
                           (format-mode-line
                            "! " 'doom-modeline-warning))
                          ((memq state '(removed conflict unregistered))
                           (format-mode-line
                            "! " 'doom-modeline-urgent))
                          (t (format-mode-line
                              "@ " 'doom-modeline-info))))
              (str (cond (vc-display-status
                          (substring vc-mode (+ (cond ((eq backend 'Hg) 2)
                                                      (t 3))
                                                2)))
                         (t ""))))
         (concat
          indicator
          (propertize
           (cond
            ((> (length str) modeline-vcs-length-max)
             (concat (substring str 0 (- modeline-vcs-length-max 3))
                     "..."))
            (t str))
           'face (cond
                  ((eq state 'needs-update)
                   'doom-modeline-warning)
                  ((memq state '(removed conflict unregistered))
                   'doom-modeline-urgent)
                  (t 'doom-modeline-info))))))
      (t "")))))

(add-hook 'find-file-hook #'modeline-update-vcs-str)
(add-hook 'after-save-hook #'modeline-update-vcs-str)
(advice-add #'vc-refresh-state :after #'modeline-update-vcs-str)

;;;###autoload
(defun modeline-format-vc-mode ()
  "Display version control system information on the mode line."
  (declare (pure t) (side-effect-free 'error-free))
  (cond
   ((and (stringp modeline-vcs-str)
         (not (string= modeline-vcs-str "")))
    (concat
     ;; (modeline-spc)
     (modeline-propertize
      (cond
       ((modeline-active-window-p) modeline-vcs-str)
       (t (propertize modeline-vcs-str 'face 'mode-line-inactive)))
      nil
      (get-text-property 1 'help-echo vc-mode)
      (get-text-property 1 'local-map vc-mode))
     (modeline-spc)))))

;;;###autoload
(defun modeline-format-input-method ()
  "Display the current input method on the mode line."
  (cond
   (current-input-method
    (concat
     (modeline-spc)
     (modeline-propertize
      (propertize
       current-input-method-title
       'face (cond ((modeline-active-window-p) 'doom-modeline-input-method)
                   (t 'mode-line-inactive)))
      nil
      (format "Current input method: %s\nmouse-2: Disable input method\nmouse-3: Describe current input method"
              current-input-method)
      mode-line-input-method-map)
     (modeline-spc))
    )
   (t "")))