From: Matthias Meulien <orontee@gmail.com>
To: Juri Linkov <juri@linkov.net>
Cc: 51809@debbugs.gnu.org
Subject: bug#51809: 29.0.50; [PATCH] Support for outline default state in Diff buffers
Date: Sat, 11 Dec 2021 19:18:44 +0100 [thread overview]
Message-ID: <87r1ajknsr.fsf@gmail.com> (raw)
In-Reply-To: <86y256uc0v.fsf@mail.linkov.net> (Juri Linkov's message of "Mon, 29 Nov 2021 19:06:40 +0200")
[-- Attachment #1: Type: text/plain, Size: 232 bytes --]
Hi Juri,
Juri Linkov <juri@linkov.net> writes:
> (...) It would be nice to move this feature completely to outline.el,
> so it could be used by other modes, not only in diff-mode.
I've this simple patch for the outline.el part.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Extend-Outline-mode-with-default-visibility-state.patch --]
[-- Type: text/x-diff, Size: 4263 bytes --]
From d8fee4c307178fc2e0e7c206b8b8a42b2acda719 Mon Sep 17 00:00:00 2001
From: Matthias Meulien <orontee@gmail.com>
Date: Wed, 8 Dec 2021 22:35:42 +0100
Subject: [PATCH] Extend Outline mode with 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
---
lisp/outline.el | 50 ++++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 45 insertions(+), 5 deletions(-)
diff --git a/lisp/outline.el b/lisp/outline.el
index 2ede4e23ea..a3e5da4f5b 100644
--- a/lisp/outline.el
+++ b/lisp/outline.el
@@ -353,7 +353,8 @@ 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)
+ (outline-apply-default-state))
(defvar outline-minor-mode-map)
@@ -436,7 +437,8 @@ 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))
+ (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))
@@ -1058,13 +1060,16 @@ outline-show-heading
(progn (outline-end-of-heading) (point))
nil))
-(defun outline-hide-sublevels (levels)
+(defun outline-hide-sublevels (levels &optional fun)
"Hide everything but the top LEVELS levels of headers, in whole buffer.
This also unhides the top heading-less body, if any.
Interactively, the prefix argument supplies the value of LEVELS.
When invoked without a prefix argument, LEVELS defaults to the level
-of the current heading, or to 1 if the current line is not a heading."
+of the current heading, or to 1 if the current line is not a heading.
+
+When FUN is defined, sublevels aren't hidden but FUN is called
+for each of them."
(interactive (list
(cond
(current-prefix-arg (prefix-numeric-value current-prefix-arg))
@@ -1093,7 +1098,9 @@ outline-hide-sublevels
(outline-map-region
(lambda ()
(if (<= (funcall outline-level) levels)
- (outline-show-heading)))
+ (if fun
+ (funcall fun)
+ (outline-show-heading))))
beg end)
;; Finally unhide any trailing newline.
(goto-char (point-max))
@@ -1307,6 +1314,39 @@ outline-headers-as-kill
(insert "\n\n"))))))
(kill-new (buffer-string)))))))
+(defcustom outline-default-state nil
+ "If non-nil, some headings are initially outlined.
+
+If equal to `only-headings', only heading are shown.
+
+If equal to a number, hide everything but the headings at that
+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 "Show all" nil)
+ (const :tag "Only headings" only-headings)
+ (natnum :tag "Outline level")
+ (function :tag "Custom function"))
+ :local t
+ :safe t)
+;; TODO fix variable being set through file local variable
+
+(defun outline-apply-default-state ()
+ "Apply the outline state defined by `outline-default-state'."
+ (interactive)
+ (cond
+ ((not outline-default-state) (outline-show-all))
+ ((eq outline-default-state 'only-headings)
+ (outline-show-all)
+ (outline-hide-region-body (point-min) (point-max)))
+ ((integerp outline-default-state)
+ (outline-hide-sublevels outline-default-state))
+ ((when (functionp outline-default-state)
+ (funcall outline-default-state)))))
+
(defun outline--cycle-state ()
"Return the cycle state of current heading.
Return either 'hide-all, 'headings-only, or 'show-all."
--
2.30.2
[-- Attachment #3: Type: text/plain, Size: 299 bytes --]
One thing that bothers me is that I am not able to store the wanted
default visibility state as a local variable... Any suggestion welcome!
Also, I've not started to rewrite the diff-mode part on top of this
patch, so comments are most welcome in case I am going in wrong
direction.
--
Matthias
next prev parent reply other threads:[~2021-12-11 18:18 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-13 13:04 bug#51809: 29.0.50; [PATCH] Support for outline default state in Diff buffers Matthias Meulien
2021-11-13 17:45 ` Juri Linkov
2021-11-13 18:08 ` Matthias Meulien
2021-11-13 18:27 ` Juri Linkov
2021-11-13 18:41 ` Matthias Meulien
2021-11-13 19:29 ` Juri Linkov
2021-11-13 21:27 ` Matthias Meulien
2021-11-13 23:29 ` Matthias Meulien
2021-11-29 17:06 ` Juri Linkov
2021-11-30 19:33 ` Matthias Meulien
2021-12-11 18:18 ` Matthias Meulien [this message]
2021-12-12 8:43 ` Juri Linkov
2021-12-13 7:55 ` Matthias Meulien
2021-12-13 8:58 ` Juri Linkov
2021-12-26 16:05 ` Matthias Meulien
2021-12-26 16:21 ` Eli Zaretskii
2021-12-26 19:19 ` Matthias Meulien
2021-12-26 20:32 ` Matthias Meulien
2021-12-26 20:55 ` Matthias Meulien
2021-12-27 19:52 ` Juri Linkov
2021-12-28 18:37 ` Juri Linkov
2021-12-28 21:46 ` Matthias Meulien
2021-12-28 22:28 ` Matthias Meulien
2022-01-11 17:46 ` Juri Linkov
2022-01-14 16:41 ` Matthias Meulien
2022-01-16 18:14 ` Juri Linkov
2022-01-17 21:10 ` Matthias Meulien
2022-01-29 19:12 ` Juri Linkov
2022-02-05 18:45 ` Juri Linkov
2022-02-05 22:00 ` Lars Ingebrigtsen
2022-02-12 17:09 ` Juri Linkov
2022-02-12 17:26 ` Matthias Meulien
2022-02-14 21:07 ` Matthias Meulien
2022-02-14 21:13 ` Matthias Meulien
2022-02-14 21:33 ` Matthias Meulien
2022-02-14 21:39 ` Matthias Meulien
2022-02-16 19:20 ` Juri Linkov
2021-12-28 18:32 ` Juri Linkov
2021-12-28 21:45 ` Matthias Meulien
2021-11-14 18:25 ` Juri Linkov
2021-11-14 19:35 ` Matthias Meulien
2021-11-14 19:46 ` Juri Linkov
2021-11-14 19:54 ` Matthias Meulien
2021-11-14 20:31 ` Juri Linkov
2021-12-28 8:09 ` Matthias Meulien
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r1ajknsr.fsf@gmail.com \
--to=orontee@gmail.com \
--cc=51809@debbugs.gnu.org \
--cc=juri@linkov.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).