Merge branch 'maint'
[org-mode/org-tableheadings.git] / lisp / ob-comint.el
blob7c768d38805ba71514775b559a68696e31e23002
1 ;;; ob-comint.el --- org-babel functions for interaction with comint buffers
3 ;; Copyright (C) 2009-2014 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research, comint
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 ;; These functions build on comint to ease the sending and receiving
27 ;; of commands and results from comint buffers.
29 ;; Note that the buffers in this file are analogous to sessions in
30 ;; org-babel at large.
32 ;;; Code:
33 (require 'ob-core)
34 (require 'org-compat)
35 (require 'comint)
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
49 `save-match-data'."
50 (declare (indent 1))
51 `(progn
52 (unless (org-babel-comint-buffer-livep ,buffer)
53 (error "Buffer %s does not exist or has no process" ,buffer))
54 (save-match-data
55 (with-current-buffer ,buffer
56 (let ((comint-input-filter (lambda (input) nil)))
57 ,@body)))))
58 (def-edebug-spec org-babel-comint-in-buffer (form body))
60 (defmacro org-babel-comint-with-output (meta &rest body)
61 "Evaluate BODY in BUFFER and return process output.
62 Will wait until EOE-INDICATOR appears in the output, then return
63 all process output. If REMOVE-ECHO and FULL-BODY are present and
64 non-nil, then strip echo'd body from the returned output. META
65 should be a list containing the following where the last two
66 elements are optional.
68 (BUFFER EOE-INDICATOR REMOVE-ECHO FULL-BODY)
70 This macro ensures that the filter is removed in case of an error
71 or user `keyboard-quit' during execution of body."
72 (declare (indent 1))
73 (let ((buffer (nth 0 meta))
74 (eoe-indicator (nth 1 meta))
75 (remove-echo (nth 2 meta))
76 (full-body (nth 3 meta)))
77 `(org-babel-comint-in-buffer ,buffer
78 (let* ((string-buffer "")
79 (comint-output-filter-functions
80 (cons (lambda (text) (setq string-buffer (concat string-buffer text)))
81 comint-output-filter-functions))
82 dangling-text raw)
83 ;; got located, and save dangling text
84 (goto-char (process-mark (get-buffer-process (current-buffer))))
85 (let ((start (point))
86 (end (point-max)))
87 (setq dangling-text (buffer-substring start end))
88 (delete-region start end))
89 ;; pass FULL-BODY to process
90 ,@body
91 ;; wait for end-of-evaluation indicator
92 (while (progn
93 (goto-char comint-last-input-end)
94 (not (save-excursion
95 (and (re-search-forward
96 (regexp-quote ,eoe-indicator) nil t)
97 (re-search-forward
98 comint-prompt-regexp nil t)))))
99 (accept-process-output (get-buffer-process (current-buffer)))
100 ;; thought the following this would allow async
101 ;; background running, but I was wrong...
102 ;; (run-with-timer .5 .5 'accept-process-output
103 ;; (get-buffer-process (current-buffer)))
105 ;; replace cut dangling text
106 (goto-char (process-mark (get-buffer-process (current-buffer))))
107 (insert dangling-text)
109 ;; remove echo'd FULL-BODY from input
110 (if (and ,remove-echo ,full-body
111 (string-match
112 (replace-regexp-in-string
113 "\n" "[\r\n]+" (regexp-quote (or ,full-body "")))
114 string-buffer))
115 (setq raw (substring string-buffer (match-end 0))))
116 (split-string string-buffer comint-prompt-regexp)))))
117 (def-edebug-spec org-babel-comint-with-output (sexp body))
119 (defun org-babel-comint-input-command (buffer cmd)
120 "Pass CMD to BUFFER.
121 The input will not be echoed."
122 (org-babel-comint-in-buffer buffer
123 (goto-char (process-mark (get-buffer-process buffer)))
124 (insert cmd)
125 (comint-send-input)
126 (org-babel-comint-wait-for-output buffer)))
128 (defun org-babel-comint-wait-for-output (buffer)
129 "Wait until output arrives from BUFFER.
130 Note: this is only safe when waiting for the result of a single
131 statement (not large blocks of code)."
132 (org-babel-comint-in-buffer buffer
133 (while (progn
134 (goto-char comint-last-input-end)
135 (not (and (re-search-forward comint-prompt-regexp nil t)
136 (goto-char (match-beginning 0))
137 (string= (face-name (face-at-point))
138 "comint-highlight-prompt"))))
139 (accept-process-output (get-buffer-process buffer)))))
141 (defun org-babel-comint-eval-invisibly-and-wait-for-file
142 (buffer file string &optional period)
143 "Evaluate STRING in BUFFER invisibly.
144 Don't return until FILE exists. Code in STRING must ensure that
145 FILE exists at end of evaluation."
146 (unless (org-babel-comint-buffer-livep buffer)
147 (error "Buffer %s does not exist or has no process" buffer))
148 (if (file-exists-p file) (delete-file file))
149 (process-send-string
150 (get-buffer-process buffer)
151 (if (= (aref string (1- (length string))) ?\n) string (concat string "\n")))
152 ;; From Tramp 2.1.19 the following cache flush is not necessary
153 (if (file-remote-p default-directory)
154 (let (v)
155 (with-parsed-tramp-file-name default-directory nil
156 (tramp-flush-directory-property v ""))))
157 (while (not (file-exists-p file)) (sit-for (or period 0.25))))
159 (provide 'ob-comint)
163 ;;; ob-comint.el ends here