148 lines
4.9 KiB
EmacsLisp
148 lines
4.9 KiB
EmacsLisp
;;; evil-collection-diff-mode.el --- Add Evil bindings to diff-mode -*- lexical-binding: t -*-
|
|
|
|
;; Copyright (C) 2017 Pierre Neidhardt
|
|
|
|
;; Author: Pierre Neidhardt <mail@ambrevar.xyz>
|
|
;; Maintainer: James Nguyen <james@jojojames.com>
|
|
;; Pierre Neidhardt <mail@ambrevar.xyz>
|
|
;; URL: https://github.com/emacs-evil/evil-collection
|
|
;; Version: 0.0.1
|
|
;; Package-Requires: ((emacs "25.1"))
|
|
;; Keywords: evil, diff, tools
|
|
|
|
;; This file 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, or (at your
|
|
;; option) any later version.
|
|
;;
|
|
;; This file 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.
|
|
;;
|
|
;; For a full copy of the GNU General Public License
|
|
;; see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
;;
|
|
;; Evil-Collection-Diff re-uses the read-only particularity of `diff-mode':
|
|
;; When the buffer is read-only, enter motion state
|
|
;; and manipulate the diffs with simple bindings.
|
|
;; When the buffer is writage, use normal/insert states with some Evil-specific
|
|
;; keys to ease navigation.
|
|
;;
|
|
;; See also `evil-collection-diff-toggle-setup'.
|
|
|
|
;;; Code:
|
|
|
|
(require 'evil-collection)
|
|
(require 'diff-mode)
|
|
|
|
(defconst evil-collection-diff-mode-maps '(diff-mode-map))
|
|
|
|
(defun evil-collection-diff-read-only-state-switch ()
|
|
"Make read-only in motion state, writable in normal state."
|
|
(when (eq major-mode 'diff-mode)
|
|
(if buffer-read-only
|
|
(evil-motion-state)
|
|
(evil-normal-state))))
|
|
|
|
;;;###autoload
|
|
(defun evil-collection-diff-toggle-setup ()
|
|
"Toggle visiting diff buffers in motion state."
|
|
(interactive)
|
|
(when (eq major-mode 'diff-mode)
|
|
(if (memq 'evil-collection-diff-read-only-state-switch read-only-mode-hook)
|
|
(remove-hook 'read-only-mode-hook 'evil-collection-diff-read-only-state-switch t)
|
|
(add-hook 'read-only-mode-hook 'evil-collection-diff-read-only-state-switch nil t))))
|
|
|
|
;;; TODO: Report toggle function upstream?
|
|
(defun evil-collection-diff-toggle-context-unified (start end)
|
|
"Toggle between context and unified views.
|
|
|
|
START and END are either taken from the region (if a prefix arg is given) or
|
|
else cover the whole buffer."
|
|
(interactive (if (or current-prefix-arg (use-region-p))
|
|
(list (region-beginning) (region-end))
|
|
(list (point-min) (point-max))))
|
|
;; There seems to be no way to know whether we are in context or unified views.
|
|
;; Workaround: assume that point-max will change. This is brittle.
|
|
(let ((old-point-max (point-max)))
|
|
(diff-unified->context start end)
|
|
(when (= old-point-max (point-max))
|
|
(diff-context->unified start end))))
|
|
|
|
;;; TODO: Report toggle function upstream?
|
|
(defun evil-collection-diff-toggle-restrict-view (&optional arg)
|
|
"Toggle the restriction of the view to the current hunk.
|
|
When restricting and if the prefix ARG is given, restrict the view to the
|
|
current file instead."
|
|
(interactive "P")
|
|
(if (buffer-narrowed-p)
|
|
(widen)
|
|
(diff-restrict-view arg)))
|
|
|
|
;;;###autoload
|
|
(defun evil-collection-diff-mode-setup ()
|
|
"Set up `evil' bindings for `diff-mode'."
|
|
|
|
;; Don't switch to read-only/motion state by default as this can interfere
|
|
;; with other modes which require a writable buffer, e.g. magit.
|
|
(evil-set-initial-state 'diff-mode 'normal)
|
|
|
|
(evil-collection-define-key 'normal 'diff-mode-map
|
|
;; motion
|
|
(kbd "SPC") 'scroll-up-command
|
|
(kbd "S-SPC") 'scroll-down-command
|
|
(kbd "[[") 'diff-file-prev
|
|
(kbd "]]") 'diff-file-next
|
|
(kbd "C-j") 'diff-hunk-next
|
|
(kbd "C-k") 'diff-hunk-prev
|
|
"gj" 'diff-hunk-next
|
|
"gk" 'diff-hunk-prev
|
|
|
|
"q" 'quit-window
|
|
|
|
"\\" 'read-only-mode) ; magit has "\"
|
|
|
|
(evil-collection-define-key 'motion 'diff-mode-map
|
|
;; motion
|
|
(kbd "SPC") 'scroll-up-command
|
|
(kbd "S-SPC") 'scroll-down-command
|
|
(kbd "[[") 'diff-file-prev
|
|
(kbd "]]") 'diff-file-next
|
|
(kbd "C-j") 'diff-hunk-next
|
|
(kbd "C-k") 'diff-hunk-prev
|
|
"gj" 'diff-hunk-next
|
|
"gk" 'diff-hunk-prev
|
|
|
|
(kbd "RET") 'diff-goto-source
|
|
"A" 'diff-add-change-log-entries-other-window
|
|
|
|
"a" 'diff-apply-hunk
|
|
"*" 'diff-refine-hunk
|
|
"D" 'diff-file-kill
|
|
"d" 'diff-hunk-kill
|
|
|
|
"ge" 'diff-ediff-patch
|
|
"i" 'next-error-follow-minor-mode
|
|
"o" 'evil-collection-diff-toggle-restrict-view
|
|
"~" 'diff-reverse-direction
|
|
"s" 'diff-split-hunk
|
|
"c" 'diff-test-hunk
|
|
"x" 'evil-collection-diff-toggle-context-unified
|
|
"#" 'diff-ignore-whitespace-hunk
|
|
|
|
"\\" 'read-only-mode)) ; magit has "\"
|
|
|
|
|
|
|
|
(add-hook 'diff-mode-hook 'evil-collection-diff-toggle-setup)
|
|
|
|
(defun evil-collection-diff-unload-function ()
|
|
"For `unload-feature'."
|
|
(remove-hook 'diff-mode-hook 'evil-collection-diff-toggle-setup))
|
|
|
|
(provide 'evil-collection-diff-mode)
|
|
;;; evil-collection-diff-mode.el ends here
|