Merge branch 'maint'
[org-mode/org-kjn.git] / lisp / ob-asymptote.el
blob21c0a17041dfc2b51dd802d68c71bfae36bb8cf9
1 ;;; ob-asymptote.el --- org-babel functions for asymptote 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 asymptote source code.
28 ;; This differs from most standard languages in that
30 ;; 1) there is no such thing as a "session" in asymptote
32 ;; 2) we are generally only going to return results of type "file"
34 ;; 3) we are adding the "file" and "cmdline" header arguments, if file
35 ;; is omitted then the -V option is passed to the asy command for
36 ;; interactive viewing
38 ;;; Requirements:
40 ;; - The asymptote program :: http://asymptote.sourceforge.net/
42 ;; - asy-mode :: Major mode for editing asymptote files
44 ;;; Code:
45 (require 'ob)
46 (eval-when-compile (require 'cl))
48 (declare-function orgtbl-to-generic "org-table" (table params))
49 (declare-function org-combine-plists "org" (&rest plists))
51 (defvar org-babel-tangle-lang-exts)
52 (add-to-list 'org-babel-tangle-lang-exts '("asymptote" . "asy"))
54 (defvar org-babel-default-header-args:asymptote
55 '((:results . "file") (:exports . "results"))
56 "Default arguments when evaluating an Asymptote source block.")
58 (defun org-babel-execute:asymptote (body params)
59 "Execute a block of Asymptote code.
60 This function is called by `org-babel-execute-src-block'."
61 (let* ((result-params (split-string (or (cdr (assoc :results params)) "")))
62 (out-file (cdr (assoc :file params)))
63 (format (or (and out-file
64 (string-match ".+\\.\\(.+\\)" out-file)
65 (match-string 1 out-file))
66 "pdf"))
67 (cmdline (cdr (assoc :cmdline params)))
68 (in-file (org-babel-temp-file "asymptote-"))
69 (cmd
70 (concat "asy "
71 (if out-file
72 (concat
73 "-globalwrite -f " format
74 " -o " (org-babel-process-file-name out-file))
75 "-V")
76 " " cmdline
77 " " (org-babel-process-file-name in-file))))
78 (with-temp-file in-file
79 (insert (org-babel-expand-body:generic
80 body params
81 (org-babel-variable-assignments:asymptote params))))
82 (message cmd) (shell-command cmd)
83 nil)) ;; signal that output has already been written to file
85 (defun org-babel-prep-session:asymptote (session params)
86 "Return an error if the :session header argument is set.
87 Asymptote does not support sessions"
88 (error "Asymptote does not support sessions"))
90 (defun org-babel-variable-assignments:asymptote (params)
91 "Return list of asymptote statements assigning the block's variables."
92 (mapcar #'org-babel-asymptote-var-to-asymptote
93 (mapcar #'cdr (org-babel-get-header params :var))))
95 (defun org-babel-asymptote-var-to-asymptote (pair)
96 "Convert an elisp value into an Asymptote variable.
97 The elisp value PAIR is converted into Asymptote code specifying
98 a variable of the same value."
99 (let ((var (car pair))
100 (val (let ((v (cdr pair)))
101 (if (symbolp v) (symbol-name v) v))))
102 (cond
103 ((integerp val)
104 (format "int %S=%S;" var val))
105 ((floatp val)
106 (format "real %S=%S;" var val))
107 ((stringp val)
108 (format "string %S=\"%s\";" var val))
109 ((and (listp val) (not (listp (car val))))
110 (let* ((type (org-babel-asymptote-define-type val))
111 (fmt (if (eq 'string type) "\"%s\"" "%s"))
112 (vect (mapconcat (lambda (e) (format fmt e)) val ", ")))
113 (format "%s[] %S={%s};" type var vect)))
114 ((listp val)
115 (let* ((type (org-babel-asymptote-define-type val))
116 (fmt (if (eq 'string type) "\"%s\"" "%s"))
117 (array (mapconcat (lambda (row)
118 (concat "{"
119 (mapconcat (lambda (e) (format fmt e))
120 row ", ")
121 "}"))
122 val ",")))
123 (format "%S[][] %S={%s};" type var array))))))
125 (defun org-babel-asymptote-define-type (data)
126 "Determine type of DATA.
128 DATA is a list. Return type as a symbol.
130 The type is `string' if any element in DATA is
131 a string. Otherwise, it is either `real', if some elements are
132 floats, or `int'."
133 (let* ((type 'int)
134 find-type ; for byte-compiler
135 (find-type
136 (function
137 (lambda (row)
138 (catch 'exit
139 (mapc (lambda (el)
140 (cond ((listp el) (funcall find-type el))
141 ((stringp el) (throw 'exit (setq type 'string)))
142 ((floatp el) (setq type 'real))))
143 row))))))
144 (funcall find-type data) type))
146 (provide 'ob-asymptote)
150 ;;; ob-asymptote.el ends here