From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Matthias Meulien Newsgroups: gmane.emacs.bugs Subject: bug#51809: 29.0.50; [PATCH] Support for outline default state in Diff buffers Date: Sat, 13 Nov 2021 22:27:52 +0100 Message-ID: <87wnlbwxt3.fsf@gmail.com> References: <87lf1sw6ji.fsf@gmail.com> <86h7cgdk4v.fsf@mail.linkov.net> <87ee7kvshn.fsf@gmail.com> <87a6i7x5iq.fsf@gmail.com> <86k0hbam7r.fsf@mail.linkov.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="37846"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: 51809@debbugs.gnu.org To: Juri Linkov Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Nov 13 22:29:12 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mm0aG-0009d7-9J for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 13 Nov 2021 22:29:12 +0100 Original-Received: from localhost ([::1]:50176 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mm0aE-0002GE-JL for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 13 Nov 2021 16:29:10 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:44966) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mm0a6-0002Fr-UR for bug-gnu-emacs@gnu.org; Sat, 13 Nov 2021 16:29:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:36762) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mm0a6-0000ix-Ly for bug-gnu-emacs@gnu.org; Sat, 13 Nov 2021 16:29:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mm0a6-0003da-H7 for bug-gnu-emacs@gnu.org; Sat, 13 Nov 2021 16:29:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Matthias Meulien Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 13 Nov 2021 21:29:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 51809 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 51809-submit@debbugs.gnu.org id=B51809.163683889013910 (code B ref 51809); Sat, 13 Nov 2021 21:29:02 +0000 Original-Received: (at 51809) by debbugs.gnu.org; 13 Nov 2021 21:28:10 +0000 Original-Received: from localhost ([127.0.0.1]:48308 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mm0ZF-0003cI-SU for submit@debbugs.gnu.org; Sat, 13 Nov 2021 16:28:10 -0500 Original-Received: from mail-wm1-f46.google.com ([209.85.128.46]:51815) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mm0ZB-0003bk-7d for 51809@debbugs.gnu.org; Sat, 13 Nov 2021 16:28:08 -0500 Original-Received: by mail-wm1-f46.google.com with SMTP id z200so10613684wmc.1 for <51809@debbugs.gnu.org>; Sat, 13 Nov 2021 13:28:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=9W+xJS/8OF3hfO2V1BrkCUJm3xGkA8amfDS6i68dNJM=; b=VJFr6PfjlM55wHTkl1WOBdbcp7/wzUVTbkmUF6tu8W8mTZbze2smVhffNecKNRH7TQ OSa293WznWEFQkvqM3orvimCjUyViRNRlu2zCIWWdSIg6Gu6liYmYGr4Z7mnwl0wzMP3 0q1x95Vt7JBpvenduGrewleI/tvzAXwOtF4Bmcn4xcdzbIMVT6CiLnFHdFjw6VY0si83 4FyLLMx8lrFP94jEjV1/7wEzreimxdE5XN22azXqHXcfgZcFzEcayrTty2+gGeGvL110 Qkwc9ICRKKfopQAYYxeZVnbKz3EYbh2ZjZpv7oCQIVjgPzL+ALS0q6tI+iX+7F5e9X1M L1Hg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=9W+xJS/8OF3hfO2V1BrkCUJm3xGkA8amfDS6i68dNJM=; b=kA81XwVQnc+qXJ6mq+pg61Lb72MR2lIEfiAudsXdJy2gS17koWTLNy4O7dRL+yj51f 0MDa4z2xCBzzjSo7WL1ocotQGN0Vs92yx92sNnDzsce+seVv4nD9uQA2D2RtUf3wccfj nVdbqxmcSjOL0fZKlh5oqPvVNfgWvq+GcfJBWFYMkyXV3KfuNQkAxqjSBLkAkEfVIsXR nRAsGdVoPd7Wbg6reyPMF3bblNDYIEsSkp/Ur/BJQuoS1BQoGh6WIFlXf2CI9LEom2W/ CVRAfIjcm5WFLg+8QFKjriXl4L33z4SFO/LcHN3O2GJOf2kc2wUTPH4C6/OGy9u8JEXI 6q4A== X-Gm-Message-State: AOAM532lFZl/4RymFM+xTUTvZrg4GnPL8jAlOQMVieGOQunCH0e2nvcs GeguZlr6E8KlfWzyptaTW8oUJDEi1XA= X-Google-Smtp-Source: ABdhPJx9aLYFzuyplQyLpiJTWsr/8flF0q+E5lDNERl3YCNHLkUgzgLoXu001BMUt3UIrP8Dj20JKA== X-Received: by 2002:a05:600c:3b28:: with SMTP id m40mr46642674wms.100.1636838879042; Sat, 13 Nov 2021 13:27:59 -0800 (PST) Original-Received: from carbon.localdomain ([2a01:e0a:245:c850:98f5:429a:aa8e:95bb]) by smtp.gmail.com with ESMTPSA id o63sm10151595wme.2.2021.11.13.13.27.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 13 Nov 2021 13:27:58 -0800 (PST) In-Reply-To: <86k0hbam7r.fsf@mail.linkov.net> (Juri Linkov's message of "Sat, 13 Nov 2021 21:29:12 +0200") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:219840 Archived-At: --=-=-= Content-Type: text/plain Juri Linkov writes: Thanks for your comments! >> +(autoload 'outline-minor-mode "outline") > > Actually, outline-minor-mode is already autoloaded, so no special > handling is needed for it. Ok, I'll improve this. > But the problem is that too many outline functions are used in > diff-mode.el in your patch. This is a clear indication that > some part should be moved to outline.el. You're right. > Note that the following function has no diff-specific code, so it could > be refactored and some generalized function added to outline.el. Such > function could be like `outline-map-region' to accept arguments `beg', `end' > and a predicate function that defines whether to hide or show the > body. Ok. I'll make a try. In the meantime, here is a new version that implements both: - Outline based on presence of long lines (using `so-long-detected-long-line-p' predicate) - Outline based on file names matching a regexp (well, truly file heading matching a regexp). --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Support-for-outline-default-state-in-Diff-buffers.patch >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 --=-=-= Content-Type: text/plain -- Matthias --=-=-=--