From: Leo Vivier <leo.vivier+dev@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org-capture: Update plist before finalizing
Date: Sun, 26 Jul 2020 00:50:49 +0200 [thread overview]
Message-ID: <87h7tv9pkm.fsf@hidden> (raw)
[-- Attachment #1: Type: text/plain, Size: 3124 bytes --]
Hi there,
I’m working on the parallelisation of `org-capture' for Org-roam, and
I’ve run into a problem with the updating of `org-capture-plist'.
;;---------------------------------------------------------------------
;; DESCRIPTION
;;---------------------------------------------------------------------
We use the global-variable `org-capture-plist' to populate the
local-variable `org-capture-current-plist' on the init of the
`org-capture' buffer. However, we do not do the opposite (i.e. update
the global-variable with the local-variable) on `org-capture-finalize'.
This is fine for the majority of `org-capture-finalize', since we’re
using the LOCAL arg of `org-capture-get' to read
`org-capture-current-plist' instead of `org-capture-list', but this
trick does not work for `org-capture-after-finalize', since the hook is
run after the `org-capture-buffer' has been closed.
This causes problem with `:kill-buffer t', and it limits what can be
done with cleanup functions in `org-capture-after-finalize'.
;;---------------------------------------------------------------------
;; DEMONSTRATION
;;---------------------------------------------------------------------
Tested in emacs -Q.
Summary:
- Start a capture process (A)
- Start another capture process (B)
- Cancel B
- Cancel A
Form:
--------------------------------[START]--------------------------------
;; Eval the following form:
(progn
(setq org-capture-templates
'(("a" "foo" plain (file "/tmp/foo.org") "* %?"
:kill-buffer t)
("b" "bar" plain (file "/tmp/bar.org") "* %?"
:kill-buffer t)))
(let* ((a (save-window-excursion
(org-capture nil "a")
(current-buffer)))
(b (save-window-excursion
(org-capture nil "b")
(current-buffer))))
(with-current-buffer b
(org-capture-kill))
(with-current-buffer a
(org-capture-kill))))
;; Result: (error "Selecting deleted buffer")
;; `foo.org' is still alive
---------------------------------[END]---------------------------------
;;---------------------------------------------------------------------
;; ANALYSIS
;;---------------------------------------------------------------------
The problem happens during `org-capture-after-finalize'. A’s
`org-capture-finalize' does not update `org-capture-plist' with the value
of `org-current-capture-plist' during its execution, which means that
`org-capture-plist' still holds B’s value, including :buffer. Since B’s
base-buffer was killed, :buffer points to a killed buffer, which is what
is raising the error.
;;---------------------------------------------------------------------
;; PATCH
;;---------------------------------------------------------------------
I propose to update `org-capture-plist' early in `org-capture-finalize'.
I don’t think this would have unforeseen effects, since
`org-capture-list' is already meant to be transient, and we’d only be
expanding its use from init-only to init-and-exit.
HTH,
--
Leo Vivier
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-capture-Update-plist-before-finalizing.patch --]
[-- Type: text/x-patch, Size: 882 bytes --]
From d14f15ab76d60c3f65837a6d14712dadabf324bf Mon Sep 17 00:00:00 2001
From: Leo Vivier <leo.vivier+dev@gmail.com>
Date: Sat, 25 Jul 2020 21:53:07 +0200
Subject: [PATCH] org-capture: Update plist before finalizing
* lisp/org-capture.el (org-capture-finalize): Update
`org-capture-plist' with local-value before finalizing.
---
lisp/org-capture.el | 3 +++
1 file changed, 3 insertions(+)
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index 2cc1ce394..223ed4124 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -728,6 +728,9 @@ captured item after finalizing."
(run-hooks 'org-capture-prepare-finalize-hook)
+ ;; Update `org-capture-plist' with the local-value
+ (setq org-capture-plist org-capture-current-plist)
+
;; Did we start the clock in this capture buffer?
(when (and org-capture-clock-was-started
org-clock-marker
--
2.27.0
next reply other threads:[~2020-07-25 22:51 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-25 22:50 Leo Vivier [this message]
2020-09-02 4:50 ` [PATCH] org-capture: Update plist before finalizing Kyle Meyer
2020-09-05 7:11 ` Leo Vivier
2020-09-05 9:14 ` Bastien
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=87h7tv9pkm.fsf@hidden \
--to=leo.vivier+dev@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).