forked from mirrors/org-mode
* ob-eval.el (org-babel-eval): Improve documentation and rename local variables to be consistent with `org-babel--shell-command-on-region' * (org-babel--shell-command-on-region): Remove START and END as parameters. * (org-babel--shell-command-on-region): Refactored out parts of function to `org-babel--write-temp-buffer-input-file' and `org-babel--get-shell-file-name'. This removes two parameters from `org-babel--shell-command-on-region'. It appears that START and END were parameters only because shell-command-on-region has them. This function is only called by org-babel-eval so it looks safe to remove those parameters, since they are always (point-min) and (point-max) and are never changed. Given the way the function works and that it is, it is unlikely that any user code relies on it.
161 lines
6.1 KiB
EmacsLisp
161 lines
6.1 KiB
EmacsLisp
;;; ob-eval.el --- Babel Functions for External Code Evaluation -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2009-2021 Free Software Foundation, Inc.
|
|
|
|
;; Author: Eric Schulte
|
|
;; Keywords: literate programming, reproducible research, comint
|
|
;; Homepage: https://orgmode.org
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; These functions build existing Emacs support for executing external
|
|
;; shell commands.
|
|
|
|
;;; Code:
|
|
(require 'org-macs)
|
|
|
|
(defvar org-babel-error-buffer-name "*Org-Babel Error Output*")
|
|
(declare-function org-babel-temp-file "ob-core" (prefix &optional suffix))
|
|
|
|
(defun org-babel-eval-error-notify (exit-code stderr)
|
|
"Open a buffer to display STDERR and a message with the value of EXIT-CODE."
|
|
(let ((buf (get-buffer-create org-babel-error-buffer-name)))
|
|
(with-current-buffer buf
|
|
(goto-char (point-max))
|
|
(save-excursion (insert stderr)))
|
|
(display-buffer buf))
|
|
(message "Babel evaluation exited with code %S" exit-code))
|
|
|
|
(defun org-babel-eval (command query)
|
|
"Run COMMAND on QUERY.
|
|
Writes QUERY into a temp-buffer that is processed with
|
|
org-babel--shell-command-on-region. If COMMAND succeeds then return
|
|
its results, otherwise display STDERR with
|
|
`org-babel-eval-error-notify'."
|
|
(let ((error-buffer (get-buffer-create " *Org-Babel Error*")) exit-code)
|
|
(with-current-buffer error-buffer (erase-buffer))
|
|
(with-temp-buffer
|
|
(insert query)
|
|
(setq exit-code
|
|
(org-babel--shell-command-on-region
|
|
command error-buffer))
|
|
(if (or (not (numberp exit-code)) (> exit-code 0))
|
|
(progn
|
|
(with-current-buffer error-buffer
|
|
(org-babel-eval-error-notify exit-code (buffer-string)))
|
|
(save-excursion
|
|
(when (get-buffer org-babel-error-buffer-name)
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
(unless (derived-mode-p 'compilation-mode)
|
|
(compilation-mode))
|
|
;; Compilation-mode enforces read-only, but Babel expects the buffer modifiable.
|
|
(setq buffer-read-only nil))))
|
|
nil)
|
|
(buffer-string)))))
|
|
|
|
(defun org-babel-eval-read-file (file)
|
|
"Return the contents of FILE as a string."
|
|
(with-temp-buffer (insert-file-contents file)
|
|
(buffer-string)))
|
|
|
|
(defun org-babel--shell-command-on-region (command error-buffer)
|
|
"Execute COMMAND in an inferior shell with region as input.
|
|
Stripped down version of `shell-command-on-region' for internal use in
|
|
Babel only. This lets us work around errors in the original function
|
|
in various versions of Emacs. This expects the query to be run to be
|
|
in the current temp buffer. This is written into
|
|
input-file. ERROR-BUFFER is the name of the file which
|
|
`org-babel-eval' has created to use for any error messages that are
|
|
returned."
|
|
|
|
(let ((input-file (org-babel-temp-file "ob-input-"))
|
|
(error-file (if error-buffer (org-babel-temp-file "ob-error-") nil))
|
|
(shell-file-name (org-babel--get-shell-file-name))
|
|
exit-status)
|
|
;; There is an error in `process-file' when `error-file' exists.
|
|
;; This is fixed in Emacs trunk as of 2012-12-21; let's use this
|
|
;; workaround for now.
|
|
(unless (file-remote-p default-directory)
|
|
(delete-file error-file))
|
|
;; we always call this with 'replace, remove conditional
|
|
;; Replace specified region with output from command.
|
|
(org-babel--write-temp-buffer-input-file input-file)
|
|
(setq exit-status
|
|
(process-file shell-file-name input-file
|
|
(if error-file
|
|
(list t error-file)
|
|
t)
|
|
nil shell-command-switch command))
|
|
|
|
(when (and input-file (file-exists-p input-file)
|
|
;; bind org-babel--debug-input around the call to keep
|
|
;; the temporary input files available for inspection
|
|
(not (when (boundp 'org-babel--debug-input)
|
|
org-babel--debug-input)))
|
|
(delete-file input-file))
|
|
|
|
(when (and error-file (file-exists-p error-file))
|
|
(when (< 0 (file-attribute-size (file-attributes error-file)))
|
|
(with-current-buffer (get-buffer-create error-buffer)
|
|
(let ((pos-from-end (- (point-max) (point))))
|
|
(or (bobp)
|
|
(insert "\f\n"))
|
|
;; Do no formatting while reading error file,
|
|
;; because that can run a shell command, and we
|
|
;; don't want that to cause an infinite recursion.
|
|
(format-insert-file error-file nil)
|
|
;; Put point after the inserted errors.
|
|
(goto-char (- (point-max) pos-from-end)))
|
|
(current-buffer)))
|
|
(delete-file error-file))
|
|
exit-status))
|
|
|
|
(defun org-babel--write-temp-buffer-input-file (input-file)
|
|
"Write the contents of the current temp buffer into INPUT-FILE."
|
|
(let ((start (point-min))
|
|
(end (point-max)))
|
|
(goto-char start)
|
|
(push-mark (point) 'nomsg)
|
|
(write-region start end input-file)
|
|
(delete-region start end)
|
|
(exchange-point-and-mark)))
|
|
|
|
(defun org-babel-eval-wipe-error-buffer ()
|
|
"Delete the contents of the Org code block error buffer.
|
|
This buffer is named by `org-babel-error-buffer-name'."
|
|
(when (get-buffer org-babel-error-buffer-name)
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
(delete-region (point-min) (point-max)))))
|
|
|
|
(defun org-babel--get-shell-file-name ()
|
|
"Return system `shell-file-name', defaulting to /bin/sh.
|
|
Unfortunately, `executable-find' does not support file name
|
|
handlers. Therefore, we could use it in the local case only."
|
|
;; FIXME: This is generic enough that it should probably be in emacs, not org-mode
|
|
(cond ((and (not (file-remote-p default-directory))
|
|
(executable-find shell-file-name))
|
|
shell-file-name)
|
|
((file-executable-p
|
|
(concat (file-remote-p default-directory) shell-file-name))
|
|
shell-file-name)
|
|
("/bin/sh")))
|
|
|
|
(provide 'ob-eval)
|
|
|
|
;;; ob-eval.el ends here
|