emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Rodrigo Morales <moralesrodrigo1100@gmail.com>
To: org-mode-email <emacs-orgmode@gnu.org>
Subject: [BUG][org-map-entries] Using (widen) in FUNC when SCOPE is equal to 'tree iterates through headlines outside the tree
Date: Tue, 29 Aug 2023 01:00:22 +0000	[thread overview]
Message-ID: <CAGxMbPZo_T=ou2-oYD8Wff0pLUr0LeJv7LrfFZVRHa2BpUR16w@mail.gmail.com> (raw)

The following result is expected behavior. We iterate through all
headlines starting at headline =* 1=.

#+HEADER: :results value
#+HEADER: :results verbatim
#+begin_src elisp
(with-temp-buffer
  (org-mode)
  (insert
   "* 1
,** 1.1
,** 1.2
,** 1.3
,* 2
,** 2.1
,** 2.2
,** 2.3
")
  (goto-char (point-min))
  (org-map-entries
   (lambda ()
     (org-entry-get nil "ITEM"))
   nil
   'tree))
#+end_src

#+RESULTS:
#+begin_example
("1" "1.1" "1.2" "1.3")
#+end_example

To me, the following result is unexpected behavior, because we are
iterating through headlines that are outside =* 1=, the tree in which
=org-map-entries= was called.

#+begin_quote
SCOPE determines the scope of this command.  It can be any of:

nil     The current buffer, respecting the restriction if any
tree    The subtree started with the entry at point
region  The entries within the active region, if any
region-start-level
        The entries within the active region, but only those at
        the same level than the first one.
#+end_quote

#+HEADER: :results value
#+HEADER: :results verbatim
#+HEADER: :results value
#+begin_src elisp
(with-temp-buffer
  (org-mode)
  (insert
   "* 1
,** 1.1
,** 1.2
,** 1.3
,* 2
,** 2.1
,** 2.2
,** 2.3
")
  (goto-char (point-min))
  (org-map-entries
   (lambda ()
     (widen)
     (org-entry-get nil "ITEM"))
   nil
   'tree))
#+end_src

#+RESULTS:
#+begin_example
("1" "1.1" "1.2" "1.3" "2" "2.1" "2.2" "2.3")
#+end_example

According to the docstring of =org-map-entries=, when SCOPE is =tree=,
we only iterate to the entries under the subtree starting with the
entry at point (relevant part of docstring =org-map-entries= shown
below).

#+begin_quote
SCOPE determines the scope of this command.  It can be any of:

nil     The current buffer, respecting the restriction if any
tree    The subtree started with the entry at point
region  The entries within the active region, if any
region-start-level
        The entries within the active region, but only those at
        the same level than the first one.
#+end_quote

The second result shown above proved this wrong.

* Personal thoughts

I have come up with two possible solutions to handle this scenario.

Solution no. 1: Update the description of =tree= in the docstring of
=org-map-entries= to indicate the user that =widen= shouldn't be used
in FUNC, since otherwise, =org-map-entries= will iterate through
headlines outside the tree at point.

Solution no. 2: Execute the parameter =FUNC=, which is passed to
=org-map-entries=, inside =save-restriction= to ensure that in every
iteration the restriction is not affected, thus only moving forward to
the proper headlines only.


             reply	other threads:[~2023-08-29  1:01 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-29  1:00 Rodrigo Morales [this message]
2023-08-29  8:20 ` [BUG][org-map-entries] Using (widen) in FUNC when SCOPE is equal to 'tree iterates through headlines outside the tree Ihor Radchenko
2023-08-29 13:29   ` Rodrigo Morales

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='CAGxMbPZo_T=ou2-oYD8Wff0pLUr0LeJv7LrfFZVRHa2BpUR16w@mail.gmail.com' \
    --to=moralesrodrigo1100@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /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).