Merge branch 'master' of orgmode.org:org-mode
[org-mode/org-jambu.git] / lisp / ob-ditaa.el
blob4bb838cbda074f736c01a1321c42890ac1f1ddfa
1 ;;; ob-ditaa.el --- org-babel functions for ditaa evaluation
3 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
8 ;; Version: 7.4
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Org-Babel support for evaluating ditaa source code.
29 ;; This differs from most standard languages in that
31 ;; 1) there is no such thing as a "session" in ditaa
33 ;; 2) we are generally only going to return results of type "file"
35 ;; 3) we are adding the "file" and "cmdline" header arguments
37 ;; 4) there are no variables (at least for now)
39 ;;; Code:
40 (require 'ob)
42 (defvar org-babel-default-header-args:ditaa
43 '((:results . "file") (:exports . "results"))
44 "Default arguments for evaluating a ditaa source block.")
46 (defvar org-ditaa-jar-path)
47 (defun org-babel-execute:ditaa (body params)
48 "Execute a block of Ditaa code with org-babel.
49 This function is called by `org-babel-execute-src-block'."
50 (let* ((result-params (split-string (or (cdr (assoc :results params)) "")))
51 (out-file ((lambda (el)
52 (or el
53 (error
54 "ditaa code block requires :file header argument")))
55 (cdr (assoc :file params))))
56 (cmdline (cdr (assoc :cmdline params)))
57 (in-file (org-babel-temp-file "ditaa-"))
58 (cmd (concat "java -jar "
59 (shell-quote-argument
60 (expand-file-name org-ditaa-jar-path))
61 " " cmdline
62 " " (org-babel-process-file-name in-file)
63 " " (org-babel-process-file-name out-file))))
64 (unless (file-exists-p org-ditaa-jar-path)
65 (error "Could not find ditaa.jar at %s" org-ditaa-jar-path))
66 (with-temp-file in-file (insert body))
67 (message cmd) (shell-command cmd)
68 nil)) ;; signal that output has already been written to file
70 (defun org-babel-prep-session:ditaa (session params)
71 "Return an error because ditaa does not support sessions."
72 (error "Ditaa does not support sessions"))
74 (provide 'ob-ditaa)
76 ;; arch-tag: 492cd006-07d9-4fac-bef6-5bb60b48842e
78 ;;; ob-ditaa.el ends here