emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: stardiviner <numbchild@gmail.com>
Cc: org-mode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] add "link" :results type for Babel
Date: Wed, 11 Apr 2018 22:55:29 +0200	[thread overview]
Message-ID: <87fu41zcn2.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87vacztlvw.fsf@gmail.com> (stardiviner's message of "Tue, 10 Apr 2018 18:07:47 +0800")

Hello,

stardiviner <numbchild@gmail.com> writes:

> This patch try to support following way:
>
> #+begin_src sh :results link :file "/tmp/test.txt"
> echo "hello" > /tmp/test.txt
> echo "test"
> #+end_src
>
> #+RESULTS:
> [[file:/tmp/test.txt]]
>
> Because:
>
> - ~org-babel-execute-src-block~
>   - ~(org-babel-get-src-block-info)~
>     - (let* ((info .. (apply #'org-babel-merge-params ...))))
>       - ~org-babel-merge-params~
>         - [ ] *because* code ~(`(,(or :file :file-ext) . ,value) ...)~
>           lines logic in function ~org-babel-get-src-block-info~, it
>           merge "file" ~:results~, so override params plist :results
>           value ~link~.
>         - [ ] So I put ~link~ and ~graphics~ "~:results~" type into a
>           separate group in constant
>           ~org-babel-common-header-args-w-values~.
>
> If anybody has better way, please improve my code.

IIRC, there is no technical difference between ":results graphics" and
":results link". So, what about simply stating that `link' and
`graphics' are equivalent, like, e.g., `table' and `vector' or `scalar'
and `verbatim'?

Note that `graphics' results are not properly documented in the current
manual. They should probably go in "Working with Source Code/Results of
Evaluation/Format" section.

> -    (results	. ((file list vector table scalar verbatim)
> +    (results	. (
> +		   ;; separate group to avoid been override by "file"
> +		   ;; :results in `org-babel-merge-params'.
> +		   (link)

`link' is not an output type. `graphics' is not defined here either.

> +(ert-deftest test-ob/result-file-link-type-header-argument ()
> +  "Ensure that the result is a link to a file.
> +The file is just a link to :file value. Inhibit non-empty result write to :file."
> +  (org-test-with-temp-text "#+begin_src shell :results value link :file \"/tmp/test.txt\"
> +echo \"hello\" > /tmp/test.txt
> +echo \"test\"
> +#+end_src"
> +   (org-babel-execute-src-block)
> +   (goto-char (point-min))
> +   (should (search-forward "[[file:/tmp/test.txt]]" nil nil))
> +   (should (with-temp-buffer
> +   	     (insert-file-contents "/tmp/test.txt")
> +   	     (string=
> +   	      "hello\n"
> +   	      (buffer-substring-no-properties (point-min) (point-max)))))))

Note that this test already passes when "link" is substituted with "graphics".

Regards,

-- 
Nicolas Goaziou

next prev parent reply	other threads:[~2018-04-11 20:55 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-10 10:07 [PATCH] add "link" :results type for Babel stardiviner
2018-04-11 20:55 ` Nicolas Goaziou [this message]
2018-04-12  2:04   ` stardiviner
2018-04-12 13:17     ` Nicolas Goaziou

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=87fu41zcn2.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --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

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