aboutsummaryrefslogtreecommitdiff
path: root/.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el
diff options
context:
space:
mode:
authorJack Jamison <jackqjamison@gmail.com>2026-07-05 01:19:30 -0400
committerJack Jamison <jackqjamison@gmail.com>2026-07-05 01:19:30 -0400
commitbdf9a71ab7baa2b1de9abcfd5df1a9107a55d141 (patch)
treec4524e6c41aa5107211103401dabfaefc81aa882 /.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el
parentfe3984f541bd32bdfa418afb305b614176b55ca0 (diff)
add a bunch of emacs packages HELP
Diffstat (limited to '.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el')
-rw-r--r--.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el222
1 files changed, 222 insertions, 0 deletions
diff --git a/.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el b/.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el
new file mode 100644
index 0000000..1015705
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/diff-mode/evil-collection-diff-mode.el
@@ -0,0 +1,222 @@
+;;; 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 "26.3"))
+;; 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)))
+
+(defcustom evil-collection-diff-mode-want-minor-mode t
+ "Whether to bind keys to a `evil-collection' created minor mode.
+
+When this is enabled, disable bootstrap related to setting up keys for motion,
+binding keys to a minor mode created by `evil-collection' instead."
+ :type 'boolean
+ :group 'evil-collection)
+
+(define-obsolete-variable-alias 'evil-collection-diff-mode-want-g-bindings
+ 'evil-collection-want-g-bindings "0.0.11")
+
+(defvar evil-collection-diff-mode-map (make-sparse-keymap))
+
+(define-minor-mode evil-collection-diff-mode
+ "A minor mode to attach to `diff-mode' results"
+ :group 'evil-collection-diff-mode
+ :keymap evil-collection-diff-mode-map
+ :lighter nil)
+
+(defun evil-collection-diff-mode-turn-on ()
+ "Turn on `evil-collection-diff-mode' and normalize keymaps."
+ (evil-collection-diff-mode)
+ (evil-normalize-keymaps))
+
+(defun evil-collection-diff-mode-setup-on-minor-mode ()
+ "Set up bindings on `evil-collection-diff-mode'."
+ (evil-collection-define-key 'normal 'evil-collection-diff-mode-map
+ (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
+ "ge" 'diff-ediff-patch
+ "q" 'quit-window
+ "\\" 'read-only-mode
+ (kbd "RET") 'diff-goto-source)
+
+ (if evil-collection-want-g-bindings
+ (evil-collection-define-key 'normal 'evil-collection-diff-mode-map
+ "gA" 'diff-add-change-log-entries-other-window
+ "ga" 'diff-apply-hunk
+ "g*" 'diff-refine-hunk
+ "gX" 'diff-file-kill
+ "gx" 'diff-hunk-kill
+ "gi" 'next-error-follow-minor-mode
+ "go" 'evil-collection-diff-toggle-restrict-view
+ "g~" 'diff-reverse-direction
+ "gs" 'diff-split-hunk
+ "gc" 'diff-test-hunk
+ "g%" 'evil-collection-diff-toggle-context-unified
+ "g#" 'diff-ignore-whitespace-hunk)
+ (evil-collection-define-key 'normal 'evil-collection-diff-mode-map
+ "A" 'diff-add-change-log-entries-other-window
+ "a" 'diff-apply-hunk
+ "*" 'diff-refine-hunk
+ "D" 'diff-file-kill
+ "d" 'diff-hunk-kill
+ "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))
+
+ ;; Enable a separate minor mode so that we can bind keys to it.
+ (add-hook 'diff-mode-hook 'evil-collection-diff-mode))
+
+(defun evil-collection-diff-mode-setup-on-motion-state ()
+ "Set up keys with motion state."
+ (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 "\"
+ )
+
+;;;###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)
+
+ (if evil-collection-diff-mode-want-minor-mode
+ (evil-collection-diff-mode-setup-on-minor-mode)
+ (evil-collection-diff-mode-setup-on-motion-state)))
+
+(unless evil-collection-diff-mode-want-minor-mode
+ (add-hook 'diff-mode-hook 'evil-collection-diff-toggle-setup))
+
+(defun evil-collection-diff-unload-function ()
+ "For `unload-feature'."
+ (unless evil-collection-diff-mode-want-minor-mode
+ (remove-hook 'diff-mode-hook 'evil-collection-diff-toggle-setup)))
+
+(provide 'evil-collection-diff-mode)
+;;; evil-collection-diff-mode.el ends here