[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#45147: Org-like cycling in outline-minor-mode
From: |
Juri Linkov |
Subject: |
bug#45147: Org-like cycling in outline-minor-mode |
Date: |
Wed, 16 Dec 2020 22:28:51 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (x86_64-pc-linux-gnu) |
As proposed in bug#41198, here is the support for outline-minor-mode
in the 'C-h b' Help buffer:
diff --git a/lisp/help.el b/lisp/help.el
index ac5c2f1311..be366439b8 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -509,7 +509,22 @@ describe-bindings
;; Be aware that `describe-buffer-bindings' puts its output into
;; the current buffer.
(with-current-buffer (help-buffer)
- (describe-buffer-bindings buffer prefix))))
+ (describe-buffer-bindings buffer prefix)
+
+ (setq-local outline-regexp ".*:$")
+ (setq-local outline-level (lambda () 1))
+ (setq-local outline-minor-mode-cycle t)
+ (setq-local outline-minor-mode-highlight t)
+ (outline-minor-mode +1)
+ (save-excursion
+ (let ((inhibit-read-only t))
+ (goto-char (point-min))
+ (insert "Type TAB or S-TAB on headings to cycle their
visibility.\n\n")
+ ;; Hide the longest body
+ (when (and (re-search-forward "Key translations" nil t)
+ (fboundp 'outline-cycle))
+ (outline-cycle))))
+ (font-lock-ensure))))
;; This function used to be in keymap.c.
(defun describe-bindings-internal (&optional menus prefix)
And here is an updated outline.el:
diff --git a/lisp/outline.el b/lisp/outline.el
index 85f9de4e1b..97aba091c5 100644
--- a/lisp/outline.el
+++ b/lisp/outline.el
@@ -175,23 +175,40 @@ outline-minor-mode-menu-bar-map
outline-mode-menu-bar-map))))))
map))
+(defvar outline-mode-cycle-map
+ (let ((map (make-sparse-keymap)))
+ (let ((binding `(menu-item
+ "" outline-cycle
+ ;; Only takes effect if point is on a heading.
+ :filter ,(lambda (cmd)
+ (when (outline-on-heading-p) cmd)))))
+ (define-key map (kbd "TAB") binding)
+ (define-key map [tab] binding)
+ (define-key map (kbd "<backtab>") #'outline-cycle-buffer))
+ map))
+
(defvar outline-mode-map
(let ((map (make-sparse-keymap)))
+ (set-keymap-parent map outline-mode-cycle-map)
(define-key map "\C-c" outline-mode-prefix-map)
(define-key map [menu-bar] outline-mode-menu-bar-map)
- ;; Only takes effect if point is on a heading.
- (define-key map (kbd "TAB")
- `(menu-item "" outline-cycle
- :filter ,(lambda (cmd)
- (when (outline-on-heading-p) cmd))))
- (define-key map (kbd "<backtab>") #'outline-cycle-buffer)
map))
(defvar outline-font-lock-keywords
'(
;; Highlight headings according to the level.
- (eval . (list (concat "^\\(?:" outline-regexp "\\).+")
- 0 '(outline-font-lock-face) nil t)))
+ (eval . (list (concat "^\\(?:" outline-regexp "\\)"
+ (if (string-match-p "\\$$" outline-regexp)
+ "" ".+"))
+ 0 '(if outline-minor-mode-cycle
+ (if outline-minor-mode-highlight
+ (list 'face (outline-font-lock-face) 'keymap
outline-mode-cycle-map)
+ (list 'face nil 'keymap outline-mode-cycle-map))
+ (outline-font-lock-face))
+ nil
+ (if (or outline-minor-mode-highlight
outline-minor-mode-cycle)
+ 'append
+ t))))
"Additional expressions to highlight in Outline mode.")
(defface outline-1
@@ -305,6 +322,19 @@ outline-minor-mode-prefix
(define-key outline-minor-mode-map val outline-mode-prefix-map)
(set-default sym val)))
+(defvar outline-minor-mode-highlight nil
+ "Highlight headings in `outline-minor-mode' using font-lock keywords.
+Non-nil value works well only when outline font-lock keywords
+don't conflict with the major mode's font-lock keywords.")
+;;;###autoload(put 'outline-minor-mode-highlight 'safe-local-variable
'booleanp)
+(defvar outline-minor-mode-cycle nil
+ "Enable heading cycle in `outline-minor-mode'.
+When point is on a heading line, then typing 'TAB' cycles between `hide all',
+`headings only' and `show all' (`outline-cycle'). Typing 'S-TAB' on
+a heading line cycles the whole buffer (`outline-cycle-buffer').
+Typing these keys anywhere outside heading lines uses their default bindings.")
+;;;###autoload(put 'outline-minor-mode-cycle 'safe-local-variable 'booleanp)
+
;;;###autoload
(define-minor-mode outline-minor-mode
"Toggle Outline minor mode.
@@ -314,6 +344,11 @@ outline-minor-mode
(cons outline-minor-mode-prefix outline-mode-prefix-map))
(if outline-minor-mode
(progn
+ (when (or outline-minor-mode-highlight outline-minor-mode-cycle)
+ (unless font-lock-defaults
+ (setq-local font-lock-defaults '(nil t)))
+ (font-lock-add-keywords nil outline-font-lock-keywords t)
+ (font-lock-flush))
;; Turn off this mode if we change major modes.
(add-hook 'change-major-mode-hook
(lambda () (outline-minor-mode -1))
@@ -321,6 +356,9 @@ outline-minor-mode
(setq-local line-move-ignore-invisible t)
;; Cause use of ellipses for invisible text.
(add-to-invisibility-spec '(outline . t)))
+ (when (or outline-minor-mode-highlight outline-minor-mode-cycle)
+ (font-lock-remove-keywords nil outline-font-lock-keywords)
+ (font-lock-flush))
(setq line-move-ignore-invisible nil)
;; Cause use of ellipses for invisible text.
(remove-from-invisibility-spec '(outline . t))