emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@gmail.com>
To: "Christopher M. Miles" <numbchild@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH 2-v1] New: auto display inline images under subtree when `org-cycle'.
Date: Thu, 29 Sep 2022 11:05:04 +0800	[thread overview]
Message-ID: <87y1u298yn.fsf@localhost> (raw)
In-Reply-To: <633454e3.050a0220.7278b.1fa5SMTPIN_ADDED_BROKEN@mx.google.com>

"Christopher M. Miles" <numbchild@gmail.com> writes:

> 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.

Thanks for the update!

For tests, you will need to test the existence of image overlays.
You can refer to test-org-fold/org-fold-reveal-broken-structure but
need to test overlays-at instead of just org-invisible-p.

> 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.

I will comment in the code.

>  (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)

You are providing both hook and a customization. It is redundant. Users
can already remove the hook when desired.

In this area, we generally do not use custom variables (see M-x
customize-group org-cycle). So, it is better to use hook.

> -(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)))))

You can just

(dolist (ov overlays)
  (when (memq ov org-inline-image-overlays)
    (setq org-inline-image-overlays (delq ov org-inline-image-overlays))
    (delete-overlay ov)))

Note that `delete' and `delq' are not safe to use on their own. You
should always use (setq foo (delq 'member foo)). It is detailed in the
docstring.

-- 
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92


  parent reply	other threads:[~2022-09-29  3:04 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-22  6:34 [QUESTION] How to specific image size attributes under headline scope? Christopher M. Miles
2021-11-22 18:31 ` Timothy
2022-08-18 12:44   ` Christopher M. Miles
     [not found]   ` <m2o7whra7j.fsf@numbchild>
2022-08-22 17:10     ` Timothy
2022-08-23  0:24       ` Christopher M. Miles
2022-09-11  2:20 ` [SOLVED] " Christopher M. Miles
2022-09-11  2:25 ` Christopher M. Miles
     [not found] ` <631d472b.c80a0220.2b4b2.bf86SMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-11 12:34   ` Ihor Radchenko
2022-09-12  1:54     ` [PATCH] " Christopher M. Miles
2022-09-12  1:59     ` [PATCH] New: auto display inline images under subtree when `org-cycle' Christopher M. Miles
     [not found]     ` <m2wna9bbc2.fsf@numbchild>
2022-09-12  6:03       ` [ISSUE] " Christopher M. Miles
     [not found]     ` <631e92ee.050a0220.f9c18.92f5SMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-12 10:51       ` Ihor Radchenko
2022-09-13  1:09         ` [PATCH 2] " Christopher M. Miles
     [not found]         ` <m2leqogiz8.fsf@numbchild>
2022-09-13  1:48           ` [PATCH 3] " Christopher M. Miles
     [not found]           ` <631fe1c9.050a0220.3ab2b.3f52SMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-15  3:27             ` Ihor Radchenko
2022-09-15  4:53               ` [PATCH 4] " Christopher M. Miles
     [not found]               ` <6322b0a8.050a0220.59bb8.6923SMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-15  8:47                 ` Ihor Radchenko
2022-09-15  9:43                   ` [PATCH 5] " Christopher M. Miles
     [not found]                   ` <6322f5ad.c80a0220.5e936.823eSMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-20  7:01                     ` [PATCH v6] " Ihor Radchenko
2022-09-20 11:32                       ` [PATCH v6] " Christopher M. Miles
     [not found]                       ` <6329c8b0.050a0220.412d.0a6cSMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-21  7:54                         ` Ihor Radchenko
2022-09-28 12:55                           ` [PATCH 2-v1] " Christopher M. Miles
     [not found]                           ` <633454e3.050a0220.7278b.1fa5SMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-29  3:05                             ` Ihor Radchenko [this message]
2022-09-29  6:06                               ` Christopher M. Miles
2022-09-29  6:57                               ` [PATCH 2-v1 (test v1)] " Christopher M. Miles
     [not found]                               ` <63353c69.370a0220.67788.e8a1SMTPIN_ADDED_BROKEN@mx.google.com>
2022-09-30  3:19                                 ` [PATCH 2-v1] " Ihor Radchenko
2022-09-30  8:27                                   ` [PATCH 2-v2] " Christopher M. Miles
     [not found]                                   ` <6336a955.050a0220.4e72e.2b23SMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-01  3:16                                     ` Ihor Radchenko
2022-10-01  9:51                                       ` [PATCH 2-v3] " Christopher M. Miles
     [not found]                                       ` <63380f57.370a0220.a9d9a.dee8SMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-03  3:21                                         ` Ihor Radchenko
2022-10-03  4:37                                           ` [PATCH 2-v4] " Christopher M. Miles
     [not found]                                           ` <633a67d8.050a0220.733e8.e57dSMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-04  4:36                                             ` Ihor Radchenko
2022-10-04  7:27                                               ` Christopher M. Miles
     [not found]                                               ` <633be6d3.370a0220.4060.bacdSMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-08  7:53                                                 ` Ihor Radchenko
2022-10-08  9:50                                                   ` Christopher M. Miles
     [not found]                                                   ` <634149f4.c80a0220.1376.e564SMTPIN_ADDED_BROKEN@mx.google.com>
2022-10-09  7:21                                                     ` Ihor Radchenko
2022-10-10  8:40                                                       ` Christopher M. Miles
     [not found]                                                       ` <m2v8os5aqy.fsf@numbchild>
2022-10-22  1:29                                                         ` Christopher M. Miles
2022-10-23  4:33                                                           ` Ihor Radchenko
2022-10-23  7:14                                                             ` Christopher M. Miles
2022-10-25  7:23                                                               ` Ihor Radchenko
2022-10-25 14:22                                                                 ` [PATCH v3] " Christopher M. Miles
2022-10-26  4:50                                                                   ` Ihor Radchenko

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.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87y1u298yn.fsf@localhost \
    --to=yantar92@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=numbchild@gmail.com \
    /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/org-mode.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).