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: Tue, 28 Dec 2021 09:09:04 +0100 Message-ID: <877dbpw3q7.fsf@gmail.com> References: <87lf1sw6ji.fsf@gmail.com> 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="12619"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) To: 51809@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Dec 28 09:10:34 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 1n27Z2-00037N-Ur for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 28 Dec 2021 09:10:33 +0100 Original-Received: from localhost ([::1]:38804 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n27Z0-00055l-UU for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 28 Dec 2021 03:10:30 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:42106) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n27YZ-00055O-5d for bug-gnu-emacs@gnu.org; Tue, 28 Dec 2021 03:10:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:33418) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n27YY-0005KY-4V for bug-gnu-emacs@gnu.org; Tue, 28 Dec 2021 03:10:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n27YX-0000hG-SI for bug-gnu-emacs@gnu.org; Tue, 28 Dec 2021 03:10:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Matthias Meulien Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 28 Dec 2021 08:10:01 +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.16406789552618 (code B ref 51809); Tue, 28 Dec 2021 08:10:01 +0000 Original-Received: (at 51809) by debbugs.gnu.org; 28 Dec 2021 08:09:15 +0000 Original-Received: from localhost ([127.0.0.1]:44964 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n27Xm-0000gA-Pd for submit@debbugs.gnu.org; Tue, 28 Dec 2021 03:09:15 -0500 Original-Received: from mail-wr1-f44.google.com ([209.85.221.44]:37482) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n27Xk-0000fw-80 for 51809@debbugs.gnu.org; Tue, 28 Dec 2021 03:09:13 -0500 Original-Received: by mail-wr1-f44.google.com with SMTP id t26so36803010wrb.4 for <51809@debbugs.gnu.org>; Tue, 28 Dec 2021 00:09:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:references:date:in-reply-to:message-id:user-agent :mime-version; bh=gdt6N3+zRhZ42h11PUS4NmiiS6xuRUT8GPIIA4/GoQE=; b=D9ZjlWSZH7DQtulQUEg2/eoCYfPtkOtp1ZRiBtndl4lGnuH8m+K2r6KRVBIU0LcwkK VFmt4OhEkGPnTV1+Qbavm86s9+xykYkUoyNFvcIaYwylncR6UNOpFCV50JiBnpE8lgDH EaVr1xWG4Y2igRmBRHzAd/hrcpWeOuKNp0WlInGZNnzcZ0+ax9t/PQmOuYCRPjVBgqQl VGluPTHbh3IMZXZ+LdPvRdrSXQe2zD12WCJtB3LUtQnZPnPyE/cKgflIh/pCJPjim88Q iHOOzLhOOho5oVtLoSfhGh8whP65IyQnitug8cc+xlLDKSLXBrm/AESqxyvrP7w1KGdW wfoQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=gdt6N3+zRhZ42h11PUS4NmiiS6xuRUT8GPIIA4/GoQE=; b=uWPB3CMi9WK98kQr+KyuTDLZhs3tlbO5ipEeCrpEKdq12t8Whu/sQai29KfMur/uzt qJOxc59T9FxEa6XNTTHnb0jXNP8pl6rkPlKVG8JN91DmDECw9rsPboNZhteiiF8kJenJ TJVOi7lJPLn2Il9uMIDHoEoCtFXI+UKJoZVrUDLzTv3JT6ejptb38i9HkecHV6aCY3vT jy5YVHkjqUw7H10frklAi5PPRK1fyYRh4JxxVYEtZXuww1mVCBoeLoc69t2y0xXTzVvi HOzQ5gpQfatEQ6JtxXyRrSiP27GxhGRROD/9kvcZkwSx7bNfD8EpIFs/+ocXIFg1zcxa a3CA== X-Gm-Message-State: AOAM532tcQL3SygksmM1uknZm9ebu+F1fyU1FLiY5x5bTBeXS9lbXj9V c1puR9Vzys/X/HOwQvBRpxmUJuvabao= X-Google-Smtp-Source: ABdhPJx8b0RBunf0dUKB/2zWcABvxstdLkOAHb8KfDn2qiCkfSUKMiii/yMXJbT42yb4naM2qb/1Lw== X-Received: by 2002:a5d:610c:: with SMTP id v12mr15262669wrt.410.1640678946371; Tue, 28 Dec 2021 00:09:06 -0800 (PST) Original-Received: from carbon.localdomain ([2a01:e0a:245:c850:57c9:ca7e:b934:d778]) by smtp.gmail.com with ESMTPSA id c2sm19037681wri.50.2021.12.28.00.09.05 for <51809@debbugs.gnu.org> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 28 Dec 2021 00:09:05 -0800 (PST) In-Reply-To: <87lf1sw6ji.fsf@gmail.com> (Matthias Meulien's message of "Sat, 13 Nov 2021 14:04:33 +0100") 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:223233 Archived-At: --=-=-= Content-Type: text/plain Updated patch with docstring fix. --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Extend-Outline-mode-with-default-visibility-state.patch >From 167e7f9d8d26b075e01c3a8c8618da3a2138d145 Mon Sep 17 00:00:00 2001 From: Matthias Meulien Date: Wed, 8 Dec 2021 22:35:42 +0100 Subject: [PATCH] Extend Outline mode with default visibility state * etc/NEWS: Announce support for default visibility state. * lisp/outline.el (outline-mode, outline-minor-mode): Ensure default visibility state is applied. (outline-hide-sublevels): Add optional argument for function to call on each heading. (outline-default-state): Define the default visibility state. (outline-apply-default-state): Apply default visibility state. --- etc/NEWS | 10 +++ lisp/outline.el | 190 +++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 197 insertions(+), 3 deletions(-) diff --git a/etc/NEWS b/etc/NEWS index cfea513cca..9a49ff8379 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -215,6 +215,16 @@ These will take you (respectively) to the next and previous "page". --- *** 'describe-char' now also outputs the name of emoji combinations. +** Outline Mode + +*** Support for a default visibility state. +Customize the option 'outline-default-state' to define what headings +are visible when the mode is set. When equal to a number, the option +'outline-default-state-subtree-visibility' determines the visibility +of the subtree starting at the corresponding level. Values are +provided to show a heading subtree unless the heading match a regexp, +or its subtree has long lines or is long. + ** Outline Minor Mode +++ diff --git a/lisp/outline.el b/lisp/outline.el index 5e3d4e0e00..abb0d93adf 100644 --- a/lisp/outline.el +++ b/lisp/outline.el @@ -354,7 +354,9 @@ outline-mode '(outline-font-lock-keywords t nil nil backward-paragraph)) (setq-local imenu-generic-expression (list (list nil (concat "^\\(?:" outline-regexp "\\).*$") 0))) - (add-hook 'change-major-mode-hook #'outline-show-all nil t)) + (add-hook 'change-major-mode-hook #'outline-show-all nil t) + (add-hook 'hack-local-variables-hook + #'outline-apply-default-state)) (defvar outline-minor-mode-map) @@ -437,7 +439,9 @@ outline-minor-mode nil t) (setq-local line-move-ignore-invisible t) ;; Cause use of ellipses for invisible text. - (add-to-invisibility-spec '(outline . t))) + (add-to-invisibility-spec '(outline . t)) + (add-hook 'hack-local-variables-hook + #'outline-apply-default-state)) (when (or outline-minor-mode-cycle outline-minor-mode-highlight) (if font-lock-fontified (font-lock-remove-keywords nil outline-font-lock-keywords)) @@ -1094,7 +1098,7 @@ outline-hide-sublevels (outline-map-region (lambda () (if (<= (funcall outline-level) levels) - (outline-show-heading))) + (outline-show-heading))) beg end) ;; Finally unhide any trailing newline. (goto-char (point-max)) @@ -1308,6 +1312,186 @@ outline-headers-as-kill (insert "\n\n")))))) (kill-new (buffer-string))))))) +(defcustom outline-default-state nil + "If non-nil, some headings are initially outlined. + +Note that the default state is applied when the major mode is set +or when the command `outline-apply-default-state' is called +interactively. + +When nil, headings visibility is left unchanged. + +If equal to `outline-show-all', all text of buffer is shown. + +If equal to `outline-show-only-headings', only headings are shown. + +If equal to a number, show only headings up to and including the +corresponding level. See +`outline-default-state-subtree-visibility' to customize +visibility of the subtree at the choosen level. + +If equal to a lambda function or function name, this function is +expected to toggle headings visibility, and will be called after +the mode is enabled." + :version "29.1" + :type '(choice (const :tag "Disabled" nil) + (const :tag "Show all" outline-show-all) + (const :tag "Only headings" outline-show-only-headings) + (natnum :tag "Show headings up to level" :value 1) + (function :tag "Custom function"))) + +(defcustom outline-default-state-subtree-visibility nil + "Determines visibility of subtree starting at `outline-default-state' level. + +When nil, the subtree is hidden unconditionally. + +When equal to a list, each element should be one of the following: + +- A cons cell with CAR `match-regexp' and CDR a regexp, the + subtree will be hidden when the outline heading match the + regexp. + +- `subtree-has-long-lines' to only show the heading branches when + long lines are detected in its subtree (see + `outline-long-line-threshold' for the definition of long + lines). + +- `subtree-is-long' to only show the heading branches when its + subtree contains more than `outline-line-count-threshold' + lines. + +- A lambda function or function name which will be evaluated with + point at the beginning of the heading and the match data set + appropriately, the function being expected to toggle the + heading visibility." + :version "29.1" + :type '(choice (const :tag "Hide subtree" nil) + (set :tag "Show subtree unless" + (cons :tag "Heading match regexp" + (const match-regexp) string) + (const :tag "Subtree has long lines" + subtree-has-long-lines) + (const :tag "Subtree is long" + subtree-is-long) + (cons :tag "Custom function" + (const custom-function) function)))) + +(defcustom outline-long-line-threshold 1000 + "Minimal number of characters in a line for a heading to be outlined." + :version "29.1" + :type '(natnum :tag "Number of lines")) + +(defcustom outline-line-count-threshold 50 + "Minimal number of lines for a heading to be outlined." + :version "29.1" + :type '(natnum :tag "Number of lines")) + +(defun outline-apply-default-state () + "Apply the outline state defined by `outline-default-state'." + (interactive) + (cond + ((integerp outline-default-state) + (outline--show-headings-up-to-level outline-default-state)) + ((when (functionp outline-default-state) + (funcall outline-default-state))))) + +(defun outline-show-only-headings () + "Show only headings." + (interactive) + (outline-show-all) + (outline-hide-region-body (point-min) (point-max))) + +(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) + +(defun outline--show-headings-up-to-level (level) + "Show only headings up to a LEVEL level. + +Like `outline-hide-sublevels' but, for each heading at level +LEVEL, decides of subtree visibility according to +`outline-default-state-subtree-visibility'." + (if (not outline-default-state-subtree-visibility) + (outline-hide-sublevels level) + (if (< level 1) + (error "Must keep at least one level of headers")) + (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)))) + (heading-regexp + (cdr-safe + (assoc 'match-regexp + outline-default-state-subtree-visibility))) + (check-line-count + (memq 'subtree-is-long + outline-default-state-subtree-visibility)) + (check-long-lines + (memq 'subtree-has-long-lines + outline-default-state-subtree-visibility)) + (custom-function + (cdr-safe + (assoc 'custom-function + outline-default-state-subtree-visibility)))) + (if (< end beg) + (setq beg (prog1 end (setq end beg)))) + ;; First hide everything. + (outline-hide-sublevels level) + ;; Then unhide the top level headers. + (outline-map-region + (lambda () + (let ((current-level (funcall outline-level))) + (when (< current-level level) + (outline-show-heading) + (outline-show-entry)) + (when (= current-level level) + (cond + ((and heading-regexp + (let ((beg (point)) + (end (progn (outline-end-of-heading) (point)))) + (string-match-p heading-regexp (buffer-substring beg end)))) + ;; hide entry when heading match regexp + (outline-hide-entry)) + ((and check-line-count + (save-excursion + (let* ((beg (point)) + (end (progn (outline-end-of-subtree) (point))) + (line-count (count-lines beg end))) + (< outline-line-count-threshold line-count)))) + ;; show only branches when line count of subtree > + ;; threshold + (outline-show-branches)) + ((and check-long-lines + (save-excursion + (let ((beg (point)) + (end (progn (outline-end-of-subtree) (point)))) + (save-restriction + (narrow-to-region beg end) + (let ((so-long-skip-leading-comments nil) + (so-long-threshold outline-long-line-threshold) + (so-long-max-lines nil)) + (so-long-detected-long-line-p)))))) + ;; show only branches when long lines are detected + ;; in subtree + (outline-show-branches)) + (custom-function + ;; call custom function if defined + (funcall custom-function)) + (t + ;; if no previous clause succeeds, show subtree + (outline-show-subtree)))))) + beg end))) + (run-hooks 'outline-view-change-hook))) + (defun outline--cycle-state () "Return the cycle state of current heading. Return either 'hide-all, 'headings-only, or 'show-all." -- 2.30.2 --=-=-=--