-
-
Notifications
You must be signed in to change notification settings - Fork 122
/
emacs-keybinding-command-tooltip-mode.el
182 lines (164 loc) · 5.89 KB
/
emacs-keybinding-command-tooltip-mode.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
;;; emacs-keybinding-command-tooltip-mode.el --- A minor mode for emacs commands and keybindings
;;; Commentary:
;; Makes the syntax \\[some-command] and `some-command' and (kbd "key-sequence") functional in a buffer.
;;; Code:
(defun match-next-keystroke (&optional limit)
"Fontify (kbd \"keystrokes\")."
(while (re-search-forward "(kbd \"\\(.*\\)\")" limit t)
(let* ((describe `(lambda ()
(interactive)
(describe-key (kbd ,(match-string-no-properties 1)))))
(beg (match-beginning 0))
(end (match-end 0))
(description (save-window-excursion
(describe-key (kbd (match-string-no-properties 1)))
(with-current-buffer "*Help*"
(buffer-string))))
(map (make-sparse-keymap)))
(define-key map [mouse-1] describe)
(add-text-properties
beg end
`(local-map ,map
emacs-keybinding-command t
mouse-face highlight
face font-lock-constant-face
help-echo ,(format
"%s\n\nClick for documentation on key binding."
description))))))
(defun match-next-keybinding (&optional limit)
"Move point to the next expression matching a key binding.
The syntax is \\[some-function] which in a help window is
replaced by the keybinding. LIMIT is the maximum point to search
to. Then, put properties on the match that shows the key
sequence. Non-bound commands are not fontified."
(while (and (re-search-forward
"\\\\\\[\\([[:ascii:]]*?[^ ]\\)\\]"
limit t)
(fboundp (intern (match-string 1))))
(let* ((mdata (match-data))
(beg (match-beginning 1))
(end (match-end 1))
(s (match-string 0))
(command (match-string 1))
(describe-func `(lambda ()
"Run `describe-function' on the command."
(interactive)
(describe-function (intern ,command))))
(find-func `(lambda ()
"Run `find-function' on the command."
(interactive)
(find-function (intern ,command))))
(map (make-sparse-keymap)))
;; this is what gets run when you click on it.
(define-key map [mouse-1] describe-func)
(define-key map [s-mouse-1] find-func)
;; Here we define the text properties
(add-text-properties
beg end
`(local-map ,map
emacs-keybinding-command t
mouse-face highlight
face font-lock-constant-face
help-echo ,(format
"%s\n\nClick for documentation.\ns-mouse-1 to find function."
(substitute-command-keys s))))
(set-match-data mdata)
t)))
(defun match-next-emacs-command (&optional limit)
"Move point to the next expression matching `this-syntax'.
LIMIT is the maximum point to look for a match. Then put a
tooltip on the match that shows the key sequence. Works on
commands and variables."
(while (and (re-search-forward
"`\\([[:ascii:]]*?\\)'"
limit t)
;; Make sure the match is a variable or function
(or (boundp (intern (match-string 1)))
(fboundp (intern (match-string 1)))))
(let* ((mdata (match-data))
(beg (match-beginning 1))
(end (match-end 1))
(s (match-string 0))
(command (match-string 1))
(description
(cond ((fboundp (intern command))
(documentation (intern command)))
((boundp (intern command))
(save-window-excursion
(prog1
;; this annoyingly opens a help buffer. we wrap it to
;; prevent the window from opening, and to eliminate
;; the minibuffer message.
(describe-variable (intern command))
;; clear minibuffer
(message ""))))))
(describe-func
`(lambda ()
"Run `describe-function/variable' on the command."
(interactive)
(cond ((fboundp (intern ,command))
(describe-function (intern ,command)))
((boundp (intern ,command))
(describe-variable (intern ,command))))))
(find-func `(lambda ()
"Run `find-function' on the command."
(interactive)
(find-function (intern ,command))))
(map (make-sparse-keymap)))
;; this is what gets run when you click on it.
(define-key map [mouse-1] describe-func)
(define-key map [s-mouse-1] find-func)
;; Here we define the text properties
(add-text-properties
beg end
`(local-map ,map
emacs-keybinding-command t
mouse-face highlight
face font-lock-constant-face
help-echo ,(format
"%s\n%s\nClick for documentation.%s"
(if (fboundp (intern command))
;; function show key binding
(substitute-command-keys
(format "\\[%s]\n"
command))
;; else, it is a variable
"Variable")
description
(if (fboundp (intern command))
(format
"%s\ns-mouse-1 to find function." command)
;; else, it is a variable
"Variable"))))
(set-match-data mdata)
t)))
(defun ekm-ignore (beg end _sym)
"Hook function to ignore text fontified here."
(let ((ignore (get-text-property beg 'emacs-keybinding-command)))
ignore))
;;;###autoload
(define-minor-mode emacs-keybinding-command-tooltip-mode
"Fontify on emacs keybinding syntax.
Adds a tooltip for keybinding, and make the command clickable to
get to the documentation."
:lighter " KB"
(if emacs-keybinding-command-tooltip-mode
;; turn them on
(progn
(font-lock-add-keywords
nil
'((match-next-keybinding font-lock-constant-face)
(match-next-emacs-command font-lock-constant-face)
(match-next-keystroke font-lock-constant-face)))
(add-to-list 'font-lock-extra-managed-props 'local-map)
(add-hook 'flyspell-incorrect-hook 'ekm-ignore nil t))
;; turn them off
(font-lock-remove-keywords
nil
'((match-next-keybinding font-lock-constant-face)
(match-next-emacs-command font-lock-constant-face)
(match-next-keystroke font-lock-constant-face)))
(remove-hook 'flyspell-incorrect-hook 'ekm-ignore t))
(font-lock-fontify-buffer))
(provide 'emacs-keybinding-command-tooltip-mode)
;;; emacs-keybinding-command-tooltip-mode.el ends here