From: Terje Larsen <terlar@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: [PATCH] ob-plantuml: Support for plantuml as well as the current java+jar solution
Date: Sun, 24 Nov 2019 23:29:32 +0100 [thread overview]
Message-ID: <87h82sucvn.fsf@gmail.com> (raw)
In-Reply-To: <87k17p4oi5.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Sun, 24 Nov 2019 10:22:58 +0100")
[-- Attachment #1: Type: text/plain, Size: 196 bytes --]
Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:
Hello and thank you for the feedback, made me learn a few things and
make some improvements. I have made the suggested changes (see
attachment).
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Updated version of ob-plantuml patch --]
[-- Type: text/x-patch, Size: 5922 bytes --]
From e3c46993714234c0290f3100683cbec3c0d5f056 Mon Sep 17 00:00:00 2001
From: Terje Larsen <terlar@gmail.com>
Date: Fri, 8 Nov 2019 10:25:49 +0100
Subject: [PATCH] ob-plantuml: Add support for plantuml executable
* lisp/ob-plantuml (org-babel-variable-assignments:plantuml): Support
using plantuml executable instead of jar.
Some systems come with an executable for plantuml instead of a specific
JAR file. This adds support for two different modes:
- jar :: using java together with a JAR (previous behavior)
- plantuml :: using a PlantUML executable
The PlantUML executable can be configured via
`org-plantuml-executable-path` and also the arguments that will be given
via `org-plantuml-executable-args`.
---
etc/ORG-NEWS | 5 +++
lisp/ob-plantuml.el | 94 +++++++++++++++++++++++++++++----------------
2 files changed, 65 insertions(+), 34 deletions(-)
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 689a07871..2cce7dd41 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -19,6 +19,11 @@ just as if it was at outline level 0. Inheritance for properties will
work also for this level. In other words; defining things in a
property drawer before the first headline will make them "inheritable"
for all headlines.
+*** Babel
+**** ob-plantuml now supports using PlantUML executable to generate diagrams
+Set =org-plantuml-exec-mode= to ='plantuml= in order to use the
+executable instead of JAR. Executable mode can be configured via:
+=org-plantuml-executable-path= and =org-plantuml-executable-args=.
* Version 9.3
diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index 09c9a3334..aeea1802f 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -31,7 +31,7 @@
;;; Requirements:
;; plantuml | http://plantuml.sourceforge.net/
-;; plantuml.jar | `org-plantuml-jar-path' should point to the jar file
+;; plantuml.jar | `org-plantuml-jar-path' should point to the jar file (when exec mode is `jar')
;;; Code:
(require 'ob)
@@ -46,6 +46,31 @@
:version "24.1"
:type 'string)
+(defcustom org-plantuml-exec-mode 'jar
+ "Method to use for PlantUML diagram generation.
+`jar' means to use java together with the JAR.
+The JAR can be configured via `org-plantuml-jar-path'.
+
+`plantuml' means to use the PlantUML executable.
+The executable can be configured via `org-plantuml-executable-path'.
+You can also configure extra arguments via `org-plantuml-executable-args'."
+ :group 'org-babel
+ :package-version '(Org . "9.4")
+ :type 'symbol
+ :options '(jar plantuml))
+
+(defcustom org-plantuml-executable-path "plantuml"
+ "File name of the PlantUML executable."
+ :group 'org-babel
+ :package-version '(Org . "9.4")
+ :type 'string)
+
+(defcustom org-plantuml-executable-args (list "-headless")
+ "The arguments passed to plantuml executable when executing PlantUML."
+ :group 'org-babel
+ :package-version '(Org . "9.4")
+ :type '(repeat string))
+
(defun org-babel-variable-assignments:plantuml (params)
"Return a list of PlantUML statements assigning the block's variables.
PARAMS is a property list of source block parameters, which may
@@ -82,40 +107,41 @@ This function is called by `org-babel-execute-src-block'."
(cmdline (cdr (assq :cmdline params)))
(in-file (org-babel-temp-file "plantuml-"))
(java (or (cdr (assq :java params)) ""))
+ (executable (cond ((eq org-plantuml-exec-mode 'plantuml) org-plantuml-executable-path)
+ (t "java")))
+ (executable-args (cond ((eq org-plantuml-exec-mode 'plantuml) org-plantuml-executable-args)
+ ((string= "" org-plantuml-jar-path)
+ (error "`org-plantuml-jar-path' is not set"))
+ ((not (file-exists-p org-plantuml-jar-path))
+ (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
+ (t (list java
+ "-jar"
+ (shell-quote-argument (expand-file-name org-plantuml-jar-path))))))
(full-body (org-babel-plantuml-make-body body params))
- (cmd (if (string= "" org-plantuml-jar-path)
- (error "`org-plantuml-jar-path' is not set")
- (concat "java " java " -jar "
- (shell-quote-argument
- (expand-file-name org-plantuml-jar-path))
- (if (string= (file-name-extension out-file) "png")
- " -tpng" "")
- (if (string= (file-name-extension out-file) "svg")
- " -tsvg" "")
- (if (string= (file-name-extension out-file) "eps")
- " -teps" "")
- (if (string= (file-name-extension out-file) "pdf")
- " -tpdf" "")
- (if (string= (file-name-extension out-file) "tex")
- " -tlatex" "")
- (if (string= (file-name-extension out-file) "vdx")
- " -tvdx" "")
- (if (string= (file-name-extension out-file) "xmi")
- " -txmi" "")
- (if (string= (file-name-extension out-file) "scxml")
- " -tscxml" "")
- (if (string= (file-name-extension out-file) "html")
- " -thtml" "")
- (if (string= (file-name-extension out-file) "txt")
- " -ttxt" "")
- (if (string= (file-name-extension out-file) "utxt")
- " -utxt" "")
- " -p " cmdline " < "
- (org-babel-process-file-name in-file)
- " > "
- (org-babel-process-file-name out-file)))))
- (unless (file-exists-p org-plantuml-jar-path)
- (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
+ (cmd (string-join
+ (append
+ (list executable)
+ executable-args
+ (pcase (file-name-extension out-file)
+ ("png" '("-tpng"))
+ ("svg" '("-tsvg"))
+ ("eps" '("-teps"))
+ ("pdf" '("-tpdf"))
+ ("tex" '("-tlatex"))
+ ("vdx" '("-tvdx"))
+ ("xmi" '("-txmi"))
+ ("scxml" '("-tscxml"))
+ ("html" '("-thtml"))
+ ("txt" '("-ttxt"))
+ ("utxt" '("-utxt")))
+ (list
+ "-p"
+ cmdline
+ "<"
+ (org-babel-process-file-name in-file)
+ ">"
+ (org-babel-process-file-name out-file)))
+ " ")))
(with-temp-file in-file (insert full-body))
(message "%s" cmd) (org-babel-eval cmd "")
nil)) ;; signal that output has already been written to file
--
2.24.0
[-- Attachment #3: Type: text/plain, Size: 233 bytes --]
> Could you rebase it on top of "next" branch and add an entry in
> ORG-NEWS, section "Org 9.4" about it?
>
I didn't find a section Org 9.4, so I put it under the section
Version Next.
Thank you for your help.
Best regards,
Terje
next prev parent reply other threads:[~2019-11-24 22:29 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-08 13:26 [PATCH] ob-plantuml: Support for plantuml as well as the current java+jar solution Terje Larsen
2019-11-24 9:22 ` Nicolas Goaziou
2019-11-24 22:29 ` Terje Larsen [this message]
2020-02-12 17:30 ` Bastien
2020-02-16 13:20 ` Terje Larsen
2020-02-16 23:29 ` Bastien
2020-05-26 19:29 ` Terje Larsen
2020-06-01 13:59 ` Bastien
2020-06-09 6:53 ` Terje Larsen
2020-08-30 19:49 ` Terje Larsen
2020-09-04 10:38 ` 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=87h82sucvn.fsf@gmail.com \
--to=terlar@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).