From a571efeb5f90e42d1c86e0bef8fe0ebba819914c Mon Sep 17 00:00:00 2001 From: Matthias Meulien Date: Sat, 13 Nov 2021 12:08:58 +0100 Subject: [PATCH] Support for outline default state in Diff buffers * lisp/vc/diff-mode.el (diff-outline-default-state): Add custom variable that defines an outline state and apply that state in Diff buffers. --- lisp/vc/diff-mode.el | 166 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 164 insertions(+), 2 deletions(-) diff --git a/lisp/vc/diff-mode.el b/lisp/vc/diff-mode.el index e68aa2257d..578e80b4e2 100644 --- a/lisp/vc/diff-mode.el +++ b/lisp/vc/diff-mode.el @@ -50,7 +50,11 @@ ;; ;; - in diff-apply-hunk, strip context in replace-match to better ;; preserve markers and spacing. +;; ;; - Handle `diff -b' output in context->unified. +;; +;; - Support outlining files by name (eg to skip automatically +;; generated files like package-lock.json in Javascript projects). ;;; Code: (eval-when-compile (require 'cl-lib)) @@ -62,6 +66,15 @@ (defvar vc-find-revision-no-save) (defvar add-log-buffer-file-name-function) +(eval-when-compile (require 'outline)) +(autoload 'outline-minor-mode "outline") +(defvar outline-minor-mode) + +(eval-when-compile (require 'so-long)) +(autoload 'so-long-detected-long-line-p "so-long") +(defvar so-long-skip-leading-comments) +(defvar so-long-threshold) +(defvar so-long-max-lines) (defgroup diff-mode () "Major mode for viewing/editing diffs." @@ -147,6 +160,61 @@ diff-font-lock-syntax (const :tag "Highlight syntax" t) (const :tag "Allow hunk-based fallback" hunk-also))) +(defcustom diff-outline-default-state nil + "If non-nil, some files or hunk are outlined. +Outlining is performed by Outline minor mode. + +If equal to `outline-hunks', only file and hunk headings are +visibles. + +If equal to a lambda function or function name, this function is +expected to toggle file or hunks visibility, and will be called +after the mode is enabled. + +If equal to a list of symbols, hunk headings will be outlined +depending on the conditions defined for each symbol: + +- If `line-count-threshold', when hunks under a given file + heading cover more than `diff-outline-line-count-threshold' + lines, they are outlined; + +- If `file-heading-regexp', file headings which match the regexp + `diff-outline-file-heading-regexp' are outlined; + +- If `long-line-threshold', when a hunk under a given file + heading have a line with more than + `diff-outline-long-line-threshold' characters, all hunks for + that file heading are outlined." + :version "29.1" + :type '(choice (const :tag "Don't outline " nil) + (const :tag "Outline hunks" outline-hunks) + (set :tag "Outline some files" + (const + :tag "Outline files with long hunks" + line-count-threshold) + (const + :tag "Outline files by name" + file-heading-regexp) + (const + :tag "Outline files whose hunks involve long lines" + long-line-threshold)) + (function :tag "Custom function"))) + +(defcustom diff-outline-line-count-threshold 50 + "Minimal number of lines of hunks for a file to be outlined." + :version "29.1" + :type '(natnum :tag "Number of lines")) + +(defcustom diff-outline-file-heading-regexp "ChangeLog\\|package-lock\\.json" + "Regexp to match file headings to be outlined." + :version "29.1" + :type '(regexp :tag "Files to outline")) + +(defcustom diff-outline-long-line-threshold 1000 + "Minimal number of characters in a line for a file to be outlined." + :version "29.1" + :type '(natnum :tag "Number of lines")) + (defvar diff-vc-backend nil "The VC backend that created the current Diff buffer, if any.") @@ -1578,7 +1646,8 @@ diff-setup-whitespace (defun diff-setup-buffer-type () "Try to guess the `diff-buffer-type' from content of current Diff mode buffer. -`outline-regexp' is updated accordingly." +`outline-regexp' is updated accordingly and outline default state +applied." (save-excursion (goto-char (point-min)) (setq-local diff-buffer-type @@ -1589,7 +1658,8 @@ diff-setup-buffer-type (setq diff-outline-regexp (concat "\\(^diff --git.*\n\\|" diff-hunk-header-re "\\)")) (setq-local outline-level #'diff--outline-level)) - (setq-local outline-regexp diff-outline-regexp)) + (setq-local outline-regexp diff-outline-regexp) + (diff-outline-apply-default-state)) (defun diff-delete-if-empty () ;; An empty diff file means there's no more diffs to integrate, so we @@ -2143,6 +2213,98 @@ diff-refresh-hunk (delete-file file1) (delete-file file2)))) +(defun diff-outline-apply-default-state () + "Apply the outline state defined by `diff-outline-default-state'. + +When `diff-outline-default-state' is non-nil, Outline minor mode +is enabled." + (when diff-outline-default-state + (when (not outline-minor-mode) + (outline-minor-mode)) + (cond + ((eq diff-outline-default-state 'outline-hunks) + (outline-hide-body)) + ((listp diff-outline-default-state) + (diff--outline-apply-default-state)) + ((when (functionp diff-outline-default-state) + (funcall diff-outline-default-state)))))) + +(defun diff--outline-apply-default-state () + "Outline file or hunks according to `diff-outline-default-state'. + +See `diff-outline-default-state' for details. + +Inspired by `outline-hide-sublevels'." + (interactive) + (when outline-minor-mode + (save-excursion + (let* (outline-view-change-hook + (beg (progn + (goto-char (point-min)) + ;; Skip the prelude, if any. + (unless (outline-on-heading-p t) (outline-next-heading)) + (point))) + (end (progn + (goto-char (point-max)) + ;; Keep empty last line, if available. + (if (bolp) (1- (point)) (point))))) + (if (< end beg) + (setq beg (prog1 end (setq end beg)))) + ;; First hide sublevels + (outline-hide-sublevels 1) + ;; Then unhide short subtrees + (outline-map-region + (lambda () + (when (= (funcall outline-level) 1) + (goto-char (match-end 0)) + (let ((overlays (overlays-at (point)))) + (while overlays + (let ((overlay (car overlays))) + (progn + (when (eq (overlay-get overlay 'invisible) 'outline) + (goto-char (match-beginning 0)) + (cond + ((and + (memq 'file-heading-regexp + diff-outline-default-state) + ;; hide entry when file heading match + ;; `diff-outline-file-heading-regexp' + (message (concat "trying regexp on " (match-string 0))) + (string-match-p + diff-outline-file-heading-regexp + (match-string 0))) + (outline-hide-entry)) + + ((and + (memq 'line-count-threshold + diff-outline-default-state) + ;; show only branches when line count > + ;; threshold + (let ((line-count (count-lines + (overlay-end overlay) + (overlay-start overlay)))) + (< diff-outline-line-count-threshold line-count))) + (outline-show-branches)) + + ((and + (memq 'long-line-threshold + diff-outline-default-state) + ;; show only branches when a long line is + ;; detected + (save-restriction + (narrow-to-region (overlay-start overlay) + (overlay-end overlay)) + (let ((so-long-skip-leading-comments nil) + (so-long-threshold + diff-outline-long-line-threshold) + (so-long-max-lines nil)) + (so-long-detected-long-line-p)))) + (outline-show-branches)) + + (t (outline-show-subtree)))) + (setq overlays (cdr overlays)))))))) + beg end))))) + ;;; Fine change highlighting. (defface diff-refine-changed -- 2.30.2