Merge branch 'maint'
[org-mode.git] / lisp / ob-dot.el
blob99748b0a95bc19897a6f33ed349fdb2d304d4fcd
1 ;;; ob-dot.el --- org-babel functions for dot evaluation
3 ;; Copyright (C) 2009-2012 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 dot source code.
28 ;; For information on dot see http://www.graphviz.org/
30 ;; This differs from most standard languages in that
32 ;; 1) there is no such thing as a "session" in dot
34 ;; 2) we are generally only going to return results of type "file"
36 ;; 3) we are adding the "file" and "cmdline" header arguments
38 ;; 4) there are no variables (at least for now)
40 ;;; Code:
41 (require 'ob)
42 (require 'ob-eval)
44 (defvar org-babel-default-header-args:dot
45 '((:results . "file") (:exports . "results"))
46 "Default arguments to use when evaluating a dot source block.")
48 (defun org-babel-expand-body:dot (body params)
49 "Expand BODY according to PARAMS, return the expanded body."
50 (let ((vars (mapcar #'cdr (org-babel-get-header params :var))))
51 (mapc
52 (lambda (pair)
53 (let ((name (symbol-name (car pair)))
54 (value (cdr pair)))
55 (setq body
56 (replace-regexp-in-string
57 (concat "\$" (regexp-quote name))
58 (if (stringp value) value (format "%S" value))
59 body))))
60 vars)
61 body))
63 (defun org-babel-execute:dot (body params)
64 "Execute a block of Dot code with org-babel.
65 This function is called by `org-babel-execute-src-block'."
66 (let* ((result-params (cdr (assoc :result-params params)))
67 (out-file (cdr (or (assoc :file params)
68 (error "You need to specify a :file parameter"))))
69 (cmdline (or (cdr (assoc :cmdline params))
70 (format "-T%s" (file-name-extension out-file))))
71 (cmd (or (cdr (assoc :cmd params)) "dot"))
72 (in-file (org-babel-temp-file "dot-")))
73 (with-temp-file in-file
74 (insert (org-babel-expand-body:dot body params)))
75 (org-babel-eval
76 (concat cmd
77 " " (org-babel-process-file-name in-file)
78 " " cmdline
79 " -o " (org-babel-process-file-name out-file)) "")
80 nil)) ;; signal that output has already been written to file
82 (defun org-babel-prep-session:dot (session params)
83 "Return an error because Dot does not support sessions."
84 (error "Dot does not support sessions"))
86 (provide 'ob-dot)
90 ;;; ob-dot.el ends here