| blob | 8929e2bad152deaad4b31dc18e7d1d36af91d03c |
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."
561 ;; else
565 ;; else
567 ess-process-name-list
568 nil ; predicate
569 'require-match
570 ;; If in S buffer, don't offer current process
572 ess-language
573 ess-current-process-name
574 ;; maybe ess-local-process-name IF exists?
575 )))))
580 nil
582 proc)))
586 "Make sure the current buffer is attached to an ESS process.
587 If not, or FORCE (prefix argument) is non-nil,
588 prompt for a process name with PROMPT.
589 `ess-local-process-name' is set to the name of the process selected.
590 `ess-dialect' is set to the dialect associated with the process selected."
594 nil ; do nothing
595 ;; Make sure the source buffer is attached to a process
598 ;; ess-local-process-name is nil -- which process to attach to
601 temp-ess-help-filetype
602 dialect)
612 "Force a switch to a new underlying process."
616 ;;*;;; Commands for switching to the process buffer
619 "Switch to the current inferior ESS process buffer.
620 With (prefix) EOB-P non-nil, positions cursor at end of buffer.
621 This function should follow the description in `ess-show-buffer'
622 for showing the iESS buffer, except that the iESS buffer is also
623 made current."
628 ;; Display the buffer, but don't select it yet.
631 t)
637 "Switch to the end of the inferior ESS process buffer."
642 "Return the buffer associated with the ESS process named by NAME."
646 "Remove names with no process."
653 ess-process-name-list)
657 defunct))
661 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
662 ;; ess-show-buffer
663 ;; Something like this almost works, but problems with XEmacs and Emacs
664 ;; differing implementations of the args to display-buffer make this
665 ;; too tough to pursue. The longer version below works.
666 ;; (defun ess-show-buffer (buf)
667 ;; "Display the buffer BUF, a string, but do not select it.
668 ;; Returns the window corresponding to the buffer."
669 ;; ;; On XEmacs, I get an error if third arg to display-buffer is t and
670 ;; ;; the BUF is in another frame. Emacs does not have this problem.
671 ;; (if (featurep 'xemacs)
672 ;; (display-buffer buf nil (get-frame-for-buffer buf))
673 ;; (display-buffer buf nil t)))
674 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
676 "Ensure the ESS buffer BUF is visible.
677 The buffer, specified as a string, is typically an iESS (e.g. *R*) buffer.
679 This handles several cases:
681 1. If BUF is visible in the current frame, nothing is done.
682 2. If BUF is visible in another frame, then we ensure that frame is
683 visible (it may have been iconified).
684 3. If buffer is not visible in any frame, simply show it in another window
685 in the current frame.
687 Iff VISIT is non-nil, as well as making BUF visible, we also select it
688 as the current buffer."
691 ;;1. Nothing to do, BUF visible in this frame; just return window
692 ;; where this buffer is.
693 t
695 ;; 2. Maybe BUF visible in another frame.
698 ;; BUF is visible in frame, so just check frame is raised.
700 ;; frame is not yet visible, so raise it.
702 ;; 3. else BUF not visible in any frame, so show it (but do
703 ;; not select it) in another window in current frame.
705 ;; At this stage, the buffer should now be visible on screen,
706 ;; although it won't have been made current.
708 ;; Need to select the buffer.
709 ;;
710 ;; First of all, check case 2 if buffer is in another frame
711 ;; but that frame may not be selected.
718 ;; The next few functions are copied from my (SJE) iswitchb library.
720 "Used by `ess-get-buffers-in-frames' to walk through all windows."
723 ;; Only add buf if it is not already in list.
724 ;; This prevents same buf in two different windows being
725 ;; put into the list twice.
730 "Return the list of buffers that are visible in the current frame.
731 If optional argument CURRENT is given, restrict searching to the
732 current frame, rather than all frames."
735 ess-bufs-in-frame))
738 "Return t if BUF is visible in current frame."
742 "Return t if BUF is visible in another frame.
743 Assumes that buffer has not already been in found in current frame."
746 nil))
752 "Returns t iff `ess-local-process-name' is associated with an
753 inferior-ess-ddeclient, and nil if the ess-process is running as an
754 ordinary inferior process. Alway nil on Unix machines."
762 "Wait for a prompt to appear at BOL of current buffer.
763 PROC is the ESS process. Does not change point"
768 ;; get output if there is some ready
770 ;; (if (and ess-microsoft-p ess-ms-slow)
771 ;; (accept-process-output proc 0 1500) ; Microsoft is slow
773 ;; )
786 ;; Insert the text, moving the process-marker.
794 "Send the ESS process command COM and delete the output
795 from the ESS process buffer. If an optional second argument BUF exists
796 save the output in that buffer. BUF is erased before use.
797 COM should have a terminating newline.
798 Guarantees that the value of .Last.value will be preserved.
799 When optional third arg SLEEP is non-nil, `(sleep-for (* a SLEEP))'
800 will be used in a few places where `a' is proportional to `ess-cmd-delay'."
801 ;; Use this function when you need to evaluate some S code, and the
802 ;; result is needed immediately. Waits until the output is ready
804 ;; the ddeclient-p checks needs to use the local-process-name
809 nil
814 ;; else: "normal", non-DDE behavior:
817 sbuffer
818 do-sleep end-of-output
819 oldpb oldpf oldpm
820 )
840 ;; need the buffer-local values in result buffer "buf":
845 ;; Output is now going to BUF:
851 ;; need time for ess-create-object-name-db on PC
853 ;;(if do-sleep (sleep-for (* 0.0 sleep))); microsoft: 0.5
855 ;; goto end, making sure final prompt is deleted
856 ;; FIXME? do this with much less code
862 ))
863 ;; Restore old values for process filter
869 "Replace all matches in STR for REGEXP with NEWTEXT string.
870 Optional LITERAL non-nil means do a literal replacement.
878 nil
880 newtext))
884 match prev-start)
888 rtn-str
890 rtn-str
907 ;; Invalid match num
921 ;;*;; Evaluating lines, paragraphs, regions, and buffers.
923 ;;--- The two basic building blocks [called by all other ess-eval..] are
924 ;; (ess-eval-linewise ....)
925 ;; and
926 ;; (ess-eval-region ....)
929 invisibly eob even-empty
930 wait-last-prompt sleep-sec timeout-ms)
931 ;; RDB 28/8/92 added optional arg eob
932 ;; AJR 971022: text-withtabs was text.
933 ;; MM 2006-08-23: added 'timeout-ms' -- but the effect seems "nil"
934 ;; MM 2007-01-05: added 'sleep-sec'
935 "Evaluate TEXT-WITHTABS in the ESS process buffer as if typed in w/o tabs.
936 Waits for prompt after each line of input, so won't break on large texts.
938 If optional second arg INVISIBLY is non-nil, don't echo commands. If it
939 is a string, just include that string. If optional third arg
940 EOB is non-nil go to end of ESS process buffer after evaluation. If
941 optional 4th arg EVEN-EMPTY is non-nil, also send empty text (e.g. an
942 empty line). If 5th arg WAIT-LAST-PROMPT is non-nil, also wait for
943 the prompt after the last line; if 6th arg SLEEP-SEC is a number, ESS
945 7th arg TIMEOUT-MS is set to number, it will be used instead of the
947 ;; but the effect is unclear
950 invisibly eob even-empty
952 ess-eval-ddeclient-sleep))
954 ;; else: "normal", non-DDE behavior:
956 ;; Use this to evaluate some code, but don't wait for output.
961 start-of-output
962 com pos txt-gt-0)
967 ;;(message "'ess-eval-linewise: sbuffer = %s" sbuffer)
970 ;; the following is required to make sure things work!
973 ;; dbg:
974 ;; dbg(ess-write-to-dribble-buffer
975 ;; dbg (format "(eval-visibly 1): lang %s (invis=%s, eob=%s, even-empty=%s)\n"
976 ;; dbg ess-language invisibly eob even-empty))
981 ;; dbg:
982 ;; dbg (ess-write-to-dribble-buffer
983 ;; dbg (format "(eval-visibly 2): text[%d]= '%s'\n" (length text) text))
985 even-empty)
992 ;; else 0-length text
994 )
997 ;; Terrible kludge -- need to insert after all markers *except*`
998 ;; the process mark
1004 ;; A kludge to prevent the delay between insert and process output
1005 ;; affecting the display. A case for a comint-send-input-hook?
1006 ;; (save-excursion
1007 ;; ;; comint-postoutput-scroll-to-bottom can change
1008 ;; ;; current-buffer. Argh.
1009 ;; (let ((functions comint-output-filter-functions))
1010 ;; (while functions
1011 ;; (funcall (car functions) com)
1012 ;; (setq functions (cdr functions)))))
1014 ;; wait for the prompt - after the last line of input only if wait-last:
1029 ;; Once SBUFFER is visible, we can then move the point in that
1030 ;; window to the end of the buffer.
1038 ;;;*;;; Evaluate only
1041 "Send the current region to the inferior ESS process.
1042 With prefix argument toggle the meaning of `ess-eval-visibly-p';
1043 this does not apply when using the S-plus GUI, see `ess-eval-region-ddeclient'."
1045 ;;(untabify (point-min) (point-max))
1046 ;;(untabify start end); do we really need to save-excursion?
1052 ;; else: "normal", non-DDE behavior:
1059 ;; else [almost always!]
1065 ;; return value
1069 "Send the current buffer to the inferior ESS process.
1070 Arg has same meaning as for `ess-eval-region'."
1075 "Send the current function to the inferior ESS process.
1076 Arg has same meaning as for `ess-eval-region'."
1082 name)
1089 ;; This is from Mary Lindstrom <lindstro@Biostat.Wisc.Edu>
1090 ;; 31 Aug 1995 14:11:43 To: S-mode@stat.math.ethz.ch
1092 "Send the current paragraph to the inferior ESS process.
1093 Prefix arg VIS toggles visibility of ess-code as for `ess-eval-region'."
1103 paragraph other to the inferior ESS process.
1104 Prefix arg VIS toggles visibility of ess-code as for `ess-eval-region'."
1109 name)
1116 ;; else: not in a function
1118 ))
1119 )
1122 "Send the current line to the inferior ESS process.
1123 Arg has same meaning as for `ess-eval-region'."
1134 ;; Contributed by Stephen Eglen <stephen@anc.ed.ac.uk> {idea from octave int.}
1136 "Move ARG lines of code forward (backward if ARG is negative).
1137 Skips past all empty and comment lines. Default for ARG is 1.
1139 On success, return 0. Otherwise, go as far as possible and return -1."
1151 n))
1156 possibly via prefix arg. If 2nd arg EVEN-EMPTY [prefix as well],
1157 also send empty lines. When the variable `ess-eval-empty' is non-nil
1158 both SIMPLE-NEXT and EVEN-EMPTY are interpreted as true."
1159 ;; From an idea by Rod Ball (rod@marcam.dsir.govt.nz)
1166 ;; go to end of process buffer so user can see result
1174 "Evaluate the current line invisibly and step to the next line.
1175 Evaluate all comments and empty lines."
1179 ;; goes to the real front, in case you do double function definition
1180 ;; 29-Jul-92 -FER
1181 ;; don't know why David changed it.
1183 ;; FER's versions don't work properly with nested functions. Replaced
1184 ;; mine. DMS 16 Nov 92
1186 ;;;*;;; Evaluate and switch to S
1189 "Send the current region to the inferior S and switch to the process buffer.
1190 Arg has same meaning as for `ess-eval-region'."
1196 "Send the current buffer to the inferior S and switch to the process buffer.
1197 Arg has same meaning as for `ess-eval-region'."
1203 "Send the current function to the inferior ESS process and switch to
1204 the process buffer. Arg has same meaning as for `ess-eval-region'."
1210 "Send the current line to the inferior ESS process and switch to the
1211 process buffer. Arg has same meaning as for `ess-eval-region'."
1217 "Send the current paragraph to the inferior ESS process and switch to the
1218 process buffer. Arg has same meaning as for `ess-eval-region'."
1224 "Send the current paragraph to the inferior ESS process and move forward to
1225 the next paragraph. Arg has same meaning as for `ess-eval-region'."
1229 )
1231 ;;; Related to the ess-eval-* commands, there are the ess-load
1232 ;;; commands. Need to add appropriate stuff...
1236 "Load an S source file into an inferior ESS process."
1249 ;; else
1253 ;; else: "normal", non-DDE behavior:
1255 ;; Find the process to load into
1262 error-occurred nomessage)
1273 ;; Load did not cause an error
1275 ;; There was a warning message from S
1277 ;; Consider deleting the file
1281 ess-keep-dump-files)
1297 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1298 ;;;; In this section:
1299 ;;;;
1300 ;;;; * The major mode inferior-ess-mode
1301 ;;;; * Process handling code
1302 ;;;; * Completion code
1303 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1305 ;;*;; Major mode definition
1308 nil
1311 ;; Code for XEmacs
1315 ;; Code for GNU Emacs
1318 ;; Use syntax valid *both* for GNU emacs and XEmacs :
1323 ;; the above OVERRIDES comint-dynamic-list-input-ring --> re-assign:
1332 ;;(define-key inferior-ess-mode-map "\C-c\C-a" 'ess-execute-attach)
1343 inferior-ess-mode-menu inferior-ess-mode-map
1344 "Menu for use in Inferior S mode"
1354 "------"
1358 "------"
1360 ;; need a toggle switch for above, AJR.
1363 "------"
1367 ))
1371 "Hook to install `ess-mode' menu for XEmacs (w/ easymenu)."
1382 ;; Code for XEmacs
1387 ;; Code for Emacs
1395 "Major mode for interacting with an inferior ESS process.
1396 Runs an S interactive job as a subprocess of Emacs, with I/O through an
1397 Emacs buffer. Variable `inferior-ess-program' controls which S
1398 is run.
1400 Commands are sent to the ESS process by typing them, and pressing
1402 completes known object names or filenames, as appropriate. Other
1403 keybindings for this mode are:
1408 `ess-load-file' keeps source files (if `ess-keep-dump-files' is non-nil) in
1409 the directory specified by `ess-source-directory', with the
1410 filename chosen according to `ess-dump-filename-template'. When a file is
1411 loaded, `ess-mode' parses error messages and jumps to the appropriate file
1412 if errors occur. The ess-eval- commands do not do this.
1414 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
1415 `inferior-ess-mode-hook' (in that order).
1417 You can send text to the inferior ESS process from other buffers containing
1418 S source. The key bindings of these commands can be found by typing
1419 C-h m (help for mode) in the other buffers.
1420 `ess-eval-region' sends the current region to the ESS process.
1421 `ess-eval-buffer' sends the current buffer to the ESS process.
1422 `ess-eval-function' sends the current function to the ESS process.
1423 `ess-eval-line' sends the current line to the ESS process.
1424 `ess-beginning-of-function' and `ess-end-of-function' move the point to
1425 the beginning and end of the current S function.
1426 `ess-switch-to-ESS' switches the current buffer to the ESS process buffer.
1427 `ess-switch-to-end-of-ESS' switches the current buffer to the ESS process
1428 buffer and puts point at the end of it.
1430 `ess-eval-region-and-go', `ess-eval-buffer-and-go',
1431 `ess-eval-function-and-go', and `ess-eval-line-and-go' switch to the S
1432 process buffer after sending their text.
1433 `ess-dump-object-into-edit-buffer' moves an S object into a temporary file
1434 and buffer for editing
1435 `ess-load-file' sources a file of commands to the ESS process.
1437 Commands:
1438 Return after the end of the process' output sends the text from the
1439 end of process to point.
1440 Return before the end of the process' output copies the sexp ending at point
1441 to the end of the process' output, and sends it.
1442 Delete converts tabs to spaces as it moves back.
1443 C-M-q does Tab on each line starting within following expression.
1444 Paragraphs are separated only by blank lines. Crosshatches start comments.
1446 to continue it."
1448 ;;(message " at very beg. of (inferior-ess-mode): inf.-ess-prompt= %s"
1449 ;; inferior-ess-prompt)
1451 ;;
1453 ;; SJE: is this the proper place for setting inferior-ess-prompt,
1454 ;; rather than within ess-multi? Tony - have you remembered yet
1456 ;; about the setq-default, as I changed it back to setq.
1458 ;; shouldn't be setq-default! And I've
1459 ;; forgotten why! (AJR)
1460 ;; Do not anchor to bol with `^'
1462 inferior-ess-primary-prompt
1464 inferior-ess-secondary-prompt
1474 ;; FIXME: need to do something if not set! Get from the proper place!
1475 )
1482 comint-process-echoes comint-input-sender))
1489 ;; Configuration for SAS/XLispStat input handling
1490 ;; We set comint-process-echoes to t because inferior-ess-input-sender
1491 ;; recopies the input. If comint-process-echoes was *meant* to be t ...
1492 ;;
1493 ;; except that XLS doesn't like it. This is an ugly hack that ought
1494 ;; to go into the dialect configuration...
1500 ;; Configuration for S/R input handling
1501 ;; AJR: add KH's fix. This is ugly, change to do it right.
1502 ;; i.e. put it as a buffer local var, in S or R defuns...
1516 ;; Configuration for Stata input handling
1517 ;; AJR: Stata is hell. This is the primary configuration point.
1523 ;; Configuration for Omegahat input handling
1526 ;; the following doesn't exist (until needed?)
1527 ;;(setq comint-input-sender 'inferior-OMG-input-sender)
1533 comint-process-echoes comint-input-sender))
1534 ;; Font-lock support
1535 ;; AJR: This (the following local-var is already the case!
1536 ;; KH sez: only in XEmacs :-(.
1547 ;;; Completion support ----------------
1549 ;; SJE: comint-dynamic-complete-functions is regarded as a hook, rather
1550 ;; than a regular variable. Note order of completion (thanks David Brahm):
1559 ;; When a hook is buffer-local, the dummy function `t' is added to
1560 ;; indicate that the functions in the global value of the hook
1561 ;; should also be run. SJE: I have removed this, as I think it
1562 ;; interferes with our normal completion.
1565 ;; MM: in *R* in GNU emacs and in Xemacs, the c*-dyn*-compl*-fun* are now
1566 ;; (ess-complete-filename
1567 ;; ess-complete-object-name
1568 ;; comint-replace-by-expanded-history)
1570 ;; However this fails in Xemacs 21.4.17 where the value in *shell* is
1571 ;; -- the same as in GNU emacs *shell* :
1572 ;; (comint-replace-by-expanded-history shell-dynamic-complete-environment-variable shell-dynamic-complete-command shell-replace-by-expanded-directory comint-dynamic-complete-filename)
1574 ;; and the (Xemacs) global 'Default-value' is
1575 ;; (comint-replace-by-expanded-history comint-dynamic-complete-filename)
1577 ;; (setq comint-completion-addsuffix nil) ; To avoid spaces after filenames
1578 ;; KH: next 2 lines solve.
1584 ;;; Keep <tabs> out of the code.
1593 ;; SJE Tue 28 Dec 2004: do not attempt to load object name db.
1594 ;; (ess-load-object-name-db-file)
1595 ;; (sleep-for 0.5)
1602 ess-version)))
1604 ;;*;; Commands used exclusively in inferior-ess-mode
1606 ;;;*;;; Main user commands
1614 ;;> <PD writes>:
1615 ;;> Also, invoking help() from the command line may lead to confusing
1616 ;;> output, somewhat worse with R than with S. You're not really supposed
1617 ;;> to do that (use C-c C-v to invoke ess-display-help-on-object), but it's
1618 ;;> an obvious newcomer's mistake.
1619 ;;>
1620 ;;> (I wonder: could the elisp-code not quite easily recognize help
1621 ;;> calls (at least in the ?xxx form) and do the right thing automagically?)
1622 ;;>
1623 ;;> As promised, here is a quick hack:
1624 ;; ___hack much improved by MM___ , both help(.) and ?... now work
1625 ;; FIXME: Note that '??' nicely works in *R*, but
1626 ;; 'type ? topic' doesn't use ess-help {but display in *R*}
1632 ;; REALLY only for debugging: this S_L_O_W_S D_O_W_N [here AND below]
1633 ;;(ess-write-to-dribble-buffer (format "(inf..-R-..): string='%s'; " string))
1634 ;; rmh: 2002-01-12 catch page() in R
1641 ;; (ess-write-to-dribble-buffer (format " new string='%s'\n" string2))
1658 ;; else: normal command
1663 "Sends the command on the current line to the ESS process."
1671 "Return the ESS command surrounding point."
1692 command)))
1694 ;;;*;;; Hot key commands
1697 "Send the objects() command to the ESS process.
1698 By default, gives the objects at position 1.
1699 A prefix argument toggles the meaning of `ess-execute-in-process-buffer'.
1700 A prefix argument of 2 or more means get objects for that position.
1701 A negative prefix argument gets the objects for that position
1702 and toggles `ess-execute-in-process-buffer' as well."
1713 " ("
1718 ;;;; S4 Version
1719 ;;;; soup-up the interactive usage: allow modifications to a default pattern
1720 ;;(defun ess-execute-objects (posn)
1721 ;; "Send the `inferior-ess-objects-command' to the ESS process.
1722 ;;No prefix argument uses position 1 and pattern inferior-ess-objects-pattern.
1723 ;;A nonnegative prefix gets objects for that position and prompts for
1724 ;; the pattern.
1725 ;;A negative prefix also toggles ess-execute-in-process-buffer."
1726 ;; (interactive "P")
1727 ;; (ess-make-buffer-current)
1728 ;; (let* ((num-arg (if (listp posn) 1
1729 ;; (prefix-numeric-value posn)))
1730 ;; (the-posn (if (< num-arg 0) (- num-arg) num-arg))
1731 ;; (invert (< num-arg 0))
1732 ;; (pattern (if current-prefix-arg (read-string "Pattern (.*): ")
1733 ;; inferior-ess-objects-pattern))
1734 ;; (pattern (if (string= pattern "") ".*" pattern))
1735 ;; (the-command (format inferior-ess-objects-command the-posn pattern))
1736 ;; (the-message (concat ">>> Position "
1737 ;; the-posn
1738 ;; " ("
1739 ;; (nth (1- the-posn) (ess-search-list))
1740 ;; ") (pattern = "
1741 ;; pattern
1742 ;; ")\n")))
1743 ;; (ess-execute the-command invert "S objects" the-message)))
1746 "Send the `inferior-ess-search-list-command' command to the `ess-language' process.
1747 [search(..) in S]"
1752 "Attach a directory in the `ess-language' process with the attach() command.
1753 When used interactively, user is prompted for DIR to attach and
1754 prefix argument is used for POSN (or 2, if absent.)
1755 Doesn't work for data frames."
1768 This is a good thing to put in `ess-post-run-hook' --- for the S dialects."
1772 ;; when run inside an ESS process buffer, use that one
1782 "Send a command to the ESS process.
1783 A newline is automatically added to COMMAND. Prefix arg (or second arg
1784 INVERT) means invert the meaning of
1785 `ess-execute-in-process-buffer'. If INVERT is 'buffer, output is
1786 forced to go to the process buffer. If the output is going to a
1787 buffer, name it *BUFF*. This buffer is erased before use. Optional
1788 fourth arg MESSAGE is text to print at the top of the buffer (defaults
1789 to the command if BUFF is not given.)"
1792 nil
1793 ess-mode-minibuffer-map)
1794 current-prefix-arg))
1800 ess-execute-in-process-buffer)))
1810 ;; Print the command in the buffer if it has not been
1811 ;; given a special name
1813 ;;(make-local-variable 'ess-local-process-name)
1817 ;;;*;;; Quitting
1820 "Issue an exiting command to the inferior process, additionally
1834 ;;SJE - suggest no need to rename buffer upon exit.
1835 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1836 ))))
1839 "Issue an exiting command to an inferior R process, and optionally clean up.
1840 This version is for killing *R* processes; it asks the extra question
1841 regarding whether the workspace image should be saved."
1845 ;;Q response
1848 ;;Q (setq response (completing-read "Save workspace image? "
1849 ;;Q '( ( "yes".1) ("no" . 1) ("cancel" . 1))
1850 ;;Q nil t))
1851 ;;Q (if (string-equal response "")
1852 ;;Q (setq response "default")); which will ask again (in most situations)
1853 ;;Q (unless (string-equal response "cancel")
1855 ;;Q (setq cmd (format "q(\"%s\")\n" response))
1859 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1860 ;;Q )
1861 ))
1864 "Kill the ESS process, without executing .Last or terminating devices.
1866 ;;; Provided as a safety measure over the default binding of C-c C-z in
1867 ;;; comint-mode-map.
1870 (message "WARNING: \\[inferior-ess-exit-command] will not be executed and graphics devices won't finish properly!")
1877 "Possibly kill or offer to kill, depending on the value of
1878 `ess-S-quit-kill-buffers-p', all buffers associated with this ESS process.
1879 Leaves you in the ESS process buffer. It's a good idea to run this
1895 ;; Consider buffers for which
1896 ;; ess-local-process-name is the same as
1897 ;; the-procname
1899 ess-local-process-name
1906 "Function run just before an ESS process buffer is killed."
1907 ;; This simply deletes the buffers process to avoid an Emacs bug
1908 ;; where the sentinel is run *after* the buffer is deleted
1912 ;;*;; Object name completion
1914 ;;;*;;; The user completion command
1916 "Perform completion on `ess-language' object preceding point.
1917 The object is compared against those objects known by
1918 `ess-get-object-list' and any additional characters up to ambiguity are
1919 inserted. Completion only works on globally-known objects (including
1920 elements of attached data frames), and thus is most suitable for
1921 interactive command-line entry, and not so much for function editing
1922 since local objects (e.g. argument names) aren't known.
1925 This is done automatically (and transparently) if a directory is
1926 modified (S only!), so the most up-to-date list of object names is always
1927 available. However attached dataframes are *not* updated, so this
1928 command may be necessary if you modify an attached dataframe.
1930 If ARG is non-nil, no completion is attempted, but the available
1931 completions are listed [__UNIMPLEMENTED__]."
1946 ;; See if we're indexing a list with `$'
1948 full-prefix)
1957 ;; are we trying to get a slot via `@' ?
1959 full-prefix)
1968 pattern))
1975 ;; Default case: It hangs here when
1976 ;; options(error=recoves) :
1978 ;; always return a non-nil value to prevent history expansions
1982 "List all possible completions of the object name at point."
1986 ;;;*;;; Support functions
1988 "Return the object names in position POSN of ALIST.
1989 ALIST is an alist like `ess-sl-modtime-alist'. POSN should be in 1 .. (length
1990 ALIST). If optional third arg FORCE is t, the corresponding element
1991 of the search list is re-read. Otherwise it is only re-read if it's a
1992 directory and has been modified since it was last read."
1997 ;; Refresh the object listing if necessary
2003 "Return the last modtime if DIR is a directory, and nil otherwise."
2009 "Return the modtime of the S object OBJECT (a string).
2010 Searches along the search list for a file named OBJECT and returns its modtime
2011 Returns nil if that file cannot be found, i.e., for R or any non-S language!"
2013 result)
2017 object)))
2022 "Return t if MOD1 is later than MOD2."
2029 "Return a list of current S object names associated with process NAME,
2030 using `ess-object-list' if that is non-nil."
2039 ;;else
2041 )
2045 result)
2047 ;; Always force a re-read of position 1 :
2051 ;; Re-read remaining directories if necessary.
2060 "Evaluate the S command COMMAND, which returns a character vector.
2061 Return the elements of the result of COMMAND as an alist of strings.
2062 COMMAND should have a terminating newline."
2065 names)
2075 )
2080 ;;DBG, do *not* (i.e., comment):
2082 )
2088 names))
2091 "Return non-nil if DIR is an S object directory with special files.
2092 I.e. if the filenames in DIR are not representative of the objects in DIR."
2098 "Return alist of S object names in directory (or object) OBJ.
2099 If OBJ is a directory name (begins with `/') returns a listing of that dir.
2100 This may use the search list position POS if necessary.
2101 If OBJ is an object name, returns result of S command names(OBJ).
2102 If OBJ is nil or not a directory, POS must be supplied, and objects(POS) is returned.
2103 In all cases, the value is an list of object names."
2105 ;; FIXME: in both cases below, use the same fallback "objects(POS)" -- merge!
2107 ;; Check the pre-compiled object list in ess-object-name-db first
2109 ;; FIXME: If used at all, ess-object-name-db should not only
2110 ;; ----- be used in the directory case !!
2112 ;; Take a directory listing
2114 ;; first try .Data subdirectory:
2115 ;;FIXME: move ".Data" or ``this function'' to essd-sp6.el etc:
2121 ;; Get objects(pos) instead
2124 t)
2125 pos
2128 ;; "else" should really give an error!
2129 ;; would need pos = which(obj = search())
2131 ;; else
2135 obj))
2136 t)
2142 ;; get objects(pos)
2145 ; s4 needs 2
2146 ; args, rest only need 1 ?
2147 ; changes needed to allow for
2148 ; pattern argument to
2149 ; .SmodeObs
2152 "Return alist of S4 slot names of S4 object OBJ."
2156 ;;; SJE: Wed 29 Dec 2004 --- remove this function.
2157 ;;; rmh: Wed 5 Jan 2005 --- bring it back for use on Windows
2159 "Create a database of object names in standard S directories. This
2160 database is saved in the file specified by `ess-object-name-db-file',
2161 and is loaded when `ess-mode' is loaded. It defines the variable
2162 `ess-object-name-db', which is used for completions.
2164 Before you call this function, modify the S search list so that it contains
2165 all the non-changing (i.e. system) S directories. All positions of the search
2166 list except for position 1 are searched and stored in the database.
2168 After running this command, you should move ess-namedb.el to a directory in
2169 the `load-path'."
2174 name
2185 temp-object-name-db))
2189 temp-object-name-db pos))
2205 "Reread all directories/objects in variable `ess-search-list' to
2206 form completions."
2218 "Do file completion only within strings, or when ! call is being used."
2221 ;; (- comint-last-input-start 1) (point)) <- from S4 modeadds.
2222 ;; changed on 4/12/96 (dxsun)
2223 ;; This is sensible, but makes it hard to use history refs
2224 ;; (or
2225 ;; (save-excursion
2226 ;; (goto-char comint-last-input-start)
2227 ;; (looking-at "\\s-*!"))
2228 ;; (comint-within-quotes comint-last-input-start (point)))
2230 ;;DBG (ess-write-to-dribble-buffer "ess-complete-f.name: within-quotes")
2233 ;; GNU emacs and correctly working Xemacs:
2235 ;; always return t if in a string
2236 t)))
2239 ;; Heuristic: after partial pathname if it looks like we're in a
2240 ;; string, and that string looks like a pathname. Not the best for
2241 ;; use with unix() (or it's alias, !). Oh well.
2246 nil t)
2249 ;;*;; Functions handling the search list
2252 "Return the current search list as a list of strings.
2253 Elements which are apparently directories are expanded to full dirnames.
2262 ;; use cache:
2263 ess-search-list
2264 ;; else, re-compute:
2269 elt)
2272 ;; guaranteed by the initial space in its name: (buffer-disable-undo)
2279 ;;Dbg: (ess-write-to-dribble-buffer (format " .. elt= %s \t" elt))
2283 ;;Dbg: (ess-write-to-dribble-buffer "*IS* directory\n")
2285 ;;else
2286 ;;dbg
2287 ;;- (ess-write-to-dribble-buffer "not dir.\n")
2288 )
2293 result))))
2295 ;;; ess-sl-modtime-alist is a list with elements as follows:
2296 ;;; * key (directory or object name)
2297 ;;; * modtime (list of 2 integers)
2298 ;;; * name, name ... (accessible objects in search list posn labeled by key)
2299 ;;; It is a buffer-local variable (belonging to e.g. *R*, *S+6*, .. etc)
2300 ;;; and has the same number of elements and is in the same order as the
2301 ;;; S search list
2304 "Record the modification times of the directories in the search list,
2305 and the objects in those directories.
2306 The result is stored in `ess-sl-modtime-alist'."
2307 ;; Operation applies to process of current buffer
2310 posn
2311 newalist)
2316 newalist
2324 ))))))
2327 ;;DBG:
2336 "Check if input STR changed the search path.
2337 This function monitors user input to the inferior ESS process so that
2338 Emacs can keep the variable `ess-search-list' up to date. `completing-read' in
2340 for an object to dump."
2346 ;;;*;;; Routines for reading object names
2349 "Read an S object name from the minibuffer with completion, and return it.
2350 P-STRING is the prompt string."
2354 p-string))
2362 "Return the object name at point, or nil if none."
2365 ;; The following line circumvents an 18.57 bug in following-char
2367 ;; Get onto a symbol
2381 ;; The following line circumvents an 18.57 bug in following-char
2383 ;; Get onto a symbol
2395 ;;*;; Temporary buffer handling
2397 ;(defun ess-create-temp-buffer (name)
2398 ; "Create an empty buffer called NAME, but doesn't display it."
2399 ; (let ((buff (get-buffer-create name)))
2400 ; (save-excursion
2401 ; (set-buffer buff)
2402 ; (erase-buffer))
2403 ; buff))
2406 ;; Ed Kademan's version:
2407 ;From: Ed Kademan <kademan@phz.com>
2408 ;Subject: Re: ess-mode 5.1.16; search list
2409 ;To: rossini@biostat.washington.edu (A.J. Rossini)
2410 ;Cc: Martin Maechler <maechler@stat.math.ethz.ch>, ess-bugs@stat.math.ethz.ch
2411 ;Date: 26 Jul 2000 16:12:12 -0400
2412 ;
2413 ;Dear Tony Rossini,
2414 ;
2415 ;I was having trouble looking at the search list under ess. When I
2416 ;started up multiple inferior processes---each for a different
2417 ;dialect---ess-mode would issue the wrong variant of the "search"
2418 ;command when I typed C-c C-s. In case it is useful let me tell you
2419 ;what I did to get it to work for me.
2420 ;
2421 ;I added the component:
2422 ; (inferior-ess-search-list-command . "search()\n")
2423 ;to S+3-customize-alist and R-customize-alist, and then I redefined the
2424 ;ess-create-temp-buffer function as follows:
2426 "Create an empty buffer called NAME."
2433 buff))
2434 ;;These two steps seem to insure that the temporary buffer in which the
2435 ;;search results appear has the correct version of the local variables.
2436 ;;I am not that well acquainted with the ess code and don't know whether
2437 ;;this is a good fundamental way of fixing the problem, or even whether
2438 ;;or not this breaks some other feature of ess-mode that I never use.
2439 ;;Thanks for listening.
2440 ;;Ed K.
2441 ;;--
2442 ;;Ed Kademan 508.651.3700
2443 ;;PHZ Capital Partners 508.653.1745 (fax)
2444 ;;321 Commonwealth Road <kademan@phz.com>
2445 ;;Wayland, MA 01778
2450 "Display the buffer BUFF using `temp-buffer-show-function' and respecting
2451 `ess-display-buffer-reuse-frames'."
2455 ;;*;; Error messages
2458 "Something bad has happened.
2459 Display the S buffer, and cause an error displaying MSG."
2469 ;;; This file is automatically placed in Outline minor mode.
2470 ;;; The file is structured as follows:
2471 ;;; Chapters: ^L ;
2472 ;;; Sections: ;;*;;
2473 ;;; Subsections: ;;;*;;;
2474 ;;; Components: defuns, defvars, defconsts
2475 ;;; Random code beginning with a ;;;;* comment
2477 ;;; Local variables:
2478 ;;; mode: emacs-lisp
2479 ;;; outline-minor-mode: nil
2480 ;;; mode: outline-minor
2481 ;;; outline-regexp: "\^L\\|\\`;\\|;;\\*\\|;;;\\*\\|(def[cvu]\\|(setq\\|;;;;\\*"
2482 ;;; End:
2484 ;;; ess-inf.el ends here