| blob | 0372b7c8365ce274c991bc7d616d6351acb4f4ad |
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
355 "Sentinel for use with ESS processes.
356 This marks the process with a message, at a particular time point."
367 procname
368 inferior-ess-start-args
370 "Make an S comint process in buffer BUFNAME with process PROCNAME.
371 This was rewritten by KH in April 1996."
372 ;;; This function is a modification of make-comint from the comint.el
373 ;;; code of Olin Shivers.
376 ;; If no process, or nuked process, crank up a new one and put buffer in
377 ;; comint mode. Otherwise, leave buffer and existing process alone.
389 process-environment)))
393 buffer
394 procname
395 inferior-ess-program
396 inferior-ess-start-file
397 inferior-ess-start-args))
399 procname
400 inferior-ess-program
401 inferior-ess-start-file
403 inferior-ess-start-args)))))
404 buffer))
407 ;;*;; Requester functions called at startup
409 ;(defun ess-get-directory-ORIG (default)
410 ; "Request and return S starting directory."
411 ; (let ((the-dir
412 ; (expand-file-name
413 ; (file-name-as-directory
414 ; (read-file-name
415 ; (format "ESS [%s(%s): %s] starting data directory? "
416 ; ess-language ess-dialect inferior-ess-program)
417 ; (file-name-as-directory default)
418 ; (file-name-as-directory default) t nil)))))
419 ; (if (file-directory-p the-dir) nil
420 ; (error "%s is not a valid directory" the-dir))
421 ; the-dir))
425 default
427 ess-language ess-dialect inferior-ess-program)))
430 "`prompt' for a directory, using `default' as the usual."
435 ;; use XEmacs' read-directory-name if exists.
444 the-dir))
447 ;;*;; General process handling code
450 "Return the ESS process named by NAME."
459 "Wait until the ESS process is ready for input."
474 ;; above, except for Stata, which has "broken" i/o,
475 ;; sigh... (AJR)
482 ;;--- Unfinished idea (ESS-help / R-help ) -- probably not worth it...
483 ;;- (defun ess-set-inferior-program-name (filename)
484 ;;- "Allows to set or change `inferior-ess-program', the program (file)name."
485 ;;- (interactive "fR executable (script) file: ")
486 ;;- ;; "f" : existing file {file name completion} !
487 ;;- (setq inferior-ess-program filename))
488 ;; the inferior-ess-program is initialized in the customize..alist,
489 ;; e.g. from inferior-R-program-name ... --> should change rather these.
490 ;; However these really depend on the current ess-language!
491 ;; Plan: 1) must know and use ess-language
492 ;; 2) change the appropriate inferior-<ESSlang>-program-name
493 ;; (how?) in R/S : assign(paste("inferior-",ESSlang,"-p...."), filename))
495 ;;*;; Multiple process handling code
498 "Make the process associated with the current buffer the current ESS process.
499 Returns the name of the process, or nil if the current buffer has none."
503 ess-local-process-name)
506 "Return the variable VAR (symbol) local to ESS process called NAME (string)."
512 "Set variable VAR (symbol) local to ESS process called NAME (string) to VAL."
518 "Ask for a process, and make it the current ESS process.
519 Also switches to the process buffer unless NOSWITCH is non-nil. Interactively,
520 NOSWITCH can be set by giving a prefix argument.
521 Returns the name of the selected process."
528 ess-process-name-list
529 nil ; predicate
530 'require-match
531 ;; If in S buffer, don't offer current process
533 ess-language
534 ess-current-process-name
535 ;; maybe ess-local-process-name IF exists?
536 ))))
541 nil
543 proc))
546 "Make sure the current buffer is attached to an ESS process.
547 If not, or FORCE (prefix argument) is non-nil,
548 prompt for a process name with PROMPT.
549 `ess-local-process-name' is set to the name of the process selected.
550 `ess-dialect' is set to the dialect associated with the process selected."
554 nil ; do nothing
555 ;; Make sure the source buffer is attached to a process
558 ;; ess-local-process-name is nil -- which process to attach to
561 dialect)
569 "Force a switch to a new underlying process."
573 ;;*;;; Commands for switching to the process buffer
576 "Switch to the current inferior ESS process buffer.
577 With (prefix) EOB-P non-nil, positions cursor at end of buffer.
578 This function should follow the description in `ess-show-buffer'
579 for showing the iESS buffer, except that the iESS buffer is also
580 made current."
585 ;; Display the buffer, but don't select it yet.
588 t)
594 "Switch to the end of the inferior ESS process buffer."
599 "Return the buffer associated with the ESS process named by NAME."
603 "Remove names with no process."
610 ess-process-name-list)
614 defunct))
618 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
619 ;; ess-show-buffer
620 ;; Something like this almost works, but problems with XEmacs and Emacs
621 ;; differing implementations of the args to display-buffer make this
622 ;; too tough to pursue. The longer version below works.
623 ;; (defun ess-show-buffer (buf)
624 ;; "Display the buffer BUF, a string, but do not select it.
625 ;; Returns the window corresponding to the buffer."
626 ;; ;; On XEmacs, I get an error if third arg to display-buffer is t and
627 ;; ;; the BUF is in another frame. Emacs does not have this problem.
628 ;; (if (featurep 'xemacs)
629 ;; (display-buffer buf nil (get-frame-for-buffer buf))
630 ;; (display-buffer buf nil t)))
631 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
633 "Ensure the ESS buffer BUF is visible.
634 The buffer, specified as a string, is typically an iESS (e.g. *R*) buffer.
636 This handles several cases:
638 1. If BUF is visible in the current frame, nothing is done.
639 2. If BUF is visible in another frame, then we ensure that frame is
640 visible (it may have been iconified).
641 3. If buffer is not visible in any frame, simply show it in another window
642 in the current frame.
644 Iff VISIT is non-nil, as well as making BUF visible, we also select it
645 as the current buffer."
648 ;;1. Nothing to do, BUF visible in this frame; just return window
649 ;; where this buffer is.
650 t
652 ;; 2. Maybe BUF visible in another frame.
655 ;; BUF is visible in frame, so just check frame is raised.
657 ;; frame is not yet visible, so raise it.
659 ;; 3. else BUF not visible in any frame, so show it (but do
660 ;; not select it) in another window in current frame.
662 ;; At this stage, the buffer should now be visible on screen,
663 ;; although it won't have been made current.
666 ;; Need to select the buffer.
667 ;;
668 ;; First of all, check case 2 if buffer is in another frame
669 ;; but that frame may not be selected.
672 ;; need to select the frame
674 ;; reposition mouse to make frame active.
679 ;; The next few functions are copied from my (SJE) iswitchb library.
681 "Used by `ess-get-buffers-in-frames' to walk through all windows."
684 ;; Only add buf if it is not already in list.
685 ;; This prevents same buf in two different windows being
686 ;; put into the list twice.
691 "Return the list of buffers that are visible in the current frame.
692 If optional argument CURRENT is given, restrict searching to the
693 current frame, rather than all frames."
696 ess-bufs-in-frame))
699 "Return t if BUF is visible in current frame."
703 "Return t if BUF is visible in another frame.
704 Assumes that buffer has not already been in found in current frame."
707 nil))
713 "Returns t if the ess-local-process-name is associated with an
714 inferior-ess-ddeclient, and nil if the ess-process is running as an
715 ordinary inferior process. Alway nil on Unix machines."
723 "Wait for a prompt to appear at BOL of current buffer.
724 PROC is the ESS process. Does not change point"
729 ;; get output if there is some ready
731 ;; (if (and ess-microsoft-p ess-ms-slow)
732 ;; (accept-process-output proc 0 1500) ; Microsoft is slow
734 ;; )
747 ;; Insert the text, moving the process-marker.
755 "Send the ESS process command COM and delete the output
756 from the ESS process buffer. If an optional second argument BUF exists
757 save the output in that buffer. BUF is erased before use.
758 COM should have a terminating newline.
759 Guarantees that the value of .Last.value will be preserved.
760 When optional third arg SLEEP is non-nil, `(sleep-for (* a SLEEP))'
761 will be used in a few places where `a' is proportional to `ess-cmd-delay'."
762 ;; Use this function when you need to evaluate some S code, and the
763 ;; result is needed immediately. Waits until the output is ready
765 sbuffer
766 do-sleep end-of-output
767 oldpb oldpf oldpm
768 my-retr-cmd my-save-cmd)
789 ;; need the buffer-local values in result buffer "buf":
796 ;; Output is now going to BUF:
807 ;; need time for ess-create-object-name-db on PC
809 ;;(if do-sleep (sleep-for (* 0.0 sleep))); microsoft: 0.5
819 ;; Get rid out output from last assign
821 ;; Restore old values for process filter
827 "Replace all matches in STR for REGEXP with NEWTEXT string.
828 Optional LITERAL non-nil means do a literal replacement.
836 nil
838 newtext))
842 match prev-start)
846 rtn-str
848 rtn-str
865 ;; Invalid match num
879 ;;*;; Evaluating lines, paragraphs, regions, and buffers.
881 ;;--- The two basic building blocks [called by all other ess-eval..] are
882 ;; (ess-eval-linewise ....)
883 ;; and
884 ;; (ess-eval-region ....)
887 ;; RDB 28/8/92 added optional arg eob
888 ;; AJR 971022: text-withtabs was text.
889 "Evaluate TEXT-WITHTABS in the ESS process buffer as if typed in w/o tabs.
890 Waits for prompt after each line of input, so won't break on large texts.
892 If optional second arg INVISIBLY is non-nil, don't echo commands. If it
893 is a string, just include that string. If optional third arg
894 EOB is non-nil go to end of ESS process buffer after evaluation. If optional
895 4th arg EVEN-EMPTY is non-nil, also send empty text (e.g. an empty line)."
896 ;; Use this to evaluate some code, but don't wait for output.
901 start-of-output
902 com pos txt-gt-0)
904 ;;(message "'ess-eval-linewise: sbuffer = %s" sbuffer)
907 ;; the following is required to make sure things work!
910 ;; dbg:
911 ;; dbg(ess-write-to-dribble-buffer
912 ;; dbg (format "(eval-visibly 1): lang %s (invis=%s, eob=%s, even-empty=%s)\n"
913 ;; dbg ess-language invisibly eob even-empty))
918 ;; dbg:
919 ;; dbg (ess-write-to-dribble-buffer
920 ;; dbg (format "(eval-visibly 2): text[%d]= «%s»\n" (length text) text))
922 even-empty)
929 ;; else 0-length text
931 )
934 ;; Terrible kludge -- need to insert after all markers *except*`
935 ;; the process mark
941 ;; A kludge to prevent the delay between insert and process output
942 ;; affecting the display. A case for a comint-send-input-hook?
943 ;; (save-excursion
944 ;; ;; comint-postoutput-scroll-to-bottom can change
945 ;; ;; current-buffer. Argh.
946 ;; (let ((functions comint-output-filter-functions))
947 ;; (while functions
948 ;; (funcall (car functions) com)
949 ;; (setq functions (cdr functions)))))
951 ;; Don't hang around waiting for the prompt after the last
952 ;; line of input
954 nil
966 ;; Once SBUFFER is visible, we can then move the point in that
967 ;; window to the end of the buffer.
971 ))
973 ;;;*;;; Evaluate only
976 "Send the current region to the inferior ESS process.
977 With prefix argument, toggle meaning of `ess-eval-visibly-p'."
979 ;;(untabify (point-min) (point-max))
980 ;;(untabify start end); do we really need to save-excursion?
989 ;; else [almost always!]
996 "Send the current buffer to the inferior ESS process.
997 Arg has same meaning as for `ess-eval-region'."
999 ;; already in eval-region:
1000 ;; (ess-force-buffer-current "Process to load into: ")
1004 "Send the current function to the inferior ESS process.
1005 Arg has same meaning as for `ess-eval-region'."
1007 ;; already in eval-region:
1008 ;; (ess-force-buffer-current "Process to load into: ")
1013 name)
1020 ;; This is from Mary Lindstrom <lindstro@Biostat.Wisc.Edu>
1021 ;; 31 Aug 1995 14:11:43 To: S-mode@stat.math.ethz.ch
1023 "Send the current paragraph to the inferior ESS process.
1024 Prefix arg VIS toggles visibility of ess-code as for `ess-eval-region'."
1034 "Send the current line to the inferior ESS process.
1035 Arg has same meaning as for `ess-eval-region'."
1047 ;; Contributed by Stephen Eglen <stephen@anc.ed.ac.uk> {idea from octave int.}
1049 "Move ARG lines of code forward (backward if ARG is negative).
1050 Skips past all empty and comment lines. Default for ARG is 1.
1052 On success, return 0. Otherwise, go as far as possible and return -1."
1064 n))
1069 possibly via prefix arg. If 2nd arg EVEN-EMPTY [prefix as well],
1070 also send empty lines. When the variable `ess-eval-empty' is non-nil
1071 both SIMPLE-NEXT and EVEN-EMPTY are interpreted as true."
1072 ;; From an idea by Rod Ball (rod@marcam.dsir.govt.nz)
1079 ;; go to end of process buffer so user can see result
1087 "Evaluate the current line invisibly and step to the next line.
1088 Evaluate all comments and empty lines."
1092 ;; goes to the real front, in case you do double function definition
1093 ;; 29-Jul-92 -FER
1094 ;; don't know why David changed it.
1096 ;; FER's versions don't work properly with nested functions. Replaced
1097 ;; mine. DMS 16 Nov 92
1099 ;;;*;;; Evaluate and switch to S
1102 "Send the current region to the inferior S and switch to the process buffer.
1103 Arg has same meaning as for `ess-eval-region'."
1109 "Send the current buffer to the inferior S and switch to the process buffer.
1110 Arg has same meaning as for `ess-eval-region'."
1116 "Send the current function to the inferior ESS process and switch to
1117 the process buffer. Arg has same meaning as for `ess-eval-region'."
1123 "Send the current line to the inferior ESS process and switch to the
1124 process buffer. Arg has same meaning as for `ess-eval-region'."
1129 ;;; Related to the ess-eval-* commands, there are the ess-load
1130 ;;; commands. Need to add appropriate stuff...
1133 "Load an S source file into an inferior ESS process."
1144 ;; Find the process to load into
1151 error-occurred nomessage)
1162 ;; Load did not cause an error
1164 ;; There was a warning message from S
1166 ;; Consider deleting the file
1170 ess-keep-dump-files)
1186 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1187 ;;;; In this section:
1188 ;;;;
1189 ;;;; * The major mode inferior-ess-mode
1190 ;;;; * Process handling code
1191 ;;;; * Completion code
1192 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1194 ;;*;; Major mode definition
1197 nil
1200 ;; Code for XEmacs
1204 ;; Code for GNU Emacs
1207 ;; Use syntax valid *both* for GNU emacs and XEmacs :
1212 ;; the above OVERRIDES comint-dynamic-list-input-ring --> re-assign:
1221 ;;(define-key inferior-ess-mode-map "\C-c\C-a" 'ess-execute-attach)
1232 inferior-ess-mode-menu inferior-ess-mode-map
1233 "Menu for use in Inferior S mode"
1243 "------"
1247 "------"
1249 ;; need a toggle switch for above, AJR.
1252 "------"
1256 ))
1260 "Hook to install `ess-mode' menu for XEmacs (w/ easymenu)."
1271 ;; Code for XEmacs
1276 ;; Code for Emacs
1284 "Major mode for interacting with an inferior ESS process.
1285 Runs an S interactive job as a subprocess of Emacs, with I/O through an
1286 Emacs buffer. Variable `inferior-ess-program' controls which S
1287 is run.
1289 Commands are sent to the ESS process by typing them, and pressing
1291 completes known object names or filenames, as appropriate. Other
1292 keybindings for this mode are:
1297 `ess-load-file' keeps source files (if `ess-keep-dump-files' is non-nil) in
1298 the directory specified by `ess-source-directory', with the
1299 filename chosen according to `ess-dump-filename-template'. When a file is
1300 loaded, `ess-mode' parses error messages and jumps to the appropriate file
1301 if errors occur. The ess-eval- commands do not do this.
1303 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
1304 `inferior-ess-mode-hook' (in that order).
1306 You can send text to the inferior ESS process from other buffers containing
1307 S source. The key bindings of these commands can be found by typing
1308 C-h m (help for mode) in the other buffers.
1309 `ess-eval-region' sends the current region to the ESS process.
1310 `ess-eval-buffer' sends the current buffer to the ESS process.
1311 `ess-eval-function' sends the current function to the ESS process.
1312 `ess-eval-line' sends the current line to the ESS process.
1313 `ess-beginning-of-function' and `ess-end-of-function' move the point to
1314 the beginning and end of the current S function.
1315 `ess-switch-to-ESS' switches the current buffer to the ESS process buffer.
1316 `ess-switch-to-end-of-ESS' switches the current buffer to the ESS process
1317 buffer and puts point at the end of it.
1319 `ess-eval-region-and-go', `ess-eval-buffer-and-go',
1320 `ess-eval-function-and-go', and `ess-eval-line-and-go' switch to the S
1321 process buffer after sending their text.
1322 `ess-dump-object-into-edit-buffer' moves an S object into a temporary file
1323 and buffer for editing
1324 `ess-load-file' sources a file of commands to the ESS process.
1326 Commands:
1327 Return after the end of the process' output sends the text from the
1328 end of process to point.
1329 Return before the end of the process' output copies the sexp ending at point
1330 to the end of the process' output, and sends it.
1331 Delete converts tabs to spaces as it moves back.
1332 C-M-q does Tab on each line starting within following expression.
1333 Paragraphs are separated only by blank lines. Crosshatches start comments.
1335 to continue it."
1337 ;;(message " at very beg. of (inferior-ess-mode): inf.-ess-prompt= %s"
1338 ;; inferior-ess-prompt)
1340 ;;
1342 ;; SJE: is this the proper place for setting inferior-ess-prompt,
1343 ;; rather than within ess-multi? Tony - have you remembered yet
1345 ;; about the setq-default, as I changed it back to setq.
1347 ;; shouldn't be setq-default! And I've
1348 ;; forgotten why! (AJR)
1349 ;; Do not anchor to bol with `^'
1351 inferior-ess-primary-prompt
1353 inferior-ess-secondary-prompt
1363 ; FIXME: need to do something if not set! Get from the proper place!
1364 )
1371 comint-process-echoes comint-input-sender))
1378 ;; Configuration for SAS/XLispStat input handling
1379 ;; We set comint-process-echoes to t because inferior-ess-input-sender
1380 ;; recopies the input. If comint-process-echoes was *meant* to be t ...
1381 ;;
1382 ;; except that XLS doesn't like it. This is an ugly hack that ought
1383 ;; to go into the dialect configuration...
1389 ;; Configuration for S/R input handling
1390 ;; AJR: add KH's fix. This is ugly, change to do it right.
1391 ;; i.e. put it as a buffer local var, in S or R defuns...
1405 ;; Configuration for Stata input handling
1406 ;; AJR: Stata is hell. This is the primary configuration point.
1412 ;; Configuration for Omegahat input handling
1415 ; the following doesn't exist (until needed?)
1416 ;(setq comint-input-sender 'inferior-OMG-input-sender)
1422 comint-process-echoes comint-input-sender))
1423 ;; Font-lock support
1424 ;; AJR: This (the following local-var is already the case!
1425 ;; KH sez: only in XEmacs :-(.
1436 ;; Completion support
1437 ;; SJE: comint-dynamic-complete-functions is regarded as a hook, rather
1438 ;; than a regular variable.
1448 ;; (setq comint-completion-addsuffix nil) ; To avoid spaces after filenames
1449 ;; KH: next 2 lines solve.
1455 ;;; Keep <tabs> out of the code.
1464 ;; SJE Tue 28 Dec 2004: do not attempt to load object name db.
1465 ;; (ess-load-object-name-db-file)
1466 ;; (sleep-for 0.5)
1473 ess-version)))
1475 ;;*;; Commands used exclusively in inferior-ess-mode
1477 ;;;*;;; Main user commands
1485 ;;> <PD writes>:
1486 ;;> Also, invoking help() from the command line may lead to confusing
1487 ;;> output, somewhat worse with R than with S. You're not really supposed
1488 ;;> to do that (use C-c C-v to invoke ess-display-help-on-object), but it's
1489 ;;> an obvious newcomer's mistake.
1490 ;;>
1491 ;;> (I wonder: could the elisp-code not quite easily recognize help
1492 ;;> calls (at least in the ?xxx form) and do the right thing automagically?)
1493 ;;>
1494 ;;> As promised, here is a quick hack:
1495 ;; ___hack much improved by MM___ , both help(.) and ?... now work
1496 ;; FIXME: Note that '??' nicely works in *R*, but
1497 ;; 'type ? topic' doesn't use ess-help {but display in *R*}
1503 ;; REALLY only for debugging: this S_L_O_W_S D_O_W_N [here AND below]
1504 ;;(ess-write-to-dribble-buffer (format "(inf..-R-..): string=«%s»; " string))
1505 ;; rmh: 2002-01-12 catch page() in R
1512 ;; (ess-write-to-dribble-buffer (format " new string=«%s»\n" string2))
1529 ;; else: normal command
1534 "Sends the command on the current line to the ESS process."
1542 "Return the ESS command surrounding point."
1563 command)))
1565 ;;;*;;; Hot key commands
1568 "Send the objects() command to the ESS process.
1569 By default, gives the objects at position 1.
1570 A prefix argument toggles the meaning of `ess-execute-in-process-buffer'.
1571 A prefix argument of 2 or more means get objects for that position.
1572 A negative prefix argument gets the objects for that position
1573 and toggles `ess-execute-in-process-buffer' as well."
1584 " ("
1589 ;;;; S4 Version
1590 ;;;; soup-up the interactive usage: allow modifications to a default pattern
1591 ;;(defun ess-execute-objects (posn)
1592 ;; "Send the `inferior-ess-objects-command' to the ESS process.
1593 ;;No prefix argument uses position 1 and pattern inferior-ess-objects-pattern.
1594 ;;A nonnegative prefix gets objects for that position and prompts for
1595 ;; the pattern.
1596 ;;A negative prefix also toggles ess-execute-in-process-buffer."
1597 ;; (interactive "P")
1598 ;; (ess-make-buffer-current)
1599 ;; (let* ((num-arg (if (listp posn) 1
1600 ;; (prefix-numeric-value posn)))
1601 ;; (the-posn (if (< num-arg 0) (- num-arg) num-arg))
1602 ;; (invert (< num-arg 0))
1603 ;; (pattern (if current-prefix-arg (read-string "Pattern (.*): ")
1604 ;; inferior-ess-objects-pattern))
1605 ;; (pattern (if (string= pattern "") ".*" pattern))
1606 ;; (the-command (format inferior-ess-objects-command the-posn pattern))
1607 ;; (the-message (concat ">>> Position "
1608 ;; the-posn
1609 ;; " ("
1610 ;; (nth (1- the-posn) (ess-search-list))
1611 ;; ") (pattern = "
1612 ;; pattern
1613 ;; ")\n")))
1614 ;; (ess-execute the-command invert "S objects" the-message)))
1617 "Send the `inferior-ess-search-list-command' command to the `ess-language' process.
1618 [search(..) in S]"
1623 "Attach a directory in the `ess-language' process with the attach() command.
1624 When used interactively, user is prompted for DIR to attach and
1625 prefix argument is used for POSN (or 2, if absent.)
1626 Doesn't work for data frames."
1639 This is a good thing to put in `ess-post-run-hook' --- for the S dialects."
1646 "Send a command to the ESS process.
1647 A newline is automatically added to COMMAND. Prefix arg (or second arg
1648 INVERT) means invert the meaning of
1649 `ess-execute-in-process-buffer'. If INVERT is 'buffer, output is
1650 forced to go to the process buffer. If the output is going to a
1651 buffer, name it *BUFF*. This buffer is erased before use. Optional
1652 fourth arg MESSAGE is text to print at the top of the buffer (defaults
1653 to the command if BUFF is not given.)"
1656 nil
1657 ess-mode-minibuffer-map)
1658 current-prefix-arg))
1664 ess-execute-in-process-buffer)))
1674 ;; Print the command in the buffer if it has not been
1675 ;; given a special name
1677 ;;(make-local-variable 'ess-local-process-name)
1681 ;;;*;;; Quitting
1684 "Issue an exiting command to the inferior process.
1685 By default, you will be asked if you wish to delete all buffers
1686 associated with the current buffer; if you specify a prefix
1687 arg (with C-u), this step will be omitted."
1700 ;;SJE - suggest no need to rename buffer upon exit.
1701 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1702 ))))
1705 "Issue an exiting command to an inferior R process, and optionally clean up.
1706 This version is for killing *R* processes; it asks the extra question
1707 regarding whether the workspace image should be saved."
1715 nil t))
1723 ;;(rename-buffer (concat (buffer-name) "-exited") t)
1724 )))
1727 "Kill the ESS process, without executing .Last or terminating devices.
1729 ;;; Provided as a safety measure over the default binding of C-c C-z in
1730 ;;; comint-mode-map.
1733 (message "WARNING: \\[inferior-ess-exit-command] will not be executed and graphics devices won't finish properly!")
1740 "Kill (or offer to kill) all buffers associated with this ESS process.
1741 Leaves you in the ESS process buffer. It's a good idea to run this
1753 ;; Consider buffers for which
1754 ;; ess-local-process-name is the same as
1755 ;; the-procname
1757 ess-local-process-name
1764 "Function run just before an ESS process buffer is killed."
1765 ;; This simply deletes the buffers process to avoid an Emacs bug
1766 ;; where the sentinel is run *after* the buffer is deleted
1770 ;;*;; Object name completion
1772 ;;;*;;; The user completion command
1774 "Perform completion on `ess-language' object preceding point.
1775 The object is compared against those objects known by
1776 `ess-get-object-list' and any additional characters up to ambiguity are
1777 inserted. Completion only works on globally-known objects (including
1778 elements of attached data frames), and thus is most suitable for
1779 interactive command-line entry, and not so much for function editing
1780 since local objects (e.g. argument names) aren't known.
1783 This is done automatically (and transparently) if a directory is
1784 modified (S only!), so the most up-to-date list of object names is always
1785 available. However attached dataframes are *not* updated, so this
1786 command may be necessary if you modify an attached dataframe.
1788 If ARG is non-nil, no completion is attempted, but the available
1789 completions are listed [__UNIMPLEMENTED__]."
1804 ;; See if we're indexing a list with `$'
1806 full-prefix)
1815 ;; are we trying to get a slot via `@' ?
1817 full-prefix)
1826 pattern))
1834 ;; always return a non-nil value to prevent history expansions
1838 "List all possible completions of the object name at point."
1842 ;;;*;;; Support functions
1844 "Return the object names in position POSN of ALIST.
1845 ALIST is an alist like `ess-sl-modtime-alist'. POSN should be in 1 .. (length
1846 ALIST). If optional third arg FORCE is t, the corresponding element
1847 of the search list is re-read. Otherwise it is only re-read if it's a
1848 directory and has been modified since it was last read."
1853 ;; Refresh the object listing if necessary
1859 "Return the last modtime if DIR is a directory, and nil otherwise."
1865 "Return the modtime of the S object OBJECT (a string).
1866 Searches along the search list for a file named OBJECT and returns its modtime
1867 Returns nil if that file cannot be found, i.e., for R or any non-S language!"
1869 result)
1873 object)))
1878 "Return t if MOD1 is later than MOD2."
1885 "Return a list of current S object names associated with process NAME,
1886 using `ess-object-list' if that is non-nil."
1895 ;;else
1897 )
1901 result)
1902 ;; Always force a re-read of position 1 :
1904 ;; Re-read remaining directories if necessary.
1913 "Evaluate the S command COMMAND, which returns a character vector.
1914 Return the elements of the result of COMMAND as an alist of strings.
1915 A newline is automatically added to COMMAND."
1918 names)
1928 )
1933 ;;DBG, do *not* (i.e., comment):
1935 )
1941 names))
1944 "Return non-nil if DIR is an S object directory with special files.
1945 I.e. if the filenames in DIR are not representative of the objects in DIR."
1951 "Return alist of S object names in directory (or object) OBJ.
1952 If OBJ is a directory name (begins with `/') returns a listing of that dir.
1953 This may use the search list position POS if necessary.
1954 If OBJ is an object name, returns result of S command names(OBJ).
1955 If OBJ is nil or not a directory, POS must be supplied, and objects(POS) is returned.
1956 In all cases, the value is an list of object names."
1958 ;; FIXME: in both cases below, use the same fallback "objects(POS)" -- merge!
1960 ;; Check the pre-compiled object list in ess-object-name-db first
1962 ;; FIXME: If used at all, ess-object-name-db should not only
1963 ;; ----- be used in the directory case !!
1965 ;; Take a directory listing
1967 ;; first try .Data subdirectory:
1968 ;;FIXME: move ".Data" or ``this function'' to essd-sp6.el etc:
1974 ;; Get objects(pos) instead
1977 t)
1978 pos
1981 ;; "else" should really give an error!
1982 ;; would need pos = which(obj = search())
1984 ;; else
1988 obj))
1989 t)
1995 ;; get objects(pos)
1998 ; s4 needs 2
1999 ; args, rest only need 1 ?
2000 ; changes needed to allow for
2001 ; pattern argument to
2002 ; .SmodeObs
2005 "Return alist of S4 slot names of S4 object OBJ."
2009 ;;; SJE: Wed 29 Dec 2004 --- remove this function.
2010 ;;; rmh: Wed 5 Jan 2005 --- bring it back for use on Windows
2012 "Create a database of object names in standard S directories. This
2013 database is saved in the file specified by `ess-object-name-db-file',
2014 and is loaded when `ess-mode' is loaded. It defines the variable
2015 `ess-object-name-db', which is used for completions.
2017 Before you call this function, modify the S search list so that it contains
2018 all the non-changing (i.e. system) S directories. All positions of the search
2019 list except for position 1 are searched and stored in the database.
2021 After running this command, you should move ess-namedb.el to a directory in
2022 the `load-path'."
2027 name
2038 temp-object-name-db))
2042 temp-object-name-db pos))
2058 "Reread all directories/objects in variable `ess-search-list' to
2059 form completions."
2071 ;; Do file completion only within strings, or when the ! call is being used
2074 ;; (- comint-last-input-start 1) (point)) <- from S4 modeadds.
2075 ;; changed on 4/12/96 (dxsun)
2076 ;; This is sensible, but makes it hard to use history refs
2077 ;; (or
2078 ;; (save-excursion
2079 ;; (goto-char comint-last-input-start)
2080 ;; (looking-at "\\s-*!"))
2081 ;; (comint-within-quotes comint-last-input-start (point)))
2084 ;; always return t if in a string
2085 t)))
2088 ;; Heuristic: after partial pathname if it looks like we're in a
2089 ;; string, and that string looks like a pathname. Not the best for
2090 ;; use with unix() (or it's alias, !). Oh well.
2095 nil t)
2098 ;;*;; Functions handling the search list
2101 "Return the current search list as a list of strings.
2102 Elements which are apparently directories are expanded to full dirnames.
2111 ;; use cache:
2112 ess-search-list
2113 ;; else, re-compute:
2117 elt)
2120 ;; guaranteed by the initial space in its name: (buffer-disable-undo)
2125 ;;Dbg: (ess-write-to-dribble-buffer (format " .. elt= %s \t" elt))
2129 ;;Dbg: (ess-write-to-dribble-buffer "*IS* directory\n")
2131 ;;else
2132 ;;dbg
2133 ;;- (ess-write-to-dribble-buffer "not dir.\n")
2134 )
2139 result))))
2141 ;;; ess-sl-modtime-alist is a list with elements as follows:
2142 ;;; * key (directory or object name)
2143 ;;; * modtime (list of 2 integers)
2144 ;;; * name, name ... (accessible objects in search list posn labeled by key)
2145 ;;; It is a buffer-local variable (belonging to e.g. *R*, *S+6*, .. etc)
2146 ;;; and has the same number of elements and is in the same order as the
2147 ;;; S search list
2150 "Record the modification times of the directories in the search list,
2151 and the objects in those directories.
2152 The result is stored in `ess-sl-modtime-alist'."
2153 ;; Operation applies to process of current buffer
2156 posn
2157 newalist)
2162 newalist
2170 ))))))
2173 ;;DBG:
2182 "Check if input STR changed the search path.
2183 This function monitors user input to the inferior ESS process so that
2184 Emacs can keep the variable `ess-search-list' up to date. `completing-read' in
2186 for an object to dump."
2192 ;;;*;;; Routines for reading object names
2195 "Read an S object name from the minibuffer with completion, and return it.
2196 P-STRING is the prompt string."
2200 p-string))
2208 "Return the object name at point, or nil if none."
2211 ;; The following line circumvents an 18.57 bug in following-char
2213 ;; Get onto a symbol
2227 ;; The following line circumvents an 18.57 bug in following-char
2229 ;; Get onto a symbol
2241 ;;*;; Temporary buffer handling
2243 ;(defun ess-create-temp-buffer (name)
2244 ; "Create an empty buffer called NAME, but doesn't display it."
2245 ; (let ((buff (get-buffer-create name)))
2246 ; (save-excursion
2247 ; (set-buffer buff)
2248 ; (erase-buffer))
2249 ; buff))
2252 ;; Ed Kademan's version:
2253 ;From: Ed Kademan <kademan@phz.com>
2254 ;Subject: Re: ess-mode 5.1.16; search list
2255 ;To: rossini@biostat.washington.edu (A.J. Rossini)
2256 ;Cc: Martin Maechler <maechler@stat.math.ethz.ch>, ess-bugs@stat.math.ethz.ch
2257 ;Date: 26 Jul 2000 16:12:12 -0400
2258 ;
2259 ;Dear Tony Rossini,
2260 ;
2261 ;I was having trouble looking at the search list under ess. When I
2262 ;started up multiple inferior processes---each for a different
2263 ;dialect---ess-mode would issue the wrong variant of the "search"
2264 ;command when I typed C-c C-s. In case it is useful let me tell you
2265 ;what I did to get it to work for me.
2266 ;
2267 ;I added the component:
2268 ; (inferior-ess-search-list-command . "search()\n")
2269 ;to S+3-customize-alist and R-customize-alist, and then I redefined the
2270 ;ess-create-temp-buffer function as follows:
2272 "Create an empty buffer called NAME."
2279 buff))
2280 ;;These two steps seem to insure that the temporary buffer in which the
2281 ;;search results appear has the correct version of the local variables.
2282 ;;I am not that well acquainted with the ess code and don't know whether
2283 ;;this is a good fundamental way of fixing the problem, or even whether
2284 ;;or not this breaks some other feature of ess-mode that I never use.
2285 ;;Thanks for listening.
2286 ;;Ed K.
2287 ;;--
2288 ;;Ed Kademan 508.651.3700
2289 ;;PHZ Capital Partners 508.653.1745 (fax)
2290 ;;321 Commonwealth Road <kademan@phz.com>
2291 ;;Wayland, MA 01778
2296 "Display the buffer BUFF using `temp-buffer-show-function'."
2299 ;;*;; Error messages
2302 "Something bad has happened.
2303 Display the S buffer, and cause an error displaying MSG."
2313 ;;; This file is automatically placed in Outline minor mode.
2314 ;;; The file is structured as follows:
2315 ;;; Chapters: ^L ;
2316 ;;; Sections: ;;*;;
2317 ;;; Subsections: ;;;*;;;
2318 ;;; Components: defuns, defvars, defconsts
2319 ;;; Random code beginning with a ;;;;* comment
2321 ;;; Local variables:
2322 ;;; mode: emacs-lisp
2323 ;;; outline-minor-mode: nil
2324 ;;; mode: outline-minor
2325 ;;; outline-regexp: "\^L\\|\\`;\\|;;\\*\\|;;;\\*\\|(def[cvu]\\|(setq\\|;;;;\\*"
2326 ;;; End:
2328 ;;; ess-inf.el ends here