home · contact · privacy
577e674c1812f857d1fa1f19a46452c24ebbfcee
[plomvi.el] / plomvi.el
1 ;;; plomvi.el --- poor man's vim emulation
2
3 ;; Copyright (C) 2019
4
5 ;; Author: Christian Heller <plom+plomvi@plomlompom.com>
6
7 ;; This program is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
11
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 ;; GNU General Public License for more details.
16
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 ;;; Commentary:
21
22 ;; A very imperfect simulation of a small subset of Vim behavior, far
23 ;; from the sophistication of packages like evil; an intentionally
24 ;; thin wrapper around native Emacs behavior instead. To the author,
25 ;; it mostly serves to both avoid muscle memory context switches
26 ;; between Emacs and most basic Vim usages, and at the same time avoid
27 ;; the conceptual distances evil puts between the user and native
28 ;; Emacs logic. It does not care though to keep default Emacs
29 ;; keybindings intact, overwriting some common ones with those from
30 ;; the Vim universe.
31
32 ;;; Instructions:
33
34 ;; 1. load this script into your init file: (load ...)
35
36 ;; 2. to start plomvi by default, put this into your init file:
37 ;; (plomvi-global-mode 1)
38
39 ;; 3. define some otherwise unused keybinding to simulate what would
40 ;; be a jump back from Insert mode to Normal mode in Vim (but is de
41 ;; facto just a plomvi mode activation), such as this:
42 ;; (global-set-key (kbd "<f1>") 'plomvi-activate)
43
44
45
46 (defun plomvi-half-scroll()
47   "Scroll down half a screen width."
48   (interactive)
49   (scroll-up (/ (window-height) 2)))
50
51 (defun plomvi-goto-line (count)
52   "Jump to line: on nil count, last one, else count."
53   (interactive "P")
54   (if (null count)
55       (goto-char (point-max))
56     (goto-char (point-min))
57     (forward-line (1- count))))
58
59 (defun plomvi-prefix-zero-or-line-start (prev-prefix)
60   "If no prefix so far, jump to start of line, else start new prefix with 0."
61   (interactive "P")
62   (if (null prev-prefix)
63       (beginning-of-line)
64     (setq prefix-arg 0)))
65
66 (defun plomvi-prompt (prompt-input)
67   "Provide super-basic : prompt that only accepts:
68 q
69 q!
70 w
71 w FILENAME
72 wq
73 vsplit
74 split
75
76 If search and replace syntax is detected, it recommends using `query-replace'
77 instead.
78 "
79   (interactive "M:")
80   (cond
81    ((string= prompt-input "q!")
82     (kill-emacs))
83    ((string= prompt-input "q")
84     (save-buffers-kill-emacs))
85    ((string= prompt-input "w")
86     (save-buffer))
87    ((string-match "^w [^ ]+" prompt-input)
88     (let ((file-name (substring prompt-input 2))) (write-file file-name)))
89    ((string-match "^%?s/" prompt-input)
90     (message "NOT IMPLEMENTED, consider using query-replace(-regexp)"))
91    ((string= prompt-input "wq")
92     ((lambda () (save-some-buffers t) (kill-emacs))))
93    ((string= prompt-input "vsplit")
94     (split-window-horizontally))
95    ((string= prompt-input "split")
96     (split-window-vertically))
97    (t (message "NOT IMPLEMENTED"))))
98
99 (defun plomvi-newline-above ()
100   "Open and jump into new line above current line, deactivate `plomvi-mode'."
101   (interactive)
102   (beginning-of-line)
103   (insert "\n")
104   (previous-line)
105   (plomvi-deactivate))
106
107 (defun plomvi-newline-below ()
108   "Open and jump into new line below current line, deactivate `plomvi-mode'."
109   (interactive)
110   (end-of-line)
111   (insert "\n")
112   (plomvi-deactivate))
113
114 (defun plomvi-paste-backward ()
115   "Paste last kill leftwards in current line, or (if kill ends in \n) above it.
116
117 Note that this ignores killed rectangles.
118 "
119   (interactive)
120   (if (eq nil (string-match "\n$" (current-kill 0)))
121       (yank)
122     (beginning-of-line)
123     (yank)
124     (previous-line)))
125
126 (defun plomvi-paste-forward ()
127   "Paste last kill rightwards in current line, or (if kill ends in \n) under it.
128
129 Note that this ignores killed rectangles."
130   (interactive)
131   (if (eq nil (string-match "\n$" (current-kill 0)))
132       (progn
133         (right-char)
134         (yank))
135     (end-of-line)
136     (right-char)
137     (yank)
138     (previous-line)))
139
140 (defun plomvi-region-kill()
141   "Kill marked region."
142   (interactive)
143   (kill-region (region-beginning) (region-end)))
144
145 (defun plomvi-x()
146   "If rectangle or region marked, kill those; else, kill char after point."
147   (interactive)
148   (cond
149    ((and (boundp 'rectangle-mark-mode) (eq t rectangle-mark-mode))
150     (kill-rectangle (region-beginning) (region-end)))
151    ((use-region-p)
152     (plomvi-region-kill))
153    (t
154     (delete-char 1))))
155
156 (defun plomvi-rectangle-mark()
157   "Start marked rectangle, move right one char so a single column is visible."
158   (interactive)
159   (push-mark (point) nil t)
160   (rectangle-mark-mode)
161   (right-char))
162
163 (defun plomvi-search-forward()
164   "Find next occurence of search string last targeted by isearch."
165   (interactive)
166   (search-forward isearch-string))
167
168 (defun plomvi-search-backward()
169   "Find previous  occurence of search string last targeted by isearch."
170   (interactive)
171   (search-backward isearch-string))
172
173
174 (defun plomvi-copy-line()
175   "Copy current line into kill buffer."
176   (interactive)
177   (let ((keep_pos (point)))  ; We sort of cheat: We kill the line, then we
178     (kill-whole-line)        ; paste it back, and return point to its
179     (plomvi-paste-backward)  ; original position.
180     (goto-char keep_pos)))   ;
181
182 (defun plomvi-copy-region()
183   "Copy marked region."
184   (interactive)
185   (copy-region-as-kill (region-beginning) (region-end)))
186
187 (defun plomvi-replace-char (c)
188   "Replace char after point with c."
189   (interactive "cplomvi-replace-char")
190   (delete-char 1) (insert-char c) (left-char))
191
192 (defun plomvi-no-redo()
193   "Tell user what to do, since implementing vim redo was too much of a hassle."
194   (interactive)
195   (message "Vim-style redo not available. Try M-x for Emacs' undo-undo."))
196
197 (defun plomvi-activate()
198   "Activate `plomvi-mode'."
199   (interactive)
200   (plomvi-mode))
201
202 (defun plomvi-deactivate()
203   "Deactivate `plomvi-mode'."
204   (interactive)
205   (plomvi-mode -1))
206
207 (defvar plomvi-mode-basic-map (make-sparse-keymap)
208   "Keymap for `plomvi-mode' on read-only buffers.
209
210 In contrast to the keymap `plomvi-editable-mode' for editable
211 buffers, this excludes keybindings for editing text, which thus
212 become available to be used for other purposes.")
213 (suppress-keymap plomvi-mode-basic-map t)
214 (define-key plomvi-mode-basic-map (kbd ":") 'plomvi-prompt)
215 (define-key plomvi-mode-basic-map (kbd "C-w") 'other-window)
216 (define-key plomvi-mode-basic-map (kbd "k") 'previous-line)
217 (define-key plomvi-mode-basic-map (kbd "j") 'next-line)
218 (define-key plomvi-mode-basic-map (kbd "h") 'left-char)
219 (define-key plomvi-mode-basic-map (kbd "l") 'right-char)
220 (define-key plomvi-mode-basic-map (kbd "w") 'forward-word)
221 (define-key plomvi-mode-basic-map (kbd "b") 'backward-word)
222 (define-key plomvi-mode-basic-map (kbd "/") 'isearch-forward)
223 (define-key plomvi-mode-basic-map (kbd "N") 'plomvi-search-backward)
224 (define-key plomvi-mode-basic-map (kbd "n") 'plomvi-search-forward)
225 (define-key plomvi-mode-basic-map (kbd "v") 'set-mark-command)
226 (define-key plomvi-mode-basic-map (kbd "C-v") 'plomvi-rectangle-mark)
227 (define-prefix-command 'plomvi-g-map)
228 (define-key plomvi-mode-basic-map (kbd "g") 'plomvi-g-map)
229 (define-key plomvi-g-map (kbd "g") 'beginning-of-buffer)
230 (define-key plomvi-mode-basic-map (kbd "G") 'plomvi-goto-line)
231 (define-key plomvi-mode-basic-map (kbd "$") 'end-of-line)
232 (define-key plomvi-mode-basic-map (kbd "0") 'plomvi-prefix-zero-or-line-start)
233 (define-key plomvi-mode-basic-map (kbd "1") 'digit-argument)
234 (define-key plomvi-mode-basic-map (kbd "2") 'digit-argument)
235 (define-key plomvi-mode-basic-map (kbd "3") 'digit-argument)
236 (define-key plomvi-mode-basic-map (kbd "4") 'digit-argument)
237 (define-key plomvi-mode-basic-map (kbd "5") 'digit-argument)
238 (define-key plomvi-mode-basic-map (kbd "6") 'digit-argument)
239 (define-key plomvi-mode-basic-map (kbd "7") 'digit-argument)
240 (define-key plomvi-mode-basic-map (kbd "8") 'digit-argument)
241 (define-key plomvi-mode-basic-map (kbd "9") 'digit-argument)
242 (define-key plomvi-mode-basic-map (kbd "C-b") 'scroll-down)
243 (define-key plomvi-mode-basic-map (kbd "C-f") 'scroll-up)
244 (define-key plomvi-mode-basic-map (kbd "C-d") 'plomvi-half-scroll)
245
246 (defvar plomvi-mode-editable-map (make-sparse-keymap)
247   "Keymap for `plomvi-mode' on editable buffers.
248
249 Inherits from `plomvi-mode-basic-map', but adds keybindings for
250 text editing.")
251 (set-keymap-parent plomvi-mode-editable-map plomvi-mode-basic-map)
252 (define-key plomvi-mode-editable-map (kbd "i") 'plomvi-deactivate)
253 (define-key plomvi-mode-editable-map (kbd "x") 'plomvi-x)
254 (define-key plomvi-mode-editable-map (kbd "o") 'plomvi-newline-below)
255 (define-key plomvi-mode-editable-map (kbd "O") 'plomvi-newline-above)
256 (define-key plomvi-mode-editable-map (kbd "r") 'plomvi-replace-char)
257 (define-key plomvi-mode-editable-map (kbd "u") 'undo-only)
258 (define-key plomvi-mode-editable-map (kbd "C-r") 'plomvi-no-redo)
259 (define-key plomvi-mode-editable-map (kbd "I") 'string-insert-rectangle)
260 (define-key plomvi-mode-editable-map (kbd "p") 'plomvi-paste-forward)
261 (define-key plomvi-mode-editable-map (kbd "P") 'plomvi-paste-backward)
262 (define-key plomvi-mode-editable-map (kbd "Y") 'plomvi-copy-line)
263 (define-key plomvi-mode-editable-map (kbd "y") 'plomvi-copy-region)
264 (define-key plomvi-mode-editable-map (kbd "D") 'plomvi-region-kill)
265 (define-prefix-command 'plomvi-d-map)
266 (define-key plomvi-mode-editable-map (kbd "d") 'plomvi-d-map)
267 (define-key plomvi-d-map (kbd "w") 'kill-word)
268 (define-key plomvi-d-map (kbd "$") 'kill-line)
269 (define-key plomvi-d-map (kbd "d") 'kill-whole-line)
270 (defvar plomvi-mode-hook)
271 (defvar plomvi-mode-basic-hook)
272 (defvar plomvi-mode-editable-hook)
273 (defvar plomvi-mode-disable-hook)
274 (defvar plomvi-mode-basic-disable-hook)
275 (defvar plomvi-mode-editable-disable-hook)
276 (defvar-local plomvi-mode nil "mode variable for `plomvi-mode'")
277 (defvar-local plomvi-mode-basic nil
278   "toggles `plomvi-mode-basic-map' in `minor-mode-map-alist' for `plomvi-mode'")
279 (defvar-local plomvi-mode-editable nil
280   "toggles `plomvi-mode-editable-map' in `minor-mode-map-alist' for `plomvi-mode'")
281
282 (defun plomvi-mode (&optional arg)
283   "Imperfectly emulates a subset of Vim's Normal mode.
284
285 Sets mode variable `plomvi-mode' and, on read-only buffers, `plomvi-mode-basic',
286 or, on editable buffers, `plomvi-mode-editable'. The latter two's values in
287 `minor-mode-map-alist' toggle either `plomvi-mode-basic-map' or
288 `plomvi-mode-editable-map'."
289   (interactive (list (or current-prefix-arg 'toggle)))
290   (let ((enable (if (eq arg 'toggle)                   ; follow suggestions
291                     (not plomvi-mode)                  ; from (elisp)Minor
292                   (> (prefix-numeric-value arg) 0 )))) ; Mode Conventions
293     (if enable
294         (unless (minibufferp)
295           (if buffer-read-only
296               (setq plomvi-mode-basic t)
297             (setq plomvi-mode-editable t))
298           (setq plomvi-mode t)
299           (run-hooks 'plomvi-mode-hook)
300           (if plomvi-mode-basic
301               (run-hooks 'plomvi-mode-basic-hook)
302             (run-hooks 'plomvi-mode-editable-hook)))
303       (setq plomvi-mode-editable nil
304             plomvi-mode-basic nil
305             plomvi-mode nil)
306       (run-hooks 'plomvi-mode-editable-disable-hook)
307       (run-hooks 'plomvi-mode-basic-disable-hook)
308       (run-hooks 'plomvi-mode-disable-hook))))
309
310 (define-globalized-minor-mode plomvi-global-mode plomvi-mode plomvi-activate)
311 (add-to-list 'minor-mode-alist '(plomvi-mode " PV"))
312 (add-to-list 'minor-mode-map-alist (cons 'plomvi-mode-basic
313                                          plomvi-mode-basic-map))
314 (add-to-list 'minor-mode-map-alist (cons 'plomvi-mode-editable
315                                          plomvi-mode-editable-map))