1 ;;; ob-sh.el --- org-babel functions for shell 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/>.
26 ;; Org-Babel support for evaluating shell source code.
34 (eval-when-compile (require 'cl
))
36 (declare-function org-babel-comint-in-buffer
"ob-comint" (buffer &rest body
))
37 (declare-function org-babel-comint-wait-for-output
"ob-comint" (buffer))
38 (declare-function org-babel-comint-buffer-livep
"ob-comint" (buffer))
39 (declare-function org-babel-comint-with-output
"ob-comint" (meta &rest body
))
40 (declare-function orgtbl-to-generic
"org-table" (table params
))
42 (defvar org-babel-default-header-args
:sh
'())
44 (defvar org-babel-sh-command
"sh"
45 "Command used to invoke a shell.
46 This will be passed to `shell-command-on-region'")
48 (defcustom org-babel-sh-var-quote-fmt
49 "$(cat <<'BABEL_TABLE'\n%s\nBABEL_TABLE\n)"
50 "Format string used to escape variables when passed to shell scripts."
54 (defun org-babel-execute:sh
(body params
)
55 "Execute a block of Shell commands with Babel.
56 This function is called by `org-babel-execute-src-block'."
57 (let* ((session (org-babel-sh-initiate-session
58 (cdr (assoc :session params
))))
59 (stdin ((lambda (stdin) (when stdin
(org-babel-sh-var-to-string
60 (org-babel-ref-resolve stdin
))))
61 (cdr (assoc :stdin params
))))
62 (full-body (org-babel-expand-body:generic
63 body params
(org-babel-variable-assignments:sh params
))))
64 (org-babel-reassemble-table
65 (org-babel-sh-evaluate session full-body params stdin
)
67 (cdr (assoc :colname-names params
)) (cdr (assoc :colnames params
)))
69 (cdr (assoc :rowname-names params
)) (cdr (assoc :rownames params
))))))
71 (defun org-babel-prep-session:sh
(session params
)
72 "Prepare SESSION according to the header arguments specified in PARAMS."
73 (let* ((session (org-babel-sh-initiate-session session
))
74 (var-lines (org-babel-variable-assignments:sh params
)))
75 (org-babel-comint-in-buffer session
77 (insert var
) (comint-send-input nil t
)
78 (org-babel-comint-wait-for-output session
)) var-lines
))
81 (defun org-babel-load-session:sh
(session body params
)
82 "Load BODY into SESSION."
83 (save-window-excursion
84 (let ((buffer (org-babel-prep-session:sh session params
)))
85 (with-current-buffer buffer
86 (goto-char (process-mark (get-buffer-process (current-buffer))))
87 (insert (org-babel-chomp body
)))
92 (defun org-babel-variable-assignments:sh
(params)
93 "Return list of shell statements assigning the block's variables."
94 (let ((sep (cdr (assoc :separator params
))))
99 (org-babel-sh-var-to-sh (cdr pair
) sep
)))
100 (mapcar #'cdr
(org-babel-get-header params
:var
)))))
102 (defun org-babel-sh-var-to-sh (var &optional sep
)
103 "Convert an elisp value to a shell variable.
104 Convert an elisp var into a string of shell commands specifying a
105 var of the same value."
106 (format org-babel-sh-var-quote-fmt
(org-babel-sh-var-to-string var sep
)))
108 (defun org-babel-sh-var-to-string (var &optional sep
)
109 "Convert an elisp value to a string."
110 (let ((echo-var (lambda (v) (if (stringp v
) v
(format "%S" v
)))))
112 ((and (listp var
) (listp (car var
)))
113 (orgtbl-to-generic var
(list :sep
(or sep
"\t") :fmt echo-var
)))
115 (mapconcat echo-var var
"\n"))
116 (t (funcall echo-var var
)))))
118 (defun org-babel-sh-table-or-results (results)
119 "Convert RESULTS to an appropriate elisp value.
120 If the results look like a table, then convert them into an
121 Emacs-lisp table, otherwise return the results as a string."
122 (org-babel-script-escape results
))
124 (defun org-babel-sh-initiate-session (&optional session params
)
125 "Initiate a session named SESSION according to PARAMS."
126 (when (and session
(not (string= session
"none")))
127 (save-window-excursion
128 (or (org-babel-comint-buffer-livep session
)
129 (progn (shell session
) (get-buffer (current-buffer)))))))
131 (defvar org-babel-sh-eoe-indicator
"echo 'org_babel_sh_eoe'"
132 "String to indicate that evaluation has completed.")
133 (defvar org-babel-sh-eoe-output
"org_babel_sh_eoe"
134 "String to indicate that evaluation has completed.")
136 (defun org-babel-sh-evaluate (session body
&optional params stdin
)
137 "Pass BODY to the Shell process in BUFFER.
138 If RESULT-TYPE equals 'output then return a list of the outputs
139 of the statements in BODY, if RESULT-TYPE equals 'value then
140 return the value of the last statement in BODY."
143 (let ((result-params (cdr (assoc :result-params params
))))
144 (org-babel-result-cond result-params
146 (let ((tmp-file (org-babel-temp-file "sh-")))
147 (with-temp-file tmp-file
(insert results
))
148 (org-babel-import-elisp-from-file tmp-file
))))))
150 (stdin ; external shell script w/STDIN
151 (let ((script-file (org-babel-temp-file "sh-script-"))
152 (stdin-file (org-babel-temp-file "sh-stdin-"))
153 (shebang (cdr (assoc :shebang params
)))
154 (padline (not (string= "no" (cdr (assoc :padline params
))))))
155 (with-temp-file script-file
156 (when shebang
(insert (concat shebang
"\n")))
157 (when padline
(insert "\n"))
159 (set-file-modes script-file
#o755
)
160 (with-temp-file stdin-file
(insert stdin
))
162 (call-process-shell-command
165 (format "%s %s" org-babel-sh-command script-file
))
169 (session ; session evaluation
171 #'org-babel-sh-strip-weird-long-prompt
175 (org-babel-comint-with-output
176 (session org-babel-sh-eoe-output t body
)
180 (comint-send-input nil t
)
181 (while (save-excursion
182 (goto-char comint-last-input-end
)
183 (not (re-search-forward
184 comint-prompt-regexp nil t
)))
185 (accept-process-output (get-buffer-process (current-buffer)))))
187 (split-string (org-babel-trim body
) "\n")
188 (list org-babel-sh-eoe-indicator
))))
190 ('otherwise
; external shell script
191 (if (and (cdr (assoc :shebang params
))
192 (> (length (cdr (assoc :shebang params
))) 0))
193 (let ((script-file (org-babel-temp-file "sh-script-"))
194 (shebang (cdr (assoc :shebang params
)))
195 (padline (not (string= "no" (cdr (assoc :padline params
))))))
196 (with-temp-file script-file
197 (when shebang
(insert (concat shebang
"\n")))
198 (when padline
(insert "\n"))
200 (set-file-modes script-file
#o755
)
201 (org-babel-eval script-file
""))
202 (org-babel-eval org-babel-sh-command
(org-babel-trim body
)))))))
204 (defun org-babel-sh-strip-weird-long-prompt (string)
205 "Remove prompt cruft from a string of shell output."
206 (while (string-match "^% +[\r\n$]+ *" string
)
207 (setq string
(substring string
(match-end 0))))
214 ;;; ob-sh.el ends here