Return inferior buffer from runners (#884)

* Return inferior buffer from runners

* Set buffer explicitly in roxy test

Author: lionel-

doc/newfeat.texi

@@ -4,6 +4,14 @@
 Changes and New Features in 19.04 (unreleased):
 @itemize @bullet
 
+@item iESS: Process runners now return the inferior buffer.
+Note that callers of inferior runners should not assume that the current
+buffer has been set to the inferior buffer. Instead, use
+@code{with-current-buffer} with the return value of the inferior.
+
+@item iESS[SAS]: The SAS keymap was only set in iESS buffers
+called `*SAS*`. This is now fixed.
+
 @item ESS[R]: Fixed longstanding indentation issues involving
 @code{::} and @code{:::} operators.
 

lisp/ess-gretl.el

@@ -553,18 +553,18 @@ to gretl, put them in the variable `inferior-gretl-args'."
 		       (concat "Starting Args [other than `"
 			       inferior-gretl-args
 			       "'] ? "))
-		    nil))))
-    (inferior-ess r-start-args)
+		    nil)))
+         (inf-buf (inferior-ess r-start-args)))
     (set (make-local-variable 'indent-line-function) 'gretl-indent-line)
     (set (make-local-variable 'gretl-basic-offset) 4)
     (setq indent-tabs-mode nil)
     (goto-char (point-max))
     ;; (if inferior-ess-language-start
     ;; 	(ess-eval-linewise inferior-ess-language-start
     ;; 			   nil nil nil 'wait-prompt)))
-    (with-ess-process-buffer nil
+    (with-current-buffer inf-buf
       (run-mode-hooks 'ess-gretl-post-run-hook))
-    ))
+    inf-buf))
 
 
 ;;;; IMENU

lisp/ess-inf.el

@@ -175,38 +175,38 @@ This may be useful for debugging."
            (proc-name (with-current-buffer inf-buf ess-local-process-name))
            (cur-dir (inferior-ess--maybe-prompt-startup-directory proc-name temp-dialect))
            (default-directory cur-dir))
-      (set-buffer inf-buf)
-      (setq-local default-directory cur-dir)
-      ;; TODO: Get rid of this, we should rely on modes to set the
-      ;; variables they need.
-      (ess-setq-vars-local ess-customize-alist)
-      (let ((inf-args (or ess-start-args
-                          inferior-ess-start-args)))
-        (inferior-ess--set-major-mode ess-dialect)
-        ;; Show the buffer
-        ;; TODO: Remove inferior-ess-own-frame after ESS 19.04, then just have:
-        ;; (pop-to-buffer inf-buf)
-        (pop-to-buffer inf-buf (with-no-warnings
-                                 (when inferior-ess-own-frame
-                                   '(display-buffer-pop-up-frame))))
-        (let ((proc (inferior-ess--start-process inf-buf proc-name inf-args)))
-          (ess-make-buffer-current)
-          (goto-char (point-max))
-          (unless no-wait
-            (ess-write-to-dribble-buffer "(inferior-ess: waiting for process to start (before hook)\n")
-            (ess-wait-for-process proc nil 0.01 t))
-          (unless (and proc (eq (process-status proc) 'run))
-            (error "Process %s failed to start" proc-name))
-          (when ess-setwd-command
-            (ess-set-working-directory cur-dir))
-          (setq-local font-lock-fontify-region-function #'inferior-ess-fontify-region)
-          (setq-local ess-sl-modtime-alist nil)
-          (run-hooks 'ess-post-run-hook)
-          ;; User initialization can take some time ...
-          (unless no-wait
-            (ess-write-to-dribble-buffer "(inferior-ess 3): waiting for process after hook")
-            (ess-wait-for-process proc)))
-        inf-buf))))
+      (with-current-buffer inf-buf
+        (setq-local default-directory cur-dir)
+        ;; TODO: Get rid of this, we should rely on modes to set the
+        ;; variables they need.
+        (ess-setq-vars-local ess-customize-alist)
+        (let ((inf-args (or ess-start-args
+                            inferior-ess-start-args)))
+          (inferior-ess--set-major-mode ess-dialect)
+          ;; Show the buffer
+          ;; TODO: Remove inferior-ess-own-frame after ESS 19.04, then just have:
+          ;; (pop-to-buffer inf-buf)
+          (pop-to-buffer inf-buf (with-no-warnings
+                                   (when inferior-ess-own-frame
+                                     '(display-buffer-pop-up-frame))))
+          (let ((proc (inferior-ess--start-process inf-buf proc-name inf-args)))
+            (ess-make-buffer-current)
+            (goto-char (point-max))
+            (unless no-wait
+              (ess-write-to-dribble-buffer "(inferior-ess: waiting for process to start (before hook)\n")
+              (ess-wait-for-process proc nil 0.01 t))
+            (unless (and proc (eq (process-status proc) 'run))
+              (error "Process %s failed to start" proc-name))
+            (when ess-setwd-command
+              (ess-set-working-directory cur-dir))
+            (setq-local font-lock-fontify-region-function #'inferior-ess-fontify-region)
+            (setq-local ess-sl-modtime-alist nil)
+            (run-hooks 'ess-post-run-hook)
+            ;; User initialization can take some time ...
+            (unless no-wait
+              (ess-write-to-dribble-buffer "(inferior-ess 3): waiting for process after hook")
+              (ess-wait-for-process proc)))
+          inf-buf)))))
 
 (defun inferior-ess--get-proc-buffer-create (name)
   "Get a process buffer, creating a new one if needed.

lisp/ess-julia.el

@@ -434,23 +434,23 @@ always be passed to julia, put them in the variable
                                      (concat " [other than '" inferior-julia-args "']"))
                                  " ? "))
 		              nil))))
-      (inferior-ess jl-start-args)
-
-      (ess--tb-start)
-      ;; remove ` from julia's logo
-      (goto-char (point-min))
-      (while (re-search-forward "`" nil t)
-        (replace-match "'"))
-      ;; remove an offending unmatched parenthesis
-      (goto-char (point-min))
-      (forward-line 4)
-      (when (re-search-forward "(" nil t)
-        (replace-match "|"))
-      (goto-char (point-max))
-      ;; --> julia helpers from ../etc/ess-julia.jl :
-      (ess--inject-code-from-file (format "%sess-julia.jl" ess-etc-directory))
-      (with-ess-process-buffer nil
-        (run-mode-hooks 'ess-julia-post-run-hook)))))
+      (let ((inf-buf (inferior-ess jl-start-args)))
+        (ess--tb-start)
+        ;; Remove ` from julia's logo
+        (goto-char (point-min))
+        (while (re-search-forward "`" nil t)
+          (replace-match "'"))
+        ;; Remove an offending unmatched parenthesis
+        (goto-char (point-min))
+        (forward-line 4)
+        (when (re-search-forward "(" nil t)
+          (replace-match "|"))
+        (goto-char (point-max))
+        ;; --> julia helpers from ../etc/ess-julia.jl :
+        (ess--inject-code-from-file (format "%sess-julia.jl" ess-etc-directory))
+        (with-current-buffer inf-buf
+          (run-mode-hooks 'ess-julia-post-run-hook))
+        inf-buf))))
 
 (cl-defmethod ess--help-major-mode (&context ((string= ess-dialect "julia") (eql t)))
   (ess-julia-help-mode))

lisp/ess-r-mode.el

@@ -523,29 +523,27 @@ will be prompted to enter arguments interactively."
         (setq default-process-coding-system '(undecided-dos . undecided-dos))))
 
     (let ((inf-buf (inferior-ess r-start-args cust-alist gdbp)))
-
-      (ess-process-put 'funargs-pre-cache ess-r--funargs-pre-cache)
-
-      (remove-hook 'completion-at-point-functions 'ess-filename-completion 'local) ;; should be first
-      (add-hook 'completion-at-point-functions 'ess-r-object-completion nil 'local)
-      (add-hook 'completion-at-point-functions 'ess-filename-completion nil 'local)
-      (add-hook 'xref-backend-functions #'ess-r-xref-backend nil 'local)
-      (setq comint-input-sender 'inferior-ess-r-input-sender)
-
-      (if gdbp
-          (progn
-            ;; We need to use callback, because R might start with a gdb process
-            (ess-process-put 'callbacks '(R-initialize-on-start))
-            ;; trigger the callback
-            (process-send-string (get-process ess-local-process-name) "\n"))
-        (ess-wait-for-process)
-        (R-initialize-on-start)
-        (comint-goto-process-mark))
-
-      (ess-write-to-dribble-buffer
-       (format "(R): inferior-ess-language-start=%s\n"
-               inferior-ess-language-start))
-      inf-buf)))
+      (with-current-buffer inf-buf
+        (ess-process-put 'funargs-pre-cache ess-r--funargs-pre-cache)
+        (remove-hook 'completion-at-point-functions 'ess-filename-completion 'local) ;; should be first
+        (add-hook 'completion-at-point-functions 'ess-r-object-completion nil 'local)
+        (add-hook 'completion-at-point-functions 'ess-filename-completion nil 'local)
+        (add-hook 'xref-backend-functions #'ess-r-xref-backend nil 'local)
+        (setq comint-input-sender 'inferior-ess-r-input-sender)
+        (if gdbp
+            (progn
+              ;; We need to use callback, because R might start with a gdb process
+              (ess-process-put 'callbacks '(R-initialize-on-start))
+              ;; Trigger the callback
+              (process-send-string (get-process ess-local-process-name) "\n"))
+          (ess-wait-for-process)
+          (R-initialize-on-start)
+          (comint-goto-process-mark))
+        (ess-write-to-dribble-buffer
+         (format "(R): inferior-ess-language-start=%s\n"
+                 inferior-ess-language-start)))
+      ;; FIXME: Current ob-R expects current buffer set to process buffer
+      (set-buffer inf-buf))))
 
 ;;;###autoload
 (defalias 'R #'run-ess-r)

lisp/ess-sas-d.el

@@ -307,10 +307,10 @@ Better logic needed!  (see 2 uses, in this file).")
              temp-dialect))
     (ess-SAS-pre-run-hook temp-dialect)
     (setq ess-eval-visibly-p nil)
-    (inferior-ess)
-    (with-current-buffer "*SAS*"
-      (use-local-map sas-mode-local-map))))
-
+    (let ((inf-buf (inferior-ess)))
+      (with-current-buffer inf-buf
+        (use-local-map sas-mode-local-map))
+      inf-buf)))
 
 (defun ess-multi-frame-SAS ()
   "Put running SAS buffers into separate frames.

lisp/ess-sp6-d.el

@@ -116,12 +116,13 @@ New way to do it."
   (setq ess-customize-alist S+-customize-alist)
   (ess-write-to-dribble-buffer
    (format "\n(S+): ess-dialect=%s, buf=%s\n" ess-dialect (current-buffer)))
-  (inferior-ess)
-  (ess-command ess-S+--injected-code)
-  (if inferior-ess-language-start
+  (let ((inf-buf (inferior-ess)))
+    (ess-command ess-S+--injected-code)
+    (when inferior-ess-language-start
       (ess-eval-linewise inferior-ess-language-start))
-  (with-ess-process-buffer nil
-    (run-mode-hooks 'ess-S+-post-run-hook)))
+    (with-current-buffer inf-buf
+      (run-mode-hooks 'ess-S+-post-run-hook))
+    inf-buf))
 
 
 (defalias 'S+6-mode 'S+-mode)

lisp/ess-stata-mode.el

@@ -150,20 +150,21 @@ This function is placed in `ess-presend-filter-functions'.
    (format "(STA): ess-dialect=%s , buf=%s \n"
            ess-dialect
            (current-buffer)))
-  (let ((sta-start-args 
-         (concat inferior-STA-start-args
-                 (when start-args (read-string "Starting Args [possibly -k####] ? ")))))
-    (inferior-ess sta-start-args)
-    (let ((proc (get-process ess-local-process-name)))
-      (while (process-get proc 'sec-prompt)
-        ;; get read of all --more-- if stata.msg is too long.
-        (ess-send-string proc "q")
-        (ess-wait-for-process proc t))
-      (ess-send-string proc "set more off")
-      (goto-char (point-max))
-      (with-current-buffer (process-buffer proc)
-        (add-hook 'ess-presend-filter-functions 'ess-sta-remove-comments nil 'local)
-        (run-mode-hooks 'ess-stata-post-run-hook)))))
+  (let* ((sta-start-args
+          (concat inferior-STA-start-args
+                  (when start-args (read-string "Starting Args [possibly -k####] ? "))))
+         (inf-buf (inferior-ess sta-start-args))
+         (inf-proc (get-buffer-process inf-buf)))
+    (while (process-get inf-proc 'sec-prompt)
+      ;; get read of all --more-- if stata.msg is too long.
+      (ess-send-string inf-proc "q")
+      (ess-wait-for-process inf-proc t))
+    (ess-send-string inf-proc "set more off")
+    (goto-char (point-max))
+    (with-current-buffer inf-buf
+      (add-hook 'ess-presend-filter-functions 'ess-sta-remove-comments nil 'local)
+      (run-mode-hooks 'ess-stata-post-run-hook))
+    inf-buf))
 
 (defvar inferior-ess-stata-mode-syntax-table
   (let ((tab (copy-syntax-table ess-stata-mode-syntax-table)))

lisp/essd-els.el

@@ -71,9 +71,10 @@ The default value is nil."
   (ess-write-to-dribble-buffer
    (format "\n(S+elsewhere): ess-dialect=%s, buf=%s\n" ess-dialect
            (current-buffer)))
-  (inferior-ess)
-  (if inferior-ess-language-start
-      (ess-eval-linewise inferior-ess-language-start)))
+  (let ((inf-buf (inferior-ess)))
+    (when inferior-ess-language-start
+      (ess-eval-linewise inferior-ess-language-start))
+    inf-buf))
 
 (defun S+elsewhere-mode (&optional _proc-name)
   "Major mode for editing S+3 source.  See `ess-mode' for more help."

test/ess-test-r.el

@@ -286,10 +286,11 @@
 
 ;; roxy
 (ert-deftest ess-roxy-preview-Rd-test ()
-  (with-r-running nil
-    (if (member "roxygen2" (ess-installed-packages))
-        (should
-         (string= "% Generated by roxygen2: do not edit by hand
+  (let ((buf (generate-new-buffer " *temp*")))
+    (with-r-running buf
+      (if (member "roxygen2" (ess-installed-packages))
+          (should
+           (string= "% Generated by roxygen2: do not edit by hand
 \\name{add}
 \\alias{add}
 \\title{Add together two numbers.
@@ -301,24 +302,24 @@ add(x, y)
 Add together two numbers. add(10, 1)
 } 
 "
-                  (with-temp-buffer
-                    (R-mode)
-                    (ess-roxy-mode)
-                    (insert
-                     "##' Add together two numbers.
+                    (with-current-buffer buf
+                      (R-mode)
+                      (ess-roxy-mode)
+                      (insert
+                       "##' Add together two numbers.
 ##' add(10, 1)
 add <- function(x, y) {
   x + y
 }")
-                    (goto-char (point-min))
-                    (ess-roxy-preview-Rd)
-                    ;; Delete the reference to the file which isn't
-                    ;; reproducible across different test environments
-                    (goto-char (point-min))
-                    (forward-line 1)
-                    (kill-whole-line)
-                    (buffer-substring-no-properties (point-min) (point-max)))))
-      (ert-skip "Roxygen2 not installed"))))
+                      (goto-char (point-min))
+                      (ess-roxy-preview-Rd)
+                      ;; Delete the reference to the file which isn't
+                      ;; reproducible across different test environments
+                      (goto-char (point-min))
+                      (forward-line 1)
+                      (kill-whole-line)
+                      (buffer-substring-no-properties (point-min) (point-max)))))
+        (ert-skip "Roxygen2 not installed")))))
 
 (ert-deftest ess-test-roxy-font-lock ()
   (ess-r-test-with-temp-text