From: Matt Huszagh <huszaghmatt@gmail.com>
To: Kyle Meyer <kyle@kyleam.com>
Cc: , Emacs-Orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] Omit file description when :file-desc has nil value
Date: Wed, 23 Sep 2020 23:16:53 -0700 [thread overview]
Message-ID: <87eemrzokq.fsf@gmail.com> (raw)
In-Reply-To: <87a6xfvjck.fsf@kyleam.com>
Kyle Meyer <kyle@kyleam.com> writes:
> But it's not a direct comparison against that use case and the use case
> you want to support. The potential breakage of existing documents is a
> big factor to go against.
Yep, I agree. I think my phrasing could have just been better. I meant
to include the breakage as a factor against.
> Unfortunately, such a kludge is how I'd suggest to move forward.
> Perhaps an empty string, or perhaps any value (e.g., ":file-desc []")
> that org-babel-read won't treat as a string or nil (the two cases that
> mean something right now). The rough patch below is an example of the
> latter.
I like this solution better than mine. I guess it's still a bit of a
hack, but it doesn't seem to be one that could break a use case, whereas
the empty string could conceivably be intended, though I'm still not
sure why.
> I'm not sure I get this. What's next down the road in this scenario?
> With something like the above kludge, haven't we exhausted the cases for
> :file-desc?
Yes I think you're right. I was referring to my solution of an empty
string, which I didn't see a personal use for, but felt it might be a
valid use case for someone else. I really can't think of any reason the
empty vector would otherwise be valid.
> diff --git a/lisp/ob-core.el b/lisp/ob-core.el
> index 7300f239e..4483585a1 100644
> --- a/lisp/ob-core.el
> +++ b/lisp/ob-core.el
> @@ -646,6 +646,13 @@ (defun org-babel--expand-body (info)
> (replace-regexp-in-string
> (org-src-coderef-regexp coderef) "" expand nil nil 1))))
>
> +(defun org-babel--file-desc (params result)
> + (pcase (assq :file-desc params)
> + (`nil nil)
> + (`(:file-desc) result)
> + (`(:file-desc . ,(and (pred stringp) val)) val)
> + (_ nil)))
> +
> ;;;###autoload
> (defun org-babel-execute-src-block (&optional arg info params)
> "Execute the current source code block.
> @@ -749,8 +756,7 @@ (defun org-babel-execute-src-block (&optional arg info params)
> (let ((*this* (if (not file) result
> (org-babel-result-to-file
> file
> - (let ((desc (assq :file-desc params)))
> - (and desc (or (cdr desc) result)))))))
> + (org-babel--file-desc params result)))))
> (setq result (org-babel-ref-resolve post))
> (when file
> (setq result-params (remove "file" result-params))))))
> @@ -2257,9 +2263,8 @@ (defun org-babel-insert-result (result &optional result-params info hash lang)
> (setq result (org-no-properties result))
> (when (member "file" result-params)
> (setq result (org-babel-result-to-file
> - result (when (assq :file-desc (nth 2 info))
> - (or (cdr (assq :file-desc (nth 2 info)))
> - result))))))
> + result
> + (org-babel--file-desc (nth 2 info) result)))))
> ((listp result))
> (t (setq result (format "%S" result))))
> (if (and result-params (member "silent" result-params))
> diff --git a/testing/lisp/test-ob.el b/testing/lisp/test-ob.el
> index 648e9c115..e7a292de3 100644
> --- a/testing/lisp/test-ob.el
> +++ b/testing/lisp/test-ob.el
> @@ -1084,7 +1084,16 @@ (ert-deftest test-ob/file-desc-header-argument ()
> (org-babel-execute-src-block)
> (goto-char (point-min))
> (should (search-forward "[[file:foo][bar]]" nil t))
> - (should (search-forward "[[file:foo][foo]]" nil t))))
> + (should (search-forward "[[file:foo][foo]]" nil t)))
> + (should (string-match-p
> + (regexp-quote "[[file:foo]]")
> + (org-test-with-temp-text "
> +#+begin_src emacs-lisp :results file :file-desc []
> + \"foo\"
> +#+end_src"
> + (org-babel-next-src-block)
> + (org-babel-execute-src-block)
> + (buffer-substring-no-properties (point-min) (point-max))))))
>
> (ert-deftest test-ob/result-file-link-type-header-argument ()
> "Ensure that the result is a link to a file.
This patch looks good. I've tested it and it works well for me. Thanks
for coming up with a good solution! I think the one thing still missing
is some documentation in the info manual. Something along the lines of
The ‘file-desc’ header argument defines the description (see *note
Link Format::) for the link. If ‘file-desc’ has no value, Org uses
the generated file name for both the “link” and “description” parts
of the link. If you want to omit the description (i.e., [[link]]),
you can either omit the ‘file-desc’ header argument or provide it
with an empty vector (i.e., :file-desc []).
Feel free to add this (or something else) to your patch. Or, if you'd
prefer that I created a patch for it, let me know.
Matt
next prev parent reply other threads:[~2020-09-24 6:17 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-05 19:19 [PATCH] Omit file description when :file-desc has nil value Huszaghmatt
2020-09-06 4:19 ` Kyle Meyer
2020-09-09 19:50 ` Matt Huszagh
2020-09-15 17:09 ` Matt Huszagh
2020-09-24 5:23 ` Kyle Meyer
2020-09-24 6:16 ` Matt Huszagh [this message]
2020-09-24 23:07 ` Kyle Meyer
2020-09-29 21:33 ` Matt Huszagh
2020-10-03 6:08 ` Kyle Meyer
2020-10-06 13:17 ` Matt Huszagh
2020-10-07 3:19 ` Kyle Meyer
-- strict thread matches above, loose matches on Subject: below --
2020-09-03 6:19 Matt Huszagh
2020-09-03 6:53 ` Matt Huszagh
2020-09-04 5:21 ` Kyle Meyer
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=87eemrzokq.fsf@gmail.com \
--to=huszaghmatt@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=kyle@kyleam.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).