[PATCH v3] lisp/ob-plantuml.el: Insert results in buffer

[PATCH v3] lisp/ob-plantuml.el: Insert results in buffer

[Joseph Turner]

When :results header arg is set to a value that doesn't include
"file", insert txt output in buffer below src block.

TINYCHANGE
---
 etc/ORG-NEWS        |  7 +++++++
 lisp/ob-plantuml.el | 12 +++++++++---
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 4cda357f1..b8cd05d4e 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -295,6 +295,13 @@ files that are exported to Texinfo.
 
 =org-at-heading-p= now returns t by default on headings inside folds.
 Passing optional argument will produce the old behaviour.
+
+*** =org-babel-execute:plantuml= can output ASCII graphs in the buffer
+
+Previously, executing PlantUML src blocks always exported to a file.  Now, if
+:results is set to a value which does not include "file", no file will be
+exported and an ASCII graph will be inserted below the src block.
+
 ** Removed or renamed functions and variables
 *** =org-plantump-executable-args= is renamed and applies to jar as well
 
diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index ebbcdf166..a339d8485 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -109,8 +109,11 @@ If BODY does not contain @startXXX ... @endXXX clauses, @startuml
 (defun org-babel-execute:plantuml (body params)
   "Execute a block of plantuml code with org-babel.
 This function is called by `org-babel-execute-src-block'."
-  (let* ((out-file (or (cdr (assq :file params))
-		       (error "PlantUML requires a \":file\" header argument")))
+  (let* ((do-export (member "file" (cdr (assq :result-params params))))
+         (out-file (if do-export
+                       (or (cdr (assq :file params))
+                           (error "No :file provided but :results set to file. For plain text output, set :results to verbatim"))
+		     (org-babel-temp-file "plantuml-" ".txt")))
 	 (cmdline (cdr (assq :cmdline params)))
 	 (in-file (org-babel-temp-file "plantuml-"))
 	 (java (or (cdr (assq :java params)) ""))
@@ -155,7 +158,10 @@ This function is called by `org-babel-execute-src-block'."
     (if (and (string= (file-name-extension out-file) "svg")
              org-babel-plantuml-svg-text-to-path)
         (org-babel-eval (format "inkscape %s -T -l %s" out-file out-file) ""))
-    nil)) ;; signal that output has already been written to file
+    (unless do-export (with-temp-buffer
+                        (insert-file-contents out-file)
+                        (buffer-substring-no-properties
+                         (point-min) (point-max))))))
 
 (defun org-babel-prep-session:plantuml (_session _params)
   "Return an error because plantuml does not support sessions."
-- 
2.37.0

Re: [PATCH v3] lisp/ob-plantuml.el: Insert results in buffer

[Ihor Radchenko]

Joseph Turner <joseph@breatheoutbreathe.in> writes:

> When :results header arg is set to a value that doesn't include
> "file", insert txt output in buffer below src block.
>
> TINYCHANGE
> ---
>  etc/ORG-NEWS        |  7 +++++++
>  lisp/ob-plantuml.el | 12 +++++++++---
>  2 files changed, 16 insertions(+), 3 deletions(-)

Thanks!
Applied onto main via 9cc60dee4.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=9cc60dee48851756dd95af46b37b7adc172952e2

-- 
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92

Re: [PATCH v3] lisp/ob-plantuml.el: Insert results in buffer

[Joseph Turner]

[-- Attachment #1: Type: text/plain, Size: 903 bytes --]

You're very welcome! Thank you for your guidance. I learned quite a lot of Elisp during this process.

On August 6, 2022 1:24:46 AM PDT, Ihor Radchenko <yantar92@gmail.com> wrote:
>Joseph Turner <joseph@breatheoutbreathe.in> writes:
>
>> When :results header arg is set to a value that doesn't include
>> "file", insert txt output in buffer below src block.
>>
>> TINYCHANGE
>> ---
>>  etc/ORG-NEWS        |  7 +++++++
>>  lisp/ob-plantuml.el | 12 +++++++++---
>>  2 files changed, 16 insertions(+), 3 deletions(-)
>
>Thanks!
>Applied onto main via 9cc60dee4.
>https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=9cc60dee48851756dd95af46b37b7adc172952e2
>
>-- 
>Ihor Radchenko,
>Org mode contributor,
>Learn more about Org mode at https://orgmode.org/.
>Support Org development at https://liberapay.com/org-mode,
>or support my work at https://liberapay.com/yantar92

[-- Attachment #2: Type: text/html, Size: 1585 bytes --]