| blob | 5fc2ad66ed4806c604dd276e6b90b6e03fb86def |
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--2005 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
57 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
58 ;;;; In this section:
59 ;;;;
60 ;;;; * User commands for starting an ESS process
61 ;;;; * Functions called at startup
62 ;;;; * Process handling code
63 ;;;; * Multiple process implementation
64 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
67 ;;*;; Starting a process
70 "Return name of process N, as a string, with NAME prepended."
78 "Start inferior ESS process.
80 Without a prefix argument, starts a new ESS process, or switches
81 to the ESS process associated with the current buffer.
82 With a prefix, starts the process with those args.
83 The current buffer is used if it is an `inferior-ess-mode'
84 or `ess-transcript-mode' buffer.
86 If `ess-ask-about-transfile' is non-nil, you will be asked for a
87 transcript file to use. If there is no transcript file, the buffer
88 name will be like *S* or *S2*.
90 Takes the program name from the variable `inferior-ess-program'.
91 An initialization file (dumped into the process) is specified by
92 `inferior-ess-start-file', and `inferior-ess-start-args' is used to
93 accompany the call for `inferior-ess-program'.
97 ;; Use the current buffer if it is in inferior-ess-mode or ess-trans-mode
98 ;; If not, maybe ask about starting directory and/or transcript file.
99 ;; If no transfile, use buffer *S*
100 ;;
101 ;; This function is primarily used to figure out the Process and
102 ;; buffer names to use for inferior-ess.
104 ;; Once, long ago, it was used for switching buffers, but we don't
105 ;; do that any more (at least not from here).
112 ;; set up for current language (need here, to get ess-language, etc).
114 ;; Couldn't we rather set all the default values or Local values now ?
115 ;;>>> (ess-setq-vars-default ess-customize-alist (current-buffer))
116 ;;>>> (ess-setq-vars-local ess-customize-alist (current-buffer))
117 ;;; AJR sez: I think we should set them later; don't want to nuke if
118 ;;; I don't have to.
119 ;;- MM: We shouldn't have to use ess-setq-vars-default _at all_ ;
120 ;; only do the buffer local ...-vars-local ones
122 ess-customize-alist))))
124 ess-customize-alist)))))
126 ;;- Is this needed? (no, but it's useful to see them there [MM])
128 ;; Hack to work around the following "default" (global) setting of vars:
129 ;; make sure our comint-... hack doesn't affect anything else
131 ;; now the abomination:
135 ;;>> Doesn't set ess-language,
136 ;;>> => comint-input-sender is not set to 'ess-input- ==> no input echo!
137 ;;>> => that's why things fail:
138 ;;>> (ess-setq-vars-local ess-customize-alist (current-buffer))
139 ;; ======
140 ;;MM --- why set them here again when already "(let ..)" above ?
141 ;; --> trying without (comment the following 4 lines):
142 ;; (setq temp-ess-dialect
143 ;; (eval(cdr(assoc 'ess-dialect ess-customize-alist))))
144 ;; (setq temp-ess-lang
145 ;; (eval(cdr(assoc 'ess-language ess-customize-alist))))
146 )
148 ;; run hooks now, to overwrite the above!
155 ess-directory default-directory))
164 ntry
165 temp-dialect)))))
173 procname
174 temp-dialect
175 buf-name-str))
177 ;; Since it's a new or terminated process, try to use current buffer
184 defdir))
189 ;; Not an ESS buffer yet
196 ;; Ask for transcript file and startdir
197 ;; FIXME -- this should be in ess-get-transfile
198 ;; AJR: Why? I'm not clear about the logic, i.e. when would it
199 ;; be used again, to justify?
204 defdir))
207 "Use transcript file (default none):"
212 transfilename)))))
218 ;; Now that we have the buffer, set buffer-local variables.
221 ;; Was: if not, set to null.
222 ;;(setq inferior-ess-start-args "")) ;; AJR: Errors with XLS?
223 ;; I think I might have solved this?
225 ;; Write out debug info
228 ess-language
229 ess-dialect
233 ess-start-args
234 inferior-ess-start-args))
237 ess-language
238 ess-dialect
239 inferior-ess-program
240 ess-current-process-name
241 ess-local-process-name))
243 ;; Start from the "right" directory
245 ;; Set up history
248 ;; initialize.
254 "The language/dialect specific command for listing objects.
255 It is initialized from the corresponding inferior-<lang>-objects-command
260 "The command to save the last value. See S section for more details.
265 "The command to retrieve the last value. See S section for more details.
269 ;;; A note on multiple processes: the following variables
270 ;;; ess-local-process-name
271 ;;; ess-search-list
272 ;;; ess-sl-modtime-alist
273 ;;; ess-sp-change
274 ;;; ess-prev-load-dir/file
275 ;;; ess-directory
276 ;;; ess-object-list
277 ;;; are specific to each ess-process and are buffer-local variables
278 ;;; local to the ESS process buffer. If required, these variables should
279 ;;; be accessed with the function ess-get-process-variable
282 "Start or switch to ESS process named NAME in the buffer BUFFER.
283 BUFFER is only needed if process NAME is not running. BUFFER must
284 exist. Default-directory is the ESS starting directory. BUFFER may be
285 visiting a file.
287 If ess-process NAME is running, switch to it. If not, use COMINT to
288 start up a new process, using NAME and BUFFER (which is needed if
289 there is no process NAME)."
297 ;; If ESS process NAME is running, switch to it
300 ;; Otherwise, crank up a new process
310 inf-ess-start-args comint-process-echoes))
315 inf-ess-start-args comint-process-echoes))
318 ;; load past history
322 ;; create and run process.
325 inf-ess-start-args))
329 proc-name
330 inf-ess-start-args
331 switches)
333 proc-name
334 inf-ess-start-args)))
335 ;; Set the process sentinel to save the history
337 ;; Add this process to ess-process-name-list, if needed
346 ;; Get search list when needed
349 ;; Add the process filter to catch certain output.
359 "Standard output filter for the inferior ESS process.
360 Ring Emacs bell if process output starts with an ASCII bell, and pass
361 the rest to `comint-output-filter'.
362 Taken from octave-mod.el."
366 "Strip leading `^G' character.
367 If STRING starts with a `^G', ring the Emacs bell and strip it.
368 Depending on the value of `visual-bell', either the frame will
369 flash or you'll hear a beep. Taken from octave-mod.el."
374 string)
378 "Sentinel for use with ESS processes.
379 This marks the process with a message, at a particular time point."
390 procname
391 inferior-ess-start-args
393 "Make an S comint process in buffer BUFNAME with process PROCNAME.
394 This was rewritten by KH in April 1996."
395 ;;; This function is a modification of make-comint from the comint.el
396 ;;; code of Olin Shivers.
399 ;; If no process, or nuked process, crank up a new one and put buffer in
400 ;; comint mode. Otherwise, leave buffer and existing process alone.
412 process-environment)))
416 buffer
417 procname
418 inferior-ess-program
419 inferior-ess-start-file
420 inferior-ess-start-args))
422 procname
423 inferior-ess-program
424 inferior-ess-start-file
426 inferior-ess-start-args)))))
427 buffer))
430 ;;*;; Requester functions called at startup
432 ;(defun ess-get-directory-ORIG (default)
433 ; "Request and return S starting directory."
434 ; (let ((the-dir
435 ; (expand-file-name
436 ; (file-name-as-directory
437 ; (read-file-name
438 ; (format "ESS [%s(%s): %s] starting data directory? "
439 ; ess-language ess-dialect inferior-ess-program)
440 ; (file-name-as-directory default)
441 ; (file-name-as-directory default) t nil)))))
442 ; (if (file-directory-p the-dir) nil
443 ; (error "%s is not a valid directory" the-dir))
444 ; the-dir))
448 default
450 ess-language ess-dialect inferior-ess-program)))
453 "`prompt' for a directory, using `default' as the usual."
458 ;; use XEmacs' read-directory-name if exists.
467 the-dir))
470 ;;*;; General process handling code
473 "Return the ESS process named by NAME."
482 "Wait until the ESS process is ready for input."
497 ;; above, except for Stata, which has "broken" i/o,
498 ;; sigh... (AJR)
505 ;;--- Unfinished idea (ESS-help / R-help ) -- probably not worth it...
506 ;;- (defun ess-set-inferior-program-name (filename)
507 ;;- "Allows to set or change `inferior-ess-program', the program (file)name."
508 ;;- (interactive "fR executable (script) file: ")
509 ;;- ;; "f" : existing file {file name completion} !
510 ;;- (setq inferior-ess-program filename))
511 ;; the inferior-ess-program is initialized in the customize..alist,
512 ;; e.g. from inferior-R-program-name ... --> should change rather these.
513 ;; However these really depend on the current ess-language!
514 ;; Plan: 1) must know and use ess-language
515 ;; 2) change the appropriate inferior-<ESSlang>-program-name
516 ;; (how?) in R/S : assign(paste("inferior-",ESSlang,"-p...."), filename))
518 ;;*;; Multiple process handling code
521 "Make the process associated with the current buffer the current ESS process.
522 Returns the name of the process, or nil if the current buffer has none."
526 ess-local-process-name)
529 "Return the variable VAR (symbol) local to ESS process called NAME (string)."
535 "Set variable VAR (symbol) local to ESS process called NAME (string) to VAL."
541 "Ask for a process, and make it the current ESS process.
542 Also switches to the process buffer unless NOSWITCH is non-nil. Interactively,
543 NOSWITCH can be set by giving a prefix argument.
544 Returns the name of the selected process."
551 ess-process-name-list
552 nil ; predicate
553 'require-match
554 ;; If in S buffer, don't offer current process
556 ess-language
557 ess-current-process-name
558 ;; maybe ess-local-process-name IF exists?
559 ))))
564 nil
566 proc))
569 "Make sure the current buffer is attached to an ESS process.
570 If not, or FORCE (prefix argument) is non-nil,
571 prompt for a process name with PROMPT.
572 `ess-local-process-name' is set to the name of the process selected.
573 `ess-dialect' is set to the dialect associated with the process selected."
577 nil ; do nothing
578 ;; Make sure the source buffer is attached to a process
581 ;; ess-local-process-name is nil -- which process to attach to
584 dialect)
592 "Force a switch to a new underlying process."
596 ;;*;;; Commands for switching to the process buffer
599 "Switch to the current inferior ESS process buffer.
600 With (prefix) EOB-P non-nil, positions cursor at end of buffer.
601 This function should follow the description in `ess-show-buffer'
602 for showing the iESS buffer, except that the iESS buffer is also
603 made current."
608 ;; Display the buffer, but don't select it yet.
611 t)
617 "Switch to the end of the inferior ESS process buffer."
622 "Return the buffer associated with the ESS process named by NAME."
626 "Remove names with no process."
633 ess-process-name-list)
637 defunct))
641 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
642 ;; ess-show-buffer
643 ;; Something like this almost works, but problems with XEmacs and Emacs
644 ;; differing implementations of the args to display-buffer make this
645 ;; too tough to pursue. The longer version below works.
646 ;; (defun ess-show-buffer (buf)
647 ;; "Display the buffer BUF, a string, but do not select it.
648 ;; Returns the window corresponding to the buffer."
649 ;; ;; On XEmacs, I get an error if third arg to display-buffer is t and
650 ;; ;; the BUF is in another frame. Emacs does not have this problem.
651 ;; (if (featurep 'xemacs)
652 ;; (display-buffer buf nil (get-frame-for-buffer buf))
653 ;; (display-buffer buf nil t)))
654 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
656 "Ensure the ESS buffer BUF is visible.
657 The buffer, specified as a string, is typically an iESS (e.g. *R*) buffer.
659 This handles several cases:
661 1. If BUF is visible in the current frame, nothing is done.
662 2. If BUF is visible in another frame, then we ensure that frame is
663 visible (it may have been iconified).
664 3. If buffer is not visible in any frame, simply show it in another window
665 in the current frame.
667 Iff VISIT is non-nil, as well as making BUF visible, we also select it
668 as the current buffer."
671 ;;1. Nothing to do, BUF visible in this frame; just return window
672 ;; where this buffer is.
673 t
675 ;; 2. Maybe BUF visible in another frame.
678 ;; BUF is visible in frame, so just check frame is raised.
680 ;; frame is not yet visible, so raise it.
682 ;; 3. else BUF not visible in any frame, so show it (but do
683 ;; not select it) in another window in current frame.
685 ;; At this stage, the buffer should now be visible on screen,
686 ;; although it won't have been made current.
689 ;; Need to select the buffer.
690 ;;
691 ;; First of all, check case 2 if buffer is in another frame
692 ;; but that frame may not be selected.
695 ;; need to select the frame
697 ;; reposition mouse to make frame active.
702 ;; The next few functions are copied from my (SJE) iswitchb library.
704 "Used by `ess-get-buffers-in-frames' to walk through all windows."
707 ;; Only add buf if it is not already in list.
708 ;; This prevents same buf in two different windows being
709 ;; put into the list twice.
714 "Return the list of buffers that are visible in the current frame.
715 If optional argument CURRENT is given, restrict searching to the
716 current frame, rather than all frames."
719 ess-bufs-in-frame))
722 "Return t if BUF is visible in current frame."
726 "Return t if BUF is visible in another frame.
727 Assumes that buffer has not already been in found in current frame."
730 nil))
736 "Returns t if the ess-local-process-name is associated with an
737 inferior-ess-ddeclient, and nil if the ess-process is running as an
738 ordinary inferior process. Alway nil on Unix machines."
746 "Wait for a prompt to appear at BOL of current buffer.
747 PROC is the ESS process. Does not change point"
752 ;; get output if there is some ready
754 ;; (if (and ess-microsoft-p ess-ms-slow)
755 ;; (accept-process-output proc 0 1500) ; Microsoft is slow
757 ;; )
770 ;; Insert the text, moving the process-marker.
778 "Send the ESS process command COM and delete the output
779 from the ESS process buffer. If an optional second argument BUF exists
780 save the output in that buffer. BUF is erased before use.
781 COM should have a terminating newline.
782 Guarantees that the value of .Last.value will be preserved.
783 When optional third arg SLEEP is non-nil, `(sleep-for (* a SLEEP))'
784 will be used in a few places where `a' is proportional to `ess-cmd-delay'."
785 ;; Use this function when you need to evaluate some S code, and the
786 ;; result is needed immediately. Waits until the output is ready
788 sbuffer
789 do-sleep end-of-output
790 oldpb oldpf oldpm
791 my-retr-cmd my-save-cmd)
812 ;; need the buffer-local values in result buffer "buf":
819 ;; Output is now going to BUF:
830 ;; need time for ess-create-object-name-db on PC
832 ;;(if do-sleep (sleep-for (* 0.0 sleep))); microsoft: 0.5
842 ;; Get rid out output from last assign
844 ;; Restore old values for process filter
850 "Replace all matches in STR for REGEXP with NEWTEXT string.
851 Optional LITERAL non-nil means do a literal replacement.
859 nil
861 newtext))
865 match prev-start)
869 rtn-str
871 rtn-str
888 ;; Invalid match num
902 ;;*;; Evaluating lines, paragraphs, regions, and buffers.
904 ;;--- The two basic building blocks [called by all other ess-eval..] are
905 ;; (ess-eval-linewise ....)
906 ;; and
907 ;; (ess-eval-region ....)
910 ;; RDB 28/8/92 added optional arg eob
911 ;; AJR 971022: text-withtabs was text.
912 "Evaluate TEXT-WITHTABS in the ESS process buffer as if typed in w/o tabs.
913 Waits for prompt after each line of input, so won't break on large texts.
915 If optional second arg INVISIBLY is non-nil, don't echo commands. If it
916 is a string, just include that string. If optional third arg
917 EOB is non-nil go to end of ESS process buffer after evaluation. If optional
918 4th arg EVEN-EMPTY is non-nil, also send empty text (e.g. an empty line)."
919 ;; Use this to evaluate some code, but don't wait for output.
924 start-of-output
925 com pos txt-gt-0)
927 ;;(message "'ess-eval-linewise: sbuffer = %s" sbuffer)
930 ;; the following is required to make sure things work!
933 ;; dbg:
934 ;; dbg(ess-write-to-dribble-buffer
935 ;; dbg (format "(eval-visibly 1): lang %s (invis=%s, eob=%s, even-empty=%s)\n"
936 ;; dbg ess-language invisibly eob even-empty))
941 ;; dbg:
942 ;; dbg (ess-write-to-dribble-buffer
943 ;; dbg (format "(eval-visibly 2): text[%d]= '%s'\n" (length text) text))
945 even-empty)
952 ;; else 0-length text
954 )
957 ;; Terrible kludge -- need to insert after all markers *except*`
958 ;; the process mark
964 ;; A kludge to prevent the delay between insert and process output
965 ;; affecting the display. A case for a comint-send-input-hook?
966 ;; (save-excursion
967 ;; ;; comint-postoutput-scroll-to-bottom can change
968 ;; ;; current-buffer. Argh.
969 ;; (let ((functions comint-output-filter-functions))
970 ;; (while functions
971 ;; (funcall (car functions) com)
972 ;; (setq functions (cdr functions)))))
974 ;; Don't hang around waiting for the prompt after the last
975 ;; line of input
977 nil
989 ;; Once SBUFFER is visible, we can then move the point in that
990 ;; window to the end of the buffer.
994 ))
996 ;;;*;;; Evaluate only
999 "Send the current region to the inferior ESS process.
1000 With prefix argument, toggle meaning of `ess-eval-visibly-p'."
1002 ;;(untabify (point-min) (point-max))
1003 ;;(untabify start end); do we really need to save-excursion?
1012 ;; else [almost always!]
1019 "Send the current buffer to the inferior ESS process.
1020 Arg has same meaning as for `ess-eval-region'."
1022 ;; already in eval-region:
1023 ;; (ess-force-buffer-current "Process to load into: ")
1027 "Send the current function to the inferior ESS process.
1028 Arg has same meaning as for `ess-eval-region'."
1030 ;; already in eval-region:
1031 ;; (ess-force-buffer-current "Process to load into: ")
1036 name)
1043 ;; This is from Mary Lindstrom <lindstro@Biostat.Wisc.Edu>
1044 ;; 31 Aug 1995 14:11:43 To: S-mode@stat.math.ethz.ch
1046 "Send the current paragraph to the inferior ESS process.
1047 Prefix arg VIS toggles visibility of ess-code as for `ess-eval-region'."
1057 "Send the current line to the inferior ESS process.
1058 Arg has same meaning as for `ess-eval-region'."
1070 ;; Contributed by Stephen Eglen <stephen@anc.ed.ac.uk> {idea from octave int.}
1072 "Move ARG lines of code forward (backward if ARG is negative).
1073 Skips past all empty and comment lines. Default for ARG is 1.
1075 On success, return 0. Otherwise, go as far as possible and return -1."
1087 n))
1092 possibly via prefix arg. If 2nd arg EVEN-EMPTY [prefix as well],
1093 also send empty lines. When the variable `ess-eval-empty' is non-nil
1094 both SIMPLE-NEXT and EVEN-EMPTY are interpreted as true."
1095 ;; From an idea by Rod Ball (rod@marcam.dsir.govt.nz)
1102 ;; go to end of process buffer so user can see result
1110 "Evaluate the current line invisibly and step to the next line.
1111 Evaluate all comments and empty lines."
1115 ;; goes to the real front, in case you do double function definition
1116 ;; 29-Jul-92 -FER
1117 ;; don't know why David changed it.
1119 ;; FER's versions don't work properly with nested functions. Replaced
1120 ;; mine. DMS 16 Nov 92
1122 ;;;*;;; Evaluate and switch to S
1125 "Send the current region to the inferior S and switch to the process buffer.
1126 Arg has same meaning as for `ess-eval-region'."
1132 "Send the current buffer to the inferior S and switch to the process buffer.
1133 Arg has same meaning as for `ess-eval-region'."
1139 "Send the current function to the inferior ESS process and switch to
1140 the process buffer. Arg has same meaning as for `ess-eval-region'."
1146 "Send the current line to the inferior ESS process and switch to the
1147 process buffer. Arg has same meaning as for `ess-eval-region'."
1152 ;;; Related to the ess-eval-* commands, there are the ess-load
1153 ;;; commands. Need to add appropriate stuff...
1156 "Load an S source file into an inferior ESS process."
1167 ;; Find the process to load into
1174 error-occurred nomessage)
1185 ;; Load did not cause an error
1187 ;; There was a warning message from S
1189 ;; Consider deleting the file
1193 ess-keep-dump-files)
1209 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1210 ;;;; In this section:
1211 ;;;;
1212 ;;;; * The major mode inferior-ess-mode
1213 ;;;; * Process handling code
1214 ;;;; * Completion code
1215 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1217 ;;*;; Major mode definition
1220 nil
1223 ;; Code for XEmacs
1227 ;; Code for GNU Emacs
1230 ;; Use syntax valid *both* for GNU emacs and XEmacs :
1235 ;; the above OVERRIDES comint-dynamic-list-input-ring --> re-assign:
1244 ;;(define-key inferior-ess-mode-map "\C-c\C-a" 'ess-execute-attach)
1255 inferior-ess-mode-menu inferior-ess-mode-map
1256 "Menu for use in Inferior S mode"
1266 "------"
1270 "------"
1272 ;; need a toggle switch for above, AJR.
1275 "------"
1279 ))
1283 "Hook to install `ess-mode' menu for XEmacs (w/ easymenu)."
1294 ;; Code for XEmacs
1299 ;; Code for Emacs
1307 "Major mode for interacting with an inferior ESS process.
1308 Runs an S interactive job as a subprocess of Emacs, with I/O through an
1309 Emacs buffer. Variable `inferior-ess-program' controls which S
1310 is run.
1312 Commands are sent to the ESS process by typing them, and pressing
1314 completes known object names or filenames, as appropriate. Other
1315 keybindings for this mode are:
1320 `ess-load-file' keeps source files (if `ess-keep-dump-files' is non-nil) in
1321 the directory specified by `ess-source-directory', with the
1322 filename chosen according to `ess-dump-filename-template'. When a file is
1323 loaded, `ess-mode' parses error messages and jumps to the appropriate file
1324 if errors occur. The ess-eval- commands do not do this.
1326 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
1327 `inferior-ess-mode-hook' (in that order).
1329 You can send text to the inferior ESS process from other buffers containing
1330 S source. The key bindings of these commands can be found by typing
1331 C-h m (help for mode) in the other buffers.
1332 `ess-eval-region' sends the current region to the ESS process.
1333 `ess-eval-buffer' sends the current buffer to the ESS process.
1334 `ess-eval-function' sends the current function to the ESS process.
1335 `ess-eval-line' sends the current line to the ESS process.
1336 `ess-beginning-of-function' and `ess-end-of-function' move the point to
1337 the beginning and end of the current S function.
1338 `ess-switch-to-ESS' switches the current buffer to the ESS process buffer.
1339 `ess-switch-to-end-of-ESS' switches the current buffer to the ESS process
1340 buffer and puts point at the end of it.
1342 `ess-eval-region-and-go', `ess-eval-buffer-and-go',
1343 `ess-eval-function-and-go', and `ess-eval-line-and-go' switch to the S
1344 process buffer after sending their text.
1345 `ess-dump-object-into-edit-buffer' moves an S object into a temporary file
1346 and buffer for editing
1347 `ess-load-file' sources a file of commands to the ESS process.
1349 Commands:
1350 Return after the end of the process' output sends the text from the
1351 end of process to point.
1352 Return before the end of the process' output copies the sexp ending at point
1353 to the end of the process' output, and sends it.
1354 Delete converts tabs to spaces as it moves back.
1355 C-M-q does Tab on each line starting within following expression.
1356 Paragraphs are separated only by blank lines. Crosshatches start comments.
1358 to continue it."
1360 ;;(message " at very beg. of (inferior-ess-mode): inf.-ess-prompt= %s"
1361 ;; inferior-ess-prompt)
1363 ;;
1365 ;; SJE: is this the proper place for setting inferior-ess-prompt,
1366 ;; rather than within ess-multi? Tony - have you remembered yet
1368 ;; about the setq-default, as I changed it back to setq.
1370 ;; shouldn't be setq-default! And I've
1371 ;; forgotten why! (AJR)
1372 ;; Do not anchor to bol with `^'
1374 inferior-ess-primary-prompt
1376 inferior-ess-secondary-prompt
1386 ; FIXME: need to do something if not set! Get from the proper place!
1387 )
1394 comint-process-echoes comint-input-sender))
1401 ;; Configuration for SAS/XLispStat input handling
1402 ;; We set comint-process-echoes to t because inferior-ess-input-sender
1403 ;; recopies the input. If comint-process-echoes was *meant* to be t ...
1404 ;;
1405 ;; except that XLS doesn't like it. This is an ugly hack that ought
1406 ;; to go into the dialect configuration...
1412 ;; Configuration for S/R input handling
1413 ;; AJR: add KH's fix. This is ugly, change to do it right.
1414 ;; i.e. put it as a buffer local var, in S or R defuns...
1428 ;; Configuration for Stata input handling
1429 ;; AJR: Stata is hell. This is the primary configuration point.
1435 ;; Configuration for Omegahat input handling
1438 ; the following doesn't exist (until needed?)
1439 ;(setq comint-input-sender 'inferior-OMG-input-sender)
1445 comint-process-echoes comint-input-sender))
1446 ;; Font-lock support
1447 ;; AJR: This (the following local-var is already the case!
1448 ;; KH sez: only in XEmacs :-(.
1459 ;; Completion support
1460 ;; SJE: comint-dynamic-complete-functions is regarded as a hook, rather
1461 ;; than a regular variable.
1471 ;; (setq comint-completion-addsuffix nil) ; To avoid spaces after filenames
1472 ;; KH: next 2 lines solve.
1478 ;;; Keep <tabs> out of the code.
1487 ;; SJE Tue 28 Dec 2004: do not attempt to load object name db.
1488 ;; (ess-load-object-name-db-file)
1489 ;; (sleep-for 0.5)
1496 ess-version)))
1498 ;;*;; Commands used exclusively in inferior-ess-mode
1500 ;;;*;;; Main user commands
1508 ;;> <PD writes>:
1509 ;;> Also, invoking help() from the command line may lead to confusing
1510 ;;> output, somewhat worse with R than with S. You're not really supposed
1511 ;;> to do that (use C-c C-v to invoke ess-display-help-on-object), but it's
1512 ;;> an obvious newcomer's mistake.
1513 ;;>
1514 ;;> (I wonder: could the elisp-code not quite easily recognize help
1515 ;;> calls (at least in the ?xxx form) and do the right thing automagically?)
1516 ;;>
1517 ;;> As promised, here is a quick hack:
1518 ;; ___hack much improved by MM___ , both help(.) and ?... now work
1519 ;; FIXME: Note that '??' nicely works in *R*, but
1520 ;; 'type ? topic' doesn't use ess-help {but display in *R*}
1526 ;; REALLY only for debugging: this S_L_O_W_S D_O_W_N [here AND below]
1527 ;;(ess-write-to-dribble-buffer (format "(inf..-R-..): string='%s'; " string))
1528 ;; rmh: 2002-01-12 catch page() in R
1535 ;; (ess-write-to-dribble-buffer (format " new string='%s'\n" string2))
1552 ;; else: normal command
1557 "Sends the command on the current line to the ESS process."
1565 "Return the ESS command surrounding point."
1586 command)))
1588 ;;;*;;; Hot key commands
1591 "Send the objects() command to the ESS process.
1592 By default, gives the objects at position 1.
1593 A prefix argument toggles the meaning of `ess-execute-in-process-buffer'.
1594 A prefix argument of 2 or more means get objects for that position.
1595 A negative prefix argument gets the objects for that position
1596 and toggles `ess-execute-in-process-buffer' as well."
1607 " ("
1612 ;;;; S4 Version
1613 ;;;; soup-up the interactive usage: allow modifications to a default pattern
1614 ;;(defun ess-execute-objects (posn)
1615 ;; "Send the `inferior-ess-objects-command' to the ESS process.
1616 ;;No prefix argument uses position 1 and pattern inferior-ess-objects-pattern.
1617 ;;A nonnegative prefix gets objects for that position and prompts for
1618 ;; the pattern.
1619 ;;A negative prefix also toggles ess-execute-in-process-buffer."
1620 ;; (interactive "P")
1621 ;; (ess-make-buffer-current)
1622 ;; (let* ((num-arg (if (listp posn) 1
1623 ;; (prefix-numeric-value posn)))
1624 ;; (the-posn (if (< num-arg 0) (- num-arg) num-arg))
1625 ;; (invert (< num-arg 0))
1626 ;; (pattern (if current-prefix-arg (read-string "Pattern (.*): ")
1627 ;; inferior-ess-objects-pattern))
1628 ;; (pattern (if (string= pattern "") ".*" pattern))
1629 ;; (the-command (format inferior-ess-objects-command the-posn pattern))
1630 ;; (the-message (concat ">>> Position "
1631 ;; the-posn
1632 ;; " ("
1633 ;; (nth (1- the-posn) (ess-search-list))
1634 ;; ") (pattern = "
1635 ;; pattern
1636 ;; ")\n")))
1637 ;; (ess-execute the-command invert "S objects" the-message)))
1640 "Send the `inferior-ess-search-list-command' command to the `ess-language' process.
1641 [search(..) in S]"
1646 "Attach a directory in the `ess-language' process with the attach() command.
1647 When used interactively, user is prompted for DIR to attach and
1648 prefix argument is used for POSN (or 2, if absent.)
1649 Doesn't work for data frames."
1662 This is a good thing to put in `ess-post-run-hook' --- for the S dialects."
1669 "Send a command to the ESS process.
1670 A newline is automatically added to COMMAND. Prefix arg (or second arg
1671 INVERT) means invert the meaning of
1672 `ess-execute-in-process-buffer'. If INVERT is 'buffer, output is
1673 forced to go to the process buffer. If the output is going to a
1674 buffer, name it *BUFF*. This buffer is erased before use. Optional
1675 fourth arg MESSAGE is text to print at the top of the buffer (defaults
1676 to the command if BUFF is not given.)"
1679 nil
1680 ess-mode-minibuffer-map)
1681 current-prefix-arg))
1687 ess-execute-in-process-buffer)))
1697 ;; Print the command in the buffer if it has not been
1698 ;; given a special name
1700 ;;(make-local-variable 'ess-local-process-name)
1704 ;;;*;;; Quitting
1707 "Issue an exiting command to the inferior process, additionally
1721 ;;SJE - suggest no need to rename buffer upon exit.
1722 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1723 ))))
1726 "Issue an exiting command to an inferior R process, and optionally clean up.
1727 This version is for killing *R* processes; it asks the extra question
1728 regarding whether the workspace image should be saved."
1732 ;;Q response
1735 ;;Q (setq response (completing-read "Save workspace image? "
1736 ;;Q '( ( "yes".1) ("no" . 1) ("cancel" . 1))
1737 ;;Q nil t))
1738 ;;Q (if (string-equal response "")
1739 ;;Q (setq response "default")); which will ask again (in most situations)
1740 ;;Q (unless (string-equal response "cancel")
1742 ;;Q (setq cmd (format "q(\"%s\")\n" response))
1746 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1747 ;;Q )
1748 ))
1751 "Kill the ESS process, without executing .Last or terminating devices.
1753 ;;; Provided as a safety measure over the default binding of C-c C-z in
1754 ;;; comint-mode-map.
1757 (message "WARNING: \\[inferior-ess-exit-command] will not be executed and graphics devices won't finish properly!")
1764 "Possibly kill or offer to kill, depending on the value of
1765 `ess-S-quit-kill-buffers-p', all buffers associated with this ESS process.
1766 Leaves you in the ESS process buffer. It's a good idea to run this
1782 ;; Consider buffers for which
1783 ;; ess-local-process-name is the same as
1784 ;; the-procname
1786 ess-local-process-name
1793 "Function run just before an ESS process buffer is killed."
1794 ;; This simply deletes the buffers process to avoid an Emacs bug
1795 ;; where the sentinel is run *after* the buffer is deleted
1799 ;;*;; Object name completion
1801 ;;;*;;; The user completion command
1803 "Perform completion on `ess-language' object preceding point.
1804 The object is compared against those objects known by
1805 `ess-get-object-list' and any additional characters up to ambiguity are
1806 inserted. Completion only works on globally-known objects (including
1807 elements of attached data frames), and thus is most suitable for
1808 interactive command-line entry, and not so much for function editing
1809 since local objects (e.g. argument names) aren't known.
1812 This is done automatically (and transparently) if a directory is
1813 modified (S only!), so the most up-to-date list of object names is always
1814 available. However attached dataframes are *not* updated, so this
1815 command may be necessary if you modify an attached dataframe.
1817 If ARG is non-nil, no completion is attempted, but the available
1818 completions are listed [__UNIMPLEMENTED__]."
1833 ;; See if we're indexing a list with `$'
1835 full-prefix)
1844 ;; are we trying to get a slot via `@' ?
1846 full-prefix)
1855 pattern))
1863 ;; always return a non-nil value to prevent history expansions
1867 "List all possible completions of the object name at point."
1871 ;;;*;;; Support functions
1873 "Return the object names in position POSN of ALIST.
1874 ALIST is an alist like `ess-sl-modtime-alist'. POSN should be in 1 .. (length
1875 ALIST). If optional third arg FORCE is t, the corresponding element
1876 of the search list is re-read. Otherwise it is only re-read if it's a
1877 directory and has been modified since it was last read."
1882 ;; Refresh the object listing if necessary
1888 "Return the last modtime if DIR is a directory, and nil otherwise."
1894 "Return the modtime of the S object OBJECT (a string).
1895 Searches along the search list for a file named OBJECT and returns its modtime
1896 Returns nil if that file cannot be found, i.e., for R or any non-S language!"
1898 result)
1902 object)))
1907 "Return t if MOD1 is later than MOD2."
1914 "Return a list of current S object names associated with process NAME,
1915 using `ess-object-list' if that is non-nil."
1924 ;;else
1926 )
1930 result)
1931 ;; Always force a re-read of position 1 :
1933 ;; Re-read remaining directories if necessary.
1942 "Evaluate the S command COMMAND, which returns a character vector.
1943 Return the elements of the result of COMMAND as an alist of strings.
1944 A newline is automatically added to COMMAND."
1947 names)
1957 )
1962 ;;DBG, do *not* (i.e., comment):
1964 )
1970 names))
1973 "Return non-nil if DIR is an S object directory with special files.
1974 I.e. if the filenames in DIR are not representative of the objects in DIR."
1980 "Return alist of S object names in directory (or object) OBJ.
1981 If OBJ is a directory name (begins with `/') returns a listing of that dir.
1982 This may use the search list position POS if necessary.
1983 If OBJ is an object name, returns result of S command names(OBJ).
1984 If OBJ is nil or not a directory, POS must be supplied, and objects(POS) is returned.
1985 In all cases, the value is an list of object names."
1987 ;; FIXME: in both cases below, use the same fallback "objects(POS)" -- merge!
1989 ;; Check the pre-compiled object list in ess-object-name-db first
1991 ;; FIXME: If used at all, ess-object-name-db should not only
1992 ;; ----- be used in the directory case !!
1994 ;; Take a directory listing
1996 ;; first try .Data subdirectory:
1997 ;;FIXME: move ".Data" or ``this function'' to essd-sp6.el etc:
2003 ;; Get objects(pos) instead
2006 t)
2007 pos
2010 ;; "else" should really give an error!
2011 ;; would need pos = which(obj = search())
2013 ;; else
2017 obj))
2018 t)
2024 ;; get objects(pos)
2027 ; s4 needs 2
2028 ; args, rest only need 1 ?
2029 ; changes needed to allow for
2030 ; pattern argument to
2031 ; .SmodeObs
2034 "Return alist of S4 slot names of S4 object OBJ."
2038 ;;; SJE: Wed 29 Dec 2004 --- remove this function.
2039 ;;; rmh: Wed 5 Jan 2005 --- bring it back for use on Windows
2041 "Create a database of object names in standard S directories. This
2042 database is saved in the file specified by `ess-object-name-db-file',
2043 and is loaded when `ess-mode' is loaded. It defines the variable
2044 `ess-object-name-db', which is used for completions.
2046 Before you call this function, modify the S search list so that it contains
2047 all the non-changing (i.e. system) S directories. All positions of the search
2048 list except for position 1 are searched and stored in the database.
2050 After running this command, you should move ess-namedb.el to a directory in
2051 the `load-path'."
2056 name
2067 temp-object-name-db))
2071 temp-object-name-db pos))
2087 "Reread all directories/objects in variable `ess-search-list' to
2088 form completions."
2100 ;; Do file completion only within strings, or when the ! call is being used
2103 ;; (- comint-last-input-start 1) (point)) <- from S4 modeadds.
2104 ;; changed on 4/12/96 (dxsun)
2105 ;; This is sensible, but makes it hard to use history refs
2106 ;; (or
2107 ;; (save-excursion
2108 ;; (goto-char comint-last-input-start)
2109 ;; (looking-at "\\s-*!"))
2110 ;; (comint-within-quotes comint-last-input-start (point)))
2113 ;; always return t if in a string
2114 t)))
2117 ;; Heuristic: after partial pathname if it looks like we're in a
2118 ;; string, and that string looks like a pathname. Not the best for
2119 ;; use with unix() (or it's alias, !). Oh well.
2124 nil t)
2127 ;;*;; Functions handling the search list
2130 "Return the current search list as a list of strings.
2131 Elements which are apparently directories are expanded to full dirnames.
2140 ;; use cache:
2141 ess-search-list
2142 ;; else, re-compute:
2146 elt)
2149 ;; guaranteed by the initial space in its name: (buffer-disable-undo)
2154 ;;Dbg: (ess-write-to-dribble-buffer (format " .. elt= %s \t" elt))
2158 ;;Dbg: (ess-write-to-dribble-buffer "*IS* directory\n")
2160 ;;else
2161 ;;dbg
2162 ;;- (ess-write-to-dribble-buffer "not dir.\n")
2163 )
2168 result))))
2170 ;;; ess-sl-modtime-alist is a list with elements as follows:
2171 ;;; * key (directory or object name)
2172 ;;; * modtime (list of 2 integers)
2173 ;;; * name, name ... (accessible objects in search list posn labeled by key)
2174 ;;; It is a buffer-local variable (belonging to e.g. *R*, *S+6*, .. etc)
2175 ;;; and has the same number of elements and is in the same order as the
2176 ;;; S search list
2179 "Record the modification times of the directories in the search list,
2180 and the objects in those directories.
2181 The result is stored in `ess-sl-modtime-alist'."
2182 ;; Operation applies to process of current buffer
2185 posn
2186 newalist)
2191 newalist
2199 ))))))
2202 ;;DBG:
2211 "Check if input STR changed the search path.
2212 This function monitors user input to the inferior ESS process so that
2213 Emacs can keep the variable `ess-search-list' up to date. `completing-read' in
2215 for an object to dump."
2221 ;;;*;;; Routines for reading object names
2224 "Read an S object name from the minibuffer with completion, and return it.
2225 P-STRING is the prompt string."
2229 p-string))
2237 "Return the object name at point, or nil if none."
2240 ;; The following line circumvents an 18.57 bug in following-char
2242 ;; Get onto a symbol
2256 ;; The following line circumvents an 18.57 bug in following-char
2258 ;; Get onto a symbol
2270 ;;*;; Temporary buffer handling
2272 ;(defun ess-create-temp-buffer (name)
2273 ; "Create an empty buffer called NAME, but doesn't display it."
2274 ; (let ((buff (get-buffer-create name)))
2275 ; (save-excursion
2276 ; (set-buffer buff)
2277 ; (erase-buffer))
2278 ; buff))
2281 ;; Ed Kademan's version:
2282 ;From: Ed Kademan <kademan@phz.com>
2283 ;Subject: Re: ess-mode 5.1.16; search list
2284 ;To: rossini@biostat.washington.edu (A.J. Rossini)
2285 ;Cc: Martin Maechler <maechler@stat.math.ethz.ch>, ess-bugs@stat.math.ethz.ch
2286 ;Date: 26 Jul 2000 16:12:12 -0400
2287 ;
2288 ;Dear Tony Rossini,
2289 ;
2290 ;I was having trouble looking at the search list under ess. When I
2291 ;started up multiple inferior processes---each for a different
2292 ;dialect---ess-mode would issue the wrong variant of the "search"
2293 ;command when I typed C-c C-s. In case it is useful let me tell you
2294 ;what I did to get it to work for me.
2295 ;
2296 ;I added the component:
2297 ; (inferior-ess-search-list-command . "search()\n")
2298 ;to S+3-customize-alist and R-customize-alist, and then I redefined the
2299 ;ess-create-temp-buffer function as follows:
2301 "Create an empty buffer called NAME."
2308 buff))
2309 ;;These two steps seem to insure that the temporary buffer in which the
2310 ;;search results appear has the correct version of the local variables.
2311 ;;I am not that well acquainted with the ess code and don't know whether
2312 ;;this is a good fundamental way of fixing the problem, or even whether
2313 ;;or not this breaks some other feature of ess-mode that I never use.
2314 ;;Thanks for listening.
2315 ;;Ed K.
2316 ;;--
2317 ;;Ed Kademan 508.651.3700
2318 ;;PHZ Capital Partners 508.653.1745 (fax)
2319 ;;321 Commonwealth Road <kademan@phz.com>
2320 ;;Wayland, MA 01778
2325 "Display the buffer BUFF using `temp-buffer-show-function'."
2328 ;;*;; Error messages
2331 "Something bad has happened.
2332 Display the S buffer, and cause an error displaying MSG."
2342 ;;; This file is automatically placed in Outline minor mode.
2343 ;;; The file is structured as follows:
2344 ;;; Chapters: ^L ;
2345 ;;; Sections: ;;*;;
2346 ;;; Subsections: ;;;*;;;
2347 ;;; Components: defuns, defvars, defconsts
2348 ;;; Random code beginning with a ;;;;* comment
2350 ;;; Local variables:
2351 ;;; mode: emacs-lisp
2352 ;;; outline-minor-mode: nil
2353 ;;; mode: outline-minor
2354 ;;; outline-regexp: "\^L\\|\\`;\\|;;\\*\\|;;;\\*\\|(def[cvu]\\|(setq\\|;;;;\\*"
2355 ;;; End:
2357 ;;; ess-inf.el ends here