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

Eric S. Raymond's avatar
Eric S. Raymond committed
3 4
;;; Copyright Olin Shivers (1988).

Eric S. Raymond's avatar
Eric S. Raymond committed
5 6
;; Maintainer: Olin Shivers <shivers@cs.cmu.edu>
;; Version: 2.03
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keyword: estensions, processes
Eric S. Raymond's avatar
Eric S. Raymond committed
8

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

;;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;;; the Free Software Foundation; either version 2, or (at your option)
David Lawrence's avatar
David Lawrence committed
14 15 16 17 18 19 20 21 22 23 24
;;; any later version.

;;; 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.

;;; 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.

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

Jim Blandy's avatar
Jim Blandy committed
27 28 29 30 31 32
;;; 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
33 34 35 36 37 38 39
;;; 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
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
;;; Several packages are already defined using comint mode:
;;; - cmushell.el defines a shell-in-a-buffer mode.
;;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
;;; Cmushell and cmulisp mode are similar to, and intended to replace,
;;; their counterparts in the standard gnu emacs release (in shell.el). 
;;; These replacements are more featureful, robust, and uniform than the 
;;; released versions. The key bindings in lisp mode are also more compatible
;;; with the bindings of Hemlock and Zwei (the Lisp Machine emacs).
;;;
;;; - 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
57 58 59 60 61
;;; 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
62 63
;;; 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
64 65 66
;;; instead of shell-mode, see the notes at the end of this file.


Jim Blandy's avatar
Jim Blandy committed
67 68 69 70 71 72 73 74
;;; Brief Command Documentation:
;;;============================================================================
;;; Comint Mode Commands: (common to all derived modes, like cmushell & cmulisp
;;; mode)
;;;
;;; m-p	    comint-previous-input    	    Cycle backwards in input history
;;; m-n	    comint-next-input  	    	    Cycle forwards
;;; m-s     comint-previous-similar-input   Previous similar input
Jim Blandy's avatar
Jim Blandy committed
75
;;; c-m-r   comint-previous-input-matching  Search backwards in input history
Jim Blandy's avatar
Jim Blandy committed
76 77 78 79 80 81 82 83 84 85 86
;;; 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
87 88 89 90 91 92 93
;;; 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
94 95 96 97 98 99 100 101 102 103 104 105 106
;;; 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
107

Eric S. Raymond's avatar
Eric S. Raymond committed
108 109 110 111
;;; Code:

(defconst comint-version "2.03")

David Lawrence's avatar
David Lawrence committed
112 113 114 115 116

;;; 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
117
;;;     comint-last-input-start - marker       Handy if inferior always echos
Jim Blandy's avatar
Jim Blandy committed
118
;;;     comint-last-input-end   - marker       For comint-kill-output command
David Lawrence's avatar
David Lawrence committed
119 120 121 122 123 124 125 126 127 128
;;;     input-ring-size         - integer      For the input history
;;;     input-ring              - ring             mechanism
;;;     input-ring-index        - marker           ...
;;;     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
129 130 131
(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
132 133

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

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

Jim Blandy's avatar
Jim Blandy committed
143 144
(defvar input-ring-size 30
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
145 146

;;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
147 148
(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
149 150 151
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
152
leading text matching comint-prompt-regexp")
David Lawrence's avatar
David Lawrence committed
153

Jim Blandy's avatar
Jim Blandy committed
154 155 156
(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
157

Jim Blandy's avatar
Jim Blandy committed
158 159 160
(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
161
Only inputs answering true to this function are saved on the input
Jim Blandy's avatar
Jim Blandy committed
162 163 164 165 166 167 168 169 170 171 172 173
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
174 175

(defvar comint-mode-hook '()
Jim Blandy's avatar
Jim Blandy committed
176 177 178 179 180 181 182 183 184 185 186
  "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
187 188 189 190 191 192

(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
193 194
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
195 196

This mode is typically customised to create inferior-lisp-mode,
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200
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
201 202 203 204 205 206 207 208 209 210 211 212

An input history is maintained of size input-ring-size, and
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
213
Entry to this mode runs the hooks on comint-mode-hook"
David Lawrence's avatar
David Lawrence committed
214
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
215 216 217 218 219 220 221 222 223
  (let ((old-ring (and (assq 'input-ring (buffer-local-variables))
		       (boundp 'input-ring)
		       input-ring))
	(old-ptyp comint-ptyp)) ; preserve across local var kill. gross.
;   (kill-all-local-variables) ; Removed 1/15/90 Olin
    (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
224 225
    (make-local-variable 'comint-last-input-start)
    (setq comint-last-input-start (make-marker))
Jim Blandy's avatar
Jim Blandy committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
    (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
    (make-local-variable 'input-ring-size)      ; ...to global val.
    (make-local-variable 'input-ring)
    (make-local-variable 'input-ring-index)
    (setq input-ring-index 0)
    (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)
    (setq comint-ptyp old-ptyp)
Jim Blandy's avatar
Jim Blandy committed
242
    (make-local-variable 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246 247 248 249 250 251 252 253 254 255
    (run-hooks 'comint-mode-hook)
    ;Do this after the hook so the user can mung INPUT-RING-SIZE w/his hook.
    ;The test is so we don't lose history if we run comint-mode twice in
    ;a buffer.
    (setq input-ring (if (ring-p old-ring) old-ring
			 (make-ring input-ring-size)))))

;;; The old-ptyp stuff above is because we have to preserve the value of
;;; comint-ptyp across calls to comint-mode, in spite of the
;;; kill-all-local-variables that it does. Blech. Hopefully, this will all
;;; go away when a later release fixes the signalling bug.
;;; (Later: I removed the kill-all-local-variables, but have left this
;;; other code in place just in case I reverse myself.)
David Lawrence's avatar
David Lawrence committed
256

Jim Blandy's avatar
Jim Blandy committed
257 258 259 260 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 295 296
(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)
  (define-key comint-mode-map "\es" 'comint-previous-similar-input)
  (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
297 298 299 300

;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
;;; for the second argument (program).
(defun make-comint (name program &optional startfile &rest switches)
Jim Blandy's avatar
Jim Blandy committed
301
  (let ((buffer (get-buffer-create (concat "*" name "*"))))
David Lawrence's avatar
David Lawrence committed
302 303
    ;; If no process, or nuked process, crank up a new one and put buffer in
    ;; comint mode. Otherwise, leave buffer and existing process alone.
Jim Blandy's avatar
Jim Blandy committed
304
    (cond ((not (comint-check-proc buffer))
Jim Blandy's avatar
Jim Blandy committed
305
	   (save-excursion
David Lawrence's avatar
David Lawrence committed
306 307 308 309 310
	     (set-buffer buffer)
	     (comint-mode)) ; Install local vars, mode, keymap, ...
	   (comint-exec buffer name program startfile switches)))
    buffer))

Jim Blandy's avatar
Jim Blandy committed
311 312 313 314
(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.")

David Lawrence's avatar
David Lawrence committed
315 316
(defun comint-exec (buffer name command startfile switches)
  "Fires up a process in buffer for comint modes.
Jim Blandy's avatar
Jim Blandy committed
317 318 319
Blasts any old process running in the buffer. Doesn't set the buffer mode.
You can use this to cheaply run a series of processes in the same comint
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

Jim Blandy's avatar
Jim Blandy committed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 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
;;; Ring Code
;;;============================================================================
;;; This code defines a ring data structure. A ring is a 
;;;     (hd-index tl-index . vector) 
;;; list. You can insert to, remove from, and rotate a ring. When the ring
;;; fills up, insertions cause the oldest elts to be quietly dropped.
;;;
;;; HEAD = index of the newest item on the ring.
;;; TAIL = index of the oldest item on the ring.
;;;
;;; These functions are used by the input history mechanism, but they can
;;; be used for other purposes as well.

(defun ring-p (x) 
  "T if X is a ring; NIL otherwise."
  (and (consp x) (integerp (car x))
       (consp (cdr x)) (integerp (car (cdr x)))
       (vectorp (cdr (cdr x)))))

(defun make-ring (size)
  "Make a ring that can contain SIZE elts"
  (cons 1 (cons 0 (make-vector (+ size 1) nil))))

(defun ring-plus1 (index veclen)
  "INDEX+1, with wraparound"
  (let ((new-index (+ index 1)))
    (if (= new-index veclen) 0 new-index)))

(defun ring-minus1 (index veclen)
  "INDEX-1, with wraparound"
  (- (if (= 0 index) veclen index) 1))

(defun ring-length (ring)
  "Number of elts in the ring."
  (let ((hd (car ring)) (tl (car (cdr ring)))  (siz (length (cdr (cdr ring)))))
    (let ((len (if (<= hd tl) (+ 1 (- tl hd)) (+ 1 tl (- siz hd)))))
      (if (= len siz) 0 len))))

(defun ring-empty-p (ring)
  (= 0 (ring-length ring)))

(defun ring-insert (ring item)
  "Insert a new item onto the ring. If the ring is full, dump the oldest
item to make room."       
  (let* ((vec (cdr (cdr ring)))  (len (length vec))
	 (new-hd (ring-minus1 (car ring) len)))
      (setcar ring new-hd)
      (aset vec new-hd item)
      (if (ring-empty-p ring) ;overflow -- dump one off the tail.
	  (setcar (cdr ring) (ring-minus1 (car (cdr ring)) len)))))

(defun ring-remove (ring)
  "Remove the oldest item retained on the ring."
  (if (ring-empty-p ring) (error "Ring empty")
      (let ((tl (car (cdr ring)))  (vec (cdr (cdr ring))))
	(set-car (cdr ring) (ring-minus1 tl (length vec)))
	(aref vec tl))))

;;; This isn't actually used in this package. I just threw it in in case
;;; someone else wanted it. If you want rotating-ring behavior on your history
;;; retrieval (analagous to kill ring behavior), this function is what you
;;; need. I should write the yank-input and yank-pop-input-or-kill to go with
;;; this, and not bind it to a key by default, so it would be available to
;;; people who want to bind it to a key. But who would want it? Blech.
(defun ring-rotate (ring n)
  (if (not (= n 0))
      (if (ring-empty-p ring) ;Is this the right error check?
	  (error "ring empty")
	  (let ((hd (car ring))  (tl (car (cdr ring)))  (vec (cdr (cdr ring))))
	    (let ((len (length vec)))
	      (while (> n 0)
		(setq tl (ring-plus1 tl len))
		(aset ring tl (aref ring hd))
		(setq hd (ring-plus1 hd len))
		(setq n (- n 1)))
	      (while (< n 0)
		(setq hd (ring-minus1 hd len))
		(aset vec hd (aref vec tl))
		(setq tl (ring-minus1 tl len))
		(setq n (- n 1))))
	    (set-car ring hd)
	    (set-car (cdr ring) tl)))))

(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)

(defun ring-ref (ring index)
  (let ((numelts (ring-length ring)))
    (if (= numelts 0) (error "indexed empty ring")
	(let* ((hd (car ring))  (tl (car (cdr ring)))  (vec (cdr (cdr ring)))
	       (index (comint-mod index numelts))
	       (vec-index (comint-mod (+ index hd) 
				      (length vec))))
	  (aref vec vec-index)))))


David Lawrence's avatar
David Lawrence committed
493 494
;;; Input history retrieval commands
;;; M-p -- previous input    M-n -- next input
Jim Blandy's avatar
Jim Blandy committed
495
;;; M-C-r -- previous input matching
David Lawrence's avatar
David Lawrence committed
496 497 498 499 500 501
;;; ===========================================================================

(defun comint-previous-input (arg)
  "Cycle backwards through input history."
  (interactive "*p")
  (let ((len (ring-length input-ring)))
Jim Blandy's avatar
Jim Blandy committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
    (cond ((<= len 0)
	   (message "Empty input ring")
	   (ding))
	  ((not (comint-after-pmark-p))
	   (message "Not after process mark")
	   (ding))
	  (t
	   (cond ((eq last-command 'comint-previous-input)
		  (delete-region (mark) (point)))
		 ((eq last-command 'comint-previous-similar-input)
		  (delete-region 
		   (process-mark (get-buffer-process (current-buffer)))
		   (point)))
		 (t                          
		  (setq input-ring-index
			(if (> arg 0) -1
			    (if (< arg 0) 1 0)))
		  (push-mark (point))))
	   (setq input-ring-index (comint-mod (+ input-ring-index arg) len))
	   (message "%d" (1+ input-ring-index))
	   (insert (ring-ref input-ring input-ring-index))
	   (setq this-command 'comint-previous-input)))))
	 
David Lawrence's avatar
David Lawrence committed
525 526 527 528 529
(defun comint-next-input (arg)
  "Cycle forwards through input history."
  (interactive "*p")
  (comint-previous-input (- arg)))

Jim Blandy's avatar
Jim Blandy committed
530 531 532 533
(defvar comint-last-input-match ""
  "Last string searched for by comint input history search, for defaulting.
Buffer local variable.") 

David Lawrence's avatar
David Lawrence committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
(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 
			 (format "Command substring (default %s): "
				 comint-last-input-match))))
		 (list (if (string= s "") comint-last-input-match s))))
; (interactive "sCommand substring: ")
  (setq comint-last-input-match str) ; update default
  (if (not (eq last-command 'comint-previous-input))
      (setq input-ring-index -1))
  (let ((str (regexp-quote str))
        (len (ring-length input-ring))
	(n (+ input-ring-index 1)))
    (while (and (< n len) (not (string-match str (ring-ref input-ring n))))
      (setq n (+ n 1)))
    (cond ((< n len)
	   (comint-previous-input (- n input-ring-index)))
	  (t (if (eq last-command 'comint-previous-input) 
		 (setq this-command 'comint-previous-input))
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
	     (message "Not found.")
	     (ding)))))


;;; 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
611 612 613 614 615 616

;;;
;;; 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
617 618
(defvar comint-last-similar-string "" 
  "The string last used in a similar string search.")
David Lawrence's avatar
David Lawrence committed
619 620 621 622 623
(defun comint-previous-similar-input (arg)
  "Reenters the last input that matches the string typed so far.  If repeated 
successively older inputs are reentered.  If arg is 1, it will go back
in the history, if -1 it will go forward."
  (interactive "p")
Jim Blandy's avatar
Jim Blandy committed
624
  (if (not (comint-after-pmark-p))
David Lawrence's avatar
David Lawrence committed
625 626 627
      (error "Not after process mark"))
  (if (not (eq last-command 'comint-previous-similar-input))
      (setq input-ring-index -1
Jim Blandy's avatar
Jim Blandy committed
628 629 630 631
	    comint-last-similar-string 
	    (buffer-substring 
	     (process-mark (get-buffer-process (current-buffer)))
	     (point))))
David Lawrence's avatar
David Lawrence committed
632 633 634 635 636 637 638 639 640 641 642 643
  (let* ((size (length comint-last-similar-string))
	 (len (ring-length input-ring))
	 (n (+ input-ring-index arg))
	 entry)
    (while (and (< n len) 
		(or (< (length (setq entry (ring-ref input-ring n))) size)
		    (not (equal comint-last-similar-string 
				(substring entry 0 size)))))
      (setq n (+ n arg)))
    (cond ((< n len)
	   (setq input-ring-index n)
	   (if (eq last-command 'comint-previous-similar-input)
Jim Blandy's avatar
Jim Blandy committed
644 645
	       (delete-region (mark) (point)) ; repeat
	       (push-mark (point)))	      ; 1st time
David Lawrence's avatar
David Lawrence committed
646
	   (insert (substring entry size)))
Jim Blandy's avatar
Jim Blandy committed
647 648 649
	  (t (message "Not found.") (ding) (sit-for 1)))
    (message "%d" (1+ input-ring-index))))

David Lawrence's avatar
David Lawrence committed
650

Jim Blandy's avatar
Jim Blandy committed
651 652 653 654 655 656 657 658 659 660 661 662
(defun comint-send-input () 
  "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
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
663 664

comint-get-old-input, comint-input-sentinel, and comint-input-filter are chosen
Jim Blandy's avatar
Jim Blandy committed
665
according to the command interpreter running in the buffer. E.g.,
David Lawrence's avatar
David Lawrence committed
666
If the interpreter is the csh,
Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671 672
    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
673 674

If the comint is Lucid Common Lisp, 
Jim Blandy's avatar
Jim Blandy committed
675 676 677
    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
678 679
        which matches (1) all whitespace (2) :a, :c, etc.

Jim Blandy's avatar
Jim Blandy committed
680
Similarly for Soar, Scheme, etc.."
David Lawrence's avatar
David Lawrence committed
681 682
  (interactive)
  ;; Note that the input string does not include its terminal newline.
Jim Blandy's avatar
Jim Blandy committed
683 684 685 686 687 688 689
  (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
690 691 692 693
			(let ((copy (funcall comint-get-old-input)))
			  (goto-char pmark)
			  (insert copy)
			  copy))))
Jim Blandy's avatar
Jim Blandy committed
694 695 696 697
	  (insert ?\n)
	  (if (funcall comint-input-filter input) (ring-insert input-ring input))
	  (funcall comint-input-sentinel input)
	  (funcall comint-input-sender proc input)
Jim Blandy's avatar
Jim Blandy committed
698 699 700
	  (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
701 702

(defun comint-get-old-input-default ()
Jim Blandy's avatar
Jim Blandy committed
703 704
  "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
705
  (save-excursion
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
    (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
737 738 739

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

Jim Blandy's avatar
Jim Blandy committed
743 744 745 746 747
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
748 749
  (interactive "P")
  (beginning-of-line)
Jim Blandy's avatar
Jim Blandy committed
750
  (if (null arg) (comint-skip-prompt)))
David Lawrence's avatar
David Lawrence committed
751 752 753

;;; 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
754 755
;;; Just enter m-x send-invisible and type in your line.

Jim Blandy's avatar
Jim Blandy committed
756
(defun comint-read-noecho (prompt &optional stars)
Jim Blandy's avatar
Jim Blandy committed
757 758 759
  "Prompt the user with argument PROMPT. Read a single line of text
without echoing, and return it. Note that the keystrokes comprising
the text can still be recovered (temporarily) with \\[view-lossage]. This
Jim Blandy's avatar
Jim Blandy committed
760 761
may be a security bug for some applications. Optional argument STARS
causes input to be echoed with '*' characters on the prompt line."
David Lawrence's avatar
David Lawrence committed
762
  (let ((echo-keystrokes 0)
Jim Blandy's avatar
Jim Blandy committed
763
	(cursor-in-echo-area t)
David Lawrence's avatar
David Lawrence committed
764 765
	(answ "")
	tem)
Jim Blandy's avatar
Jim Blandy committed
766 767
    (if (not (stringp prompt)) (setq prompt ""))
    (message prompt)
Jim Blandy's avatar
Jim Blandy committed
768
    (while (not(or  (= (setq tem (read-char)) ?\^m)
David Lawrence's avatar
David Lawrence committed
769
		    (= tem ?\n)))
Jim Blandy's avatar
Jim Blandy committed
770 771 772
      (setq answ (concat answ (char-to-string tem)))
      (if stars (setq prompt (concat prompt "*")))
      (message prompt))
David Lawrence's avatar
David Lawrence committed
773 774 775
    (message "")
    answ))

Jim Blandy's avatar
Jim Blandy committed
776

David Lawrence's avatar
David Lawrence committed
777
(defun send-invisible (str)
Jim Blandy's avatar
Jim Blandy committed
778 779 780 781 782
  "Read a string without echoing, and 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.
Security bug: your string can still be temporarily recovered with
\\[view-lossage]."
David Lawrence's avatar
David Lawrence committed
783 784 785 786 787 788
; (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
789
				(comint-read-noecho "Non-echoed text: " t)))
David Lawrence's avatar
David Lawrence committed
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
	(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
823
(defun comint-kill-output ()
David Lawrence's avatar
David Lawrence committed
824 825
  "Kill all output from interpreter since last input."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
826 827 828 829 830
  (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
831 832

(defun comint-show-output ()
Jim Blandy's avatar
Jim Blandy committed
833 834
  "Display start of this batch of interpreter output at top of window.
Also put cursor there."
David Lawrence's avatar
David Lawrence committed
835 836
  (interactive)
  (goto-char comint-last-input-end)
Jim Blandy's avatar
Jim Blandy committed
837
  (backward-char)
David Lawrence's avatar
David Lawrence committed
838 839
  (beginning-of-line)
  (set-window-start (selected-window) (point))
Jim Blandy's avatar
Jim Blandy committed
840
  (end-of-line))
David Lawrence's avatar
David Lawrence committed
841 842

(defun comint-interrupt-subjob ()
Jim Blandy's avatar
Jim Blandy committed
843
  "Interrupt the current subjob."
David Lawrence's avatar
David Lawrence committed
844
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
845
  (interrupt-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
846 847

(defun comint-kill-subjob ()
Jim Blandy's avatar
Jim Blandy committed
848
  "Send kill signal to the current subjob."
David Lawrence's avatar
David Lawrence committed
849
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
850
  (kill-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
851 852

(defun comint-quit-subjob ()
Jim Blandy's avatar
Jim Blandy committed
853
  "Send quit signal to the current subjob."
David Lawrence's avatar
David Lawrence committed
854
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
855
  (quit-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
856 857

(defun comint-stop-subjob ()
Jim Blandy's avatar
Jim Blandy committed
858
  "Stop the current subjob.
David Lawrence's avatar
David Lawrence committed
859
WARNING: if there is no current subjob, you can end up suspending
Jim Blandy's avatar
Jim Blandy committed
860 861 862
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
863
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
864
  (stop-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
865 866

(defun comint-continue-subjob ()
Jim Blandy's avatar
Jim Blandy committed
867
  "Send CONT signal to process buffer's process group.
David Lawrence's avatar
David Lawrence committed
868 869
Useful if you accidentally suspend the top-level process."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
870
  (continue-process nil comint-ptyp))
David Lawrence's avatar
David Lawrence committed
871 872

(defun comint-kill-input ()
Jim Blandy's avatar
Jim Blandy committed
873
  "Kill all text from last stuff output by interpreter to point."
David Lawrence's avatar
David Lawrence committed
874
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
875 876 877 878
  (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
879 880 881 882 883 884

(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
885 886 887 888
      (delete-char arg)))



David Lawrence's avatar
David Lawrence committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922

;;; 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
923
;;; commands for tea, soar, cmulisp, and cmuscheme modes. 
David Lawrence's avatar
David Lawrence committed
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
;;; 
;;; - 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
960

David Lawrence's avatar
David Lawrence committed
961 962
;;; (COMINT-CHECK-SOURCE fname)
;;;============================================================================
Jim Blandy's avatar
Jim Blandy committed
963
;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
David Lawrence's avatar
David Lawrence committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
;;; 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
981

David Lawrence's avatar
David Lawrence committed
982 983 984 985 986 987 988 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
;;; (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 ()
  "Returns string around point that starts the current line or nil." 
  (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
1022 1023 1024
		       (condition-case ()
			   (file-exists-p stringfile)
			 (error nil))
David Lawrence's avatar
David Lawrence committed
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
		       (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
1038 1039 1040 1041 1042 1043 1044 1045
;;; 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
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

;;; 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.
;;; M-<Tab> will complete the filename at the cursor as much as possible
;;; M-? will display a list of completions in the help buffer.

;;; 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
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
;;; available for people who want them. Shell-mode installs them:
;;; (define-key cmushell-mode-map "\M-\t" 'comint-dynamic-complete)
;;; (define-key cmushell-mode-map "\M-?"  'comint-dynamic-list-completions)))
;;;
;;; Commands like this are fine things to put in load hooks if you
;;; want them present in specific modes. Example:
;;; (setq cmushell-load-hook
;;;       '((lambda () (define-key lisp-mode-map "\M-\t"
;;;				   'comint-replace-by-expanded-filename))))
;;;          

David Lawrence's avatar
David Lawrence committed
1106 1107

(defun comint-match-partial-pathname ()
Jim Blandy's avatar
Jim Blandy committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
  "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
1118 1119

(defun comint-replace-by-expanded-filename ()
Jim Blandy's avatar
Jim Blandy committed
1120 1121
"Replace the filename at point with an expanded, canonicalised, and
completed replacement.
David Lawrence's avatar
David Lawrence committed
1122 1123
\"Expanded\" means environment variables (e.g., $HOME) and ~'s are
replaced with the corresponding directories.  \"Canonicalised\" means ..
Jim Blandy's avatar
Jim Blandy committed
1124 1125
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
1126 1127 1128 1129 1130 1131 1132 1133
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)
Jim Blandy's avatar
Jim Blandy committed
1134 1135
	   (message "No completions of %s." pathname)
	   (ding))
David Lawrence's avatar
David Lawrence committed
1136
	  ((eql completion t)
Jim Blandy's avatar
Jim Blandy committed
1137
	   (message "Unique completion."))
David Lawrence's avatar
David Lawrence committed
1138 1139 1140 1141
	  (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
1142

David Lawrence's avatar
David Lawrence committed
1143
(defun comint-dynamic-complete ()
Jim Blandy's avatar
Jim Blandy committed
1144
  "Dynamically complete the filename at point.
David Lawrence's avatar
David Lawrence committed
1145 1146 1147 1148 1149 1150 1151
This function is similar to comint-replace-by-expanded-filename, except
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
1152
	 (completion (file-name-completion  pathnondir
David Lawrence's avatar
David Lawrence committed
1153 1154
					   (or pathdir default-directory))))
    (cond ((null completion)
Jim Blandy's avatar
Jim Blandy committed
1155 1156
	   (message "No completions of %s." pathname)
	   (ding))
David Lawrence's avatar
David Lawrence committed
1157
	  ((eql completion t)
Jim Blandy's avatar
Jim Blandy committed
1158
	   (message "Unique completion."))
David Lawrence's avatar
David Lawrence committed
1159 1160 1161 1162 1163
	  (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
1164
  "List in help buffer all possible completions of the filename at point."
David Lawrence's avatar
David Lawrence committed
1165 1166 1167 1168 1169 1170 1171 1172
  (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)
Jim Blandy's avatar
Jim Blandy committed
1173 1174
	   (message "No completions of %s." pathname)
	   (ding))
David Lawrence's avatar
David Lawrence committed
1175 1176
	  (t
	   (let ((conf (current-window-configuration)))
Jim Blandy's avatar
Jim Blandy committed
1177
	     (with-output-to-temp-buffer "*Help*"
David Lawrence's avatar
David Lawrence committed
1178 1179 1180 1181 1182 1183 1184 1185
	       (display-completion-list completions))
	     (sit-for 0)
	     (message "Hit space to flush.")
	     (let ((ch (read-char)))
	       (if (= ch ?\ )
		   (set-window-configuration conf)
		   (setq unread-command-char ch))))))))

Jim Blandy's avatar
Jim Blandy committed
1186 1187 1188 1189
; Ergo bindings
; (global-set-key "\M-\t" 'comint-replace-by-expanded-filename)
; (global-set-key "\M-?" 'comint-dynamic-list-completions)
; (define-key shell-mode-map "\M-\t" 'comint-dynamic-complete)
David Lawrence's avatar
David Lawrence committed
1190 1191 1192

;;; Converting process modes to use comint mode
;;; ===========================================================================
Eric S. Raymond's avatar
Eric S. Raymond committed
1193 1194 1195
;;; 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
1196
;;;
David Lawrence's avatar
David Lawrence committed
1197
;;; Renaming variables
Jim Blandy's avatar
Jim Blandy committed
1198 1199 1200
;;; Most of the work is renaming variables and functions. These are the common
;;; ones:
;;; Local variables:
Jim Blandy's avatar
Jim Blandy committed
1201
;;;	last-input-start	comint-last-input-start
Jim Blandy's avatar
Jim Blandy committed
1202 1203 1204 1205
;;; 	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
1206 1207
;;;	shell-set-directory	<unnecessary>
;;; 	shell-mode-map		comint-mode-map
Jim Blandy's avatar
Jim Blandy committed
1208
;;; Commands:
David Lawrence's avatar
David Lawrence committed
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
;;;	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
1220 1221 1222
;;; 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
1223
;;; shell-set-directory-error-hook; it is gone.
Jim Blandy's avatar
Jim Blandy committed
1224 1225 1226 1227 1228 1229 1230
;;;
;;; 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
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
;;; 
;;; 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;
Jim Blandy's avatar
Jim Blandy committed
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
;;; comint-mode will take care of it. The following example, from cmushell.el,
;;; is typical:
;;; 
;;; (defun shell-mode ()
;;;   (interactive)
;;;   (comint-mode)
;;;   (setq comint-prompt-regexp shell-prompt-pattern)
;;;   (setq major-mode 'shell-mode)
;;;   (setq mode-name "Shell")
;;;   (cond ((not shell-mode-map)
;;; 	     (setq shell-mode-map (full-copy-sparse-keymap comint-mode-map))
;;; 	     (define-key shell-mode-map "\M-\t" 'comint-dynamic-complete)
;;; 	     (define-key shell-mode-map "\M-?"
;;;                      'comint-dynamic-list-completions)))
;;;   (use-local-map shell-mode-map)
;;;   (make-local-variable 'shell-directory-stack)
;;;   (setq shell-directory-stack nil)
;;;   (setq comint-input-sentinel 'shell-directory-tracker)
;;;   (run-hooks 'shell-mode-hook))
;;;
David Lawrence's avatar
David Lawrence committed
1261 1262 1263 1264 1265 1266
;;;
;;; Note that make-comint is different from make-shell in that it
;;; doesn't have a default program argument. If you give make-shell
;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
;;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument
;;; of NIL, it barfs. Adjust your code accordingly...
Jim Blandy's avatar
Jim Blandy committed
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
;;;

;;; Do the user's customisation...

(defvar comint-load-hook nil
  "This hook is run when comint is loaded in.
This is a good place to put keybindings.")
	
(run-hooks 'comint-load-hook)

;;; Change log:
;;; 9/12/89 
;;;  - Souped up the filename expansion procedures.
;;;    Doc strings are much clearer and more detailed.
;;;    Fixed a bug where doing a filename completion when the point
;;;    was in the middle of the filename instead of at the end would lose.
;;;
;;; 2/17/90 
;;;  - Souped up the command history stuff so that text inserted
;;;    by comint-previous-input-matching is removed by following
;;;    command history recalls. comint-next/previous-input-matching
;;;    is now much more smoothly integrated w/the command history stuff.
;;;  - Added comint-eol-on-send flag and comint-input-sender hook.
;;;    Comint-input-sender based on code contributed by Jeff Peck
;;;    (peck@sun.com).
;;;
;;; 3/13/90 ccm@cmu.cs.edu
;;;  - Added comint-previous-similar-input for looking up similar inputs.
;;;  - Added comint-send-and-get-output to allow snarfing input from
;;;    buffer. 
;;;  - Added the ability to pick up a source file by positioning over
;;;    a string in comint-get-source.
;;;  - Added add-hook to make it a little easier for the user to use
;;;    multiple hooks.
;;;  
;;; 5/22/90 shivers
;;; - Moved Chris' multiplexed ipc stuff to comint-ipc.el.
;;; - Altered Chris' comint-get-source string feature. The string
;;;   is only offered as a default if it names an existing file.
;;; - Changed comint-exec to directly crank up the process, instead
;;;   of calling the env program. This made background.el happy.
;;; - Added new buffer-local var comint-ptyp. The problem is that
;;;   the signalling functions don't work as advertised. If you are
;;;   communicating via pipes, the CURRENT-GROUP arg is supposed to
;;;   be ignored, but, unfortunately it seems to be the case that you
;;;   must pass a NIL for this arg in the pipe case. COMINT-PTYP
;;;   is a flag that tells whether the process is communicating
;;;   via pipes or a pty. The comint signalling functions use it
;;;   to determine the necessary CURRENT-GROUP arg value. The bug
;;;   has been reported to the Gnu folks.
;;; - comint-dynamic-complete flushes the help window if you hit space
;;;   after you execute it.
;;; - Added functions comint-send-string, comint-send-region and var 
;;;   comint-input-chunk-size.  comint-send-string tries to prevent processes
;;;   from hanging when you send them long strings by breaking them into
;;;   chunks and allowing process output between chunks. I got the idea from
;;;   Eero Simoncelli's Common Lisp package. Note that using
;;;   comint-send-string means that the process buffer's contents can change
;;;   during a call!  If you depend on process output only happening between
;;;   toplevel commands, this could be a problem. In such a case, use
;;;   process-send-string instead. If this is a problem for people, I'd like
;;;   to hear about it.
;;; - Added comint-proc-query as a simple mechanism for commands that
;;;   want to query an inferior process and display its response. For a
;;;   typical use, see lisp-show-arglist in cmulisp.el.
;;; - Added constant comint-version, which is now "2.01".
;;;
;;; 6/14/90 shivers
;;; - Had comint-update-env defined twice. Removed extra copy. Also
;;;   renamed mem to be comint-mem, for modularity. The duplication
;;;   was reported by Michael Meissner.
;;; 6/16/90 shivers
;;; - Emacs has two different mechanisms for maintaining the process
;;;   environment, determined at compile time by the MAINTAIN-ENVIRONMENT
;;;   #define. One uses the process-environment global variable, and
;;;   one uses a getenv/setenv interface. comint-exec assumed the
;;;   process-environment interface; it has been generalised (with
;;;   comint-exec-1) to handle both cases. Pretty bogus. We could,
;;;   of course, skip all this and just use the etc/env program to
;;;   handle the environment tweaking, but that obscures process
;;;   queries that other modules (like background.el) depend on. etc/env
;;;   is also fairly bogus. This bug, and some of the fix code was
;;;   reported by Dan Pierson.
;;;
;;; 9/5/90 shivers
;;; - Changed make-variable-buffer-local's to make-local-variable's.
;;;   This leaves non-comint-mode buffers alone. Stephane Payrard
;;;   reported the sloppy useage.
;;; - You can now go from comint-previous-similar-input to
;;;   comint-previous-input with no problem.
;;;
;;; 12/21/90 shivers
;;; - Added a condition-case to comint-get-source. Bogus strings
;;;   beginning with ~ were making the file-exists-p barf.
;;; - Added "=" to the set of chars recognised by file completion
;;;   as constituting a filename.
;;;
;;; 1/90 shivers
;;; These changes comprise release 2.02:
;;; - Removed the kill-all-local-variables in comint-mode. This
;;;   made it impossible for client modes to set things before calling
;;;   comint-mode. (In particular, it messed up ilisp.el) In general,
;;;   the client mode should be responsible for a k-a-l-v's.
;;; - Fixed comint-match-partial-pathname so that it works in
;;;   more cases: if the filename begins at the start-of-buffer;
;;;   if point is on the first char of the filename. Just a question
;;;   of getting the tricky bits right.
;;; - Added a hook, comint-exec-hook that is run each time a process
;;;   is cranked up. Useful for things like process-kill-without-query.
;;;
Jim Blandy's avatar
Jim Blandy committed
1377
;;; These two were pointed out by tale:
Jim Blandy's avatar
Jim Blandy committed
1378 1379 1380
;;; - Improved the doc string in comint-send-input a little bit.
;;; - Tweaked make-comint to check process status with comint-check-proc
;;;   instead of equivalent inline code.