From: Ryan Scott <ryan@vicarious-living.com>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: numbchild@gmail.com, Greg Minshall <minshall@umich.edu>,
Timothy <tecosaur@gmail.com>,
emacs-orgmode@gnu.org
Subject: Re: [PATCH] Re: New source block results option for attaching file to node
Date: Fri, 10 Jun 2022 01:06:07 -0700 [thread overview]
Message-ID: <CAHBUXNzGWDbEttnRY_+i8NgbJs9BagYQ5D4G74w6=H398yEbeA@mail.gmail.com> (raw)
In-Reply-To: <CAHBUXNwj+cvSK_Su5BJmkXmvtkio7MVzvPRtO5NG0Cv6Mu_ijQ@mail.gmail.com>
[-- Attachment #1.1: Type: text/plain, Size: 1256 bytes --]
I believe I have addressed your feedback, Ihor.
Attached is the latest version of the patch.
- Merged latest master
- :post is now handled correctly (verified with example of :post usage
in the example at https://orgmode.org/manual/Results-of-Evaluation.html)
- Added "(with quotes)" to help make the NEWS entry clearer
- Changed the attach directory detection to use a string prefix check
Let me know what you think.
On Thu, Apr 21, 2022 at 11:19 PM Ryan Scott <ryan@vicarious-living.com>
wrote:
> Great. Just making sure that this particular approach to this feature or
> type of feature wasn't fundamentally flawed given the established behavior
> of org.
> Thanks.
>
> On Thu, Apr 21, 2022 at 11:02 PM Ihor Radchenko <yantar92@gmail.com>
> wrote:
>
>> Ryan Scott <ryan@vicarious-living.com> writes:
>>
>> > With all of the layers and assumptions/behaviors inherent in the way src
>> > block parameters are handled, do you feel like this is an approach that
>> can
>> > work, or should it be abandoned?
>>
>> I am not sure if I understand your concern.
>> Your code is reusing the existing convention that current directory is
>> managed via default-directory by ob-core.el. I do not see any problem
>> here.
>>
>> Best,
>> Ihor
>>
>
[-- Attachment #1.2: Type: text/html, Size: 2075 bytes --]
[-- Attachment #2: org-src-block-results-attach-dir.patch --]
[-- Type: application/octet-stream, Size: 8710 bytes --]
From a35bb11cb20240e594902dcd58b14571be2c7fb6 Mon Sep 17 00:00:00 2001
From: Ryan C. Scott <ryan@5pmCasual.com>
Date: Fri, 10 Jun 2022 00:01:37 -0700
Subject: [PATCH] ob-core.el/babel: Special handling for attachment links in
src block
* ob-core.el (org-babel-merge-params): Specifying the symbol 'attach`
or string "'attach" as the value of the `:dir' header now functions as
":dir (org-attach-dir nil t) :mkdirp t"
(org-babel-result-to-file): Optional `TYPE' argument accepts symbol
'attachment` to fixup up paths under `(org-attach-dir)' and use the
link type "attachment:" when that is detected.
(org-babel-insert-result): Pass symbol `attachment' as `TYPE' to
`org-babel-result-to-file'
* org-attach.el (org-attach-dir): Added autoload header to simplify
dependencies necessary to support this feature (called in
`org-babel-merge-params').
---
doc/org-manual.org | 6 ++++
etc/ORG-NEWS | 7 ++++
lisp/ob-core.el | 80 +++++++++++++++++++++++++++++++++-------------
lisp/org-attach.el | 1 +
4 files changed, 71 insertions(+), 23 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 32a45f884..5f9b3353b 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -17541,6 +17541,12 @@ directory with {{{kbd(M-x cd RET DIRECTORY)}}}, and then not setting
=dir=. Under the surface, =dir= simply sets the value of the Emacs
variable ~default-directory~. Setting =mkdirp= header argument to
a non-~nil~ value creates the directory, if necessary.
+Setting =dir= to the symbol ~attach~ or the string ~"'attach"~ will
+set =dir= to the directory returned by ~(org-attach-dir)~, set =:mkdir
+yes=, and insert any file paths, as when using =:results file=, which
+are under the node's attachment directory using =attachment:= links
+instead of the usual =file:= links. Any returned path outside of the
+attachment directory will use =file:= links as per usual.
For example, to save the plot file in the =Work/= folder of the home
directory---notice tilde is expanded:
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 35af94f92..0c88378d6 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -795,6 +795,13 @@ Finally, the closures are only evaluated if they're not overridden for
a source block. This improves efficiency in cases where the result of
a compute-expensive closure would otherwise be discarded.
+*** New special value ~'attach~ for src block =:dir= option
+
+Passing the symbol ~attach~ or string ="'attach"= (with quotes) to the =:dir=
+option of a src block is now equivalent to =:dir (org-attach-dir) :mkdir yes=
+and any file results with a path descended from the attachment directory will
+use =attachment:= style links instead of the standard =file:= link type.
+
** Miscellaneous
*** =org-bibtex= includes =doi= and =url= entries when exporting to BiBTeX
=doi= and =url= entries have been made optional for some publication
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index 09d6adfe0..faec7ec9a 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -801,7 +801,8 @@ block."
(let ((*this* (if (not file) result
(org-babel-result-to-file
file
- (org-babel--file-desc params result)))))
+ (org-babel--file-desc params result)
+ 'attachment))))
(setq result (org-babel-ref-resolve post))
(when file
(setq result-params (remove "file" result-params))))))
@@ -2298,11 +2299,14 @@ INFO may provide the values of these header arguments (in the
(cond ((stringp result)
(setq result (org-no-properties result))
(when (member "file" result-params)
- (setq result (org-babel-result-to-file
- result
- (org-babel--file-desc (nth 2 info) result)))))
+ (setq result
+ (org-babel-result-to-file
+ result
+ (org-babel--file-desc (nth 2 info) result)
+ 'attachment))))
((listp result))
(t (setq result (format "%S" result))))
+
(if (and result-params (member "silent" result-params))
(progn (message (replace-regexp-in-string "%" "%%" (format "%S" result)))
result)
@@ -2605,27 +2609,46 @@ in the buffer."
(line-beginning-position 2))
(point))))))
-(defun org-babel-result-to-file (result &optional description)
+(defun org-babel-result-to-file (result &optional description type)
"Convert RESULT into an Org link with optional DESCRIPTION.
If the `default-directory' is different from the containing
-file's directory then expand relative links."
+file's directory then expand relative links.
+
+If the optional TYPE is passed as 'attachment` and the path is a
+descendant of the DEFAULT-DIRECTORY, the generated link will be
+specified as an an \"attachment:\" style link"
(when (stringp result)
- (let ((same-directory?
- (and (buffer-file-name (buffer-base-buffer))
- (not (string= (expand-file-name default-directory)
- (expand-file-name
- (file-name-directory
- (buffer-file-name (buffer-base-buffer)))))))))
- (format "[[file:%s]%s]"
- (if (and default-directory
- (buffer-file-name (buffer-base-buffer)) same-directory?)
- (if (eq org-link-file-path-type 'adaptive)
- (file-relative-name
- (expand-file-name result default-directory)
- (file-name-directory
- (buffer-file-name (buffer-base-buffer))))
- (expand-file-name result default-directory))
- result)
+ (let* ((result-file-name (expand-file-name result))
+ (base-file-name (buffer-file-name (buffer-base-buffer)))
+ (base-directory (file-name-directory base-file-name))
+ (same-directory?
+ (and base-file-name
+ (not (string= (expand-file-name default-directory)
+ (expand-file-name
+ base-directory)))))
+ (request-attachment (eq type 'attachment))
+ (attach-dir (when request-attachment
+ (let ((default-directory base-directory))
+ (org-attach-dir nil t))))
+ (in-attach-dir (and request-attachment
+ (string-prefix-p
+ attach-dir
+ result-file-name))))
+ (format "[[%s:%s]%s]"
+ (pcase type
+ ((and 'attachment (guard in-attach-dir)) "attachment")
+ (_ "file"))
+ (if (and request-attachment in-attach-dir)
+ (file-relative-name result-file-name)
+ (if (and default-directory
+ base-file-name same-directory?)
+ (if (eq org-link-file-path-type 'adaptive)
+ (file-relative-name
+ result-file-name
+ (file-name-directory
+ base-file-name))
+ result-file-name)
+ result))
(if description (concat "[" description "]") "")))))
(defun org-babel-examplify-region (beg end &optional results-switches inline)
@@ -2756,10 +2779,21 @@ parameters when merging lists."
(setq exports (funcall merge
exports-exclusive-groups
exports
- (split-string
+ (split-string
(cond ((and value (functionp value)) (funcall value))
(value value)
(t ""))))))
+ ((or '(:dir . attach) '(:dir . "'attach"))
+ (unless (org-id-get)
+ (if (or noninteractive (y-or-n-p (format "Create ID for entry \"%s\"?"
+ (org-get-heading t t t t))))
+ (org-id-get-create)
+ (error "Can't attach to entry \"%s\". Entry has no ID"
+ (org-get-heading t t t t))))
+ (setq params (append
+ `((:dir . ,(org-attach-dir nil t))
+ (:mkdirp . "yes"))
+ (assq-delete-all :dir (assq-delete-all :mkdir params)))))
;; Regular keywords: any value overwrites the previous one.
(_ (setq params (cons pair (assq-delete-all (car pair) params)))))))
;; Handle `:var' and clear out colnames and rownames for replaced
diff --git a/lisp/org-attach.el b/lisp/org-attach.el
index 5ee2b84b2..6a061b2b3 100644
--- a/lisp/org-attach.el
+++ b/lisp/org-attach.el
@@ -324,6 +324,7 @@ Shows a list of commands and prompts for another key to execute a command."
(command-execute command)
(error "No such attachment command: %c" c))))))
+;;;###autoload
(defun org-attach-dir (&optional create-if-not-exists-p no-fs-check)
"Return the directory associated with the current outline node.
First check for DIR property, then ID property.
--
2.33.0.windows.2
next prev parent reply other threads:[~2022-06-10 9:50 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-26 8:48 New source block results option for attaching file to node Ryan Scott
2021-08-31 11:15 ` Timothy
2021-08-31 19:43 ` Ryan Scott
2021-09-01 14:45 ` Ihor Radchenko
2021-09-01 20:01 ` Ryan Scott
2021-09-02 7:40 ` [PATCH] " Ryan Scott
2021-09-02 13:44 ` Greg Minshall
2021-09-03 3:10 ` Ihor Radchenko
2021-09-03 3:28 ` Ryan Scott
2021-09-05 13:22 ` Ihor Radchenko
2021-09-05 13:56 ` Ryan Scott
2021-09-10 1:04 ` Ryan Scott
2021-09-10 6:26 ` Timothy
2021-10-02 8:32 ` Ihor Radchenko
2021-10-02 9:39 ` Ryan Scott
2021-10-05 0:04 ` Christopher M. Miles
2021-10-05 1:05 ` Ryan Scott
2021-10-08 1:22 ` Christopher M. Miles
2021-11-05 7:16 ` Ryan Scott
2022-04-21 12:47 ` Ihor Radchenko
2022-04-21 17:29 ` Ryan Scott
2022-04-22 6:02 ` Ihor Radchenko
2022-04-22 6:19 ` Ryan Scott
2022-06-10 8:06 ` Ryan Scott [this message]
2022-06-11 4:32 ` Ihor Radchenko
2022-06-11 7:47 ` Ryan Scott
2022-06-11 12:49 ` Ihor Radchenko
2022-06-12 0:47 ` Ryan Scott
2022-06-14 4:11 ` Ihor Radchenko
2022-06-14 5:55 ` Ryan Scott
2022-06-14 9:04 ` Ryan Scott
2022-06-14 13:48 ` Ihor Radchenko
2022-06-14 18:23 ` Ryan Scott
2022-06-11 12:51 ` 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='CAHBUXNzGWDbEttnRY_+i8NgbJs9BagYQ5D4G74w6=H398yEbeA@mail.gmail.com' \
--to=ryan@vicarious-living.com \
--cc=emacs-orgmode@gnu.org \
--cc=minshall@umich.edu \
--cc=numbchild@gmail.com \
--cc=tecosaur@gmail.com \
--cc=yantar92@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).