ob-comint.el 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. ;;; ob-comint.el --- org-babel functions for interaction with comint buffers
  2. ;; Copyright (C) 2009-2013 Free Software Foundation, Inc.
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research, comint
  5. ;; Homepage: http://orgmode.org
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; These functions build on comint to ease the sending and receiving
  19. ;; of commands and results from comint buffers.
  20. ;; Note that the buffers in this file are analogous to sessions in
  21. ;; org-babel at large.
  22. ;;; Code:
  23. (require 'ob-core)
  24. (require 'org-compat)
  25. (require 'comint)
  26. (eval-when-compile (require 'cl))
  27. (declare-function with-parsed-tramp-file-name "tramp" (filename var &rest body))
  28. (declare-function tramp-flush-directory-property "tramp" (vec directory))
  29. (defun org-babel-comint-buffer-livep (buffer)
  30. "Check if BUFFER is a comint buffer with a live process."
  31. (let ((buffer (if buffer (get-buffer buffer))))
  32. (and buffer (buffer-live-p buffer) (get-buffer-process buffer) buffer)))
  33. (defmacro org-babel-comint-in-buffer (buffer &rest body)
  34. "Check BUFFER and execute BODY.
  35. BUFFER is checked with `org-babel-comint-buffer-livep'. BODY is
  36. executed inside the protection of `save-excursion' and
  37. `save-match-data'."
  38. (declare (indent 1))
  39. `(save-excursion
  40. (save-match-data
  41. (unless (org-babel-comint-buffer-livep ,buffer)
  42. (error "Buffer %s does not exist or has no process" ,buffer))
  43. (set-buffer ,buffer)
  44. ,@body)))
  45. (def-edebug-spec org-babel-comint-in-buffer (form body))
  46. (defmacro org-babel-comint-with-output (meta &rest body)
  47. "Evaluate BODY in BUFFER and return process output.
  48. Will wait until EOE-INDICATOR appears in the output, then return
  49. all process output. If REMOVE-ECHO and FULL-BODY are present and
  50. non-nil, then strip echo'd body from the returned output. META
  51. should be a list containing the following where the last two
  52. elements are optional.
  53. (BUFFER EOE-INDICATOR REMOVE-ECHO FULL-BODY)
  54. This macro ensures that the filter is removed in case of an error
  55. or user `keyboard-quit' during execution of body."
  56. (declare (indent 1))
  57. (let ((buffer (car meta))
  58. (eoe-indicator (cadr meta))
  59. (remove-echo (cadr (cdr meta)))
  60. (full-body (cadr (cdr (cdr meta)))))
  61. `(org-babel-comint-in-buffer ,buffer
  62. (let ((string-buffer "") dangling-text raw)
  63. ;; setup filter
  64. (setq comint-output-filter-functions
  65. (cons (lambda (text) (setq string-buffer (concat string-buffer text)))
  66. comint-output-filter-functions))
  67. (unwind-protect
  68. (progn
  69. ;; got located, and save dangling text
  70. (goto-char (process-mark (get-buffer-process (current-buffer))))
  71. (let ((start (point))
  72. (end (point-max)))
  73. (setq dangling-text (buffer-substring start end))
  74. (delete-region start end))
  75. ;; pass FULL-BODY to process
  76. ,@body
  77. ;; wait for end-of-evaluation indicator
  78. (while (progn
  79. (goto-char comint-last-input-end)
  80. (not (save-excursion
  81. (and (re-search-forward
  82. (regexp-quote ,eoe-indicator) nil t)
  83. (re-search-forward
  84. comint-prompt-regexp nil t)))))
  85. (accept-process-output (get-buffer-process (current-buffer)))
  86. ;; thought the following this would allow async
  87. ;; background running, but I was wrong...
  88. ;; (run-with-timer .5 .5 'accept-process-output
  89. ;; (get-buffer-process (current-buffer)))
  90. )
  91. ;; replace cut dangling text
  92. (goto-char (process-mark (get-buffer-process (current-buffer))))
  93. (insert dangling-text))
  94. ;; remove filter
  95. (setq comint-output-filter-functions
  96. (cdr comint-output-filter-functions)))
  97. ;; remove echo'd FULL-BODY from input
  98. (if (and ,remove-echo ,full-body
  99. (string-match
  100. (replace-regexp-in-string
  101. "\n" "[\r\n]+" (regexp-quote (or ,full-body "")))
  102. string-buffer))
  103. (setq raw (substring string-buffer (match-end 0))))
  104. (split-string string-buffer comint-prompt-regexp)))))
  105. (def-edebug-spec org-babel-comint-with-output (sexp body))
  106. (defun org-babel-comint-input-command (buffer cmd)
  107. "Pass CMD to BUFFER.
  108. The input will not be echoed."
  109. (org-babel-comint-in-buffer buffer
  110. (goto-char (process-mark (get-buffer-process buffer)))
  111. (insert cmd)
  112. (comint-send-input)
  113. (org-babel-comint-wait-for-output buffer)))
  114. (defun org-babel-comint-wait-for-output (buffer)
  115. "Wait until output arrives from BUFFER.
  116. Note: this is only safe when waiting for the result of a single
  117. statement (not large blocks of code)."
  118. (org-babel-comint-in-buffer buffer
  119. (while (progn
  120. (goto-char comint-last-input-end)
  121. (not (and (re-search-forward comint-prompt-regexp nil t)
  122. (goto-char (match-beginning 0))
  123. (string= (face-name (face-at-point))
  124. "comint-highlight-prompt"))))
  125. (accept-process-output (get-buffer-process buffer)))))
  126. (defun org-babel-comint-eval-invisibly-and-wait-for-file
  127. (buffer file string &optional period)
  128. "Evaluate STRING in BUFFER invisibly.
  129. Don't return until FILE exists. Code in STRING must ensure that
  130. FILE exists at end of evaluation."
  131. (unless (org-babel-comint-buffer-livep buffer)
  132. (error "Buffer %s does not exist or has no process" buffer))
  133. (if (file-exists-p file) (delete-file file))
  134. (process-send-string
  135. (get-buffer-process buffer)
  136. (if (string-match "\n$" string) string (concat string "\n")))
  137. ;; From Tramp 2.1.19 the following cache flush is not necessary
  138. (if (file-remote-p default-directory)
  139. (let (v)
  140. (with-parsed-tramp-file-name default-directory nil
  141. (tramp-flush-directory-property v ""))))
  142. (while (not (file-exists-p file)) (sit-for (or period 0.25))))
  143. (provide 'ob-comint)
  144. ;;; ob-comint.el ends here