vim-mode / vim-maps.el

Full commit
;;; vim-maps.el

;; Copyright (C) 2009, 2010 Frank Fischer

;; Author: Frank Fischer <>,
;; This file is not part of GNU Emacs.

;;; Commentary:

;; This file contains all standard keymaps.  Key mappings are defined
;; using one of the following vim-like macros:

;;   - vim:map ... general mapping in an arbitrary mode
;;   - vim:nmap ... mapping in the normal-mode keymap
;;   - vim:omap ... mapping in the operator-pending keymap
;;   - vim:imap ... mapping in the insert-mode keymap
;;   - vim:vmap ... mapping in the visual-mode keymap
;;   - vim:emap ... mapping in the ex-mode keymap
;; Furthermore, for each of these map-function there's a buffer-local
;; variant
;;   - vim:local-nmap ... mapping in the normal-mode local keymap
;;   - vim:local-omap ... mapping in the operator-pending local keymap
;;   - vim:local-imap ... mapping in the insert-mode local keymap
;;   - vim:local-vmap ... mapping in the visual-mode local keymap
;;   - vim:local-emap ... mapping in the ex-mode local keymap
;; The local versions should be used to define mode specific bindings
;; as local-set-key would do.
;; Commands should usually be placed in the normal-mode keymap.
;; Motions should be placed in the operator-pending keymap. All
;; commands in the operator-pending-keymap are available as
;; operator-pending in normal-mode and visual-mode (but may be
;; overwritten by the corresponding keymaps) and as motion-arguments
;; for complex commands in normal-mode.
;; A mapping has one of the following two forms:
;;   (vim:map KEYEVENTS 'my-command)
;; The first form maps the events in KEYEVENTS to the command
;; my-command.  The second form defines a vim-like mapping of
;; KEYEVENTS to MAPEVENTS, i.e. the activation of KEYEVENTS invokes
;; the (key-)events in MAPEVENTS.
;; KEYEVENTS is a usual Emacs-sequence of events as it would be used by
;; define-key.

;;; TODO:
;;   - better mapping to support stuff like
;;     (vim:def-map "c" "d{motion}a")
;;   - because of this, mapping "cc" to "0C" does not work with a
;;     count since the count is eaten by the '0'
;;   - similarily 'o' and 'O' won't work
;;   - should we have a 'deep-mapping' function: for example, "x" is
;;     mapped to "dl" in the default keymap.  If someone decides to
;;     redefine "l" to some other command, "x" will change its
;;     behaviour, too.  A 'deep-mapping' should save the mapping on
;;     definition of "x", therefor let "x" behave as usual even after
;;     redefining "l"

;;; Code:

(provide 'vim-maps)

(vim:nmap "\\" 'vim:cmd-emacs)

(vim:omap [escape] 'vim:operator-pending-mode-exit)
(vim:omap "0" 'vim:motion-beginning-of-line-or-digit-argument)
(vim:omap "1" 'digit-argument)
(vim:omap "2" 'digit-argument)
(vim:omap "3" 'digit-argument)
(vim:omap "4" 'digit-argument)
(vim:omap "5" 'digit-argument)
(vim:omap "6" 'digit-argument)
(vim:omap "7" 'digit-argument)
(vim:omap "8" 'digit-argument)
(vim:omap "9" 'digit-argument)
(vim:nmap "\"" 'vim:select-register)

(vim:nmap "ZZ" 'vim:cmd-write-and-close)

(vim:omap "h" 'vim:motion-left)
(vim:omap "l" 'vim:motion-right)
(vim:omap "^" 'vim:motion-first-non-blank)
(vim:omap "$" 'vim:motion-end-of-line)
(vim:omap "g_" 'vim:motion-last-non-blank)

(vim:omap "k" 'vim:motion-up)
(vim:omap "j" 'vim:motion-down)
(vim:omap "-" "k^")
(vim:omap "+" "j^")
(vim:omap "G" 'vim:motion-go-to-first-non-blank-end) 
(vim:omap "gg" 'vim:motion-go-to-first-non-blank-beg) 

(vim:omap "w" 'vim:motion-fwd-word)
(vim:omap "W" 'vim:motion-fwd-WORD)
(vim:omap "e" 'vim:motion-fwd-word-end)
(vim:omap "E" 'vim:motion-fwd-WORD-end)
(vim:omap "b" 'vim:motion-bwd-word)
(vim:omap "B" 'vim:motion-bwd-WORD)
(vim:omap "ge" 'vim:motion-bwd-word-end)
(vim:omap "gE" 'vim:motion-bwd-WORD-end)

(vim:omap "(" 'vim:motion-bwd-sentence)
(vim:omap ")" 'vim:motion-fwd-sentence)
(vim:omap "{" 'vim:motion-bwd-paragraph)
(vim:omap "}" 'vim:motion-fwd-paragraph)
(vim:omap "]]" 'vim:motion-fwd-section)
(vim:omap "][" 'vim:motion-fwd-section)
(vim:omap "[[" 'vim:motion-bwd-section)
(vim:omap "[]" 'vim:motion-bwd-section)

(vim:omap "f" 'vim:motion-find)
(vim:omap "F" 'vim:motion-find-back)
(vim:omap "t" 'vim:motion-find-to)
(vim:omap "T" 'vim:motion-find-back-to)
(vim:omap ";" 'vim:motion-repeat-last-find)
(vim:omap "," 'vim:motion-repeat-last-find-opposite)

(vim:omap "%" 'vim:motion-jump-item)

(vim:omap "'" 'vim:motion-mark-line)
(vim:omap "`" 'vim:motion-mark)

(vim:omap "iw" 'vim:motion-inner-word)

;(vim:nmap "x" "dl")
(vim:nmap "m" 'vim:cmd-set-mark)
(vim:nmap "x" 'vim:cmd-delete-char)
(vim:nmap "D" "d$")
(vim:nmap "d" 'vim:cmd-delete)

(vim:nmap "C" 'vim:cmd-change-rest-of-line)
(vim:nmap "c" 'vim:cmd-change)
(vim:nmap "s" 'vim:cmd-change-char)

(vim:nmap "r" 'vim:cmd-replace-char)
(vim:nmap "R" 'vim:cmd-replace)

(vim:nmap "y" 'vim:cmd-yank)
(vim:nmap "Y" "yy")
(vim:nmap "p" 'vim:cmd-paste-behind)
(vim:nmap "P" 'vim:cmd-paste-before)

(vim:nmap "J" 'vim:cmd-join-lines)

(vim:nmap "/" 'vim:search-start)
(vim:nmap "?" 'vim:search-start-backward)
(vim:nmap "*" 'vim:search-word)
(vim:nmap "#" 'vim:search-word-backward)
(vim:nmap "g*" 'vim:search-unbounded-word)
(vim:nmap "g#" 'vim:search-unbounded-word-backward)
(vim:nmap "n" 'vim:search-repeat)
(vim:nmap "N" 'vim:search-repeat-opposite)
;; The next two maps are very special for an active search.
(vim:map "n" 'vim:search-repeat :keymap vim:search-mode-keymap)
(vim:map "N" 'vim:search-repeat-opposite :keymap vim:search-mode-keymap)

(vim:nmap "i" 'vim:cmd-insert)
(vim:nmap "a" 'vim:cmd-append)
(vim:nmap "I" 'vim:cmd-Insert)
(vim:nmap "A" 'vim:cmd-Append)
(vim:nmap "o" 'vim:cmd-insert-line-below)
(vim:nmap "O" 'vim:cmd-insert-line-above)

(vim:nmap "u" 'vim:cmd-undo)
(vim:nmap (kbd "C-r") 'vim:cmd-redo)

(vim:nmap "." 'vim:cmd-repeat)

(vim:nmap "=" 'vim:cmd-indent)
(vim:nmap "<" 'vim:cmd-shift-left)
(vim:nmap ">" 'vim:cmd-shift-right)

(vim:nmap "~" "g~l")
(vim:nmap "g~" 'vim:cmd-toggle-case)
(vim:nmap "gU" 'vim:cmd-make-upcase)
(vim:nmap "gu" 'vim:cmd-make-downcase)

(vim:omap (kbd "C-e") 'vim:scroll-line-down)
(vim:omap (kbd "C-d") 'vim:scroll-down)
(vim:omap (kbd "C-f") 'vim:scroll-page-down)
(vim:omap "z+" 'vim:scroll-bottom-line-to-top)

(vim:omap (kbd "C-y") 'vim:scroll-line-up)
(vim:omap (kbd "C-u") 'vim:scroll-up)
(vim:omap (kbd "C-b") 'vim:scroll-page-up)
(vim:omap "z^" 'vim:scroll-top-line-to-bottom)

(vim:omap "zt" 'vim:scroll-line-to-top)
(vim:omap (vconcat "z" [return]) "zt^")
(vim:omap (kbd "z RET") (vconcat "z" [return]))
(vim:omap "zz" 'vim:scroll-line-to-center)
(vim:omap "z." "z.^")
(vim:omap "zb" 'vim:scroll-line-to-bottom)
(vim:omap "z-" "zb^")

(vim:nmap (kbd "C-w +") 'vim:window-increase-height)
(vim:nmap (kbd "C-w -") 'vim:window-decrease-height)
(vim:nmap (kbd "C-w =") 'vim:window-balance)
(vim:nmap (kbd "C-w >") 'vim:window-increase-width)
(vim:nmap (kbd "C-w <") 'vim:window-decrease-width)
(vim:nmap (kbd "C-w H") 'vim:window-move-far-left)
(vim:nmap (kbd "C-w J") 'vim:window-move-very-bottom)
(vim:nmap (kbd "C-w K") 'vim:window-move-very-top)
(vim:nmap (kbd "C-w L") 'vim:window-move-far-right)
(vim:nmap (kbd "C-w R") 'vim:window-rotate-upwards)
(vim:nmap (kbd "C-w C-R") (kbd "C-w R"))
(vim:nmap (kbd "C-w r") 'vim:window-rotate-downwards)
(vim:nmap (kbd "C-w C-r") (kbd "C-w r"))
(vim:nmap (kbd "C-w _") 'vim:window-set-height)
(vim:nmap (kbd "C-w C-_") (kbd "C-w _"))
(vim:nmap (kbd "C-w |") 'vim:window-set-width)
(vim:nmap (kbd "C-w b") 'vim:window-bottom-right)
(vim:nmap (kbd "C-w C-b") (kbd "C-w b"))
(vim:nmap (kbd "C-w t") 'vim:window-top-left)
(vim:nmap (kbd "C-w C-t") (kbd "C-w t"))
(vim:nmap (kbd "C-w c") 'vim:window-close)
(vim:nmap (kbd "C-w h") 'vim:window-left)
(vim:nmap (kbd "C-w C-h") (kbd "C-w h"))
(vim:nmap (kbd "C-w j") 'vim:window-down)
(vim:nmap (kbd "C-w C-j") (kbd "C-w j"))
(vim:nmap (kbd "C-w k") 'vim:window-up)
(vim:nmap (kbd "C-w C-k") (kbd "C-w k"))
(vim:nmap (kbd "C-w l") 'vim:window-right)
(vim:nmap (kbd "C-w C-l") (kbd "C-w l"))
(vim:nmap (kbd "C-w p") 'vim:window-previous)
(vim:nmap (kbd "C-w C-p") (kbd "C-w p"))
(vim:nmap (kbd "C-w n") 'vim:window-new)
(vim:nmap (kbd "C-w C-n") (kbd "C-w n"))
(vim:nmap (kbd "C-w o") 'vim:window-only)
(vim:nmap (kbd "C-w C-o") (kbd "C-w o"))
(vim:nmap (kbd "C-w s") 'vim:window-split)
(vim:nmap (kbd "C-w C-s") (kbd "C-w s"))
(vim:nmap (kbd "C-w S") (kbd "C-w s"))
(vim:nmap (kbd "C-w v") 'vim:window-vsplit)
(vim:nmap (kbd "C-w C-v") (kbd "C-w v"))

(vim:nmap "v" 'vim:visual-toggle-normal)
(vim:nmap "V" 'vim:visual-toggle-linewise)
(vim:nmap (kbd "C-v") 'vim:visual-toggle-block)
(vim:nmap "gv" 'vim:visual-mode-reactivate)

(vim:nmap ":" 'vim:ex-read-command)
(vim:nmap "q" 'vim:cmd-toggle-macro-recording)
(vim:nmap "@" 'vim:cmd-execute-macro)

(vim:imap (vector vim:ESC-event) 'vim:insert-mode-exit)
(vim:imap [insert] 'vim:insert-mode-toggle-replace)
(vim:imap [kp-insert] [insert])
(vim:imap [insertchar] [insert])

(vim:vmap (vector vim:ESC-event) 'vim:visual-mode-exit)
(vim:vmap "v" 'vim:visual-toggle-normal)
(vim:vmap "V" 'vim:visual-toggle-linewise)
(vim:vmap (kbd "C-v") 'vim:visual-toggle-block)
(vim:vmap "\"" 'vim:select-register)

(vim:vmap "d" 'vim:cmd-delete)
(vim:vmap "D" 'vim:cmd-delete)
(vim:vmap "x" 'vim:cmd-delete)

(vim:vmap "c" 'vim:cmd-change)
(vim:vmap "C" "Vc")
(vim:vmap "r" 'vim:cmd-replace-region)
(vim:vmap "R" 'vim:cmd-change)
(vim:vmap "s" 'vim:cmd-change)
(vim:vmap "S" 'vim:cmd-change)

(vim:vmap "y" 'vim:cmd-yank)
(vim:vmap "Y" 'vim:cmd-yank)

(vim:vmap "J" 'vim:cmd-join)

(vim:vmap "=" 'vim:cmd-indent)
(vim:vmap "<" 'vim:cmd-shift-left)
(vim:vmap ">" 'vim:cmd-shift-right)

(vim:vmap "~" 'vim:cmd-toggle-case)
(vim:vmap "U" 'vim:cmd-make-upcase)
(vim:vmap "u" 'vim:cmd-make-downcase)

(vim:vmap "I" 'vim:visual-insert)
(vim:vmap "A" 'vim:visual-append)

(vim:vmap "o" 'vim:visual-exchange-point-and-mark)
(vim:vmap "O" 'vim:visual-jump-point)

(vim:vmap ":" 'vim:visual-ex-read-command)

(vim:emap "edit" 'vim:cmd-edit)
(vim:emap "e" "edit")
(vim:emap "write" 'vim:cmd-write)
(vim:emap "w" "write")
(vim:emap "write!" 'vim:cmd-write-q)
(vim:emap "w!" "write!")
(vim:emap "wall" 'vim:cmd-write-all)
(vim:emap "wa" "wall")
(vim:emap "wall!" 'vim:cmd-write-all-q)
(vim:emap "wa!" "wall!")
(vim:emap "buffer" 'vim:cmd-buffer)
(vim:emap "b" "buffer")

(vim:emap "split" 'vim:window-split)
(vim:emap "sp" "split")
(vim:emap "vsplit" 'vim:window-vsplit)
(vim:emap "vs" "vsplit")
(vim:emap "new" 'vim:window-new)
(vim:emap "vnew" 'vim:window-vnew)
(vim:emap "vne" "vnew")
(vim:emap "close" 'vim:window-close)
(vim:emap "clo" "close")
(vim:emap "only" 'vim:window-only)
(vim:emap "on" "only")
(vim:emap "quit" 'vim:cmd-quit)
(vim:emap "q" "quit")
(vim:emap "quit!" 'vim:cmd-quit-q)
(vim:emap "q!" "quit")
(vim:emap "wq" 'vim:cmd-save-and-close)
(vim:emap "wq!" 'vim:cmd-save-and-close-q)
(vim:emap "quitall" 'vim:cmd-quit-all)
(vim:emap "quita" "quitall")
(vim:emap "qall" "quitall")
(vim:emap "qa" "qall")
(vim:emap "quitall!" 'vim:cmd-quit-all-q)
(vim:emap "quita!" "quitall!")
(vim:emap "qall!" "quitall!")
(vim:emap "qa!" "qall!")
(vim:emap "wqall" 'vim:cmd-save-and-quit)
(vim:emap "wqa" "wqall")
(vim:emap "xall" "wqall")
(vim:emap "xa" "xall")
(vim:emap "bdelete" 'vim:cmd-delete-buffer)
(vim:emap "bd" "bdelete")
(vim:emap "bdelete!" 'vim:cmd-delete-buffer-q)
(vim:emap "bd!" "bdelete!")
(vim:emap "substitute" 'vim:cmd-substitute)
(vim:emap "s" "substitute")
(vim:emap "marks" 'vim:cmd-show-marks)

(vim:nmap (vector vim:down-mouse-1) 'vim:visual-mouse-clicked)
(vim:vmap (vector vim:down-mouse-1) 'vim:visual-mouse-clicked)

;;; vim-maps.el ends here