Ok, I created the patch for subtree cycling display inline images. Tested by edebug when org cycling, it should works fine. I don't know how to write test for this.
But I got a little problem: When ~org-fold-core-style~ is ~'overlays~, the ~delete-overlay~ will cause subtree unfolded. More detailed check out the "org.el" function ~org-remove-inline-images~ in my patch.
From 173772d166c9974db1a76f59fe58988fe8da401a Mon Sep 17 00:00:00 2001
From: stardiviner <numbch...@gmail.com>
Date: Wed, 28 Sep 2022 20:46:52 +0800
Subject: [PATCH] org.el: Support auto display inline images when cycling
* lisp/org.el (org-toggle-inline-images): Support region.
(org-display-inline-images): Fix refresh argument logic.
(org-remove-inline-images): Support region.
* lisp/org-keys.el (org-toggle-inline-images): Update arguments.
* lisp/org-cycle.el (org-cycle-inline-images-display): Add new option to
control whether auto display inline images when cycling.
(org-cycle-display-inline-images): Add new hook function to auto display
inline images when cycling.
(org-cycle-hook): Add `org-cycle-display-inline-images' into cycling
hook by default.
---
lisp/org-cycle.el | 36 ++++++++++++++++++++++++++++++++++--
lisp/org-keys.el | 2 +-
lisp/org.el | 25 +++++++++++++++++--------
3 files changed, 52 insertions(+), 11 deletions(-)
diff --git a/lisp/org-cycle.el b/lisp/org-cycle.el
index 656ca83f2..da7a7a34e 100644
--- a/lisp/org-cycle.el
+++ b/lisp/org-cycle.el
@@ -208,8 +208,9 @@ the values `folded', `children', or `subtree'."
:type 'hook)
(defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
- org-cycle-show-empty-lines
- org-cycle-optimize-window-after-visibility-change)
+ org-cycle-show-empty-lines
+ org-cycle-optimize-window-after-visibility-change
+ org-cycle-display-inline-images)
"Hook that is run after `org-cycle' has changed the buffer visibility.
The function(s) in this hook must accept a single argument which indicates
the new state that was set by the most recent `org-cycle' command. The
@@ -229,6 +230,12 @@ normal outline commands like `show-all', but not with the cycling commands."
:group 'org-cycle
:type 'boolean)
+(defcustom org-cycle-inline-images-display nil
+ "Non-nil means auto display inline images under subtree when cycling."
+ :group 'org-startup
+ :group 'org-cycle
+ :type 'boolean)
+
(defvar org-cycle-tab-first-hook nil
"Hook for functions to attach themselves to TAB.
See `org-ctrl-c-ctrl-c-hook' for more information.
@@ -776,6 +783,31 @@ STATE should be one of the symbols listed in the docstring of
"Subtree is archived and stays closed. Use \
`\\[org-cycle-force-archived]' to cycle it anyway."))))))
+(defun org-cycle-display-inline-images (state)
+ "Auto display inline images under subtree when cycling.
+It works when `org-cycle-inline-images-display' is non-nil."
+ (when org-cycle-inline-images-display
+ (pcase state
+ ('children
+ (save-excursion
+ (save-restriction
+ (org-narrow-to-subtree)
+ ;; If has nested headlines, beg,end only from parent
+ ;; headline to first child headline which reference to
+ ;; upper let-binding `org-next-visible-heading'.
+ (org-display-inline-images
+ nil nil
+ (point-min) (progn (org-next-visible-heading 1) (point))))))
+ ('subtree
+ (save-excursion
+ (save-restriction
+ (org-narrow-to-subtree)
+ ;; If has nested headlines, also inline display images under all sub-headlines.
+ (org-display-inline-images nil nil (point-min) (point-max)))))
+ ('folded
+ (org-narrow-to-subtree)
+ (org-remove-inline-images (point-min) (point-max))))))
+
(provide 'org-cycle)
;;; org-cycle.el ends here
diff --git a/lisp/org-keys.el b/lisp/org-keys.el
index d65379a72..79e34cbd1 100644
--- a/lisp/org-keys.el
+++ b/lisp/org-keys.el
@@ -204,7 +204,7 @@
(declare-function org-toggle-radio-button "org" (&optional arg))
(declare-function org-toggle-comment "org" ())
(declare-function org-toggle-fixed-width "org" ())
-(declare-function org-toggle-inline-images "org" (&optional include-linked))
+(declare-function org-toggle-inline-images "org" (&optional include-linked beg end))
(declare-function org-latex-preview "org" (&optional arg))
(declare-function org-toggle-narrow-to-subtree "org" ())
(declare-function org-toggle-ordered-property "org" ())
diff --git a/lisp/org.el b/lisp/org.el
index 036384a04..e7eba25cc 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -16071,16 +16071,16 @@ SNIPPETS-P indicates if this is run to create snippet images for HTML."
(defvar-local org-inline-image-overlays nil)
-(defun org-toggle-inline-images (&optional include-linked)
+(defun org-toggle-inline-images (&optional include-linked beg end)
"Toggle the display of inline images.
INCLUDE-LINKED is passed to `org-display-inline-images'."
(interactive "P")
(if org-inline-image-overlays
(progn
- (org-remove-inline-images)
+ (org-remove-inline-images beg end)
(when (called-interactively-p 'interactive)
(message "Inline image display turned off")))
- (org-display-inline-images include-linked)
+ (org-display-inline-images include-linked nil beg end)
(when (called-interactively-p 'interactive)
(message (if org-inline-image-overlays
(format "%d images displayed inline"
@@ -16170,8 +16170,8 @@ BEG and END define the considered part. They default to the
buffer boundaries with possible narrowing."
(interactive "P")
(when (display-graphic-p)
- (unless refresh
- (org-remove-inline-images)
+ (when refresh
+ (org-remove-inline-images beg end)
(when (fboundp 'clear-image-cache) (clear-image-cache)))
(let ((end (or end (point-max))))
(org-with-point-at (or beg (point-min))
@@ -16322,11 +16322,20 @@ buffer boundaries with possible narrowing."
(delete ov org-inline-image-overlays)
(delete-overlay ov))))
-(defun org-remove-inline-images ()
+(defun org-remove-inline-images (&optional beg end)
"Remove inline display of images."
(interactive)
- (mapc #'delete-overlay org-inline-image-overlays)
- (setq org-inline-image-overlays nil))
+ (let* ((beg (or beg (point-min)))
+ (end (or end (point-max)))
+ (overlays (overlays-in beg end)))
+ (dolist (ov overlays)
+ (delete ov org-inline-image-overlays))
+ (mapc #'delete-overlay overlays)
+ ;; FIXME: `org-cycle-display-inline-images' can't fold because `delete-overlay' will unfold subtree.
+ (when (eq org-fold-core-style 'overlays)
+ ;; FIXME: don't know how to get the correct `spec'.
+ (let ((spec (alist-get 'org-fold-hidden org-fold-core--specs)))
+ (org-fold-core-region beg end t spec)))))
(defvar org-self-insert-command-undo-counter 0)
(defvar org-speed-command nil)
--
2.37.2
Ihor Radchenko <yanta...@gmail.com> writes: > "Christopher M. Miles" <numbch...@gmail.com> writes: > >> I checked out your patch, it's fine to me. Should be fine to apply. > > Done. > Applied onto main. > https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=95df82c5fcf926088da2aaab9354a902956ae881 > > Going back to cycling inline image visibility now. > > I think that the first step should be extending > `org-remove-inline-images' and `org-display-inline-images' to work on > regions. `org-display-inline-images' already provides BEG and END > optional arguments, but it currently clears all the images in buffer > unconditionally. > > We will need to make `org-remove-inline-images' work on region and > modify `org-display-inline-images' to not affect images outside the > provided region. > > Then, we can modify `org-toggle-inline-images' accordingly and make use > of it in org-cycle.el to toggle images in section/subtree. -- [ stardiviner ] I try to make every word tell the meaning that I want to express without misunderstanding. Blog: https://stardiviner.github.io/ IRC(libera.chat, freenode): stardiviner, Matrix: stardiviner GPG: F09F650D7D674819892591401B5DF1C95AE89AC3
signature.asc
Description: PGP signature
