1 ;;; ob-comint.el --- org-babel functions for interaction with comint buffers
3 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research, comint
7 ;; Homepage: http://orgmode.org
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/>.
27 ;; These functions build on comint to ease the sending and receiving
28 ;; of commands and results from comint buffers.
30 ;; Note that the buffers in this file are analogous to sessions in
31 ;; org-babel at large.
36 (eval-when-compile (require 'cl
))
37 (declare-function with-parsed-tramp-file-name
"tramp" (filename var
&rest body
))
38 (declare-function tramp-flush-directory-property
"tramp" (vec directory
))
40 (defun org-babel-comint-buffer-livep (buffer)
41 "Check if BUFFER is a comint buffer with a live process."
42 (let ((buffer (if buffer
(get-buffer buffer
))))
43 (and buffer
(buffer-live-p buffer
) (get-buffer-process buffer
) buffer
)))
45 (defmacro org-babel-comint-in-buffer
(buffer &rest body
)
46 "Check BUFFER and execute BODY.
47 BUFFER is checked with `org-babel-comint-buffer-livep'. BODY is
48 executed inside the protection of `save-excursion' and
53 (unless (org-babel-comint-buffer-livep ,buffer
)
54 (error "buffer %s doesn't exist or has no process" ,buffer
))
57 (def-edebug-spec org-babel-comint-in-buffer
(form body
))
59 (defmacro org-babel-comint-with-output
(meta &rest body
)
60 "Evaluate BODY in BUFFER and return process output.
61 Will wait until EOE-INDICATOR appears in the output, then return
62 all process output. If REMOVE-ECHO and FULL-BODY are present and
63 non-nil, then strip echo'd body from the returned output. META
64 should be a list containing the following where the last two
65 elements are optional.
67 (BUFFER EOE-INDICATOR REMOVE-ECHO FULL-BODY)
69 This macro ensures that the filter is removed in case of an error
70 or user `keyboard-quit' during execution of body."
72 (let ((buffer (car meta
))
73 (eoe-indicator (cadr meta
))
74 (remove-echo (cadr (cdr meta
)))
75 (full-body (cadr (cdr (cdr meta
)))))
76 `(org-babel-comint-in-buffer ,buffer
77 (let ((string-buffer "") dangling-text raw
)
78 (flet ((my-filt (text)
79 (setq string-buffer
(concat string-buffer text
))))
81 (add-hook 'comint-output-filter-functions
'my-filt
)
84 ;; got located, and save dangling text
85 (goto-char (process-mark (get-buffer-process (current-buffer))))
88 (setq dangling-text
(buffer-substring start end
))
89 (delete-region start end
))
90 ;; pass FULL-BODY to process
92 ;; wait for end-of-evaluation indicator
94 (goto-char comint-last-input-end
)
96 (and (re-search-forward
97 (regexp-quote ,eoe-indicator
) nil t
)
99 comint-prompt-regexp nil t
)))))
100 (accept-process-output (get-buffer-process (current-buffer)))
101 ;; thought the following this would allow async
102 ;; background running, but I was wrong...
103 ;; (run-with-timer .5 .5 'accept-process-output
104 ;; (get-buffer-process (current-buffer)))
106 ;; replace cut dangling text
107 (goto-char (process-mark (get-buffer-process (current-buffer))))
108 (insert dangling-text
))
110 (remove-hook 'comint-output-filter-functions
'my-filt
)))
111 ;; remove echo'd FULL-BODY from input
112 (if (and ,remove-echo
,full-body
114 (replace-regexp-in-string
115 "\n" "[\r\n]+" (regexp-quote (or ,full-body
"")))
117 (setq raw
(substring string-buffer
(match-end 0))))
118 (split-string string-buffer comint-prompt-regexp
)))))
119 (def-edebug-spec org-babel-comint-with-output
(form body
))
121 (defun org-babel-comint-input-command (buffer cmd
)
123 The input will not be echoed."
124 (org-babel-comint-in-buffer buffer
125 (goto-char (process-mark (get-buffer-process buffer
)))
128 (org-babel-comint-wait-for-output buffer
)))
130 (defun org-babel-comint-wait-for-output (buffer)
131 "Wait until output arrives from BUFFER.
132 Note: this is only safe when waiting for the result of a single
133 statement (not large blocks of code)."
134 (org-babel-comint-in-buffer buffer
136 (goto-char comint-last-input-end
)
137 (not (and (re-search-forward comint-prompt-regexp nil t
)
138 (goto-char (match-beginning 0))
139 (string= (face-name (face-at-point))
140 "comint-highlight-prompt"))))
141 (accept-process-output (get-buffer-process buffer
)))))
143 (defun org-babel-comint-eval-invisibly-and-wait-for-file
144 (buffer file string
&optional period
)
145 "Evaluate STRING in BUFFER invisibly.
146 Don't return until FILE exists. Code in STRING must ensure that
147 FILE exists at end of evaluation."
148 (unless (org-babel-comint-buffer-livep buffer
)
149 (error "buffer %s doesn't exist or has no process" buffer
))
150 (if (file-exists-p file
) (delete-file file
))
152 (get-buffer-process buffer
)
153 (if (string-match "\n$" string
) string
(concat string
"\n")))
154 ;; From Tramp 2.1.19 the following cache flush is not necessary
155 (if (file-remote-p default-directory
)
157 (with-parsed-tramp-file-name default-directory nil
158 (tramp-flush-directory-property v
""))))
159 (while (not (file-exists-p file
)) (sit-for (or period
0.25))))
163 ;; arch-tag: 9adddce6-0864-4be3-b0b5-6c5157dc7889
165 ;;; ob-comint.el ends here