lisp/org/ob-plantuml.el

   1 ;;; ob-plantuml.el --- org-babel functions for plantuml evaluation
   2
   3 ;; Copyright (C) 2010-2013 Free Software Foundation, Inc.
   4
   5 ;; Author: Zhang Weize
   6 ;; Keywords: literate programming, reproducible research
   7 ;; Homepage: http://orgmode.org
   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   :version "24.1"
  48   :type 'string)
  49
  50 (defun org-babel-execute:plantuml (body params)
  51   "Execute a block of plantuml code with org-babel.
  52 This function is called by `org-babel-execute-src-block'."
  53   (let* ((result-params (split-string (or (cdr (assoc :results params)) "")))
  54          (out-file (or (cdr (assoc :file params))
  55                        (error "PlantUML requires a \":file\" header argument")))
  56          (cmdline (cdr (assoc :cmdline params)))
  57          (in-file (org-babel-temp-file "plantuml-"))
  58          (java (or (cdr (assoc :java params)) ""))
  59          (cmd (if (not org-plantuml-jar-path)
  60                   (error "`org-plantuml-jar-path' is not set")
  61                 (concat "java " java " -jar "
  62                         (shell-quote-argument
  63                          (expand-file-name org-plantuml-jar-path))
  64                         (if (string= (file-name-extension out-file) "svg")
  65                             " -tsvg" "")
  66                         (if (string= (file-name-extension out-file) "eps")
  67                             " -teps" "")
  68                         " -p " cmdline " < "
  69                         (org-babel-process-file-name in-file)
  70                         " > "
  71                         (org-babel-process-file-name out-file)))))
  72     (unless (file-exists-p org-plantuml-jar-path)
  73       (error "Could not find plantuml.jar at %s" org-plantuml-jar-path))
  74     (with-temp-file in-file (insert (concat "@startuml\n" body "\n@enduml")))
  75     (message "%s" cmd) (org-babel-eval cmd "")
  76     nil)) ;; signal that output has already been written to file
  77
  78 (defun org-babel-prep-session:plantuml (session params)
  79   "Return an error because plantuml does not support sessions."
  80   (error "Plantuml does not support sessions"))
  81
  82 (provide 'ob-plantuml)
  83
  84
  85
  86 ;;; ob-plantuml.el ends here