-
Notifications
You must be signed in to change notification settings - Fork 42
/
evil-escape.el
342 lines (290 loc) · 12.1 KB
/
evil-escape.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
;;; evil-escape.el --- Escape from anything with a customizable key sequence
;; Copyright (C) 2014-2015 syl20bnr
;;
;; Author: Sylvain Benner <[email protected]>
;; Keywords: convenience editing evil
;; Created: 22 Oct 2014
;; Version: 3.15
;; Package-Requires: ((emacs "24") (evil "1.0.9") (cl-lib "0.5"))
;; URL: https://github.com/syl20bnr/evil-escape
;; 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:
;; Press `fd` quickly to:
;; ----------------------
;; - escape from all stock evil states to normal state
;; - escape from evil-lisp-state to normal state
;; - escape from evil-iedit-state to normal state
;; - abort evil ex command
;; - quit minibuffer
;; - quit compilation buffers
;; - abort isearch
;; - quit ibuffer
;; - quit image buffer
;; - quit magit buffers
;; - quit help buffers
;; - quit apropos buffers
;; - quit ert buffers
;; - quit undo-tree buffer
;; - quit paradox
;; - quit gist-list menu
;; - quit helm-ag-edit
;; - hide neotree buffer
;; - quit evil-multiedit
;; And more to come !
;; Configuration:
;; --------------
;; The key sequence can be customized with the variable
;; `evil-escape-key-sequence'.
;; The delay between the two key presses can be customized with
;; the variable `evil-escape-delay'. Default is `0.1'.
;; The key sequence can be entered in any order by setting
;; the variable `evil-escape-unordered-key-sequence' to non nil.
;; A major mode can be excluded by adding it to the list
;; `evil-escape-excluded-major-modes'.
;; An inclusive list of major modes can defined with the variable
;; `evil-escape-enable-only-for-major-modes'. When this list is
;; non-nil then evil-escape is enabled only for the major-modes
;; in the list.
;; A list of zero arity functions can be defined with the variable
;; `evil-escape-inhibit-functions', if any of these functions return
;; non nil then evil-escape is inhibited.
;; It is also possible to inhibit evil-escape in a let binding by
;; setting the `evil-escape-inhibit' variable to non nil.
;; It is possible to bind `evil-escape' function directly, for
;; instance to execute evil-escape with `C-c C-g':
;; (global-set-key (kbd "C-c C-g") 'evil-escape)
;; More information in the readme of the repository:
;; https://github.com/syl20bnr/evil-escape
;;; Code:
(require 'evil)
(require 'cl-lib)
(eval-when-compile
(declare-function evil-iedit-state/quit-iedit-mode "evil-iedit-state.el"))
(defgroup evil-escape nil
"Key sequence to escape insert state and everything else."
:prefix "evil-escape-"
:group 'evil)
(defcustom evil-escape-key-sequence (kbd "fd")
"Two keys sequence to escape from insert state."
:type 'key-sequence
:group 'evil-escape)
(defcustom evil-escape-lighter '(concat " " evil-escape-key-sequence)
"The lighter for the evil escape mode."
:type 'sexp
:group 'evil-escape)
(defcustom evil-escape-delay 0.1
"Max time delay between two key presses."
:type 'number
:group 'evil-escape)
(defcustom evil-escape-unordered-key-sequence nil
"If non-nil then the key sequence can also be entered with the second
key first."
:type 'boolean
:group 'evil-escape)
(defcustom evil-escape-excluded-major-modes nil
"Excluded major modes where escape sequences have no effect."
:type 'sexp
:group 'evil-escape)
(defcustom evil-escape-excluded-states nil
"Excluded states where escape sequences have no effect."
:type 'sexp
:group 'evil-escape)
(defcustom evil-escape-enable-only-for-major-modes nil
"List of major modes where evil-escape is enabled."
:type 'sexp
:group 'evil-escape)
(defcustom evil-escape-inhibit-functions nil
"List of zero argument predicate functions disabling evil-escape.
If any of these functions return non nil, evil escape will be inhibited."
:type 'sexp
:group 'evil-escape)
(defvar evil-escape-inhibit nil
"When non nil evil-escape is inhibited.")
;;;###autoload
(define-minor-mode evil-escape-mode
"Buffer-local minor mode to escape insert state and everything else
with a key sequence."
:lighter (:eval evil-escape-lighter)
:group 'evil
:global t
(if evil-escape-mode
(add-hook 'pre-command-hook 'evil-escape-pre-command-hook)
(remove-hook 'pre-command-hook 'evil-escape-pre-command-hook)))
(defun evil-escape ()
"Escape from everything... well almost everything."
(interactive)
(call-interactively (evil-escape-func)))
(defun evil-escape-func ()
"Return the function to escape from everything."
(pcase evil-state
(`normal (evil-escape--escape-normal-state))
(`motion (evil-escape--escape-motion-state))
(`insert 'evil-normal-state)
(`emacs (evil-escape--escape-emacs-state))
(`hybrid (evil-escape--escape-emacs-state))
(`evilified (evil-escape--escape-emacs-state))
(`visual 'evil-exit-visual-state)
(`replace 'evil-normal-state)
(`lisp 'evil-lisp-state/quit)
(`iedit 'evil-iedit-state/quit-iedit-mode)
(`iedit-insert 'evil-iedit-state/quit-iedit-mode)
(`multiedit 'evil-multiedit-abort)
(`multiedit-insert 'evil-multiedit-state)
(_ (evil-escape--escape-normal-state))))
(defun evil-escape-pre-command-hook ()
"evil-escape pre-command hook."
(with-demoted-errors "evil-escape: Error %S"
(when (evil-escape-p)
(let* ((modified (buffer-modified-p))
(inserted (evil-escape--insert))
(fkey (elt evil-escape-key-sequence 0))
(skey (elt evil-escape-key-sequence 1))
(evt (read-event nil nil evil-escape-delay)))
(when inserted (evil-escape--delete))
(set-buffer-modified-p modified)
(cond
((and (characterp evt)
(or (and (equal (this-command-keys) (evil-escape--first-key))
(char-equal evt skey))
(and evil-escape-unordered-key-sequence
(equal (this-command-keys) (evil-escape--second-key))
(char-equal evt fkey))))
(evil-repeat-stop)
(let ((esc-fun (evil-escape-func)))
(when esc-fun
(setq this-command esc-fun)
(setq this-original-command esc-fun))))
((null evt))
(t (setq unread-command-events
(append unread-command-events (list evt)))))))))
(defadvice evil-repeat (around evil-escape-repeat-info activate)
(let ((evil-escape-inhibit t))
ad-do-it))
(defun evil-escape-p ()
"Return non-nil if evil-escape can run."
(and evil-escape-key-sequence
(not evil-escape-inhibit)
(or (window-minibuffer-p)
(bound-and-true-p isearch-mode)
(memq major-mode '(ibuffer-mode
image-mode))
(evil-escape--is-magit-buffer)
(and (fboundp 'helm-alive-p) (helm-alive-p))
(or (not (eq 'normal evil-state))
(not (eq 'evil-force-normal-state
(lookup-key evil-normal-state-map [escape])))))
(not (memq major-mode evil-escape-excluded-major-modes))
(not (memq evil-state evil-escape-excluded-states))
(or (not evil-escape-enable-only-for-major-modes)
(memq major-mode evil-escape-enable-only-for-major-modes))
(or (equal (this-command-keys) (evil-escape--first-key))
(and evil-escape-unordered-key-sequence
(equal (this-command-keys) (evil-escape--second-key))))
(not (cl-reduce (lambda (x y) (or x y))
(mapcar 'funcall evil-escape-inhibit-functions)
:initial-value nil))))
(defun evil-escape--escape-normal-state ()
"Return the function to escape from normal state."
(cond
((and (fboundp 'helm-alive-p) (helm-alive-p)) 'helm-keyboard-quit)
((eq 'ibuffer-mode major-mode) 'ibuffer-quit)
((eq 'image-mode major-mode) 'quit-window)
((evil-escape--is-magit-buffer) 'evil-escape--escape-with-q)
((bound-and-true-p isearch-mode) 'isearch-abort)
((window-minibuffer-p) 'abort-recursive-edit)
(t (lookup-key evil-normal-state-map [escape]))))
(defun evil-escape--escape-motion-state ()
"Return the function to escape from motion state."
(cond
((or (memq major-mode '(apropos-mode
help-mode
ert-results-mode
ert-simple-view-mode
compilation-mode
image-mode))) 'quit-window)
((eq 'undo-tree-visualizer-mode major-mode) 'undo-tree-visualizer-quit)
((and (fboundp 'helm-ag--edit-abort)
(string-equal "*helm-ag-edit*" (buffer-name))) 'helm-ag--edit-abort)
((eq 'neotree-mode major-mode) 'neotree-hide)
(t 'evil-normal-state)))
(defun evil-escape--escape-emacs-state ()
"Return the function to escape from emacs state."
(cond
((bound-and-true-p isearch-mode) 'isearch-abort)
((window-minibuffer-p) 'abort-recursive-edit)
((evil-escape--is-magit-buffer) 'evil-escape--escape-with-q)
((eq 'ibuffer-mode major-mode) 'ibuffer-quit)
((eq 'emoji-cheat-sheet-plus-buffer-mode major-mode) 'kill-this-buffer)
((eq 'paradox-menu-mode major-mode) 'evil-escape--escape-with-q)
((memq major-mode '(gist-list-menu-mode
image-mode)) 'quit-window)
(t 'evil-normal-state)))
(defun evil-escape--first-key ()
"Return the first key string in the key sequence."
(let* ((first-key (elt evil-escape-key-sequence 0))
(fkeystr (char-to-string first-key)))
fkeystr))
(defun evil-escape--second-key ()
"Return the second key string in the key sequence."
(let* ((sec-key (elt evil-escape-key-sequence 1))
(fkeystr (char-to-string sec-key)))
fkeystr))
(defun evil-escape--insert-func ()
"Default insert function."
(when (not buffer-read-only) (self-insert-command 1)))
(defun evil-escape--delete-func ()
"Delete char in current buffer if not read only."
(when (not buffer-read-only) (delete-char -1)))
(defun evil-escape--insert ()
"Insert the first key of the sequence."
(condition-case err
(pcase evil-state
(`insert (evil-escape--insert-2) t)
(`emacs (evil-escape--insert-2) t)
(`hybrid (evil-escape--insert-2) t)
(`normal
(when (window-minibuffer-p) (evil-escape--insert-func) t))
(`iedit-insert (evil-escape--insert-func) t))
('error nil)))
(defun evil-escape--insert-2 ()
"Insert character while taking into account mode specificites."
(pcase major-mode
(`term-mode (call-interactively 'term-send-raw))
(_ (cond
((bound-and-true-p isearch-mode) (isearch-printing-char))
(t (evil-escape--insert-func))))))
(defun evil-escape--delete ()
"Revert the insertion of the first key of the sequence."
(pcase evil-state
(`insert (evil-escape--delete-2))
(`emacs (evil-escape--delete-2))
(`hybrid (evil-escape--delete-2))
(`normal
(when (minibuffer-window-active-p (evil-escape--delete-func))))
(`iedit-insert (evil-escape--delete-func))))
(defun evil-escape--delete-2 ()
"Delete character while taking into account mode specifities."
(pcase major-mode
(`term-mode (call-interactively 'term-send-backspace))
(_ (cond
((bound-and-true-p isearch-mode) (isearch-delete-char))
(t (evil-escape--delete-func))))))
(defun evil-escape--escape-with-q ()
"Send `q' key press event to exit from a buffer."
(interactive)
(setq unread-command-events (listify-key-sequence "q")))
(defun evil-escape--is-magit-buffer ()
"Return non nil if the current buffer is a Magit buffer."
(string-match-p "magit" (symbol-name major-mode)))
(provide 'evil-escape)
;;; evil-escape.el ends here