| blob | b7c0e1f98a1ad0e5cc84e2e83243ebdc5abab537 |
1 ;;; ess-inf.el --- Support for running S as an inferior Emacs process
3 ;; Copyright (C) 1989-1994 Bates, Kademan, Ritter and Smith
4 ;; Copyright (C) 1997-1999 A.J. Rossini <rossini@u.washington.edu>,
5 ;; Martin Maechler <maechler@stat.math.ethz.ch>.
6 ;; Copyright (C) 2000--2006 A.J. Rossini, Rich M. Heiberger, Martin
7 ;; Maechler, Kurt Hornik, Rodney Sparapani, and Stephen Eglen.
9 ;; Original Author: David Smith <dsmith@stats.adelaide.edu.au>
10 ;; Created: 7 Jan 1994
11 ;; Maintainers: ESS-core <ESS-core@stat.math.ethz.ch>
13 ;; This file is part of ESS
15 ;; This file is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; any later version.
20 ;; This file is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to
27 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
29 ;;; Commentary:
31 ;; Code for handling running ESS processes.
33 ;;; Code:
37 ;;*;; Requires
40 ;; Byte-compiler, SHUT-UP!
45 ;;*;; Autoloads
64 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
65 ;;; In this section:
66 ;;;
67 ;;; * User commands for starting an ESS process
68 ;;; * Functions called at startup
69 ;;; * Process handling code
70 ;;; * Multiple process implementation
71 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
73 ;;*;; Starting a process
76 "Return name of process N, as a string, with NAME prepended.
77 If ess-plain-first-buffername, then initial process is number-free."
84 "Start inferior ESS process.
86 Without a prefix argument, starts a new ESS process, or switches
87 to the ESS process associated with the current buffer.
88 With a prefix, starts the process with those args.
89 The current buffer is used if it is an `inferior-ess-mode'
90 or `ess-transcript-mode' buffer.
92 If `ess-ask-about-transfile' is non-nil, you will be asked for a
93 transcript file to use. If there is no transcript file, the buffer
94 name will be like *S* or *S2*.
96 Takes the program name from the variable `inferior-ess-program'.
97 An initialization file (dumped into the process) is specified by
98 `inferior-ess-start-file', and `inferior-ess-start-args' is used to
99 accompany the call for `inferior-ess-program'.
101 When creating a new process, the process buffer replaces the
102 current window if `inferior-ess-same-window' is non-nil.
103 Alternatively, it can appear in its own frame if
104 `inferior-ess-own-frame' is non-nil.
108 ;; Use the current buffer if it is in inferior-ess-mode or ess-trans-mode
109 ;; If not, maybe ask about starting directory and/or transcript file.
110 ;; If no transfile, use buffer *S*
111 ;;
112 ;; This function is primarily used to figure out the Process and
113 ;; buffer names to use for inferior-ess.
115 ;; Once, long ago, it was used for switching buffers, but we don't
116 ;; do that any more (at least not from here).
123 ;; set up for current language (need here, to get ess-language, etc).
125 ;; Couldn't we rather set all the default values or Local values now ?
126 ;;>>> (ess-setq-vars-default ess-customize-alist (current-buffer))
127 ;;>>> (ess-setq-vars-local ess-customize-alist (current-buffer))
128 ;;; AJR sez: I think we should set them later; don't want to nuke if
129 ;;; I don't have to.
130 ;;- MM: We shouldn't have to use ess-setq-vars-default _at all_ ;
131 ;; only do the buffer local ...-vars-local ones
133 ess-customize-alist))))
135 ess-customize-alist)))))
137 ;;- Is this needed? (no, but it's useful to see them there [MM])
139 ;; Hack to work around the following "default" (global) setting of vars:
140 ;; make sure our comint-... hack doesn't affect anything else
142 ;; now the abomination:
145 ;; Emacs 22.0.50: ".. obsolete since 22.1;
146 ;; use `comint-use-prompt-regexp' instead
148 ;;>> Doesn't set ess-language,
149 ;;>> => comint-input-sender is not set to 'ess-input- ==> no input echo!
150 ;;>> => that's why things fail:
151 ;;>> (ess-setq-vars-local ess-customize-alist (current-buffer))
152 ;; ======
153 )
155 ;; run hooks now, to overwrite the above!
162 ess-directory default-directory))
165 inferior-R-program-name
167 ; if not R, R program name
168 ; otherwise.
169 temp-ess-dialect))
177 ntry
178 temp-dialect)))))
186 procname
187 temp-dialect
188 buf-name-str))
190 ;; Since it's a new or terminated process, try to use current buffer
197 defdir))
202 ;; Not an ESS buffer yet
209 ;; Ask for transcript file and startdir
210 ;; FIXME -- this should be in ess-get-transfile
211 ;; AJR: Why? I'm not clear about the logic, i.e. when would it
212 ;; be used again, to justify?
217 defdir))
220 "Use transcript file (default none):"
225 transfilename)))))
231 ;; Now that we have the buffer, set buffer-local variables.
234 ;; Was: if not, set to null.
235 ;;(setq inferior-ess-start-args "")) ;; AJR: Errors with XLS?
236 ;; I think I might have solved this?
238 ;; Write out debug info
241 ess-language
242 ess-dialect
246 ess-start-args
247 inferior-ess-start-args))
250 ess-language
251 ess-dialect
252 inferior-ess-program
253 ess-current-process-name
254 ess-local-process-name))
256 ;; Start from the "right" directory
258 ;; Set up history
261 ;; initialize.
267 "The language/dialect specific command for listing objects.
268 It is initialized from the corresponding inferior-<lang>-objects-command
273 "The command to save the last value. See S section for more details.
278 "The command to retrieve the last value. See S section for more details.
282 ;;; A note on multiple processes: the following variables
283 ;;; ess-local-process-name
284 ;;; ess-search-list
285 ;;; ess-sl-modtime-alist
286 ;;; ess-sp-change
287 ;;; ess-prev-load-dir/file
288 ;;; ess-directory
289 ;;; ess-object-list
290 ;;; are specific to each ess-process and are buffer-local variables
291 ;;; local to the ESS process buffer. If required, these variables should
292 ;;; be accessed with the function ess-get-process-variable
295 "Start or switch to ESS process named NAME in the buffer BUFFER.
296 BUFFER is only needed if process NAME is not running. BUFFER must
297 exist. Default-directory is the ESS starting directory. BUFFER may be
298 visiting a file.
300 If ess-process NAME is running, switch to it. If not, use COMINT to
301 start up a new process, using NAME and BUFFER (which is needed if
302 there is no process NAME)."
310 ;; If ESS process NAME is running, switch to it
313 ;; Otherwise, crank up a new process
323 inf-ess-start-args comint-process-echoes))
328 inf-ess-start-args comint-process-echoes))
331 ;; load past history
335 ;; create and run process.
338 inf-ess-start-args))
342 proc-name
343 inf-ess-start-args
344 switches)
346 proc-name
347 inf-ess-start-args)))
348 ;; Set the process sentinel to save the history
350 ;; Add this process to ess-process-name-list, if needed
359 ;; Get search list when needed
362 ;; Add the process filter to catch certain output.
372 "Standard output filter for the inferior ESS process.
373 Ring Emacs bell if process output starts with an ASCII bell, and pass
374 the rest to `comint-output-filter'.
375 Taken from octave-mod.el."
379 "Strip leading `^G' character.
380 If STRING starts with a `^G', ring the Emacs bell and strip it.
381 Depending on the value of `visible-bell', either the frame will
382 flash or you'll hear a beep. Taken from octave-mod.el."
387 string)
391 "Sentinel for use with ESS processes.
392 This marks the process with a message, at a particular time point."
403 procname
404 inferior-ess-start-args
406 "Make an S comint process in buffer BUFNAME with process PROCNAME.
407 This was rewritten by KH in April 1996."
408 ;;; This function is a modification of make-comint from the comint.el
409 ;;; code of Olin Shivers.
412 ;; If no process, or nuked process, crank up a new one and put buffer in
413 ;; comint mode. Otherwise, leave buffer and existing process alone.
425 process-environment)))
429 buffer
430 procname
431 inferior-ess-program
432 inferior-ess-start-file
433 inferior-ess-start-args))
435 procname
436 inferior-ess-program
437 inferior-ess-start-file
439 inferior-ess-start-args)))))
440 buffer))
443 ;;*;; Requester functions called at startup
445 ;(defun ess-get-directory-ORIG (default)
446 ; "Request and return S starting directory."
447 ; (let ((the-dir
448 ; (expand-file-name
449 ; (file-name-as-directory
450 ; (read-file-name
451 ; (format "ESS [%s(%s): %s] starting data directory? "
452 ; ess-language ess-dialect inferior-ess-program)
453 ; (file-name-as-directory default)
454 ; (file-name-as-directory default) t nil)))))
455 ; (if (file-directory-p the-dir) nil
456 ; (error "%s is not a valid directory" the-dir))
457 ; the-dir))
461 default
463 ess-language ess-dialect inferior-ess-program)))
466 "`prompt' for a directory, using `default' as the usual."
471 ;; use XEmacs' read-directory-name if exists.
476 the-dir))
479 ;;*;; General process handling code
482 "Return the ESS process named by NAME."
491 "Wait until the ESS process is ready for input."
506 ;; above, except for Stata, which has "broken" i/o,
507 ;; sigh... (AJR)
514 ;;--- Unfinished idea (ESS-help / R-help ) -- probably not worth it...
515 ;;- (defun ess-set-inferior-program-name (filename)
516 ;;- "Allows to set or change `inferior-ess-program', the program (file)name."
517 ;;- (interactive "fR executable (script) file: ")
518 ;;- ;; "f" : existing file {file name completion} !
519 ;;- (setq inferior-ess-program filename))
520 ;; the inferior-ess-program is initialized in the customize..alist,
521 ;; e.g. from inferior-R-program-name ... --> should change rather these.
522 ;; However these really depend on the current ess-language!
523 ;; Plan: 1) must know and use ess-language
524 ;; 2) change the appropriate inferior-<ESSlang>-program-name
525 ;; (how?) in R/S : assign(paste("inferior-",ESSlang,"-p...."), filename))
527 ;;*;; Multiple process handling code
530 "Make the process associated with the current buffer the current ESS process.
531 Returns the name of the process, or nil if the current buffer has none."
535 ess-local-process-name)
538 "Return the variable VAR (symbol) local to ESS process called NAME (string)."
544 "Set variable VAR (symbol) local to ESS process called NAME (string) to VAL."
550 "Ask for a process, and make it the current ESS process.
551 If there is exactly one process, only ask if ASK-IF-1 is non-nil.
552 Also switches to the process buffer unless NOSWITCH is non-nil. Interactively,
553 NOSWITCH can be set by giving a prefix argument.
554 Returns the name of the selected process."
557 ; prefix sets 'noswitch
562 ;; else
567 rr)
568 ;; else
570 ess-process-name-list
571 nil ; predicate
572 'require-match
573 ;; If in S buffer, don't offer current process
575 ess-language
576 ess-current-process-name
577 ;; maybe ess-local-process-name IF exists?
578 )))))
583 nil
585 proc)))
589 "Make sure the current buffer is attached to an ESS process.
590 If not, or FORCE (prefix argument) is non-nil,
591 prompt for a process name with PROMPT.
592 `ess-local-process-name' is set to the name of the process selected.
593 `ess-dialect' is set to the dialect associated with the process selected."
597 nil ; do nothing
598 ;; Make sure the source buffer is attached to a process
601 ;; ess-local-process-name is nil -- which process to attach to
604 temp-ess-help-filetype
605 dialect)
615 "Force a switch to a new underlying process."
619 ;;*;;; Commands for switching to the process buffer
622 "Switch to the current inferior ESS process buffer.
623 With (prefix) EOB-P non-nil, positions cursor at end of buffer.
624 This function should follow the description in `ess-show-buffer'
625 for showing the iESS buffer, except that the iESS buffer is also
626 made current."
631 ;; Display the buffer, but don't select it yet.
634 t)
640 "Switch to the end of the inferior ESS process buffer."
645 "Return the buffer associated with the ESS process named by NAME."
649 "Remove names with no process."
656 ess-process-name-list)
660 defunct))
664 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
665 ;; ess-show-buffer
666 ;; Something like this almost works, but problems with XEmacs and Emacs
667 ;; differing implementations of the args to display-buffer make this
668 ;; too tough to pursue. The longer version below works.
669 ;; (defun ess-show-buffer (buf)
670 ;; "Display the buffer BUF, a string, but do not select it.
671 ;; Returns the window corresponding to the buffer."
672 ;; ;; On XEmacs, I get an error if third arg to display-buffer is t and
673 ;; ;; the BUF is in another frame. Emacs does not have this problem.
674 ;; (if (featurep 'xemacs)
675 ;; (display-buffer buf nil (get-frame-for-buffer buf))
676 ;; (display-buffer buf nil t)))
677 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
679 "Ensure the ESS buffer BUF is visible.
680 The buffer, specified as a string, is typically an iESS (e.g. *R*) buffer.
682 This handles several cases:
684 1. If BUF is visible in the current frame, nothing is done.
685 2. If BUF is visible in another frame, then we ensure that frame is
686 visible (it may have been iconified).
687 3. If buffer is not visible in any frame, simply show it in another window
688 in the current frame.
690 Iff VISIT is non-nil, as well as making BUF visible, we also select it
691 as the current buffer."
694 ;;1. Nothing to do, BUF visible in this frame; just return window
695 ;; where this buffer is.
696 t
698 ;; 2. Maybe BUF visible in another frame.
701 ;; BUF is visible in frame, so just check frame is raised.
703 ;; frame is not yet visible, so raise it.
705 ;; 3. else BUF not visible in any frame, so show it (but do
706 ;; not select it) in another window in current frame.
708 ;; At this stage, the buffer should now be visible on screen,
709 ;; although it won't have been made current.
711 ;; Need to select the buffer.
712 ;;
713 ;; First of all, check case 2 if buffer is in another frame
714 ;; but that frame may not be selected.
721 ;; The next few functions are copied from my (SJE) iswitchb library.
723 "Used by `ess-get-buffers-in-frames' to walk through all windows."
726 ;; Only add buf if it is not already in list.
727 ;; This prevents same buf in two different windows being
728 ;; put into the list twice.
733 "Return the list of buffers that are visible in the current frame.
734 If optional argument CURRENT is given, restrict searching to the
735 current frame, rather than all frames."
738 ess-bufs-in-frame))
741 "Return t if BUF is visible in current frame."
745 "Return t if BUF is visible in another frame.
746 Assumes that buffer has not already been in found in current frame."
749 nil))
755 "Returns t iff `ess-local-process-name' is associated with an
756 inferior-ess-ddeclient, and nil if the ess-process is running as an
757 ordinary inferior process. Alway nil on Unix machines."
765 "Wait for a prompt to appear at BOL of current buffer.
766 PROC is the ESS process. Does not change point"
771 ;; get output if there is some ready
773 ;; (if (and ess-microsoft-p ess-ms-slow)
774 ;; (accept-process-output proc 0 1500) ; Microsoft is slow
776 ;; )
789 ;; Insert the text, moving the process-marker.
797 "Send the ESS process command COM and delete the output
798 from the ESS process buffer. If an optional second argument BUF exists
799 save the output in that buffer. BUF is erased before use.
800 COM should have a terminating newline.
801 Guarantees that the value of .Last.value will be preserved.
802 When optional third arg SLEEP is non-nil, `(sleep-for (* a SLEEP))'
803 will be used in a few places where `a' is proportional to `ess-cmd-delay'."
804 ;; Use this function when you need to evaluate some S code, and the
805 ;; result is needed immediately. Waits until the output is ready
807 ;; the ddeclient-p checks needs to use the local-process-name
812 nil
817 ;; else: "normal", non-DDE behavior:
820 sbuffer
821 do-sleep end-of-output
822 oldpb oldpf oldpm
823 )
843 ;; need the buffer-local values in result buffer "buf":
848 ;; Output is now going to BUF:
854 ;; need time for ess-create-object-name-db on PC
856 ;;(if do-sleep (sleep-for (* 0.0 sleep))); microsoft: 0.5
858 ;; goto end, making sure final prompt is deleted
859 ;; FIXME? do this with much less code
865 ))
866 ;; Restore old values for process filter
872 "Replace all matches in STR for REGEXP with NEWTEXT string.
873 Optional LITERAL non-nil means do a literal replacement.
881 nil
883 newtext))
887 match prev-start)
891 rtn-str
893 rtn-str
910 ;; Invalid match num
924 ;;*;; Evaluating lines, paragraphs, regions, and buffers.
926 ;;--- The two basic building blocks [called by all other ess-eval..] are
927 ;; (ess-eval-linewise ....)
928 ;; and
929 ;; (ess-eval-region ....)
932 invisibly eob even-empty
933 wait-last-prompt sleep-sec timeout-ms)
934 ;; RDB 28/8/92 added optional arg eob
935 ;; AJR 971022: text-withtabs was text.
936 ;; MM 2006-08-23: added 'timeout-ms' -- but the effect seems "nil"
937 ;; MM 2007-01-05: added 'sleep-sec'
938 "Evaluate TEXT-WITHTABS in the ESS process buffer as if typed in w/o tabs.
939 Waits for prompt after each line of input, so won't break on large texts.
941 If optional second arg INVISIBLY is non-nil, don't echo commands. If it
942 is a string, just include that string. If optional third arg
943 EOB is non-nil go to end of ESS process buffer after evaluation. If
944 optional 4th arg EVEN-EMPTY is non-nil, also send empty text (e.g. an
945 empty line). If 5th arg WAIT-LAST-PROMPT is non-nil, also wait for
946 the prompt after the last line; if 6th arg SLEEP-SEC is a number, ESS
948 7th arg TIMEOUT-MS is set to number, it will be used instead of the
950 ;; but the effect is unclear
953 invisibly eob even-empty
955 ess-eval-ddeclient-sleep))
957 ;; else: "normal", non-DDE behavior:
959 ;; Use this to evaluate some code, but don't wait for output.
964 start-of-output
965 com pos txt-gt-0)
970 ;;(message "'ess-eval-linewise: sbuffer = %s" sbuffer)
973 ;; the following is required to make sure things work!
976 ;; dbg:
977 ;; dbg(ess-write-to-dribble-buffer
978 ;; dbg (format "(eval-visibly 1): lang %s (invis=%s, eob=%s, even-empty=%s)\n"
979 ;; dbg ess-language invisibly eob even-empty))
984 ;; dbg:
985 ;; dbg (ess-write-to-dribble-buffer
986 ;; dbg (format "(eval-visibly 2): text[%d]= '%s'\n" (length text) text))
988 even-empty)
995 ;; else 0-length text
997 )
1000 ;; Terrible kludge -- need to insert after all markers *except*`
1001 ;; the process mark
1007 ;; A kludge to prevent the delay between insert and process output
1008 ;; affecting the display. A case for a comint-send-input-hook?
1009 ;; (save-excursion
1010 ;; ;; comint-postoutput-scroll-to-bottom can change
1011 ;; ;; current-buffer. Argh.
1012 ;; (let ((functions comint-output-filter-functions))
1013 ;; (while functions
1014 ;; (funcall (car functions) com)
1015 ;; (setq functions (cdr functions)))))
1017 ;; wait for the prompt - after the last line of input only if wait-last:
1032 ;; Once SBUFFER is visible, we can then move the point in that
1033 ;; window to the end of the buffer.
1041 ;;;*;;; Evaluate only
1044 "Send the current region to the inferior ESS process.
1045 With prefix argument toggle the meaning of `ess-eval-visibly-p';
1046 this does not apply when using the S-plus GUI, see `ess-eval-region-ddeclient'."
1048 ;;(untabify (point-min) (point-max))
1049 ;;(untabify start end); do we really need to save-excursion?
1055 ;; else: "normal", non-DDE behavior:
1062 ;; else [almost always!]
1068 ;; return value
1072 "Send the current buffer to the inferior ESS process.
1073 Arg has same meaning as for `ess-eval-region'."
1078 "Send the current function to the inferior ESS process.
1079 Arg has same meaning as for `ess-eval-region'."
1085 name)
1092 ;; This is from Mary Lindstrom <lindstro@Biostat.Wisc.Edu>
1093 ;; 31 Aug 1995 14:11:43 To: S-mode@stat.math.ethz.ch
1095 "Send the current paragraph to the inferior ESS process.
1096 Prefix arg VIS toggles visibility of ess-code as for `ess-eval-region'."
1106 paragraph other to the inferior ESS process.
1107 Prefix arg VIS toggles visibility of ess-code as for `ess-eval-region'."
1112 name)
1119 ;; else: not in a function
1121 ))
1122 )
1125 "Send the current line to the inferior ESS process.
1126 Arg has same meaning as for `ess-eval-region'."
1137 ;; Contributed by Stephen Eglen <stephen@anc.ed.ac.uk> {idea from octave int.}
1139 "Move ARG lines of code forward (backward if ARG is negative).
1140 Skips past all empty and comment lines. Default for ARG is 1.
1142 On success, return 0. Otherwise, go as far as possible and return -1."
1154 n))
1159 possibly via prefix arg. If 2nd arg EVEN-EMPTY [prefix as well],
1160 also send empty lines. When the variable `ess-eval-empty' is non-nil
1161 both SIMPLE-NEXT and EVEN-EMPTY are interpreted as true."
1162 ;; From an idea by Rod Ball (rod@marcam.dsir.govt.nz)
1169 ;; go to end of process buffer so user can see result
1177 "Evaluate the current line invisibly and step to the next line.
1178 Evaluate all comments and empty lines."
1182 ;; goes to the real front, in case you do double function definition
1183 ;; 29-Jul-92 -FER
1184 ;; don't know why David changed it.
1186 ;; FER's versions don't work properly with nested functions. Replaced
1187 ;; mine. DMS 16 Nov 92
1189 ;;;*;;; Evaluate and switch to S
1192 "Send the current region to the inferior S and switch to the process buffer.
1193 Arg has same meaning as for `ess-eval-region'."
1199 "Send the current buffer to the inferior S and switch to the process buffer.
1200 Arg has same meaning as for `ess-eval-region'."
1206 "Send the current function to the inferior ESS process and switch to
1207 the process buffer. Arg has same meaning as for `ess-eval-region'."
1213 "Send the current line to the inferior ESS process and switch to the
1214 process buffer. Arg has same meaning as for `ess-eval-region'."
1220 "Send the current paragraph to the inferior ESS process and switch to the
1221 process buffer. Arg has same meaning as for `ess-eval-region'."
1227 "Send the current paragraph to the inferior ESS process and move forward to
1228 the next paragraph. Arg has same meaning as for `ess-eval-region'."
1232 )
1234 ;;; Related to the ess-eval-* commands, there are the ess-load
1235 ;;; commands. Need to add appropriate stuff...
1239 "Load an S source file into an inferior ESS process."
1252 ;; else
1256 ;; else: "normal", non-DDE behavior:
1258 ;; Find the process to load into
1265 error-occurred nomessage)
1276 ;; Load did not cause an error
1278 ;; There was a warning message from S
1280 ;; Consider deleting the file
1284 ess-keep-dump-files)
1300 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1301 ;;;; In this section:
1302 ;;;;
1303 ;;;; * The major mode inferior-ess-mode
1304 ;;;; * Process handling code
1305 ;;;; * Completion code
1306 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1308 ;;*;; Major mode definition
1311 nil
1314 ;; Code for XEmacs
1318 ;; Code for GNU Emacs
1321 ;; Use syntax valid *both* for GNU emacs and XEmacs :
1326 ;; the above OVERRIDES comint-dynamic-list-input-ring --> re-assign:
1335 ;;(define-key inferior-ess-mode-map "\C-c\C-a" 'ess-execute-attach)
1346 inferior-ess-mode-menu inferior-ess-mode-map
1347 "Menu for use in Inferior S mode"
1357 "------"
1361 "------"
1363 ;; need a toggle switch for above, AJR.
1366 "------"
1370 ))
1374 "Hook to install `ess-mode' menu for XEmacs (w/ easymenu)."
1385 ;; Code for XEmacs
1390 ;; Code for Emacs
1398 "Major mode for interacting with an inferior ESS process.
1399 Runs an S interactive job as a subprocess of Emacs, with I/O through an
1400 Emacs buffer. Variable `inferior-ess-program' controls which S
1401 is run.
1403 Commands are sent to the ESS process by typing them, and pressing
1405 completes known object names or filenames, as appropriate. Other
1406 keybindings for this mode are:
1411 `ess-load-file' keeps source files (if `ess-keep-dump-files' is non-nil) in
1412 the directory specified by `ess-source-directory', with the
1413 filename chosen according to `ess-dump-filename-template'. When a file is
1414 loaded, `ess-mode' parses error messages and jumps to the appropriate file
1415 if errors occur. The ess-eval- commands do not do this.
1417 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
1418 `inferior-ess-mode-hook' (in that order).
1420 You can send text to the inferior ESS process from other buffers containing
1421 S source. The key bindings of these commands can be found by typing
1422 C-h m (help for mode) in the other buffers.
1423 `ess-eval-region' sends the current region to the ESS process.
1424 `ess-eval-buffer' sends the current buffer to the ESS process.
1425 `ess-eval-function' sends the current function to the ESS process.
1426 `ess-eval-line' sends the current line to the ESS process.
1427 `ess-beginning-of-function' and `ess-end-of-function' move the point to
1428 the beginning and end of the current S function.
1429 `ess-switch-to-ESS' switches the current buffer to the ESS process buffer.
1430 `ess-switch-to-end-of-ESS' switches the current buffer to the ESS process
1431 buffer and puts point at the end of it.
1433 `ess-eval-region-and-go', `ess-eval-buffer-and-go',
1434 `ess-eval-function-and-go', and `ess-eval-line-and-go' switch to the S
1435 process buffer after sending their text.
1436 `ess-dump-object-into-edit-buffer' moves an S object into a temporary file
1437 and buffer for editing
1438 `ess-load-file' sources a file of commands to the ESS process.
1440 Commands:
1441 Return after the end of the process' output sends the text from the
1442 end of process to point.
1443 Return before the end of the process' output copies the sexp ending at point
1444 to the end of the process' output, and sends it.
1445 Delete converts tabs to spaces as it moves back.
1446 C-M-q does Tab on each line starting within following expression.
1447 Paragraphs are separated only by blank lines. Crosshatches start comments.
1449 to continue it."
1451 ;;(message " at very beg. of (inferior-ess-mode): inf.-ess-prompt= %s"
1452 ;; inferior-ess-prompt)
1454 ;;
1456 ;; SJE: is this the proper place for setting inferior-ess-prompt,
1457 ;; rather than within ess-multi? Tony - have you remembered yet
1458 ;; about the setq-default, as I changed it back to setq.
1460 ;; shouldn't be setq-default! And I've
1461 ;; forgotten why! (AJR)
1462 ;; Do not anchor to bol with `^'
1464 inferior-ess-primary-prompt
1466 inferior-ess-secondary-prompt
1476 ;; FIXME: need to do something if not set! Get from the proper place!
1477 )
1484 comint-process-echoes comint-input-sender))
1490 ;; Configuration for SAS/XLispStat input handling
1491 ;; We set comint-process-echoes to t because inferior-ess-input-sender
1492 ;; recopies the input. If comint-process-echoes was *meant* to be t ...
1493 ;;
1494 ;; except that XLS doesn't like it. This is an ugly hack that ought
1495 ;; to go into the dialect configuration...
1498 ;; Configuration for S/R input handling
1499 ;; AJR: add KH's fix. This is ugly, change to do it right.
1500 ;; i.e. put it as a buffer local var, in S or R defuns...
1501 ;;
1502 ;; SJE: Do you mean that we should put this code into (R) and the S
1503 ;; dialects? I agree that would be cleaner. e.g. in essd-r.el, for
1504 ;; the R defun we could have:
1505 ;; (inferior-ess r-start-args) ;; (R)
1506 ;; (setq comint-input-sender 'inferior-R-input-sender) ;; <<- add this.
1514 ;; Configuration for Stata input handling
1515 ;; AJR: Stata is hell. This is the primary configuration point.
1520 ;; Configuration for Omegahat input handling
1521 ;; SJE: cleanup
1523 ;; the following doesn't exist (until needed?)
1524 ;;(setq comint-input-sender 'inferior-OMG-input-sender)
1530 comint-process-echoes comint-input-sender))
1531 ;; Font-lock support
1532 ;; AJR: This (the following local-var is already the case!
1533 ;; KH sez: only in XEmacs :-(. (& Emacs 22.1, SJE).
1537 ;; SJE 2007-06-28: Emacs 22.1 has a bug in that comint-mode will set
1538 ;; this variable to t, when we need it to be nil. The Emacs 22
1539 ;; solution to this bug is to use define-dervied-mode to derive
1540 ;; inferior-ess-mode from comint-mode. Not sure if we can go down
1541 ;; that route yet. I've used the when condition so that if the var
1542 ;; is nil, don't bother setting it -- as setting it will make a new
1543 ;; local var.
1553 ;;; Completion support ----------------
1555 ;; SJE: comint-dynamic-complete-functions is regarded as a hook, rather
1556 ;; than a regular variable. Note order of completion (thanks David Brahm):
1565 ;; When a hook is buffer-local, the dummy function `t' is added to
1566 ;; indicate that the functions in the global value of the hook
1567 ;; should also be run. SJE: I have removed this, as I think it
1568 ;; interferes with our normal completion.
1571 ;; MM: in *R* in GNU emacs and in Xemacs, the c*-dyn*-compl*-fun* are now
1572 ;; (ess-complete-filename
1573 ;; ess-complete-object-name
1574 ;; comint-replace-by-expanded-history)
1576 ;; However this fails in Xemacs 21.4.17 where the value in *shell* is
1577 ;; -- the same as in GNU emacs *shell* :
1578 ;; (comint-replace-by-expanded-history shell-dynamic-complete-environment-variable shell-dynamic-complete-command shell-replace-by-expanded-directory comint-dynamic-complete-filename)
1580 ;; and the (Xemacs) global 'Default-value' is
1581 ;; (comint-replace-by-expanded-history comint-dynamic-complete-filename)
1583 ;; (setq comint-completion-addsuffix nil) ; To avoid spaces after filenames
1584 ;; KH: next 2 lines solve.
1590 ;;; Keep <tabs> out of the code.
1597 ;; SJE Tue 28 Dec 2004: do not attempt to load object name db.
1598 ;; (ess-load-object-name-db-file)
1599 ;; (sleep-for 0.5)
1606 ess-version)))
1608 ;;*;; Commands used exclusively in inferior-ess-mode
1610 ;;;*;;; Main user commands
1618 ;;> <PD writes>:
1619 ;;> Also, invoking help() from the command line may lead to confusing
1620 ;;> output, somewhat worse with R than with S. You're not really supposed
1621 ;;> to do that (use C-c C-v to invoke ess-display-help-on-object), but it's
1622 ;;> an obvious newcomer's mistake.
1623 ;;>
1624 ;;> (I wonder: could the elisp-code not quite easily recognize help
1625 ;;> calls (at least in the ?xxx form) and do the right thing automagically?)
1626 ;;>
1627 ;;> As promised, here is a quick hack:
1628 ;; ___hack much improved by MM___ , both help(.) and ?... now work
1629 ;; FIXME: Note that '??' nicely works in *R*, but
1630 ;; 'type ? topic' doesn't use ess-help {but display in *R*}
1636 ;; REALLY only for debugging: this S_L_O_W_S D_O_W_N [here AND below]
1637 ;;(ess-write-to-dribble-buffer (format "(inf..-R-..): string='%s'; " string))
1638 ;; rmh: 2002-01-12 catch page() in R
1645 ;; (ess-write-to-dribble-buffer (format " new string='%s'\n" string2))
1662 ;; else: normal command
1667 "Sends the command on the current line to the ESS process."
1675 "Return the ESS command surrounding point."
1696 command)))
1698 ;;;*;;; Hot key commands
1701 "Send the objects() command to the ESS process.
1702 By default, gives the objects at position 1.
1703 A prefix argument toggles the meaning of `ess-execute-in-process-buffer'.
1704 A prefix argument of 2 or more means get objects for that position.
1705 A negative prefix argument gets the objects for that position
1706 and toggles `ess-execute-in-process-buffer' as well."
1717 " ("
1722 ;;;; S4 Version
1723 ;;;; soup-up the interactive usage: allow modifications to a default pattern
1724 ;;(defun ess-execute-objects (posn)
1725 ;; "Send the `inferior-ess-objects-command' to the ESS process.
1726 ;;No prefix argument uses position 1 and pattern inferior-ess-objects-pattern.
1727 ;;A nonnegative prefix gets objects for that position and prompts for
1728 ;; the pattern.
1729 ;;A negative prefix also toggles ess-execute-in-process-buffer."
1730 ;; (interactive "P")
1731 ;; (ess-make-buffer-current)
1732 ;; (let* ((num-arg (if (listp posn) 1
1733 ;; (prefix-numeric-value posn)))
1734 ;; (the-posn (if (< num-arg 0) (- num-arg) num-arg))
1735 ;; (invert (< num-arg 0))
1736 ;; (pattern (if current-prefix-arg (read-string "Pattern (.*): ")
1737 ;; inferior-ess-objects-pattern))
1738 ;; (pattern (if (string= pattern "") ".*" pattern))
1739 ;; (the-command (format inferior-ess-objects-command the-posn pattern))
1740 ;; (the-message (concat ">>> Position "
1741 ;; the-posn
1742 ;; " ("
1743 ;; (nth (1- the-posn) (ess-search-list))
1744 ;; ") (pattern = "
1745 ;; pattern
1746 ;; ")\n")))
1747 ;; (ess-execute the-command invert "S objects" the-message)))
1750 "Send the `inferior-ess-search-list-command' command to the `ess-language' process.
1751 [search(..) in S]"
1756 "Attach a directory in the `ess-language' process with the attach() command.
1757 When used interactively, user is prompted for DIR to attach and
1758 prefix argument is used for POSN (or 2, if absent.)
1759 Doesn't work for data frames."
1772 This is a good thing to put in `ess-post-run-hook' --- for the S dialects."
1776 ;; when run inside an ESS process buffer, use that one
1786 "Send a command to the ESS process.
1787 A newline is automatically added to COMMAND. Prefix arg (or second arg
1788 INVERT) means invert the meaning of
1789 `ess-execute-in-process-buffer'. If INVERT is 'buffer, output is
1790 forced to go to the process buffer. If the output is going to a
1791 buffer, name it *BUFF*. This buffer is erased before use. Optional
1792 fourth arg MESSAGE is text to print at the top of the buffer (defaults
1793 to the command if BUFF is not given.)"
1796 nil
1797 ess-mode-minibuffer-map)
1798 current-prefix-arg))
1804 ess-execute-in-process-buffer)))
1814 ;; Print the command in the buffer if it has not been
1815 ;; given a special name
1817 ;;(make-local-variable 'ess-local-process-name)
1821 ;;;*;;; Quitting
1824 "Issue an exiting command to the inferior process, additionally
1838 ;;SJE - suggest no need to rename buffer upon exit.
1839 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1840 ))))
1843 "Issue an exiting command to an inferior R process, and optionally clean up.
1844 This version is for killing *R* processes; it asks the extra question
1845 regarding whether the workspace image should be saved."
1849 ;;Q response
1852 ;;Q (setq response (completing-read "Save workspace image? "
1853 ;;Q '( ( "yes".1) ("no" . 1) ("cancel" . 1))
1854 ;;Q nil t))
1855 ;;Q (if (string-equal response "")
1856 ;;Q (setq response "default")); which will ask again (in most situations)
1857 ;;Q (unless (string-equal response "cancel")
1859 ;;Q (setq cmd (format "q(\"%s\")\n" response))
1863 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1864 ;;Q )
1865 ))
1868 "Kill the ESS process, without executing .Last or terminating devices.
1870 ;;; Provided as a safety measure over the default binding of C-c C-z in
1871 ;;; comint-mode-map.
1874 (message "WARNING: \\[inferior-ess-exit-command] will not be executed and graphics devices won't finish properly!")
1881 "Possibly kill or offer to kill, depending on the value of
1882 `ess-S-quit-kill-buffers-p', all buffers associated with this ESS process.
1883 Leaves you in the ESS process buffer. It's a good idea to run this
1899 ;; Consider buffers for which
1900 ;; ess-local-process-name is the same as
1901 ;; the-procname
1903 ess-local-process-name
1910 "Function run just before an ESS process buffer is killed."
1911 ;; This simply deletes the buffers process to avoid an Emacs bug
1912 ;; where the sentinel is run *after* the buffer is deleted
1916 ;;*;; Object name completion
1918 ;;;*;;; The user completion command
1920 "Perform completion on `ess-language' object preceding point.
1921 The object is compared against those objects known by
1922 `ess-get-object-list' and any additional characters up to ambiguity are
1923 inserted. Completion only works on globally-known objects (including
1924 elements of attached data frames), and thus is most suitable for
1925 interactive command-line entry, and not so much for function editing
1926 since local objects (e.g. argument names) aren't known.
1929 This is done automatically (and transparently) if a directory is
1930 modified (S only!), so the most up-to-date list of object names is always
1931 available. However attached dataframes are *not* updated, so this
1932 command may be necessary if you modify an attached dataframe.
1934 If ARG is non-nil, no completion is attempted, but the available
1935 completions are listed [__UNIMPLEMENTED__]."
1950 ;; See if we're indexing a list with `$'
1952 full-prefix)
1961 ;; are we trying to get a slot via `@' ?
1963 full-prefix)
1972 pattern))
1979 ;; Default case: It hangs here when
1980 ;; options(error=recoves) :
1982 ;; always return a non-nil value to prevent history expansions
1986 "List all possible completions of the object name at point."
1990 ;;;*;;; Support functions
1992 "Return the object names in position POSN of ALIST.
1993 ALIST is an alist like `ess-sl-modtime-alist'. POSN should be in 1 .. (length
1994 ALIST). If optional third arg FORCE is t, the corresponding element
1995 of the search list is re-read. Otherwise it is only re-read if it's a
1996 directory and has been modified since it was last read."
2001 ;; Refresh the object listing if necessary
2007 "Return the last modtime if DIR is a directory, and nil otherwise."
2013 "Return the modtime of the S object OBJECT (a string).
2014 Searches along the search list for a file named OBJECT and returns its modtime
2015 Returns nil if that file cannot be found, i.e., for R or any non-S language!"
2017 result)
2021 object)))
2026 "Return t if MOD1 is later than MOD2."
2033 "Return a list of current S object names associated with process NAME,
2034 using `ess-object-list' if that is non-nil."
2043 ;;else
2045 )
2049 result)
2051 ;; Always force a re-read of position 1 :
2055 ;; Re-read remaining directories if necessary.
2064 "Evaluate the S command COMMAND, which returns a character vector.
2065 Return the elements of the result of COMMAND as an alist of strings.
2066 COMMAND should have a terminating newline."
2069 names)
2079 )
2084 ;;DBG, do *not* (i.e., comment):
2086 )
2092 names))
2095 "Return non-nil if DIR is an S object directory with special files.
2096 I.e. if the filenames in DIR are not representative of the objects in DIR."
2102 "Return alist of S object names in directory (or object) OBJ.
2103 If OBJ is a directory name (begins with `/') returns a listing of that dir.
2104 This may use the search list position POS if necessary.
2105 If OBJ is an object name, returns result of S command names(OBJ).
2106 If OBJ is nil or not a directory, POS must be supplied, and objects(POS) is returned.
2107 In all cases, the value is an list of object names."
2109 ;; FIXME: in both cases below, use the same fallback "objects(POS)" -- merge!
2111 ;; Check the pre-compiled object list in ess-object-name-db first
2113 ;; FIXME: If used at all, ess-object-name-db should not only
2114 ;; ----- be used in the directory case !!
2116 ;; Take a directory listing
2118 ;; first try .Data subdirectory:
2119 ;;FIXME: move ".Data" or ``this function'' to essd-sp6.el etc:
2125 ;; Get objects(pos) instead
2128 t)
2129 pos
2132 ;; "else" should really give an error!
2133 ;; would need pos = which(obj = search())
2135 ;; else
2139 obj))
2140 t)
2146 ;; get objects(pos)
2149 ; s4 needs 2
2150 ; args, rest only need 1 ?
2151 ; changes needed to allow for
2152 ; pattern argument to
2153 ; .SmodeObs
2156 "Return alist of S4 slot names of S4 object OBJ."
2160 ;;; SJE: Wed 29 Dec 2004 --- remove this function.
2161 ;;; rmh: Wed 5 Jan 2005 --- bring it back for use on Windows
2163 "Create a database of object names in standard S directories. This
2164 database is saved in the file specified by `ess-object-name-db-file',
2165 and is loaded when `ess-mode' is loaded. It defines the variable
2166 `ess-object-name-db', which is used for completions.
2168 Before you call this function, modify the S search list so that it contains
2169 all the non-changing (i.e. system) S directories. All positions of the search
2170 list except for position 1 are searched and stored in the database.
2172 After running this command, you should move ess-namedb.el to a directory in
2173 the `load-path'."
2178 name
2189 temp-object-name-db))
2193 temp-object-name-db pos))
2209 "Reread all directories/objects in variable `ess-search-list' to
2210 form completions."
2222 "Do file completion only within strings, or when ! call is being used."
2225 ;; (- comint-last-input-start 1) (point)) <- from S4 modeadds.
2226 ;; changed on 4/12/96 (dxsun)
2227 ;; This is sensible, but makes it hard to use history refs
2228 ;; (or
2229 ;; (save-excursion
2230 ;; (goto-char comint-last-input-start)
2231 ;; (looking-at "\\s-*!"))
2232 ;; (comint-within-quotes comint-last-input-start (point)))
2234 ;;DBG (ess-write-to-dribble-buffer "ess-complete-f.name: within-quotes")
2237 ;; GNU emacs and correctly working Xemacs:
2239 ;; always return t if in a string
2240 t)))
2243 ;; Heuristic: after partial pathname if it looks like we're in a
2244 ;; string, and that string looks like a pathname. Not the best for
2245 ;; use with unix() (or it's alias, !). Oh well.
2250 nil t)
2253 ;;*;; Functions handling the search list
2256 "Return the current search list as a list of strings.
2257 Elements which are apparently directories are expanded to full dirnames.
2266 ;; use cache:
2267 ess-search-list
2268 ;; else, re-compute:
2273 elt)
2276 ;; guaranteed by the initial space in its name: (buffer-disable-undo)
2283 ;;Dbg: (ess-write-to-dribble-buffer (format " .. elt= %s \t" elt))
2287 ;;Dbg: (ess-write-to-dribble-buffer "*IS* directory\n")
2289 ;;else
2290 ;;dbg
2291 ;;- (ess-write-to-dribble-buffer "not dir.\n")
2292 )
2297 result))))
2299 ;;; ess-sl-modtime-alist is a list with elements as follows:
2300 ;;; * key (directory or object name)
2301 ;;; * modtime (list of 2 integers)
2302 ;;; * name, name ... (accessible objects in search list posn labeled by key)
2303 ;;; It is a buffer-local variable (belonging to e.g. *R*, *S+6*, .. etc)
2304 ;;; and has the same number of elements and is in the same order as the
2305 ;;; S search list
2308 "Record the modification times of the directories in the search list,
2309 and the objects in those directories.
2310 The result is stored in `ess-sl-modtime-alist'."
2311 ;; Operation applies to process of current buffer
2314 posn
2315 newalist)
2320 newalist
2328 ))))))
2331 ;;DBG:
2340 "Check if input STR changed the search path.
2341 This function monitors user input to the inferior ESS process so that
2342 Emacs can keep the variable `ess-search-list' up to date. `completing-read' in
2344 for an object to dump."
2350 ;;;*;;; Routines for reading object names
2353 "Read an S object name from the minibuffer with completion, and return it.
2354 P-STRING is the prompt string."
2358 p-string))
2366 "Return the object name at point, or nil if none."
2369 ;; The following line circumvents an 18.57 bug in following-char
2371 ;; Get onto a symbol
2385 ;; The following line circumvents an 18.57 bug in following-char
2387 ;; Get onto a symbol
2399 ;;*;; Temporary buffer handling
2401 ;(defun ess-create-temp-buffer (name)
2402 ; "Create an empty buffer called NAME, but doesn't display it."
2403 ; (let ((buff (get-buffer-create name)))
2404 ; (save-excursion
2405 ; (set-buffer buff)
2406 ; (erase-buffer))
2407 ; buff))
2410 ;; Ed Kademan's version:
2411 ;From: Ed Kademan <kademan@phz.com>
2412 ;Subject: Re: ess-mode 5.1.16; search list
2413 ;To: rossini@biostat.washington.edu (A.J. Rossini)
2414 ;Cc: Martin Maechler <maechler@stat.math.ethz.ch>, ess-bugs@stat.math.ethz.ch
2415 ;Date: 26 Jul 2000 16:12:12 -0400
2416 ;
2417 ;Dear Tony Rossini,
2418 ;
2419 ;I was having trouble looking at the search list under ess. When I
2420 ;started up multiple inferior processes---each for a different
2421 ;dialect---ess-mode would issue the wrong variant of the "search"
2422 ;command when I typed C-c C-s. In case it is useful let me tell you
2423 ;what I did to get it to work for me.
2424 ;
2425 ;I added the component:
2426 ; (inferior-ess-search-list-command . "search()\n")
2427 ;to S+3-customize-alist and R-customize-alist, and then I redefined the
2428 ;ess-create-temp-buffer function as follows:
2430 "Create an empty buffer called NAME."
2437 buff))
2438 ;;These two steps seem to insure that the temporary buffer in which the
2439 ;;search results appear has the correct version of the local variables.
2440 ;;I am not that well acquainted with the ess code and don't know whether
2441 ;;this is a good fundamental way of fixing the problem, or even whether
2442 ;;or not this breaks some other feature of ess-mode that I never use.
2443 ;;Thanks for listening.
2444 ;;Ed K.
2445 ;;--
2446 ;;Ed Kademan 508.651.3700
2447 ;;PHZ Capital Partners 508.653.1745 (fax)
2448 ;;321 Commonwealth Road <kademan@phz.com>
2449 ;;Wayland, MA 01778
2454 "Display the buffer BUFF using `temp-buffer-show-function' and respecting
2455 `ess-display-buffer-reuse-frames'."
2459 ;;*;; Error messages
2462 "Something bad has happened.
2463 Display the S buffer, and cause an error displaying MSG."
2473 ;;; This file is automatically placed in Outline minor mode.
2474 ;;; The file is structured as follows:
2475 ;;; Chapters: ^L ;
2476 ;;; Sections: ;;*;;
2477 ;;; Subsections: ;;;*;;;
2478 ;;; Components: defuns, defvars, defconsts
2479 ;;; Random code beginning with a ;;;;* comment
2481 ;;; Local variables:
2482 ;;; mode: emacs-lisp
2483 ;;; outline-minor-mode: nil
2484 ;;; mode: outline-minor
2485 ;;; outline-regexp: "\^L\\|\\`;\\|;;\\*\\|;;;\\*\\|(def[cvu]\\|(setq\\|;;;;\\*"
2486 ;;; End:
2488 ;;; ess-inf.el ends here