comint.el 55.3 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1
;;; comint.el --- general command interpreter in a window stuff
2

3
;; Copyright (C) 1988, 1990, 1992, 1993 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5
;; Author: Olin Shivers <shivers@cs.cmu.edu>
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
7

8
;; This file is part of GNU Emacs.
David Lawrence's avatar
David Lawrence committed
9

10 11 12 13
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
David Lawrence's avatar
David Lawrence committed
14

15 16 17 18
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
David Lawrence's avatar
David Lawrence committed
19

20 21 22
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
David Lawrence's avatar
David Lawrence committed
23

Eric S. Raymond's avatar
Eric S. Raymond committed
24 25
;;; Commentary:

Jim Blandy's avatar
Jim Blandy committed
26 27 28 29 30 31
;;; The changelog is at the end of this file.

;;; Please send me bug reports, bug fixes, and extensions, so that I can
;;; merge them into the master source.
;;;     - Olin Shivers (shivers@cs.cmu.edu)

David Lawrence's avatar
David Lawrence committed
32 33 34 35 36 37 38
;;; This file defines a general command-interpreter-in-a-buffer package
;;; (comint mode). The idea is that you can build specific process-in-a-buffer
;;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
;;; This way, all these specific packages share a common base functionality, 
;;; and a common set of bindings, which makes them easier to use (and
;;; saves code, implementation time, etc., etc.).

Jim Blandy's avatar
Jim Blandy committed
39
;;; Several packages are already defined using comint mode:
40
;;; - shell.el defines a shell-in-a-buffer mode.
Jim Blandy's avatar
Jim Blandy committed
41 42 43 44 45 46 47 48 49 50
;;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
;;;
;;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
;;; - The file tea.el tunes scheme and inferior-scheme modes for T.
;;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
;;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
;;;   previewers, and printers from within emacs.
;;; - background.el allows csh-like job control inside emacs.
;;; It is pretty easy to make new derived modes for other processes.

David Lawrence's avatar
David Lawrence committed
51 52 53 54 55
;;; For documentation on the functionality provided by comint mode, and
;;; the hooks available for customising it, see the comments below.
;;; For further information on the standard derived modes (shell, 
;;; inferior-lisp, inferior-scheme, ...), see the relevant source files.

Jim Blandy's avatar
Jim Blandy committed
56 57
;;; For hints on converting existing process modes (e.g., tex-mode,
;;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
David Lawrence's avatar
David Lawrence committed
58 59 60
;;; instead of shell-mode, see the notes at the end of this file.


Jim Blandy's avatar
Jim Blandy committed
61 62
;;; Brief Command Documentation:
;;;============================================================================
63
;;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
Jim Blandy's avatar
Jim Blandy committed
64 65 66 67
;;; mode)
;;;
;;; m-p	    comint-previous-input    	    Cycle backwards in input history
;;; m-n	    comint-next-input  	    	    Cycle forwards
68 69
;;; m-r     comint-previous-similar-input   Previous similar input
;;; m-s     comint-next-similar-input       Next similar input
Jim Blandy's avatar
Jim Blandy committed
70
;;; c-m-r   comint-previous-input-matching  Search backwards in input history
Jim Blandy's avatar
Jim Blandy committed
71 72 73 74 75 76 77 78 79 80 81
;;; return  comint-send-input
;;; c-a     comint-bol                      Beginning of line; skip prompt.
;;; c-d	    comint-delchar-or-maybe-eof     Delete char unless at end of buff.
;;; c-c c-u comint-kill-input	    	    ^u
;;; c-c c-w backward-kill-word    	    ^w
;;; c-c c-c comint-interrupt-subjob 	    ^c
;;; c-c c-z comint-stop-subjob	    	    ^z
;;; c-c c-\ comint-quit-subjob	    	    ^\
;;; c-c c-o comint-kill-output		    Delete last batch of process output
;;; c-c c-r comint-show-output		    Show last batch of process output
;;;
David Lawrence's avatar
David Lawrence committed
82 83 84 85 86 87 88
;;; Not bound by default in comint-mode
;;; send-invisible			Read a line w/o echo, and send to proc
;;; (These are bound in shell-mode)
;;; comint-dynamic-complete		Complete filename at point.
;;; comint-dynamic-list-completions	List completions in help buffer.
;;; comint-replace-by-expanded-filename	Expand and complete filename at point;
;;;					replace with expanded/completed name.
Jim Blandy's avatar
Jim Blandy committed
89 90 91 92 93 94 95 96 97 98 99 100 101
;;; comint-kill-subjob			No mercy.
;;; comint-continue-subjob		Send CONT signal to buffer's process
;;;					group. Useful if you accidentally
;;;					suspend your process (with C-c C-z).
;;;
;;; These used to be bound for RMS -- I prefer the input history stuff,
;;; but you might like 'em.
;;; m-P	   comint-msearch-input		Search backwards for prompt
;;; m-N    comint-psearch-input		Search forwards for prompt
;;; C-cR   comint-msearch-input-matching Search backwards for prompt & string

;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
;;; comint-load-hook is run after loading in this package.
David Lawrence's avatar
David Lawrence committed
102

Eric S. Raymond's avatar
Eric S. Raymond committed
103 104 105 106
;;; Code:

(defconst comint-version "2.03")

Richard M. Stallman's avatar
Richard M. Stallman committed
107
(require 'ring)
David Lawrence's avatar
David Lawrence committed
108 109 110 111 112

;;; Buffer Local Variables:
;;;============================================================================
;;; Comint mode buffer local variables:
;;;     comint-prompt-regexp    - string       comint-bol uses to match prompt.
Jim Blandy's avatar
Jim Blandy committed
113
;;;     comint-last-input-start - marker       Handy if inferior always echos
Jim Blandy's avatar
Jim Blandy committed
114
;;;     comint-last-input-end   - marker       For comint-kill-output command
115 116 117
;;;     comint-input-ring-size  - integer      For the input history
;;;     comint-input-ring       - ring             mechanism
;;;     comint-input-ring-index - marker           ...
David Lawrence's avatar
David Lawrence committed
118 119 120 121 122 123 124
;;;     comint-last-input-match - string           ...
;;;     comint-get-old-input    - function     Hooks for specific 
;;;     comint-input-sentinel   - function         process-in-a-buffer
;;;     comint-input-filter     - function         modes.
;;;     comint-input-send	- function
;;;     comint-eol-on-send	- boolean

Jim Blandy's avatar
Jim Blandy committed
125 126 127
(defvar comint-prompt-regexp "^"
  "Regexp to recognise prompts in the inferior process.
Defaults to \"^\", the null string at BOL.
David Lawrence's avatar
David Lawrence committed
128 129

Good choices:
Jim Blandy's avatar
Jim Blandy committed
130
  Canonical Lisp: \"^[^> ]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
David Lawrence's avatar
David Lawrence committed
131
  Lucid Common Lisp: \"^\\(>\\|\\(->\\)+\\) *\"
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135
  franz: \"^\\(->\\|<[0-9]*>:\\) *\"
  kcl: \"^>+ *\"
  shell: \"^[^#$%>]*[#$%>] *\"
  T: \"^>+ *\"
David Lawrence's avatar
David Lawrence committed
136

Jim Blandy's avatar
Jim Blandy committed
137
This is a good thing to set in mode hooks.")
David Lawrence's avatar
David Lawrence committed
138

139
(defvar comint-input-ring-size 30
Jim Blandy's avatar
Jim Blandy committed
140
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
141 142

;;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
143 144
(defvar comint-get-old-input (function comint-get-old-input-default)
  "Function that submits old text in comint mode.
David Lawrence's avatar
David Lawrence committed
145 146 147
This function is called when return is typed while the point is in old text.
It returns the text to be submitted as process input.  The default is
comint-get-old-input-default, which grabs the current line, and strips off
Jim Blandy's avatar
Jim Blandy committed
148
leading text matching comint-prompt-regexp")
David Lawrence's avatar
David Lawrence committed
149

Jim Blandy's avatar
Jim Blandy committed
150 151 152
(defvar comint-input-sentinel (function ignore)
  "Called on each input submitted to comint mode process by comint-send-input.
Thus it can, for instance, track cd/pushd/popd commands issued to the csh.")
David Lawrence's avatar
David Lawrence committed
153

Jim Blandy's avatar
Jim Blandy committed
154 155 156
(defvar comint-input-filter
  (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
  "Predicate for filtering additions to input history.
David Lawrence's avatar
David Lawrence committed
157
Only inputs answering true to this function are saved on the input
Jim Blandy's avatar
Jim Blandy committed
158 159 160 161 162 163 164 165 166 167 168 169
history list. Default is to save anything that isn't all whitespace")

(defvar comint-input-sender (function comint-simple-send)
  "Function to actually send to PROCESS the STRING submitted by user.
Usually this is just 'comint-simple-send, but if your mode needs to 
massage the input string, this is your hook. This is called from
the user command comint-send-input. comint-simple-send just sends
the string plus a newline.")

(defvar comint-eol-on-send 'T
  "If non-nil, then jump to the end of the line before sending input to process.
See comint-send-input")
David Lawrence's avatar
David Lawrence committed
170 171

(defvar comint-mode-hook '()
Jim Blandy's avatar
Jim Blandy committed
172 173 174 175 176 177 178 179 180 181 182
  "Called upon entry into comint-mode
This is run before the process is cranked up.")

(defvar comint-exec-hook '()
  "Called each time a process is exec'd by comint-exec.
This is called after the process is cranked up.  It is useful for things that
must be done each time a process is executed in a comint-mode buffer (e.g.,
(process-kill-without-query)). In contrast, the comint-mode-hook is only
executed once when the buffer is created.")

(defvar comint-mode-map nil)
David Lawrence's avatar
David Lawrence committed
183

Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186 187
(defvar comint-ptyp t
  "True if communications via pty; false if by pipe.  Buffer local.
This is to work around a bug in emacs process signalling.")

188 189 190 191
(defvar comint-last-input-match ""
  "Last string searched for by comint input history search, for defaulting.
Buffer local variable.") 

192
(defvar comint-input-ring nil)
193 194
(defvar comint-last-input-start)
(defvar comint-last-input-end)
Richard M. Stallman's avatar
Richard M. Stallman committed
195 196 197
(defvar comint-input-ring-index)
(put 'comint-input-ring 'permanent-local t)
(put 'comint-ptyp 'permanent-local t)
198

David Lawrence's avatar
David Lawrence committed
199 200 201 202 203
(defun comint-mode ()
  "Major mode for interacting with an inferior interpreter.
Interpreter name is same as buffer name, sans the asterisks.
Return at end of buffer sends line as input.
Return not at end copies rest of line to end and sends it.
Jim Blandy's avatar
Jim Blandy committed
204 205
Setting mode variable comint-eol-on-send means jump to the end of the line
before submitting new input.
David Lawrence's avatar
David Lawrence committed
206 207

This mode is typically customised to create inferior-lisp-mode,
Jim Blandy's avatar
Jim Blandy committed
208 209 210 211
shell-mode, etc.. This can be done by setting the hooks
comint-input-sentinel, comint-input-filter, comint-input-sender and
comint-get-old-input to appropriate functions, and the variable
comint-prompt-regexp to the appropriate regular expression.
David Lawrence's avatar
David Lawrence committed
212

213
An input history is maintained of size comint-input-ring-size, and
David Lawrence's avatar
David Lawrence committed
214 215 216 217 218 219 220 221 222 223
can be accessed with the commands comint-next-input [\\[comint-next-input]] and 
comint-previous-input [\\[comint-previous-input]]. Commands not keybound by
default are send-invisible, comint-dynamic-complete, and 
comint-list-dynamic-completions.

If you accidentally suspend your process, use \\[comint-continue-subjob]
to continue it.

\\{comint-mode-map}

Jim Blandy's avatar
Jim Blandy committed
224
Entry to this mode runs the hooks on comint-mode-hook"
David Lawrence's avatar
David Lawrence committed
225
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
226 227
    ;; Do not remove this.  All major modes must do this.
    (kill-all-local-variables)
Jim Blandy's avatar
Jim Blandy committed
228 229 230 231
    (setq major-mode 'comint-mode)
    (setq mode-name "Comint")
    (setq mode-line-process '(": %s"))
    (use-local-map comint-mode-map)
Jim Blandy's avatar
Jim Blandy committed
232 233
    (make-local-variable 'comint-last-input-start)
    (setq comint-last-input-start (make-marker))
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238
    (make-local-variable 'comint-last-input-end)
    (setq comint-last-input-end (make-marker))
    (make-local-variable 'comint-last-input-match)
    (setq comint-last-input-match "")
    (make-local-variable 'comint-prompt-regexp) ; Don't set; default
239 240 241 242
    (make-local-variable 'comint-input-ring-size)      ; ...to global val.
    (make-local-variable 'comint-input-ring)
    (make-local-variable 'comint-input-ring-index)
    (setq comint-input-ring-index 0)
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246 247 248
    (make-local-variable 'comint-get-old-input)
    (make-local-variable 'comint-input-sentinel)
    (make-local-variable 'comint-input-filter)  
    (make-local-variable 'comint-input-sender)
    (make-local-variable 'comint-eol-on-send)
    (make-local-variable 'comint-ptyp)
Jim Blandy's avatar
Jim Blandy committed
249
    (make-local-variable 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
250
    (run-hooks 'comint-mode-hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
251 252
    (or comint-input-ring
	(setq comint-input-ring (make-ring comint-input-ring-size))))
David Lawrence's avatar
David Lawrence committed
253

Jim Blandy's avatar
Jim Blandy committed
254 255 256 257 258
(if comint-mode-map
    nil
  (setq comint-mode-map (make-sparse-keymap))
  (define-key comint-mode-map "\ep" 'comint-previous-input)
  (define-key comint-mode-map "\en" 'comint-next-input)
259 260
  (define-key comint-mode-map "\er" 'comint-previous-similar-input)
  (define-key comint-mode-map "\es" 'comint-next-similar-input)
Jim Blandy's avatar
Jim Blandy committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  (define-key comint-mode-map "\C-m" 'comint-send-input)
  (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
  (define-key comint-mode-map "\C-a" 'comint-bol)
  (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
  (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
  (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
  (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
  (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
  (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
  (define-key comint-mode-map "\C-\M-r"  'comint-previous-input-matching)
  (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
  ;;; prompt-search commands commented out 3/90 -Olin
; (define-key comint-mode-map "\eP" 'comint-msearch-input)
; (define-key comint-mode-map "\eN" 'comint-psearch-input)
; (define-key comint-mode-map "\C-cR" 'comint-msearch-input-matching)
  )


;;; This function is used to make a full copy of the comint mode map,
;;; so that client modes won't interfere with each other. This function
;;; isn't necessary in emacs 18.5x, but we keep it around for 18.4x versions.
(defun full-copy-sparse-keymap (km)
  "Recursively copy the sparse keymap KM"
  (cond ((consp km)
	 (cons (full-copy-sparse-keymap (car km))
	       (full-copy-sparse-keymap (cdr km))))
	(t km)))

(defun comint-check-proc (buffer)
  "True if there is a process associated w/buffer BUFFER, and
it is alive (status RUN or STOP). BUFFER can be either a buffer or the
name of one"
  (let ((proc (get-buffer-process buffer)))
    (and proc (memq (process-status proc) '(run stop)))))
David Lawrence's avatar
David Lawrence committed
295 296 297

;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
;;; for the second argument (program).
298
;;;###autoload
David Lawrence's avatar
David Lawrence committed
299
(defun make-comint (name program &optional startfile &rest switches)
300 301 302 303 304
  "Make a comint process NAME in a buffer, running PROGRAM.
The name of the buffer is made by surrounding NAME with `*'s.
If there is already a running process in that buffer, it is not restarted.
Optional third arg STARTFILE is the name of a file to send the contents of to 
the process.  Any more args are arguments to PROGRAM."
Jim Blandy's avatar
Jim Blandy committed
305
  (let ((buffer (get-buffer-create (concat "*" name "*"))))
David Lawrence's avatar
David Lawrence committed
306
    ;; If no process, or nuked process, crank up a new one and put buffer in
307
    ;; comint mode.  Otherwise, leave buffer and existing process alone.
Jim Blandy's avatar
Jim Blandy committed
308
    (cond ((not (comint-check-proc buffer))
Jim Blandy's avatar
Jim Blandy committed
309
	   (save-excursion
David Lawrence's avatar
David Lawrence committed
310 311 312 313 314 315 316
	     (set-buffer buffer)
	     (comint-mode)) ; Install local vars, mode, keymap, ...
	   (comint-exec buffer name program startfile switches)))
    buffer))

(defun comint-exec (buffer name command startfile switches)
  "Fires up a process in buffer for comint modes.
317
Blasts any old process running in the buffer.  Doesn't set the buffer mode.
Jim Blandy's avatar
Jim Blandy committed
318
You can use this to cheaply run a series of processes in the same comint
319
buffer.  The hook comint-exec-hook is run after each exec."
David Lawrence's avatar
David Lawrence committed
320 321 322 323 324 325
  (save-excursion
    (set-buffer buffer)
    (let ((proc (get-buffer-process buffer)))	; Blast any old process.
      (if proc (delete-process proc)))
    ;; Crank up a new process
    (let ((proc (comint-exec-1 name buffer command switches)))
Jim Blandy's avatar
Jim Blandy committed
326 327
      (make-local-variable 'comint-ptyp)
      (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
David Lawrence's avatar
David Lawrence committed
328
      ;; Jump to the end, and set the process mark.
Jim Blandy's avatar
Jim Blandy committed
329
      (goto-char (point-max))
Jim Blandy's avatar
Jim Blandy committed
330
      (set-marker (process-mark proc) (point))
David Lawrence's avatar
David Lawrence committed
331 332 333 334 335 336 337 338 339 340 341 342
      ;; Feed it the startfile.
      (cond (startfile
	     ;;This is guaranteed to wait long enough
	     ;;but has bad results if the comint does not prompt at all
	     ;;	     (while (= size (buffer-size))
	     ;;	       (sleep-for 1))
	     ;;I hope 1 second is enough!
	     (sleep-for 1)
	     (goto-char (point-max))
	     (insert-file-contents startfile)
	     (setq startfile (buffer-substring (point) (point-max)))
	     (delete-region (point) (point-max))
Jim Blandy's avatar
Jim Blandy committed
343 344
	     (comint-send-string proc startfile)))
    (run-hooks 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
345
    buffer)))
David Lawrence's avatar
David Lawrence committed
346 347

;;; This auxiliary function cranks up the process for comint-exec in
Jim Blandy's avatar
Jim Blandy committed
348
;;; the appropriate environment.
David Lawrence's avatar
David Lawrence committed
349 350

(defun comint-exec-1 (name buffer command switches)
Jim Blandy's avatar
Jim Blandy committed
351 352 353
  (let ((process-environment
	 (comint-update-env process-environment
			    (list (format "TERMCAP=emacs:co#%d:tc=unknown"
Jim Blandy's avatar
Jim Blandy committed
354
					  (frame-width))
Jim Blandy's avatar
Jim Blandy committed
355 356 357
				  "TERM=emacs"
				  "EMACS=t"))))
    (apply 'start-process name buffer command switches)))
Jim Blandy's avatar
Jim Blandy committed
358 359
	     

David Lawrence's avatar
David Lawrence committed
360 361

;; This is just (append new old-env) that compresses out shadowed entries.
Eric S. Raymond's avatar
Eric S. Raymond committed
362
;; It's also pretty ugly, mostly due to lisp's horrible iteration structures.
David Lawrence's avatar
David Lawrence committed
363 364 365 366 367 368 369 370 371 372 373
(defun comint-update-env (old-env new)
  (let ((ans (reverse new))
	(vars (mapcar (function (lambda (vv)
			(and (string-match "^[^=]*=" vv)
			     (substring vv 0 (match-end 0)))))
		      new)))
    (while old-env
      (let* ((vv (car old-env)) ; vv is var=value
	     (var (and (string-match "^[^=]*=" vv)
		       (substring vv 0 (match-end 0)))))
	(setq old-env (cdr old-env))
Jim Blandy's avatar
Jim Blandy committed
374
	(cond ((not (and var (comint-mem var vars)))
David Lawrence's avatar
David Lawrence committed
375 376 377
	       (if var (setq var (cons var vars)))
	       (setq ans (cons vv ans))))))
    (nreverse ans)))
Jim Blandy's avatar
Jim Blandy committed
378 379 380 381 382 383 384 385 386 387 388 389 390

;;; This should be in emacs, but it isn't.
(defun comint-mem (item list &optional elt=)
  "Test to see if ITEM is equal to an item in LIST.
Option comparison function ELT= defaults to equal."
  (let ((elt= (or elt= (function equal)))
	(done nil))
    (while (and list (not done))
      (if (funcall elt= item (car list))
	  (setq done list)
	  (setq list (cdr list))))
    done))

David Lawrence's avatar
David Lawrence committed
391 392 393

;;; Input history retrieval commands
;;; M-p -- previous input    M-n -- next input
Jim Blandy's avatar
Jim Blandy committed
394
;;; M-C-r -- previous input matching
David Lawrence's avatar
David Lawrence committed
395 396 397 398 399
;;; ===========================================================================

(defun comint-previous-input (arg)
  "Cycle backwards through input history."
  (interactive "*p")
400
  (let ((len (ring-length comint-input-ring)))
Jim Blandy's avatar
Jim Blandy committed
401 402 403 404 405 406 407
    (cond ((<= len 0)
	   (message "Empty input ring")
	   (ding))
	  ((not (comint-after-pmark-p))
	   (message "Not after process mark")
	   (ding))
	  (t
408 409 410 411 412 413 414 415 416 417 418
	   (delete-region (point)
			  (process-mark (get-buffer-process (current-buffer))))
	   ;; Initialize the index on the first use of this command
	   ;; so that the first M-p gets index 0, and the first M-n gets
	   ;; index -1.
	   (if (null comint-input-ring-index)
	       (setq comint-input-ring-index
		     (if (> arg 0) -1
			 (if (< arg 0) 1 0))))
	   (setq comint-input-ring-index
		 (comint-mod (+ comint-input-ring-index arg) len))
419
	   (message "%d" (1+ comint-input-ring-index))
420 421 422 423 424 425 426 427 428 429
	   (insert (ring-ref comint-input-ring comint-input-ring-index))))))

(defun comint-mod (n m)
  "Returns N mod M.  M is positive.
Answer is guaranteed to be non-negative, and less than m."
  (let ((n (% n m)))
    (if (>= n 0) n
	(+ n
	   (if (>= m 0) m (- m)))))) ; (abs m)

David Lawrence's avatar
David Lawrence committed
430 431 432 433 434 435 436 437 438
(defun comint-next-input (arg)
  "Cycle forwards through input history."
  (interactive "*p")
  (comint-previous-input (- arg)))

(defun comint-previous-input-matching (str)
  "Searches backwards through input history for substring match."
  (interactive (let* ((last-command last-command) ; preserve around r-f-m
		      (s (read-from-minibuffer 
439 440
			  (format "Command substring (default %s): "
				  comint-last-input-match))))
David Lawrence's avatar
David Lawrence committed
441 442 443
		 (list (if (string= s "") comint-last-input-match s))))
; (interactive "sCommand substring: ")
  (setq comint-last-input-match str) ; update default
444
  (if (null comint-input-ring-index)
445
      (setq comint-input-ring-index -1))
David Lawrence's avatar
David Lawrence committed
446
  (let ((str (regexp-quote str))
447 448 449
        (len (ring-length comint-input-ring))
	(n (+ comint-input-ring-index 1)))
    (while (and (< n len) (not (string-match str (ring-ref comint-input-ring n))))
David Lawrence's avatar
David Lawrence committed
450 451
      (setq n (+ n 1)))
    (cond ((< n len)
452
	   (comint-previous-input (- n comint-input-ring-index)))
453
	  (t (error "Not found")))))
Jim Blandy's avatar
Jim Blandy committed
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508


;;; These next three commands are alternatives to the input history commands
;;; -- comint-next-input, comint-previous-input and
;;; comint-previous-input-matching. They search through the process buffer
;;; text looking for occurrences of the prompt.  Bound to M-P, M-N, and C-c R
;;; (uppercase P, N, and R) for now. Try'em out. Go with what you like...

;;; comint-msearch-input-matching prompts for a string, not a regexp.
;;; This could be considered to be the wrong thing. I decided to keep it
;;; simple, and not make the user worry about regexps. This, of course,
;;; limits functionality.

;;; These commands were deemed non-winning and have been commented out.
;;; Feel free to re-enable them if you like. -Olin 3/91

;(defun comint-psearch-input ()
;  "Search forwards for next occurrence of prompt and skip to end of line.
;\(prompt is anything matching regexp comint-prompt-regexp)"
;  (interactive)
;  (if (re-search-forward comint-prompt-regexp (point-max) t)
;      (end-of-line)
;      (error "No occurrence of prompt found")))
;
;(defun comint-msearch-input ()
;  "Search backwards for previous occurrence of prompt and skip to end of line.
;Search starts from beginning of current line."
;  (interactive)
;  (let ((p (save-excursion
;	     (beginning-of-line)
;	     (cond ((re-search-backward comint-prompt-regexp (point-min) t)
;		    (end-of-line)
;		    (point))
;		   (t nil)))))
;    (if p (goto-char p)
;	(error "No occurrence of prompt found"))))
;
;(defun comint-msearch-input-matching (str)
;  "Search backwards for occurrence of prompt followed by STRING.
;STRING is prompted for, and is NOT a regular expression."
;  (interactive (let ((s (read-from-minibuffer 
;			 (format "Command (default %s): "
;				 comint-last-input-match))))
;		 (list (if (string= s "") comint-last-input-match s))))
;; (interactive "sCommand: ")
;  (setq comint-last-input-match str) ; update default
;  (let* ((r (concat comint-prompt-regexp (regexp-quote str)))
;	 (p (save-excursion
;	      (beginning-of-line)
;	      (cond ((re-search-backward r (point-min) t)
;		     (end-of-line)
;		     (point))
;		    (t nil)))))
;    (if p (goto-char p)
;	(error "No match"))))
David Lawrence's avatar
David Lawrence committed
509 510 511 512 513 514

;;;
;;; Similar input -- contributed by ccm and highly winning.
;;;
;;; Reenter input, removing back to the last insert point if it exists. 
;;;
Jim Blandy's avatar
Jim Blandy committed
515 516
(defvar comint-last-similar-string "" 
  "The string last used in a similar string search.")
David Lawrence's avatar
David Lawrence committed
517
(defun comint-previous-similar-input (arg)
518 519 520 521
  "Fetch the previous (older) input that matches the string typed so far.
Successive repetitions find successively older matching inputs.
A prefix argument serves as a repeat count; a negative argument
fetches following (more recent) inputs."
David Lawrence's avatar
David Lawrence committed
522
  (interactive "p")
Jim Blandy's avatar
Jim Blandy committed
523
  (if (not (comint-after-pmark-p))
David Lawrence's avatar
David Lawrence committed
524
      (error "Not after process mark"))
525 526 527 528 529 530 531
  (if (null comint-input-ring-index)
      (setq comint-input-ring-index
	    (if (> arg 0) -1
	      (if (< arg 0) 1 0))))
  (if (not (or (eq last-command 'comint-previous-similar-input)
	       (eq last-command 'comint-next-similar-input)))
      (setq comint-last-similar-string 
Jim Blandy's avatar
Jim Blandy committed
532 533 534
	    (buffer-substring 
	     (process-mark (get-buffer-process (current-buffer)))
	     (point))))
David Lawrence's avatar
David Lawrence committed
535
  (let* ((size (length comint-last-similar-string))
536 537
	 (len (ring-length comint-input-ring))
	 (n (+ comint-input-ring-index arg))
David Lawrence's avatar
David Lawrence committed
538 539
	 entry)
    (while (and (< n len) 
540
		(or (< (length (setq entry (ring-ref comint-input-ring n))) size)
David Lawrence's avatar
David Lawrence committed
541 542 543 544
		    (not (equal comint-last-similar-string 
				(substring entry 0 size)))))
      (setq n (+ n arg)))
    (cond ((< n len)
545
	   (setq comint-input-ring-index n)
546 547
	   (if (or (eq last-command 'comint-previous-similar-input)
		   (eq last-command 'comint-next-similar-input))
Jim Blandy's avatar
Jim Blandy committed
548 549
	       (delete-region (mark) (point)) ; repeat
	       (push-mark (point)))	      ; 1st time
David Lawrence's avatar
David Lawrence committed
550
	   (insert (substring entry size)))
551
	  (t (error "Not found")))
552
    (message "%d" (1+ comint-input-ring-index))))
Jim Blandy's avatar
Jim Blandy committed
553

554 555 556 557 558 559 560
(defun comint-next-similar-input (arg)
  "Fetch the next (newer) input that matches the string typed so far.
Successive repetitions find successively newer matching inputs.
A prefix argument serves as a repeat count; a negative argument
fetches previous (older) inputs."
  (interactive "p")
  (comint-previous-similar-input (- arg)))
David Lawrence's avatar
David Lawrence committed
561

Jim Blandy's avatar
Jim Blandy committed
562
(defun comint-send-input () 
Christopher Zaborsky's avatar
Christopher Zaborsky committed
563 564 565 566 567 568 569 570
  "Send input to process.
After the process output mark, sends all text from the process mark to
point as input to the process.  Before the process output mark, calls value
of variable comint-get-old-input to retrieve old input, copies it to the
process mark, and sends it.  A terminal newline is also inserted into the
buffer and sent to the process.  In either case, value of variable
comint-input-sentinel is called on the input before sending it.  The input
is entered into the input history ring, if the value of variable
Jim Blandy's avatar
Jim Blandy committed
571 572 573 574
comint-input-filter returns non-nil when called on the input.

If variable comint-eol-on-send is non-nil, then point is moved to the end of
line before sending the input.
David Lawrence's avatar
David Lawrence committed
575 576

comint-get-old-input, comint-input-sentinel, and comint-input-filter are chosen
Jim Blandy's avatar
Jim Blandy committed
577
according to the command interpreter running in the buffer. E.g.,
David Lawrence's avatar
David Lawrence committed
578
If the interpreter is the csh,
Jim Blandy's avatar
Jim Blandy committed
579 580 581 582 583 584
    comint-get-old-input is the default: take the current line, discard any
        initial string matching regexp comint-prompt-regexp.
    comint-input-sentinel monitors input for \"cd\", \"pushd\", and \"popd\" 
        commands. When it sees one, it cd's the buffer.
    comint-input-filter is the default: returns T if the input isn't all white
	space.
David Lawrence's avatar
David Lawrence committed
585 586

If the comint is Lucid Common Lisp, 
Jim Blandy's avatar
Jim Blandy committed
587 588 589
    comint-get-old-input snarfs the sexp ending at point.
    comint-input-sentinel does nothing.
    comint-input-filter returns NIL if the input matches input-filter-regexp,
David Lawrence's avatar
David Lawrence committed
590 591
        which matches (1) all whitespace (2) :a, :c, etc.

592
Similarly for Soar, Scheme, etc."
David Lawrence's avatar
David Lawrence committed
593 594
  (interactive)
  ;; Note that the input string does not include its terminal newline.
Jim Blandy's avatar
Jim Blandy committed
595 596 597 598 599 600 601
  (let ((proc (get-buffer-process (current-buffer))))
    (if (not proc) (error "Current buffer has no process")
	(let* ((pmark (process-mark proc))
	       (pmark-val (marker-position pmark))
	       (input (if (>= (point) pmark-val)
			  (progn (if comint-eol-on-send (end-of-line))
				 (buffer-substring pmark (point)))
Jim Blandy's avatar
Jim Blandy committed
602 603 604 605
			(let ((copy (funcall comint-get-old-input)))
			  (goto-char pmark)
			  (insert copy)
			  copy))))
Jim Blandy's avatar
Jim Blandy committed
606
	  (insert ?\n)
607 608
	  (if (funcall comint-input-filter input)
	      (ring-insert comint-input-ring input))
Jim Blandy's avatar
Jim Blandy committed
609 610
	  (funcall comint-input-sentinel input)
	  (funcall comint-input-sender proc input)
611
	  (setq comint-input-ring-index nil)
Jim Blandy's avatar
Jim Blandy committed
612 613 614
	  (set-marker comint-last-input-start pmark)
	  (set-marker comint-last-input-end (point))
	  (set-marker (process-mark proc) (point))))))
David Lawrence's avatar
David Lawrence committed
615 616

(defun comint-get-old-input-default ()
Christopher Zaborsky's avatar
Christopher Zaborsky committed
617 618 619
  "Default for comint-get-old-input.
Take the current line, and discard any initial text matching
comint-prompt-regexp."
David Lawrence's avatar
David Lawrence committed
620
  (save-excursion
Jim Blandy's avatar
Jim Blandy committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
    (beginning-of-line)
    (comint-skip-prompt)
    (let ((beg (point)))
      (end-of-line)
      (buffer-substring beg (point)))))

(defun comint-skip-prompt ()
  "Skip past the text matching regexp comint-prompt-regexp. 
If this takes us past the end of the current line, don't skip at all."
  (let ((eol (save-excursion (end-of-line) (point))))
    (if (and (looking-at comint-prompt-regexp)
	     (<= (match-end 0) eol))
	(goto-char (match-end 0)))))


(defun comint-after-pmark-p ()
  "Is point after the process output marker?"
  ;; Since output could come into the buffer after we looked at the point
  ;; but before we looked at the process marker's value, we explicitly 
  ;; serialise. This is just because I don't know whether or not emacs
  ;; services input during execution of lisp commands.
  (let ((proc-pos (marker-position
		   (process-mark (get-buffer-process (current-buffer))))))
    (<= proc-pos (point))))

(defun comint-simple-send (proc string)
  "Default function for sending to PROC input STRING.
This just sends STRING plus a newline. To override this,
set the hook COMINT-INPUT-SENDER."
  (comint-send-string proc string)
  (comint-send-string proc "\n"))
David Lawrence's avatar
David Lawrence committed
652 653 654

(defun comint-bol (arg)
  "Goes to the beginning of line, then skips past the prompt, if any.
Jim Blandy's avatar
Jim Blandy committed
655 656
If a prefix argument is given (\\[universal-argument]), then no prompt skip 
-- go straight to column 0.
David Lawrence's avatar
David Lawrence committed
657

Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662
The prompt skip is done by skipping text matching the regular expression
comint-prompt-regexp, a buffer local variable.

If you don't like this command, reset c-a to beginning-of-line 
in your hook, comint-mode-hook."
David Lawrence's avatar
David Lawrence committed
663 664
  (interactive "P")
  (beginning-of-line)
Jim Blandy's avatar
Jim Blandy committed
665
  (if (null arg) (comint-skip-prompt)))
David Lawrence's avatar
David Lawrence committed
666 667 668

;;; These two functions are for entering text you don't want echoed or
;;; saved -- typically passwords to ftp, telnet, or somesuch.
Jim Blandy's avatar
Jim Blandy committed
669 670
;;; Just enter m-x send-invisible and type in your line.

Jim Blandy's avatar
Jim Blandy committed
671
(defun comint-read-noecho (prompt &optional stars)
Noah Friedman's avatar
Noah Friedman committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685
  "Read a single line of text from user without echoing, and return it. 
Prompt with argument PROMPT, a string.  Optional argument STARS causes
input to be echoed with '*' characters on the prompt line.  Input ends with
RET, LFD, or ESC.  DEL or C-h rubs out.  C-u kills line.  C-g aborts (if
inhibit-quit is set because e.g. this function was called from a process
filter and C-g is pressed, this function will return `nil', rather than a
string).

Note that the keystrokes comprising the text can still be recovered
(temporarily) with \\[view-lossage].  This may be a security bug for some
applications."
  (let ((ans "")
	(c 0)
	(echo-keystrokes 0)
Jim Blandy's avatar
Jim Blandy committed
686
	(cursor-in-echo-area t)
Noah Friedman's avatar
Noah Friedman committed
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
        (done nil))
    (while (not done)
      (if stars
          (message "%s%s" prompt (make-string (length ans) ?*))
        (message prompt))
      (setq c (read-char))
      (cond ((= c ?\C-g)
             ;; This function may get called from a process filter, where
             ;; inhibit-quit is set.  In later versions of emacs read-char
             ;; may clear quit-flag itself and return C-g.  That would make
             ;; it impossible to quit this loop in a simple way, so
             ;; re-enable it here (for backward-compatibility the check for
             ;; quit-flag below would still be necessary, so this is seems
             ;; like the simplest way to do things).
             (setq quit-flag t
                   done t))
            ((or (= c ?\r) (= c ?\n) (= c ?\e))
             (setq done t))
            ((= c ?\C-u)
             (setq ans ""))
            ((and (/= c ?\b) (/= c ?\177))
             (setq ans (concat ans (char-to-string c))))
            ((> (length ans) 0)
             (setq ans (substring ans 0 -1)))))
    (if quit-flag
        ;; Emulate a true quit, except that we have to return a value.
        (prog1
            (setq quit-flag nil)
          (message "Quit")
          (beep t))
      (message "")
      ans)))
Jim Blandy's avatar
Jim Blandy committed
719

David Lawrence's avatar
David Lawrence committed
720
(defun send-invisible (str)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
721 722 723
  "Read a string without echoing.
Then send it to the process running in the current buffer. A new-line
is additionally sent. String is not saved on comint input history list.
Jim Blandy's avatar
Jim Blandy committed
724 725
Security bug: your string can still be temporarily recovered with
\\[view-lossage]."
David Lawrence's avatar
David Lawrence committed
726 727 728 729 730 731
; (interactive (list (comint-read-noecho "Enter non-echoed text")))
  (interactive "P") ; Defeat snooping via C-x esc
  (let ((proc (get-buffer-process (current-buffer))))
    (if (not proc) (error "Current buffer has no process")
	(comint-send-string proc
			    (if (stringp str) str
Jim Blandy's avatar
Jim Blandy committed
732
				(comint-read-noecho "Non-echoed text: " t)))
David Lawrence's avatar
David Lawrence committed
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
	(comint-send-string proc "\n"))))


;;; Low-level process communication

(defvar comint-input-chunk-size 512
  "*Long inputs send to comint processes are broken up into chunks of this size.
If your process is choking on big inputs, try lowering the value.")

(defun comint-send-string (proc str)
  "Send PROCESS the contents of STRING as input.
This is equivalent to process-send-string, except that long input strings
are broken up into chunks of size comint-input-chunk-size. Processes
are given a chance to output between chunks. This can help prevent processes
from hanging when you send them long inputs on some OS's."
  (let* ((len (length str))
	 (i (min len comint-input-chunk-size)))
    (process-send-string proc (substring str 0 i))
    (while (< i len)
      (let ((next-i (+ i comint-input-chunk-size)))
	(accept-process-output)
	(process-send-string proc (substring str i (min len next-i)))
	(setq i next-i)))))

(defun comint-send-region (proc start end)
  "Sends to PROC the region delimited by START and END.
This is a replacement for process-send-region that tries to keep
your process from hanging on long inputs. See comint-send-string."
  (comint-send-string proc (buffer-substring start end)))


;;; Random input hackage

Jim Blandy's avatar
Jim Blandy committed
766
(defun comint-kill-output ()
David Lawrence's avatar
David Lawrence committed
767 768
  "Kill all output from interpreter since last input."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
769 770 771 772 773
  (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
    (kill-region comint-last-input-end pmark)
    (goto-char pmark)    
    (insert "*** output flushed ***\n")
    (set-marker pmark (point))))
David Lawrence's avatar
David Lawrence committed
774 775

(defun comint-show-output ()
Jim Blandy's avatar
Jim Blandy committed
776 777
  "Display start of this batch of interpreter output at top of window.
Also put cursor there."
David Lawrence's avatar
David Lawrence committed
778 779
  (interactive)
  (goto-char comint-last-input-end)
Jim Blandy's avatar
Jim Blandy committed
780
  (backward-char)
David Lawrence's avatar
David Lawrence committed
781 782
  (beginning-of-line)
  (set-window-start (selected-window) (point))
Jim Blandy's avatar
Jim Blandy committed
783
  (end-of-line))
David Lawrence's avatar
David Lawrence committed
784 785

(defun comint-interrupt-subjob ()
Jim Blandy's avatar
Jim Blandy committed
786
  "Interrupt the current subjob."
David Lawrence's avatar
David Lawrence committed
787
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
788
  (interrupt-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
789 790

(defun comint-kill-subjob ()
Jim Blandy's avatar
Jim Blandy committed
791
  "Send kill signal to the current subjob."
David Lawrence's avatar
David Lawrence committed
792
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
793
  (kill-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
794 795

(defun comint-quit-subjob ()
Jim Blandy's avatar
Jim Blandy committed
796
  "Send quit signal to the current subjob."
David Lawrence's avatar
David Lawrence committed
797
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
798
  (quit-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
799 800

(defun comint-stop-subjob ()
Jim Blandy's avatar
Jim Blandy committed
801
  "Stop the current subjob.
David Lawrence's avatar
David Lawrence committed
802
WARNING: if there is no current subjob, you can end up suspending
Jim Blandy's avatar
Jim Blandy committed
803 804 805
the top-level process running in the buffer. If you accidentally do
this, use \\[comint-continue-subjob] to resume the process. (This
is not a problem with most shells, since they ignore this signal.)"
David Lawrence's avatar
David Lawrence committed
806
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
807
  (stop-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
808 809

(defun comint-continue-subjob ()
Jim Blandy's avatar
Jim Blandy committed
810
  "Send CONT signal to process buffer's process group.
David Lawrence's avatar
David Lawrence committed
811 812
Useful if you accidentally suspend the top-level process."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
813
  (continue-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
814 815

(defun comint-kill-input ()
Jim Blandy's avatar
Jim Blandy committed
816
  "Kill all text from last stuff output by interpreter to point."
David Lawrence's avatar
David Lawrence committed
817
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
818 819 820 821
  (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
	 (p-pos (marker-position pmark)))
    (if (> (point) p-pos)
	(kill-region pmark (point)))))
David Lawrence's avatar
David Lawrence committed
822 823 824 825 826 827

(defun comint-delchar-or-maybe-eof (arg)
  "Delete ARG characters forward, or send an EOF to process if at end of buffer."
  (interactive "p")
  (if (eobp)
      (process-send-eof)
Jim Blandy's avatar
Jim Blandy committed
828 829 830 831
      (delete-char arg)))



David Lawrence's avatar
David Lawrence committed
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

;;; Support for source-file processing commands.
;;;============================================================================
;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
;;; commands that process files of source text (e.g. loading or compiling
;;; files). So the corresponding process-in-a-buffer modes have commands
;;; for doing this (e.g., lisp-load-file). The functions below are useful
;;; for defining these commands.
;;;
;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
;;; and Soar, in that they don't know anything about file extensions.
;;; So the compile/load interface gets the wrong default occasionally.
;;; The load-file/compile-file default mechanism could be smarter -- it
;;; doesn't know about the relationship between filename extensions and
;;; whether the file is source or executable. If you compile foo.lisp
;;; with compile-file, then the next load-file should use foo.bin for
;;; the default, not foo.lisp. This is tricky to do right, particularly
;;; because the extension for executable files varies so much (.o, .bin,
;;; .lbin, .mo, .vo, .ao, ...).


;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
;;; commands.
;;;
;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
;;; want to save the buffer before issuing any process requests to the command
;;; interpreter.
;;;
;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
;;; for the file to process.

;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
;;;============================================================================
;;; This function computes the defaults for the load-file and compile-file
Jim Blandy's avatar
Jim Blandy committed
866
;;; commands for tea, soar, cmulisp, and cmuscheme modes. 
David Lawrence's avatar
David Lawrence committed
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
;;; 
;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last 
;;; source-file processing command. NIL if there hasn't been one yet.
;;; - SOURCE-MODES is a list used to determine what buffers contain source
;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
;;; Typically, (lisp-mode) or (scheme-mode).
;;; 
;;; If the command is given while the cursor is inside a string, *and*
;;; the string is an existing filename, *and* the filename is not a directory,
;;; then the string is taken as default. This allows you to just position
;;; your cursor over a string that's a filename and have it taken as default.
;;;
;;; If the command is given in a file buffer whose major mode is in
;;; SOURCE-MODES, then the the filename is the default file, and the
;;; file's directory is the default directory.
;;; 
;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
;;; then the default directory & file are what was used in the last source-file
;;; processing command (i.e., PREVIOUS-DIR/FILE).  If this is the first time
;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
;;; is the cwd, with no default file. (\"no default file\" = nil)
;;; 
;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
;;; for Soar programs, etc.
;;; 
;;; The function returns a pair: (default-directory . default-file).

(defun comint-source-default (previous-dir/file source-modes)
  (cond ((and buffer-file-name (memq major-mode source-modes))
	 (cons (file-name-directory    buffer-file-name)
	       (file-name-nondirectory buffer-file-name)))
	(previous-dir/file)
	(t
	 (cons default-directory nil))))

Jim Blandy's avatar
Jim Blandy committed
903

David Lawrence's avatar
David Lawrence committed
904 905
;;; (COMINT-CHECK-SOURCE fname)
;;;============================================================================
Jim Blandy's avatar
Jim Blandy committed
906
;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
David Lawrence's avatar
David Lawrence committed
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
;;; process-in-a-buffer modes), this function can be called on the filename.
;;; If the file is loaded into a buffer, and the buffer is modified, the user
;;; is queried to see if he wants to save the buffer before proceeding with
;;; the load or compile.

(defun comint-check-source (fname)
  (let ((buff (get-file-buffer fname)))
    (if (and buff
	     (buffer-modified-p buff)
	     (y-or-n-p (format "Save buffer %s first? "
			       (buffer-name buff))))
	;; save BUFF.
	(let ((old-buffer (current-buffer)))
	  (set-buffer buff)
	  (save-buffer)
	  (set-buffer old-buffer)))))

Jim Blandy's avatar
Jim Blandy committed
924

David Lawrence's avatar
David Lawrence committed
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
;;;============================================================================
;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
;;; commands that process source files (like loading or compiling a file).
;;; It prompts for the filename, provides a default, if there is one,
;;; and returns the result filename.
;;; 
;;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
;;; 
;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
;;; from the last source processing command.  SOURCE-MODES is a list of major
;;; modes used to determine what file buffers contain source files.  (These
;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
;;; then the filename reader will only accept a file that exists.
;;; 
;;; A typical use:
;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
;;;                                 '(lisp-mode) t))

;;; This is pretty stupid about strings. It decides we're in a string
;;; if there's a quote on both sides of point on the current line.
(defun comint-extract-string ()
Christopher Zaborsky's avatar
Christopher Zaborsky committed
947
  "Returns string around POINT that starts the current line or nil." 
David Lawrence's avatar
David Lawrence committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
  (save-excursion
    (let* ((point (point))
	   (bol (progn (beginning-of-line) (point)))
	   (eol (progn (end-of-line) (point)))
	   (start (progn (goto-char point) 
			 (and (search-backward "\"" bol t) 
			      (1+ (point)))))
	   (end (progn (goto-char point)
		       (and (search-forward "\"" eol t)
			    (1- (point))))))
      (and start end
	   (buffer-substring start end)))))

(defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
  (let* ((def (comint-source-default prev-dir/file source-modes))
         (stringfile (comint-extract-string))
	 (sfile-p (and stringfile
Jim Blandy's avatar
Jim Blandy committed
965 966 967
		       (condition-case ()
			   (file-exists-p stringfile)
			 (error nil))
David Lawrence's avatar
David Lawrence committed
968 969 970 971 972 973 974 975 976 977 978 979 980
		       (not (file-directory-p stringfile))))
	 (defdir  (if sfile-p (file-name-directory stringfile)
                      (car def)))
	 (deffile (if sfile-p (file-name-nondirectory stringfile)
                      (cdr def)))
	 (ans (read-file-name (if deffile (format "%s(default %s) "
						  prompt    deffile)
				  prompt)
			      defdir
			      (concat defdir deffile)
			      mustmatch-p)))
    (list (expand-file-name (substitute-in-file-name ans)))))

Jim Blandy's avatar
Jim Blandy committed
981 982 983 984 985 986 987 988
;;; I am somewhat divided on this string-default feature. It seems
;;; to violate the principle-of-least-astonishment, in that it makes
;;; the default harder to predict, so you actually have to look and see
;;; what the default really is before choosing it. This can trip you up.
;;; On the other hand, it can be useful, I guess. I would appreciate feedback
;;; on this.
;;;     -Olin

David Lawrence's avatar
David Lawrence committed
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035

;;; Simple process query facility.
;;; ===========================================================================
;;; This function is for commands that want to send a query to the process
;;; and show the response to the user. For example, a command to get the
;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
;;; to an inferior Common Lisp process.
;;; 
;;; This simple facility just sends strings to the inferior process and pops
;;; up a window for the process buffer so you can see what the process
;;; responds with.  We don't do anything fancy like try to intercept what the
;;; process responds with and put it in a pop-up window or on the message
;;; line. We just display the buffer. Low tech. Simple. Works good.

;;; Send to the inferior process PROC the string STR. Pop-up but do not select
;;; a window for the inferior process so that its response can be seen.
(defun comint-proc-query (proc str)
  (let* ((proc-buf (process-buffer proc))
	 (proc-mark (process-mark proc)))
    (display-buffer proc-buf)
    (set-buffer proc-buf) ; but it's not the selected *window*
    (let ((proc-win (get-buffer-window proc-buf))
	  (proc-pt (marker-position proc-mark)))
      (comint-send-string proc str) ; send the query
      (accept-process-output proc)  ; wait for some output
      ;; Try to position the proc window so you can see the answer.
      ;; This is bogus code. If you delete the (sit-for 0), it breaks.
      ;; I don't know why. Wizards invited to improve it.
      (if (not (pos-visible-in-window-p proc-pt proc-win))
	  (let ((opoint (window-point proc-win)))
	    (set-window-point proc-win proc-mark) (sit-for 0)
	    (if (not (pos-visible-in-window-p opoint proc-win))
		(push-mark opoint)
		(set-window-point proc-win opoint)))))))


;;; Filename completion in a buffer
;;; ===========================================================================
;;; Useful completion functions, courtesy of the Ergo group.

;;; Three commands:
;;; comint-dynamic-complete		Complete filename at point.
;;; comint-dynamic-list-completions	List completions in help buffer.
;;; comint-replace-by-expanded-filename	Expand and complete filename at point;
;;;					replace with expanded/completed name.

;;; These are not installed in the comint-mode keymap. But they are
Jim Blandy's avatar
Jim Blandy committed
1036
;;; available for people who want them. Shell-mode installs them:
1037 1038
;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
;;; (define-key shell-mode-map "\M-?"  'comint-dynamic-list-completions)))
Jim Blandy's avatar
Jim Blandy committed
1039 1040
;;;
;;; Commands like this are fine things to put in load hooks if you
1041
;;; want them present in specific modes.
Jim Blandy's avatar
Jim Blandy committed
1042

David Lawrence's avatar
David Lawrence committed
1043 1044

(defun comint-match-partial-pathname ()
Jim Blandy's avatar
Jim Blandy committed
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
  "Returns the filename at point or causes an error."
  (save-excursion
    (if (re-search-backward "[^~/A-Za-z0-9---_.$#,=]" nil 'move)
	(forward-char 1))
    ;; Anchor the search forwards.
    (if (not (looking-at "[~/A-Za-z0-9---_.$#,=]")) (error ""))
    (re-search-forward "[~/A-Za-z0-9---_.$#,=]+")
    (substitute-in-file-name
     (buffer-substring (match-beginning 0) (match-end 0)))))

David Lawrence's avatar
David Lawrence committed
1055 1056

(defun comint-replace-by-expanded-filename ()
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1057 1058 1059
"Expand the filename at point.
Replace the filename with an expanded, canonicalised, and completed
 replacement.
David Lawrence's avatar
David Lawrence committed
1060 1061
\"Expanded\" means environment variables (e.g., $HOME) and ~'s are
replaced with the corresponding directories.  \"Canonicalised\" means ..
Jim Blandy's avatar
Jim Blandy committed
1062 1063
and \. are removed, and the filename is made absolute instead of relative.
See functions expand-file-name and substitute-in-file-name. See also
David Lawrence's avatar
David Lawrence committed
1064 1065 1066 1067 1068 1069 1070 1071
comint-dynamic-complete."
  (interactive)
  (let* ((pathname (comint-match-partial-pathname))
	 (pathdir (file-name-directory pathname))
	 (pathnondir (file-name-nondirectory pathname))
	 (completion (file-name-completion pathnondir
					   (or pathdir default-directory))))
    (cond ((null completion)
1072
	   (message "No completions of %s" pathname)
Jim Blandy's avatar
Jim Blandy committed
1073
	   (ding))
David Lawrence's avatar
David Lawrence committed
1074
	  ((eql completion t)
1075
	   (message "Unique completion"))
David Lawrence's avatar
David Lawrence committed
1076 1077 1078 1079
	  (t				; this means a string was returned.
	   (delete-region (match-beginning 0) (match-end 0))
	   (insert (expand-file-name (concat pathdir completion)))))))

Jim Blandy's avatar
Jim Blandy committed
1080

David Lawrence's avatar
David Lawrence committed
1081
(defun comint-dynamic-complete ()
Jim Blandy's avatar
Jim Blandy committed
1082
  "Dynamically complete the filename at point.
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1083
This function is similar to `comint-replace-by-expanded-filename', except
David Lawrence's avatar
David Lawrence committed
1084 1085 1086 1087 1088 1089
that it won't change parts of the filename already entered in the buffer; 
it just adds completion characters to the end of the filename."
  (interactive)
  (let* ((pathname (comint-match-partial-pathname))
	 (pathdir (file-name-directory pathname))
	 (pathnondir (file-name-nondirectory pathname))
Jim Blandy's avatar
Jim Blandy committed
1090
	 (completion (file-name-completion  pathnondir
David Lawrence's avatar
David Lawrence committed
1091 1092
					   (or pathdir default-directory))))
    (cond ((null completion)
1093
	   (message "No completions of %s" pathname)
Jim Blandy's avatar
Jim Blandy committed
1094
	   (ding))
David Lawrence's avatar
David Lawrence committed
1095
	  ((eql completion t)
1096
	   (message "Unique completion"))
David Lawrence's avatar
David Lawrence committed
1097 1098 1099 1100 1101
	  (t				; this means a string was returned.
	   (goto-char (match-end 0))
	   (insert (substring completion (length pathnondir)))))))

(defun comint-dynamic-list-completions ()
Jim Blandy's avatar
Jim Blandy committed
1102
  "List in help buffer all possible completions of the filename at point."
David Lawrence's avatar
David Lawrence committed
1103 1104 1105 1106 1107 1108 1109 1110
  (interactive)
  (let* ((pathname (comint-match-partial-pathname))
	 (pathdir (file-name-directory pathname))
	 (pathnondir (file-name-nondirectory pathname))
	 (completions
	  (file-name-all-completions pathnondir
				     (or pathdir default-directory))))
    (cond ((null completions)
1111
	   (message "No completions of %s" pathname)
Jim Blandy's avatar
Jim Blandy committed
1112
	   (ding))
David Lawrence's avatar
David Lawrence committed
1113 1114
	  (t
	   (let ((conf (current-window-configuration)))
Jim Blandy's avatar
Jim Blandy committed
1115
	     (with-output-to-temp-buffer "*Help*"
David Lawrence's avatar
David Lawrence committed
1116 1117
	       (display-completion-list completions))
	     (sit-for 0)
1118
	     (message "Hit space to flush")
1119
	     (let ((ch (read-event)))
1120
	       (if (eq ch ?\ )
David Lawrence's avatar
David Lawrence committed
1121
		   (set-window-configuration conf)
1122
		 (setq unread-command-events (list ch)))))))))
David Lawrence's avatar
David Lawrence committed
1123 1124 1125

;;; Converting process modes to use comint mode
;;; ===========================================================================
Eric S. Raymond's avatar
Eric S. Raymond committed
1126 1127 1128
;;; The code in the Emacs 19 distribution has all been modified to use comint
;;; where needed.  However, there are `third-party' packages out there that
;;; still use the old shell mode.  Here's a guide to conversion.
Jim Blandy's avatar
Jim Blandy committed
1129
;;;
David Lawrence's avatar
David Lawrence committed
1130
;;; Renaming variables
Jim Blandy's avatar
Jim Blandy committed
1131 1132 1133
;;; Most of the work is renaming variables and functions. These are the common
;;; ones:
;;; Local variables:
Jim Blandy's avatar
Jim Blandy committed
1134
;;;	last-input-start	comint-last-input-start
Jim Blandy's avatar
Jim Blandy committed
1135 1136 1137 1138
;;; 	last-input-end		comint-last-input-end
;;;	shell-prompt-pattern	comint-prompt-regexp
;;;     shell-set-directory-error-hook <no equivalent>
;;; Miscellaneous:
David Lawrence's avatar
David Lawrence committed
1139 1140
;;;	shell-set-directory	<unnecessary>
;;; 	shell-mode-map		comint-mode-map
Jim Blandy's avatar
Jim Blandy committed
1141
;;; Commands:
David Lawrence's avatar
David Lawrence committed
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
;;;	shell-send-input	comint-send-input
;;;	shell-send-eof		comint-delchar-or-maybe-eof
;;; 	kill-shell-input	comint-kill-input
;;;	interrupt-shell-subjob	comint-interrupt-subjob
;;;	stop-shell-subjob	comint-stop-subjob
;;;	quit-shell-subjob	comint-quit-subjob
;;;	kill-shell-subjob	comint-kill-subjob
;;;	kill-output-from-shell	comint-kill-output
;;;	show-output-from-shell	comint-show-output
;;;	copy-last-shell-input	Use comint-previous-input/comint-next-input
;;;
Jim Blandy's avatar
Jim Blandy committed
1153 1154 1155
;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-sentinel.
;;; Comint mode does not provide functionality equivalent to
David Lawrence's avatar
David Lawrence committed
1156
;;; shell-set-directory-error-hook; it is gone.
Jim Blandy's avatar
Jim Blandy committed
1157 1158 1159 1160 1161 1162 1163
;;;
;;; comint-last-input-start is provided for modes which want to munge
;;; the buffer after input is sent, perhaps because the inferior
;;; insists on echoing the input.  The LAST-INPUT-START variable in
;;; the old shell package was used to implement a history mechanism,
;;; but you should think twice before using comint-last-input-start
;;; for this; the input history ring often does the job better.
David Lawrence's avatar
David Lawrence committed
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
;;; 
;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
;;; *not* create the comint-mode local variables in your foo-mode function.
;;; This is not modular.  Instead, call comint-mode, and let *it* create the
;;; necessary comint-specific local variables. Then create the
;;; foo-mode-specific local variables in foo-mode.  Set the buffer's keymap to
;;; be foo-mode-map, and its mode to be foo-mode.  Set the comint-mode hooks
;;; (comint-prompt-regexp, comint-input-filter, comint-input-sentinel,
;;; comint-get-old-input) that need to be different from the defaults.  Call
;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
1174
;;; comint-mode will take care of it. The following example, from shell.el,
Jim Blandy's avatar
Jim Blandy committed
1175 1176 1177 1178