Prevent duplicating calls to `org-link-search'
[org-mode.git] / lisp / ob-ditaa.el
blob888cafc394f2bdfce74fe9ce757117f6354961ef
1 ;;; ob-ditaa.el --- org-babel functions for ditaa evaluation
3 ;; Copyright (C) 2009-2014 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
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 ditaa source code.
28 ;; This differs from most standard languages in that
30 ;; 1) there is no such thing as a "session" in ditaa
32 ;; 2) we are generally only going to return results of type "file"
34 ;; 3) we are adding the "file" and "cmdline" header arguments
36 ;; 4) there are no variables (at least for now)
38 ;;; Code:
39 (require 'ob)
40 (require 'org-compat)
42 (defvar org-babel-default-header-args:ditaa
43 '((:results . "file")
44 (:exports . "results")
45 (:java . "-Dfile.encoding=UTF-8"))
46 "Default arguments for evaluating a ditaa source block.")
48 (defcustom org-ditaa-jar-path (expand-file-name
49 "ditaa.jar"
50 (file-name-as-directory
51 (expand-file-name
52 "scripts"
53 (file-name-as-directory
54 (expand-file-name
55 "../contrib"
56 (file-name-directory (org-find-library-dir "org")))))))
57 "Path to the ditaa jar executable."
58 :group 'org-babel
59 :type 'string)
61 (defcustom org-babel-ditaa-java-cmd "java"
62 "Java executable to use when evaluating ditaa blocks."
63 :group 'org-babel
64 :type 'string)
66 (defcustom org-ditaa-eps-jar-path
67 (expand-file-name "DitaaEps.jar" (file-name-directory org-ditaa-jar-path))
68 "Path to the DitaaEps.jar executable."
69 :group 'org-babel
70 :version "24.4"
71 :package-version '(Org . "8.0")
72 :type 'string)
74 (defcustom org-ditaa-jar-option "-jar"
75 "Option for the ditaa jar file.
76 Do not leave leading or trailing spaces in this string."
77 :group 'org-babel
78 :version "24.1"
79 :type 'string)
81 (defun org-babel-execute:ditaa (body params)
82 "Execute a block of Ditaa code with org-babel.
83 This function is called by `org-babel-execute-src-block'."
84 (let* ((result-params (split-string (or (cdr (assoc :results params)) "")))
85 (out-file (let ((el (cdr (assoc :file params))))
86 (or el
87 (error
88 "ditaa code block requires :file header argument"))))
89 (cmdline (cdr (assoc :cmdline params)))
90 (java (cdr (assoc :java params)))
91 (in-file (org-babel-temp-file "ditaa-"))
92 (eps (cdr (assoc :eps params)))
93 (eps-file (when eps
94 (org-babel-process-file-name (concat in-file ".eps"))))
95 (pdf-cmd (when (and (or (string= (file-name-extension out-file) "pdf")
96 (cdr (assoc :pdf params))))
97 (concat
98 "epstopdf"
99 " " eps-file
100 " -o=" (org-babel-process-file-name out-file))))
101 (cmd (concat org-babel-ditaa-java-cmd
102 " " java " " org-ditaa-jar-option " "
103 (shell-quote-argument
104 (expand-file-name
105 (if eps org-ditaa-eps-jar-path org-ditaa-jar-path)))
106 " " cmdline
107 " " (org-babel-process-file-name in-file)
108 " " (if pdf-cmd
109 eps-file
110 (org-babel-process-file-name out-file)))))
111 (unless (file-exists-p org-ditaa-jar-path)
112 (error "Could not find ditaa.jar at %s" org-ditaa-jar-path))
113 (with-temp-file in-file (insert body))
114 (message cmd) (shell-command cmd)
115 (when pdf-cmd (message pdf-cmd) (shell-command pdf-cmd))
116 nil)) ;; signal that output has already been written to file
118 (defun org-babel-prep-session:ditaa (session params)
119 "Return an error because ditaa does not support sessions."
120 (error "Ditaa does not support sessions"))
122 (provide 'ob-ditaa)
126 ;;; ob-ditaa.el ends here