Merge branch 'master' of orgmode.org:org-mode
[org-mode.git] / lisp / ob-plantuml.el
blobc17d4448a3c453402ec23427ae344e48184df6af
1 ;;; ob-plantuml.el --- org-babel functions for plantuml evaluation
3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
5 ;; Author: Zhang Weize
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Org-Babel support for evaluating plantuml script.
28 ;; Inspired by Ian Yang's org-export-blocks-format-plantuml
29 ;; http://www.emacswiki.org/emacs/org-export-blocks-format-plantuml.el
31 ;;; Requirements:
33 ;; plantuml | http://plantuml.sourceforge.net/
34 ;; plantuml.jar | `org-plantuml-jar-path' should point to the jar file
36 ;;; Code:
37 (require 'ob)
39 (defvar org-babel-default-header-args:plantuml
40 '((:results . "file") (:exports . "results"))
41 "Default arguments for evaluating a plantuml source block.")
43 (defcustom org-plantuml-jar-path nil
44 "Path to the plantuml.jar file."
45 :group 'org-babel
46 :version "24.1"
47 :type 'string)
49 (defun org-babel-execute:plantuml (body params)
50 "Execute a block of plantuml code with org-babel.
51 This function is called by `org-babel-execute-src-block'."
52 (let* ((result-params (split-string (or (cdr (assoc :results params)) "")))
53 (out-file (or (cdr (assoc :file params))
54 (error "PlantUML requires a \":file\" header argument")))
55 (cmdline (cdr (assoc :cmdline params)))
56 (in-file (org-babel-temp-file "plantuml-"))
57 (java (or (cdr (assoc :java params)) ""))
58 (cmd (if (not org-plantuml-jar-path)
59 (error "`org-plantuml-jar-path' is not set")
60 (concat "java " java " -jar "
61 (shell-quote-argument
62 (expand-file-name org-plantuml-jar-path))
63 (if (string= (file-name-extension out-file) "svg")
64 " -tsvg" "")
65 (if (string= (file-name-extension out-file) "eps")
66 " -teps" "")
67 " -p " cmdline " < "
68 (org-babel-process-file-name in-file)
69 " > "
70 (org-babel-process-file-name out-file)))))
71 (unless (file-exists-p org-plantuml-jar-path)
72 (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
73 (with-temp-file in-file (insert (concat "@startuml\n" body "\n@enduml")))
74 (message "%s" cmd) (org-babel-eval cmd "")
75 nil)) ;; signal that output has already been written to file
77 (defun org-babel-prep-session:plantuml (session params)
78 "Return an error because plantuml does not support sessions."
79 (error "Plantuml does not support sessions"))
81 (provide 'ob-plantuml)
85 ;;; ob-plantuml.el ends here