HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| afe98dfa CD |
1 | ;;; ob-plantuml.el --- org-babel functions for plantuml evaluation |
| 2 | ||
| b9db31c7 | 3 | ;; Copyright (C) 2010-2012 Free Software Foundation, Inc. |
| afe98dfa CD |
4 | |
| 5 | ;; Author: Zhang Weize | |
| 6 | ;; Keywords: literate programming, reproducible research | |
| 7 | ;; Homepage: http://orgmode.org | |
| afe98dfa CD |
8 | |
| 9 | ;; This file is part of GNU Emacs. | |
| 10 | ||
| 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. | |
| 15 | ||
| 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. | |
| 20 | ||
| 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/>. | |
| 23 | ||
| 24 | ;;; Commentary: | |
| 25 | ||
| 26 | ;; Org-Babel support for evaluating plantuml script. | |
| 27 | ;; | |
| 28 | ;; Inspired by Ian Yang's org-export-blocks-format-plantuml | |
| 29 | ;; http://www.emacswiki.org/emacs/org-export-blocks-format-plantuml.el | |
| 30 | ||
| 31 | ;;; Requirements: | |
| 32 | ||
| 33 | ;; plantuml | http://plantuml.sourceforge.net/ | |
| 34 | ;; plantuml.jar | `org-plantuml-jar-path' should point to the jar file | |
| 35 | ||
| 36 | ;;; Code: | |
| 37 | (require 'ob) | |
| 38 | (require 'ob-eval) | |
| 39 | ||
| 40 | (defvar org-babel-default-header-args:plantuml | |
| 41 | '((:results . "file") (:exports . "results")) | |
| 42 | "Default arguments for evaluating a plantuml source block.") | |
| 43 | ||
| 44 | (defcustom org-plantuml-jar-path nil | |
| 45 | "Path to the plantuml.jar file." | |
| 46 | :group 'org-babel | |
| 47 | :type 'string) | |
| 48 | ||
| 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 | (cmd (if (not org-plantuml-jar-path) | |
| 58 | (error "`org-plantuml-jar-path' is not set") | |
| 59 | (concat "java -jar " | |
| 60 | (shell-quote-argument | |
| 61 | (expand-file-name org-plantuml-jar-path)) | |
| 62 | (if (string= (file-name-extension out-file) "svg") | |
| 63 | " -tsvg" "") | |
| 3ab2c837 BG |
64 | (if (string= (file-name-extension out-file) "eps") |
| 65 | " -teps" "") | |
| afe98dfa CD |
66 | " -p " cmdline " < " |
| 67 | (org-babel-process-file-name in-file) | |
| 68 | " > " | |
| 69 | (org-babel-process-file-name out-file))))) | |
| 70 | (unless (file-exists-p org-plantuml-jar-path) | |
| 71 | (error "Could not find plantuml.jar at %s" org-plantuml-jar-path)) | |
| 72 | (with-temp-file in-file (insert (concat "@startuml\n" body "\n@enduml"))) | |
| 73 | (message "%s" cmd) (org-babel-eval cmd "") | |
| 3ab2c837 | 74 | nil)) ;; signal that output has already been written to file |
| afe98dfa CD |
75 | |
| 76 | (defun org-babel-prep-session:plantuml (session params) | |
| 77 | "Return an error because plantuml does not support sessions." | |
| 78 | (error "Plantuml does not support sessions")) | |
| 79 | ||
| 80 | (provide 'ob-plantuml) | |
| 81 | ||
| 5b409b39 | 82 | |
| afe98dfa CD |
83 | |
| 84 | ;;; ob-plantuml.el ends here |