comint.el 88.6 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>
6
;; Adapted-by: Simon Marshall <s.marshall@dcs.hull.ac.uk>
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
8

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

11 12 13 14
;; 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
15

16 17 18 19
;; 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
20

21 22 23
;; 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
24

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

Jim Blandy's avatar
Jim Blandy committed
27 28 29
;;; 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)
30
;;;     - Simon Marshall (s.marshall@dcs.hull.ac.uk)
Jim Blandy's avatar
Jim Blandy committed
31

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 70
;;; m-r     comint-previous-matching-input  Previous input matching a regexp
;;; m-s     comint-next-matching-input      Next input that matches
;;; m-c-r   comint-previous-input-matching  Search backwards in input history
Jim Blandy's avatar
Jim Blandy committed
71
;;; return  comint-send-input
72 73
;;; c-a     comint-bol                      Beginning of line; skip prompt
;;; c-d	    comint-delchar-or-maybe-eof     Delete char unless at end of buff
Jim Blandy's avatar
Jim Blandy committed
74 75 76 77 78 79 80
;;; 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
81
;;; c-c c-h comint-dynamic-list-input-ring  List input history
Jim Blandy's avatar
Jim Blandy committed
82
;;;
83
;;; Not bound by default in comint-mode (some are in shell mode)
David Lawrence's avatar
David Lawrence committed
84
;;; send-invisible			Read a line w/o echo, and send to proc
85 86 87
;;; comint-dynamic-complete-filename	Complete filename at point.
;;; comint-dynamic-complete-variable    Complete variable name at point.
;;; comint-dynamic-list-filename-completions List completions in help buffer.
David Lawrence's avatar
David Lawrence committed
88 89
;;; comint-replace-by-expanded-filename	Expand and complete filename at point;
;;;					replace with expanded/completed name.
90 91 92
;;; comint-replace-by-expanded-history	Expand history at point;
;;;					replace with expanded name.
;;; comint-magic-space                  Expand history and add (a) space(s).
Jim Blandy's avatar
Jim Blandy committed
93
;;; comint-kill-subjob			No mercy.
94
;;; comint-show-maximum-output          Show as much output as possible.
Jim Blandy's avatar
Jim Blandy committed
95 96 97 98 99
;;; comint-continue-subjob		Send CONT signal to buffer's process
;;;					group. Useful if you accidentally
;;;					suspend your process (with C-c C-z).

;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
David Lawrence's avatar
David Lawrence committed
100

Eric S. Raymond's avatar
Eric S. Raymond committed
101 102
;;; Code:

Richard M. Stallman's avatar
Richard M. Stallman committed
103
(require 'ring)
David Lawrence's avatar
David Lawrence committed
104 105 106 107

;;; Buffer Local Variables:
;;;============================================================================
;;; Comint mode buffer local variables:
108 109 110
;;;     comint-prompt-regexp    - string       comint-bol uses to match prompt
;;;     comint-delimiter-argument-list - list  For delimiters and arguments
;;;     comint-last-input-start - marker       Handy if inferior always echoes
Jim Blandy's avatar
Jim Blandy committed
111
;;;     comint-last-input-end   - marker       For comint-kill-output command
112 113
;;;     comint-input-ring-size  - integer      For the input history
;;;     comint-input-ring       - ring             mechanism
114
;;;     comint-input-ring-index - number           ...
115 116
;;;     comint-input-autoexpand - symbol           ...
;;;     comint-input-ignoredups - boolean          ...
David Lawrence's avatar
David Lawrence committed
117 118
;;;     comint-last-input-match - string           ...
;;;     comint-get-old-input    - function     Hooks for specific 
119 120 121 122 123 124 125 126
;;;     comint-get-current-command - function      process-in-a-buffer
;;;     comint-dynamic-complete-command-command -  function modes.
;;;     comint-after-partial-filename-command -
;;;     comint-input-sentinel   - function         ...
;;;     comint-input-filter     - function         ...
;;;     comint-input-send	- function         ...
;;;     comint-eol-on-send	- boolean          ...
;;;     comint-process-echoes   - boolean          ...
127
;;;     comint-scroll-to-bottom-on-input - symbol For scroll behavior
128 129 130 131 132
;;;     comint-scroll-to-bottom-on-output - symbol    ...
;;;     comint-scroll-show-maximum-output - boolean   ...
;;;
;;; Comint mode non-buffer local variables:
;;;     comint-completion-addsuffix - boolean   For file name completion
133
;;;     comint-completion-autolist  - boolean       behavior
134
;;;     comint-completion-recexact  - boolean       ...
David Lawrence's avatar
David Lawrence committed
135

Jim Blandy's avatar
Jim Blandy committed
136 137 138
(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
139 140

Good choices:
Jim Blandy's avatar
Jim Blandy committed
141
  Canonical Lisp: \"^[^> ]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
142 143
  Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
  franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
Jim Blandy's avatar
Jim Blandy committed
144 145 146
  kcl: \"^>+ *\"
  shell: \"^[^#$%>]*[#$%>] *\"
  T: \"^>+ *\"
David Lawrence's avatar
David Lawrence committed
147

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

150 151 152 153 154 155 156 157 158 159 160 161 162 163
(defvar comint-delimiter-argument-list ()
  "List of characters to recognise as separate arguments in input.
Strings comprising a character in this list will separate the arguments
surrounding them, and also be regarded as arguments in their own right (unlike
whitespace).  See `comint-arguments'.
Defaults to (), the empty list.

Good choices:
  shell: \(\"|\" \"&\" \"<\" \">\" \"\(\" \")\" \";\")

This is a good thing to set in mode hooks.")

(defvar comint-input-autoexpand 'history
  "*If non-nil, expand input command history references on completion.
164
This mirrors the optional behavior of tcsh (its autoexpand and histlit).
165 166 167 168 169 170 171 172 173 174

If the value is `input', then the expansion is seen on input.
If the value is `history', then the expansion is only when inserting
into the buffer's input ring.  See also `comint-magic-space' and
`comint-dynamic-complete'.

This variable is buffer-local.")

(defvar comint-input-ignoredups nil
  "*If non-nil, don't add input matching the last on the input ring.
175
This mirrors the optional behavior of bash.
176 177 178 179 180 181 182 183 184

This variable is buffer-local.")

(defvar comint-input-ring-file-name nil
  "*If non-nil, name of the file to read/write input history.
See also `comint-read-input-ring' and `comint-write-input-ring'.

This variable is buffer-local, and is a good thing to set in mode hooks.")

185
(defvar comint-scroll-to-bottom-on-input nil
186 187 188 189
  "*Controls whether input to interpreter causes window to scroll.
If nil, then do not scroll.  If t or `all', scroll all windows showing buffer.
If `this', scroll only the selected window.

190
The default is nil.
191

192 193
See `comint-preinput-scroll-to-bottom'.  This variable is buffer-local.")

194
(defvar comint-scroll-to-bottom-on-output nil
195 196 197 198
  "*Controls whether interpreter output causes window to scroll.
If nil, then do not scroll.  If t or `all', scroll all windows showing buffer.
If `this', scroll only the selected window.
If `others', scroll only those that are not the selected window.
199 200

The default is nil.
201

202 203
See variable `comint-scroll-show-maximum-output' and function
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local.")
204

205 206 207
(defvar comint-scroll-show-maximum-output t
  "*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
208

209 210
See variable `comint-scroll-to-bottom-on-output' and function
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local.")
211

212
(defvar comint-input-ring-size 32
Jim Blandy's avatar
Jim Blandy committed
213
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
214

Noah Friedman's avatar
Noah Friedman committed
215
(defvar comint-process-echoes nil
216
  "*If non-nil, assume that the subprocess echoes any input.
Noah Friedman's avatar
Noah Friedman committed
217
If so, delete one copy of the input so that only one copy eventually
218
appears in the buffer.
Noah Friedman's avatar
Noah Friedman committed
219 220 221

This variable is buffer-local.")

David Lawrence's avatar
David Lawrence committed
222
;;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
223
(defvar comint-get-old-input (function comint-get-old-input-default)
224
  "Function that returns old text in comint mode.
David Lawrence's avatar
David Lawrence committed
225 226
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
227 228
`comint-get-old-input-default', which grabs the current line, and strips off
leading text matching `comint-prompt-regexp'.")
David Lawrence's avatar
David Lawrence committed
229

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
(defvar comint-after-partial-filename-command 'comint-after-partial-filename
  "Function that returns non-nil if point is after a file name.
By default this is `comint-after-partial-filename'.

This is a good thing to set in mode hooks.")

(defvar comint-dynamic-complete-filename-command
  'comint-dynamic-complete-filename
  "Function that dynamically completes the file name at point.
By default this is `comint-dynamic-complete-filename', though an alternative is
`comint-replace-by-expanded-filename'.

This is a good thing to set in mode hooks.")

(defvar comint-dynamic-complete-command-command
  'comint-dynamic-complete-filename
  "Function that dynamically completes the command at point.
By default this is `comint-dynamic-complete-filename'.

This is a good thing to set in mode hooks.")

(defvar comint-get-current-command 'comint-get-old-input-default
  "Function that returns the current command including arguments.
By default this is `comint-get-old-input-default', meaning the whole line.

This is a good thing to set in mode hooks.")

Jim Blandy's avatar
Jim Blandy committed
257
(defvar comint-input-sentinel (function ignore)
258
  "Called on each input submitted to comint mode process by `comint-send-input'.
259
Thus it can, for instance, track cd/pushd/popd commands issued to a shell.")
David Lawrence's avatar
David Lawrence committed
260

Jim Blandy's avatar
Jim Blandy committed
261 262 263
(defvar comint-input-filter
  (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
  "Predicate for filtering additions to input history.
264 265 266
Takes one argument, the input.  If non-nil, the input may be saved on the input
history list.  Default is to save anything that isn't all whitespace.")

267
(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom) 
268
  "Functions to call after output is inserted into the buffer.
269 270
One possible function is `comint-postoutput-scroll-to-bottom'.
These functions get one argument, a string containing the text just inserted.
271 272

This variable is buffer-local.")
Jim Blandy's avatar
Jim Blandy committed
273 274 275

(defvar comint-input-sender (function comint-simple-send)
  "Function to actually send to PROCESS the STRING submitted by user.
276 277 278 279
Usually this is just `comint-simple-send', but if your mode needs to 
massage the input string, put a different function here.
`comint-simple-send' just sends the string plus a newline.
This is called from the user command `comint-send-input'.")
Jim Blandy's avatar
Jim Blandy committed
280

281
(defvar comint-eol-on-send t
282
  "*Non-nil means go to the end of the line before sending input.
283
See `comint-send-input'.")
David Lawrence's avatar
David Lawrence committed
284 285

(defvar comint-mode-hook '()
Jim Blandy's avatar
Jim Blandy committed
286 287 288 289
  "Called upon entry into comint-mode
This is run before the process is cranked up.")

(defvar comint-exec-hook '()
290
  "Called each time a process is exec'd by `comint-exec'.
Jim Blandy's avatar
Jim Blandy committed
291
This is called after the process is cranked up.  It is useful for things that
292 293
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
Jim Blandy's avatar
Jim Blandy committed
294 295 296
executed once when the buffer is created.")

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

Richard M. Stallman's avatar
Richard M. Stallman committed
298
(defvar comint-ptyp t
299
  "Non-nil if communications via pty; false if by pipe.  Buffer local.
300
This is to work around a bug in Emacs process signalling.")
Richard M. Stallman's avatar
Richard M. Stallman committed
301

302
(defvar comint-input-ring nil)
303 304
(defvar comint-last-input-start)
(defvar comint-last-input-end)
305 306 307 308
(defvar comint-input-ring-index nil
  "Index of last matched history element.")
(defvar comint-matching-input-from-input-string ""
  "Input previously used to match input history.")
Richard M. Stallman's avatar
Richard M. Stallman committed
309
(put 'comint-input-ring 'permanent-local t)
310 311
(put 'comint-input-ring-index 'permanent-local t)
(put 'comint-input-autoexpand 'permanent-local t)
312
(put 'comint-output-filter-functions 'permanent-local t)
313 314 315
(put 'comint-scroll-to-bottom-on-input 'permanent-local t)
(put 'comint-scroll-to-bottom-on-output 'permanent-local t)
(put 'comint-scroll-show-maximum-output 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
316
(put 'comint-ptyp 'permanent-local t)
317

David Lawrence's avatar
David Lawrence committed
318 319 320 321 322
(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.
323
Setting variable `comint-eol-on-send' means jump to the end of the line
Jim Blandy's avatar
Jim Blandy committed
324
before submitting new input.
David Lawrence's avatar
David Lawrence committed
325

326 327 328 329
This mode is customised to create major modes such as Inferior Lisp
mode, 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
330
`comint-prompt-regexp' to the appropriate regular expression.
David Lawrence's avatar
David Lawrence committed
331

332
An input history is maintained of size `comint-input-ring-size', and
333 334 335 336 337 338
can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
Input ring history expansion can be achieved with the commands
\\[comint-replace-by-expanded-history] or \\[comint-magic-space].
Input ring expansion is controlled by the variable `comint-input-autoexpand',
and addition is controlled by the variable `comint-input-ignoredups'.

339
Commands with no default key bindings include `send-invisible',
340 341 342 343
`comint-dynamic-complete', `comint-list-dynamic-completions', and 
`comint-magic-space'.

Input to, and output from, the subprocess can cause the window to scroll to
344
the end of the buffer.  See variables `comint-output-filter-functions',
345
`comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
David Lawrence's avatar
David Lawrence committed
346 347 348 349 350 351

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

\\{comint-mode-map}

352
Entry to this mode runs the hooks on `comint-mode-hook'."
David Lawrence's avatar
David Lawrence committed
353
  (interactive)
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
  ;; Do not remove this.  All major modes must do this.
  (kill-all-local-variables)
  (setq major-mode 'comint-mode)
  (setq mode-name "Comint")
  (setq mode-line-process '(": %s"))
  (use-local-map comint-mode-map)
  (make-local-variable 'comint-last-input-start)
  (setq comint-last-input-start (make-marker))
  (make-local-variable 'comint-last-input-end)
  (setq comint-last-input-end (make-marker))
  (make-local-variable 'comint-last-output-start)
  (setq comint-last-output-start (make-marker))
  (make-local-variable 'comint-prompt-regexp)        ; Don't set; default
  (make-local-variable 'comint-input-ring-size)      ; ...to global val.
  (make-local-variable 'comint-input-ring)
  (make-local-variable 'comint-input-ring-file-name)
  (or (and (boundp 'comint-input-ring) comint-input-ring)
      (setq comint-input-ring (make-ring comint-input-ring-size)))
  (make-local-variable 'comint-input-ring-index)
  (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
      (setq comint-input-ring-index nil))
  (make-local-variable 'comint-matching-input-from-input-string)
  (make-local-variable 'comint-input-autoexpand)
  (make-local-variable 'comint-input-ignoredups)
  (make-local-variable 'comint-delimiter-argument-list)
  (make-local-variable 'comint-after-partial-filename-command)
  (make-local-variable 'comint-dynamic-complete-filename-command)
  (make-local-variable 'comint-dynamic-complete-command-command)
  (make-local-variable 'comint-get-current-command)
  (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-scroll-to-bottom-on-input)
  (make-local-variable 'comint-scroll-to-bottom-on-output)
  (make-local-variable 'comint-scroll-show-maximum-output)
391 392 393
  (make-local-variable 'pre-command-hook)
  (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom)
  (make-local-variable 'comint-output-filter-functions)
394 395 396 397
  (make-local-variable 'comint-ptyp)
  (make-local-variable 'comint-exec-hook)
  (make-local-variable 'comint-process-echoes)
  (run-hooks 'comint-mode-hook))
David Lawrence's avatar
David Lawrence committed
398

Jim Blandy's avatar
Jim Blandy committed
399 400
(if comint-mode-map
    nil
401
  ;; Keys:
Jim Blandy's avatar
Jim Blandy committed
402 403 404
  (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)
405 406
  (define-key comint-mode-map "\er" 'comint-previous-matching-input)
  (define-key comint-mode-map "\es" 'comint-next-matching-input)
407 408
  (define-key comint-mode-map [?\A-\M-r] 'comint-previous-matching-input-from-input)
  (define-key comint-mode-map [?\A-\M-s] 'comint-next-matching-input-from-input)
Jim Blandy's avatar
Jim Blandy committed
409 410 411 412 413 414 415 416
  (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)
417 418
  ;; " ; Stops emacs-19.19's hilit getting confused.
  (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
Jim Blandy's avatar
Jim Blandy committed
419 420
  (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
  (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
421 422
  (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
  (define-key comint-mode-map "\C-c\C-h" 'comint-dynamic-list-input-ring)
423
  (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
424
  (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
425
  (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
426 427 428
  ;; Menu bars:
  ;; completion:
  (define-key comint-mode-map [menu-bar completion] 
429
    (cons "Complete" (make-sparse-keymap "Complete")))
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
  (define-key comint-mode-map [menu-bar completion complete-expand]
    '("Expand File Name" . comint-replace-by-expanded-filename))
  (define-key comint-mode-map [menu-bar completion complete-listing]
    '("File Completion Listing" . comint-dynamic-list-filename-completions))
  (define-key comint-mode-map [menu-bar completion complete-variable]
    '("Complete Variable Name" . comint-dynamic-complete-variable))
  (define-key comint-mode-map [menu-bar completion complete-command]
    '("Complete Command Name" . (lambda () (interactive)
				  (funcall
				   comint-dynamic-complete-command-command))))
  (define-key comint-mode-map [menu-bar completion complete-file]
    '("Complete File Name" . comint-dynamic-complete-filename))
  (define-key comint-mode-map [menu-bar completion complete]
    '("Complete Before Point" . comint-dynamic-complete))
  ;; Input history:
  (define-key comint-mode-map [menu-bar input] 
446 447 448 449 450 451 452 453 454 455 456
    (cons "In/Out" (make-sparse-keymap "In/Out")))
  (define-key comint-mode-map [menu-bar input kill-output]
    '("Kill Current Output Group" . comint-kill-output))
  (define-key comint-mode-map [menu-bar input next-prompt]
    '("Forward Output Group" . comint-next-prompt))
  (define-key comint-mode-map [menu-bar input previous-prompt]
    '("Backward Output Group" . comint-previous-prompt))
  (define-key comint-mode-map [menu-bar input show-maximum-output]
    '("Show Maximum Output" . comint-show-maximum-output))
  (define-key comint-mode-map [menu-bar input show-output]
    '("Show Current Output Group" . comint-show-output))
457 458 459 460
  (define-key comint-mode-map [menu-bar input kill-input]
    '("Kill Current Input" . comint-kill-input))
  (define-key comint-mode-map [menu-bar input copy-input]
    '("Copy Old Input" . comint-copy-old-input))
461 462 463 464
  (define-key comint-mode-map [menu-bar input forward-matching-history]
    '("Forward Matching Input..." . comint-forward-matching-input))
  (define-key comint-mode-map [menu-bar input backward-matching-history]
    '("Backward Matching Input..." . comint-backward-matching-input))
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
  (define-key comint-mode-map [menu-bar input next-matching-history]
    '("Next Matching Input..." . comint-next-matching-input))
  (define-key comint-mode-map [menu-bar input previous-matching-history]
    '("Previous Matching Input..." . comint-previous-matching-input))
  (define-key comint-mode-map [menu-bar input next-matching-history-from-input]
    '("Next Matching Current Input" . comint-next-matching-input-from-input))
  (define-key comint-mode-map [menu-bar input previous-matching-history-from-input]
    '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
  (define-key comint-mode-map [menu-bar input next-history]
    '("Next Input" . comint-next-input))
  (define-key comint-mode-map [menu-bar input previous-history]
    '("Previous Input" . comint-previous-input))
  (define-key comint-mode-map [menu-bar input list-history]
    '("List Input History" . comint-dynamic-list-input-ring))
  (define-key comint-mode-map [menu-bar input expand-history]
    '("Expand History Before Point" . comint-replace-by-expanded-history))
  ;; Signals
  (define-key comint-mode-map [menu-bar signals]
    (cons "Signals" (make-sparse-keymap "Signals")))
  (define-key comint-mode-map [menu-bar signals eof]
    '("EOF" . comint-send-eof))
  (define-key comint-mode-map [menu-bar signals kill]
    '("KILL" . comint-kill-subjob))
  (define-key comint-mode-map [menu-bar signals quit]
    '("QUIT" . comint-quit-subjob))
  (define-key comint-mode-map [menu-bar signals cont]
    '("CONT" . comint-continue-subjob))
  (define-key comint-mode-map [menu-bar signals stop]
    '("STOP" . comint-stop-subjob))
  (define-key comint-mode-map [menu-bar signals break]
    '("BREAK" . comint-interrupt-subjob))
  ;; Put them in the menu bar:
  (setq menu-bar-final-items (append '(completion input output signals)
				     menu-bar-final-items))
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502 503 504 505
  )


;;; 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)
506
  "Recursively copy the sparse keymap KM."
Jim Blandy's avatar
Jim Blandy committed
507 508 509 510 511 512
  (cond ((consp km)
	 (cons (full-copy-sparse-keymap (car km))
	       (full-copy-sparse-keymap (cdr km))))
	(t km)))

(defun comint-check-proc (buffer)
513
  "Return t if there is a living process associated w/buffer BUFFER.
514 515
Living means the status is `run' or `stop'.
BUFFER can be either a buffer or the name of one."
Jim Blandy's avatar
Jim Blandy committed
516 517
  (let ((proc (get-buffer-process buffer)))
    (and proc (memq (process-status proc) '(run stop)))))
David Lawrence's avatar
David Lawrence committed
518 519 520

;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
;;; for the second argument (program).
521
;;;###autoload
David Lawrence's avatar
David Lawrence committed
522
(defun make-comint (name program &optional startfile &rest switches)
523 524 525 526 527
  "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
528
  (let ((buffer (get-buffer-create (concat "*" name "*"))))
David Lawrence's avatar
David Lawrence committed
529
    ;; If no process, or nuked process, crank up a new one and put buffer in
530
    ;; comint mode.  Otherwise, leave buffer and existing process alone.
Jim Blandy's avatar
Jim Blandy committed
531
    (cond ((not (comint-check-proc buffer))
Jim Blandy's avatar
Jim Blandy committed
532
	   (save-excursion
David Lawrence's avatar
David Lawrence committed
533 534 535 536 537 538
	     (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)
539
  "Start up a process in buffer BUFFER for comint modes.
540
Blasts any old process running in the buffer.  Doesn't set the buffer mode.
Jim Blandy's avatar
Jim Blandy committed
541
You can use this to cheaply run a series of processes in the same comint
542
buffer.  The hook `comint-exec-hook' is run after each exec."
David Lawrence's avatar
David Lawrence committed
543 544 545 546 547 548
  (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)))
549
      (set-process-filter proc 'comint-output-filter)
Jim Blandy's avatar
Jim Blandy committed
550 551
      (make-local-variable 'comint-ptyp)
      (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
David Lawrence's avatar
David Lawrence committed
552
      ;; Jump to the end, and set the process mark.
Jim Blandy's avatar
Jim Blandy committed
553
      (goto-char (point-max))
Jim Blandy's avatar
Jim Blandy committed
554
      (set-marker (process-mark proc) (point))
David Lawrence's avatar
David Lawrence committed
555 556 557 558 559 560 561 562 563 564 565 566
      ;; 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
567 568
	     (comint-send-string proc startfile)))
    (run-hooks 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
569
    buffer)))
David Lawrence's avatar
David Lawrence committed
570 571

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

(defun comint-exec-1 (name buffer command switches)
575 576 577 578
  (let ((process-environment process-environment))
    (setenv "TERMCAP" (format "emacs:co#%d:tc=unknown" (frame-width)))
    (setenv "TERM" "emacs")
    (setenv "EMACS" "t")
Jim Blandy's avatar
Jim Blandy committed
579
    (apply 'start-process name buffer command switches)))
David Lawrence's avatar
David Lawrence committed
580

581
;;; Input history processing in a buffer
David Lawrence's avatar
David Lawrence committed
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 611 612 613 614 615 616 617 618 619 620 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 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 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 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
;;; Useful input history functions, courtesy of the Ergo group.

;;; Eleven commands:
;;; comint-dynamic-list-input-ring	List history in help buffer.
;;; comint-previous-input		Previous input...
;;; comint-previous-matching-input	...matching a string.
;;; comint-previous-matching-input-from-input ... matching the current input.
;;; comint-next-input			Next input...
;;; comint-next-matching-input		...matching a string.
;;; comint-next-matching-input-from-input     ... matching the current input.
;;; comint-backward-matching-input      Backwards input...
;;; comint-forward-matching-input       ...matching a string.
;;; comint-replace-by-expanded-history	Expand history at point;
;;;					replace with expanded history.
;;; comint-magic-space			Expand history and insert space.
;;;
;;; Two functions:
;;; comint-read-input-ring              Read into comint-input-ring...
;;; comint-write-input-ring             Write to comint-input-ring-file-name.

(defun comint-read-input-ring ()
  "Sets the buffer's `comint-input-ring' from a history file.
The name of the file is given by the variable `comint-input-ring-file-name'.
The history ring is of size `comint-input-ring-size', regardless of file size.
If `comint-input-ring-file-name' is nil this function does nothing.

Useful within mode or mode hooks.

The structure of the history file should be one input command per line, and
most recent command last.
See also `comint-input-ignoredups' and `comint-write-input-ring'."
  (cond ((null comint-input-ring-file-name)
	 nil)
	((not (file-readable-p comint-input-ring-file-name))
	 (message "Cannot read history file %s" comint-input-ring-file-name))
	(t
	 (let ((history-buf (get-file-buffer comint-input-ring-file-name))
	       (ring (make-ring comint-input-ring-size)))
	   (save-excursion
	     (set-buffer (or history-buf
			     (find-file-noselect comint-input-ring-file-name)))
	     ;; Save restriction in case file is already visited...
	     ;; Watch for those date stamps in history files!
	     (save-excursion
	       (save-restriction
		 (widen)
		 (goto-char (point-min))
		 (while (re-search-forward "^\\s *\\([^#].*\\)\\s *$" nil t)
		   (let ((history (buffer-substring (match-beginning 1)
						    (match-end 1))))
		     (if (or (null comint-input-ignoredups)
			     (ring-empty-p ring)
			     (not (string-equal (ring-ref ring 0) history)))
			 (ring-insert ring history)))))
	       ;; Kill buffer unless already visited.
	       (if (null history-buf)
		   (kill-buffer nil))))
	   (setq comint-input-ring ring
		 comint-input-ring-index nil)))))

(defun comint-write-input-ring ()
  "Writes the buffer's `comint-input-ring' to a history file.
The name of the file is given by the variable `comint-input-ring-file-name'.
The original contents of the file are lost if `comint-input-ring' is not empty.
If `comint-input-ring-file-name' is nil this function does nothing.

Useful within process sentinels.

See also `comint-read-input-ring'."
  (cond ((or (null comint-input-ring-file-name)
	     (null comint-input-ring) (ring-empty-p comint-input-ring))
	 nil)
	((not (file-writable-p comint-input-ring-file-name))
	 (message "Cannot write history file %s" comint-input-ring-file-name))
	(t
	 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
		(ring comint-input-ring)
		(file comint-input-ring-file-name)
		(index (ring-length ring)))
	   ;; Write it all out into a buffer first.  Much faster, but messier,
	   ;; than writing it one line at a time.
	   (save-excursion
	     (set-buffer history-buf)
	     (erase-buffer)
	     (while (> index 0)
	       (setq index (1- index))
	       (insert (ring-ref ring index) ?\n))
	     (write-region (buffer-string) nil file nil 'no-message)
	     (kill-buffer nil))))))


(defun comint-dynamic-list-input-ring ()
  "List in help buffer the buffer's input history."
  (interactive)
  (if (or (not (ring-p comint-input-ring))
	  (ring-empty-p comint-input-ring))
      (message "No history")
    (let ((history nil)
	  (history-buffer " *Input History*")
	  (index (1- (ring-length comint-input-ring)))
	  (conf (current-window-configuration)))
      ;; We have to build up a list ourselves from the ring vector.
      (while (>= index 0)
	(setq history (cons (ring-ref comint-input-ring index) history)
	      index (1- index)))
      ;; Change "completion" to "history reference"
      ;; to make the display accurate.
      (with-output-to-temp-buffer history-buffer
	(display-completion-list history)
	(set-buffer history-buffer)
	(forward-line 3)
	(while (search-backward "completion" nil 'move)
	  (replace-match "history reference")))
      (sit-for 0)
      (message "Hit space to flush")
      (let ((ch (read-event)))
	(if (eq ch ?\ )
	    (set-window-configuration conf)
	  (setq unread-command-events (list ch)))))))


(defun comint-regexp-arg (prompt)
  ;; Return list of regexp and prefix arg using PROMPT.
  (let* ((minibuffer-history-sexp-flag nil)
	 ;; Don't clobber this.
	 (last-command last-command)
	 (regexp (read-from-minibuffer prompt nil nil nil
				       'minibuffer-history-search-history)))
    (list (if (string-equal regexp "")
	      (setcar minibuffer-history-search-history
		      (nth 1 minibuffer-history-search-history))
	    regexp)
	  (prefix-numeric-value current-prefix-arg))))

(defun comint-search-arg (arg)
  ;; First make sure there is a ring and that we are after the process mark
  (cond ((not (comint-after-pmark-p))
	 (error "Not at command line"))
	((or (null comint-input-ring)
	     (ring-empty-p comint-input-ring))
	 (error "Empty input ring"))
	((zerop arg)
	 ;; arg of zero resets search from beginning, and uses arg of 1
	 (setq comint-input-ring-index nil)
	 1)
	(t
	 arg)))

(defun comint-search-start (arg)
  ;; Index to start a directional search, starting at comint-input-ring-index
  (if comint-input-ring-index
      ;; If a search is running, offset by 1 in direction of arg
      (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
	   (ring-length comint-input-ring))
    ;; For a new search, start from beginning or end, as appropriate
    (if (>= arg 0)
	0				       ; First elt for forward search
      (1- (ring-length comint-input-ring)))))  ; Last elt for backward search

(defun comint-previous-input-string (arg)
  "Return the string ARG places along the input ring.
Moves relative to `comint-input-ring-index'."
  (ring-ref comint-input-ring (if comint-input-ring-index
				  (mod (+ arg comint-input-ring-index) 
				       (ring-length comint-input-ring))
				arg)))
David Lawrence's avatar
David Lawrence committed
749 750 751 752

(defun comint-previous-input (arg)
  "Cycle backwards through input history."
  (interactive "*p")
753
  (comint-previous-matching-input "." arg))
754

David Lawrence's avatar
David Lawrence committed
755 756 757 758 759
(defun comint-next-input (arg)
  "Cycle forwards through input history."
  (interactive "*p")
  (comint-previous-input (- arg)))

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
(defun comint-previous-matching-input-string (regexp arg)
  "Return the string matching REGEXP ARG places along the input ring.
Moves relative to `comint-input-ring-index'."
  (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
    (if pos (ring-ref comint-input-ring pos))))

(defun comint-previous-matching-input-string-position (regexp arg &optional start)
  "Return the index matching REGEXP ARG places along the input ring.
Moves relative to START, or `comint-input-ring-index'."
  (if (or (not (ring-p comint-input-ring))
	  (ring-empty-p comint-input-ring))
      (error "No history"))
  (let* ((len (ring-length comint-input-ring))
	 (motion (if (> arg 0) 1 -1))
	 (n (mod (- (or start (comint-search-start arg)) motion) len))
	 (tried-each-ring-item nil)
	 (prev nil))
    ;; Do the whole search as many times as the argument says.
    (while (and (/= arg 0) (not tried-each-ring-item))
      ;; Step once.
      (setq prev n
	    n (mod (+ n motion) len))
      ;; If we haven't reached a match, step some more.
      (while (and (< n len) (not tried-each-ring-item)
		  (not (string-match regexp (ring-ref comint-input-ring n))))
	(setq n (mod (+ n motion) len)
	      ;; If we have gone all the way around in this search.
	      tried-each-ring-item (= n prev)))
      (setq arg (if (> arg 0) (1- arg) (1+ arg))))
    ;; Now that we know which ring element to use, if we found it, return that.
    (if (string-match regexp (ring-ref comint-input-ring n))
	n)))

793 794 795 796 797
(defun comint-previous-matching-input (regexp arg)
  "Search backwards through input history for match for REGEXP.
\(Previous history elements are earlier commands.)
With prefix argument N, search for Nth previous match.
If N is negative, find the next or Nth next match."
798 799 800 801 802 803 804 805 806 807 808 809
  (interactive (comint-regexp-arg "Previous input matching (regexp): "))
  (setq arg (comint-search-arg arg))
  (let ((pos (comint-previous-matching-input-string-position regexp arg)))
    ;; Has a match been found?
    (if (null pos)
	(error "Not found")
      (setq comint-input-ring-index pos)
      (message "History item: %d" (1+ pos))
      (delete-region 
       ;; Can't use kill-region as it sets this-command
       (process-mark (get-buffer-process (current-buffer))) (point))
      (insert (ring-ref comint-input-ring pos)))))
810 811 812 813 814 815

(defun comint-next-matching-input (regexp arg)
  "Search forwards through input history for match for REGEXP.
\(Later history elements are more recent commands.)
With prefix argument N, search for Nth following match.
If N is negative, find the previous or Nth previous match."
816
  (interactive (comint-regexp-arg "Next input matching (regexp): "))
817
  (comint-previous-matching-input regexp (- arg)))
David Lawrence's avatar
David Lawrence committed
818

819 820 821 822 823 824 825 826 827 828 829 830 831 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 866 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 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 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 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 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
(defun comint-previous-matching-input-from-input (arg)
  "Search backwards through input history for match for current input.
\(Previous history elements are earlier commands.)
With prefix argument N, search for Nth previous match.
If N is negative, find the next or Nth next match."
  (interactive "p")
  (if (not (memq last-command '(comint-previous-matching-input-from-input
				comint-next-matching-input-from-input)))
      ;; Starting a new search
      (setq comint-matching-input-from-input-string
	    (buffer-substring 
	     (process-mark (get-buffer-process (current-buffer))) 
	     (point))
	    comint-input-ring-index nil))
  (comint-previous-matching-input
   (concat "^" (regexp-quote comint-matching-input-from-input-string))
   arg))

(defun comint-next-matching-input-from-input (arg)
  "Search forwards through input history for match for current input.
\(Previous history elements are earlier commands.)
With prefix argument N, search for Nth previous match.
If N is negative, find the next or Nth next match."
  (interactive "p")
  (comint-previous-matching-input-from-input (- arg)))


(defun comint-replace-by-expanded-history ()
  "Expand input command history references before point.
This function depends on the buffer's idea of the input history, which may not
match the command interpreter's idea, assuming it has one.

Assumes history syntax is like typical Un*x shells'.  However, since emacs
cannot know the interpreter's idea of input line numbers, assuming it has one,
it cannot expand absolute input line number references.

See also `comint-magic-space'."
  (interactive)
  (save-excursion
    (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
	  (start (progn (comint-bol nil) (point))))
      (while (re-search-forward
	      "[!^]" (save-excursion (end-of-line nil) (- (point) toend)) t)
	;; This seems a bit complex.  We look for references such as !!, !-num,
	;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
	;; If that wasn't enough, the plings can be suffixed with argument
	;; range specifiers.
	;; Argument ranges are complex too, so we hive off the input line,
	;; referenced with plings, with the range string to `comint-args'.
	(setq comint-input-ring-index nil)
	(goto-char (match-beginning 0))
	(cond ((or (= (preceding-char) ?\\)
		   (comint-within-quotes start (point)))
	       ;; The history is quoted, or we're in quotes.
	       (goto-char (match-end 0)))
	      ((looking-at "![0-9]+\\($\\|[^-]\\)")
	       ;; We cannot know the interpreter's idea of input line numbers.
	       (goto-char (match-end 0))
	       (message "Absolute reference cannot be expanded"))
	      ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
	       ;; Just a number of args from `number' lines backward.
	       (let ((number (1- (string-to-number
				  (buffer-substring (match-beginning 1)
						    (match-end 1))))))
		 (if (<= number (ring-length comint-input-ring))
		     (progn
		       (replace-match
			(comint-args (comint-previous-input-string number)
				     (match-beginning 2) (match-end 2)) t t)
		       (setq comint-input-ring-index number)
		       (message "History item: %d" (1+ number)))
		   (goto-char (match-end 0))
		   (message "Relative reference exceeds input history size"))))
	      ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
	       ;; Just a number of args from the previous input line.
	       (replace-match
		(comint-args (comint-previous-input-string 0)
			     (match-beginning 1) (match-end 1)) t t))
	      ((looking-at
		"!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
	       ;; Most recent input starting with or containing (possibly
	       ;; protected) string, maybe just a number of args.  Phew.
	       (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
		      (mb2 (match-beginning 2)) (me2 (match-end 2))
		      (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
		      (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
		      (pos (save-match-data
			     (comint-previous-matching-input-string-position
			      (concat pref (regexp-quote exp)) 1))))
		 (if (null pos)
		     (progn (message "Not found")
			    (goto-char (match-end 0))
			    (ding))
		   (setq comint-input-ring-index pos)
		   (message "History item: %d" (1+ pos))
		   (replace-match
		    (comint-args (ring-ref comint-input-ring pos)
				 (match-beginning 4) (match-end 4))
		    t t))))
	      ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
	       ;; Quick substitution on the previous input line.
	       (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
		     (new (buffer-substring (match-beginning 2) (match-end 2)))
		     (pos nil))
		 (replace-match (comint-previous-input-string 0) t t)
		 (setq pos (point))
		 (goto-char (match-beginning 0))
		 (if (search-forward old pos t)
		     (replace-match new t t)
		   (message "Not found")
		   (ding))))
	      (t
	       (goto-char (match-end 0))))))))


(defun comint-magic-space (arg)
  "Expand input history references before point and insert ARG spaces.
A useful command to bind to SPC.  See `comint-replace-by-expanded-history'."
  (interactive "p")
  (comint-replace-by-expanded-history)
  (self-insert-command arg))

(defun comint-within-quotes (beg end)
  "Return t if the number of quotes between BEG and END is odd.
Quotes are single and double."
  (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
	(countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
    (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))

(defun comint-how-many-region (regexp beg end)
  "Return number of matches for REGEXP from BEG to END."
  (let ((count 0))
    (save-excursion
      (save-match-data
	(goto-char beg)
	(while (re-search-forward regexp end t)
	  (setq count (1+ count)))))
    count))

(defun comint-args (string begin end)
  ;; From STRING, return the args depending on the range specified in the text
  ;; from BEGIN to END.  If BEGIN is nil, assume all args.  Ignore leading `:'.
  ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
  (save-match-data
    (if (null begin)
	(comint-arguments string 0 nil)
      (let* ((range (buffer-substring
		     (if (eq (char-after begin) ?:) (1+ begin) begin) end))
	     (nth (cond ((string-match "^[*^]" range) 1)
			((string-match "^-" range) 0)
			((string-equal range "$") nil)
			(t (string-to-number range))))
	     (mth (cond ((string-match "[-*$]$" range) nil)
			((string-match "-" range)
			 (string-to-number (substring range (match-end 0))))
			(t nth))))
	(comint-arguments string nth mth)))))

(defun comint-delim-arg (arg)
  ;; Return a list of arguments from ARG.  If there's a quote in there, just
  ;; a list of the arg, otherwise try and break up using characters in
  ;; comint-delimiter-argument-list.  Returned list is backwards.
  (if (or (null comint-delimiter-argument-list)
	  (string-match "[\"\'\`]" arg))
      (list arg)
    (let ((not-delim (format "[^%s]+" (mapconcat
				       (function (lambda (d) (regexp-quote d)))
				       comint-delimiter-argument-list "")))
	  (delim-str (mapconcat (function (lambda (d)
					    (concat (regexp-quote d) "+")))
				comint-delimiter-argument-list "\\|"))
	  (args ()) (pos 0))
      (while (or (eq pos (string-match not-delim arg pos))
		 (eq pos (string-match delim-str arg pos)))
	(setq pos (match-end 0)
	      args (cons (substring arg (match-beginning 0) pos) args)))
      args)))

(defun comint-arguments (string nth mth)
  "Return from STRING the NTH to MTH arguments.
NTH and/or MTH can be nil, which means the last argument.
Returned arguments are separated by single spaces.  Arguments are assumed to be
delimited by whitespace.  Strings comprising characters in the variable
`comint-delimiter-argument-list' are treated as delimiters and arguments.
Argument 0 is the command name."
  (let ((arg "\\(\\S \\|\\(\"[^\"]*\"\\|\'[^\']*\'\\|\`[^\`]*\`\\)\\)+")
	(args ()) (pos 0) (str nil))
    ;; We build a list of all the args.  Unnecessary, but more efficient, when
    ;; ranges of args are required, than picking out one by one and recursing.
    (while (string-match arg string pos)
      (setq pos (match-end 0)
	    str (substring string (match-beginning 0) pos)
	    args (nconc (comint-delim-arg str) args)))
    (let ((n (or nth (1- (length args))))
	  (m (if mth (1- (- (length args) mth)) 0)))
      (mapconcat
       (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))

David Lawrence's avatar
David Lawrence committed
1017
;;;
1018
;;; Input processing stuff
David Lawrence's avatar
David Lawrence committed
1019
;;;
1020

Jim Blandy's avatar
Jim Blandy committed
1021
(defun comint-send-input () 
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1022 1023 1024
  "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
Noah Friedman's avatar
Noah Friedman committed
1025
of variable `comint-get-old-input' to retrieve old input, copies it to the
1026
process mark, and sends it.  If variable `comint-process-echoes' is nil,
Noah Friedman's avatar
Noah Friedman committed
1027
a terminal newline is also inserted into the buffer and sent to the process
1028 1029
\(if it is non-nil, all text from the process mark to point is deleted,
since it is assumed the remote process will re-echo it).
Noah Friedman's avatar
Noah Friedman committed
1030

1031 1032 1033 1034 1035
Any history reference may be expanded depending on the value of the variable
`comint-input-autoexpand'.  The 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.
1036 1037

If variable `comint-eol-on-send' is non-nil, then point is moved to the
Noah Friedman's avatar
Noah Friedman committed
1038 1039 1040 1041
end of line before sending the input.

`comint-get-old-input', `comint-input-sentinel', and `comint-input-filter'
are chosen according to the command interpreter running in the buffer.  E.g.,
David Lawrence's avatar
David Lawrence committed
1042
If the interpreter is the csh,
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046
    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.
1047
    comint-input-filter is the default: returns t if the input isn't all white
Jim Blandy's avatar
Jim Blandy committed
1048
	space.
David Lawrence's avatar
David Lawrence committed
1049 1050

If the comint is Lucid Common Lisp, 
Jim Blandy's avatar
Jim Blandy committed
1051 1052
    comint-get-old-input snarfs the sexp ending at point.
    comint-input-sentinel does nothing.
1053
    comint-input-filter returns nil if the input matches input-filter-regexp,
David Lawrence's avatar
David Lawrence committed
1054 1055
        which matches (1) all whitespace (2) :a, :c, etc.

1056
Similarly for Soar, Scheme, etc."
David Lawrence's avatar
David Lawrence committed
1057 1058
  (interactive)
  ;; Note that the input string does not include its terminal newline.
Jim Blandy's avatar
Jim Blandy committed
1059 1060 1061
  (let ((proc (get-buffer-process (current-buffer))))
    (if (not proc) (error "Current buffer has no process")
	(let* ((pmark (process-mark proc))
1062
	       (intxt (if (>= (point) (marker-position pmark))
Jim Blandy's avatar
Jim Blandy committed
1063 1064
			  (progn (if comint-eol-on-send (end-of-line))
				 (buffer-substring pmark (point)))
Jim Blandy's avatar
Jim Blandy committed
1065 1066 1067
			(let ((copy (funcall comint-get-old-input)))
			  (goto-char pmark)
			  (insert copy)
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
			  copy)))
	       (input (if (not (eq comint-input-autoexpand 'input))
			  ;; Just whatever's already there
			  intxt
			;; Expand and leave it visible in buffer
			(comint-replace-by-expanded-history)
			(buffer-substring pmark (point))))
	       (history (if (not (eq comint-input-autoexpand 'history))
			    (comint-arguments input 0 nil)
			  ;; This is messy 'cos ultimately the original
			  ;; functions used do insertion, rather than return
			  ;; strings.  We have to expand, then insert back.
			  (comint-replace-by-expanded-history)
			  (let ((copy (buffer-substring pmark (point))))
			    (delete-region pmark (point))
			    (insert input)
			    (comint-arguments copy 0 nil)))))
Noah Friedman's avatar
Noah Friedman committed
1085 1086
          (if comint-process-echoes
              (delete-region pmark (point))
1087 1088 1089 1090 1091 1092 1093 1094
	    (insert ?\n))
	  (if (and (funcall comint-input-filter history)
		   (or (null comint-input-ignoredups)
		       (not (ring-p comint-input-ring))
		       (ring-empty-p comint-input-ring)
		       (not (string-equal (ring-ref comint-input-ring 0)
					  history))))
	      (ring-insert comint-input-ring history))
Jim Blandy's avatar
Jim Blandy committed
1095 1096
	  (funcall comint-input-sentinel input)
	  (funcall comint-input-sender proc input)
1097
	  (setq comint-input-ring-index nil)
Jim Blandy's avatar
Jim Blandy committed
1098 1099
	  (set-marker comint-last-input-start pmark)
	  (set-marker comint-last-input-end (point))
1100 1101 1102
	  (set-marker (process-mark proc) (point))
	  ;; A kludge to prevent the delay between insert and process output
	  ;; affecting the display.  A case for a comint-send-input-hook?
1103 1104 1105 1106
	  (let ((functions comint-output-filter-functions))
	    (while functions
	      (funcall (car functions) (concat input "\n"))
	      (setq functions (cdr functions))))))))
David Lawrence's avatar
David Lawrence committed
1107

1108
;; The purpose of using this filter for comint processes
1109 1110
;; is to keep comint-last-input-end from moving forward
;; when output is inserted.
1111 1112
(defun comint-output-filter (process string)
  ;; First check for killed buffer
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
  (let ((oprocbuf (process-buffer process)))
    (if (and oprocbuf (buffer-name oprocbuf))
	(let ((obuf (current-buffer))
	      (opoint nil) (obeg nil) (oend nil))
	  (set-buffer oprocbuf)
	  (setq opoint (point))
	  (setq obeg (point-min))
	  (setq oend (point-max))
	  (let ((buffer-read-only nil)
		(nchars (length string))
		(ostart nil))
	    (widen)
	    (goto-char (process-mark process))
	    (setq ostart (point))
	    (if (<= (point) opoint)
		(setq opoint (+ opoint nchars)))
	    ;; Insert after old_begv, but before old_zv.
	    (if (< (point) obeg)
		(setq obeg (+ obeg nchars)))
	    (if (<= (point) oend)
		(setq oend (+ oend nchars)))
	    (insert-before-markers string)
	    ;; Don't insert initial prompt outside the top of the window.
	    (if (= (window-start (selected-window)) (point))
		(set-window-start (selected-window) (- (point) (length string))))
	    (if (and comint-last-input-end
		     (marker-buffer comint-last-input-end)
		     (= (point) comint-last-input-end))
		(set-marker comint-last-input-end (- comint-last-input-end nchars)))
	    (set-marker comint-last-output-start ostart)
	    (set-marker (process-mark process) (point))
	    (force-mode-line-update))

	  (narrow-to-region obeg oend)
	  (goto-char opoint)
	  (let ((functions comint-output-filter-functions))
	    (while functions
	      (funcall (car functions) string)
	      (setq functions (cdr functions))))
	  (set-buffer obuf)))))
1153

1154
(defun comint-preinput-scroll-to-bottom ()
1155 1156 1157
  "Go to the end of buffer in all windows showing it.
Movement occurs if point in the selected window is not after the process mark,
and `this-command' is an insertion command.  Insertion commands recognised
1158 1159
are `self-insert-command', `comint-magic-space', `yank', `mouse-yank-at-click',
and `hilit-yank'.
1160 1161
Depends on the value of `comint-scroll-to-bottom-on-input'.

1162
This function should be a pre-command hook."
1163
  (if (and comint-scroll-to-bottom-on-input
1164 1165
	   (memq this-command '(self-insert-command comint-magic-space yank
				mouse-yank-at-click hilit-yank)))
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
      (let* ((selected (selected-window))
	     (current (current-buffer))
	     (process (get-buffer-process current))
	     (scroll comint-scroll-to-bottom-on-input))
	(if (and process (< (point) (process-mark process))
		 scroll (not (window-minibuffer-p selected)))
	    (walk-windows
	     (function (lambda (window)
	       (if (and (eq (window-buffer window) current)
			(or (eq scroll t) (eq scroll 'all)
			    (and (eq scroll 'this) (eq selected window))))
		   (progn
		     (select-window window)
		     (goto-char (point-max))
		     (select-window selected)))))
	     'not-minibuf t)))))

1183
(defun comint-postoutput-scroll-to-bottom (string)
1184 1185 1186 1187 1188
  "Go to the end of buffer in all windows showing it.
Does not scroll if the current line is the last line in the buffer.
Depends on the value of `comint-scroll-to-bottom-on-output' and
`comint-scroll-show-maximum-output'.

1189
This function should be in the list `comint-output-filter-functions'."
1190 1191 1192 1193
  (let* ((selected (selected-window))
	 (current (current-buffer))
	 (process (get-buffer-process current))
	 (scroll comint-scroll-to-bottom-on-output))
1194
    (if process
1195 1196
	(walk-windows
	 (function (lambda (window)
1197
	   (if (eq (window-buffer window) current)
1198 1199
	       (progn
		 (select-window window)
1200 1201 1202 1203 1204 1205 1206 1207
		 (if (and (< (point) (process-mark process))
			  (or (eq scroll t) (eq scroll 'all)
			      ;; Maybe user wants point to jump to the end.
			      (and (eq scroll 'this) (eq selected window))
			      (and (eq scroll 'others) (not (eq selected window)))
			      ;; If point was at the end, keep it at the end.
			      (>= (point)
				  (- (process-mark process) (length string)))))
1208
		     (goto-char (process-mark process)))
1209 1210 1211 1212 1213 1214 1215
		 ;; Optionally scroll so that the text
		 ;; ends at the bottom of the window.
		 (if (and comint-scroll-show-maximum-output
			  (>= (point) (process-mark process)))
		     (save-excursion
		       (goto-char (point-max))
		       (recenter -1)))
1216
		 (select-window selected)))))
1217
	 nil t))))
1218 1219 1220 1221 1222 1223

(defun comint-show-maximum-output ()
  "Put the end of the buffer at the bottom of the window."
  (interactive)
  (goto-char (point-max))
  (recenter -1))
1224

David Lawrence's avatar
David Lawrence committed
1225
(defun comint-get-old-input-default ()
1226
  "Default for `comint-get-old-input'.
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1227
Take the current line, and discard any initial text matching
1228
`comint-prompt-regexp'."
David Lawrence's avatar
David Lawrence committed
1229
  (save-excursion
Jim Blandy's avatar
Jim Blandy committed
1230 1231 1232 1233 1234 1235
    (beginning-of-line)
    (comint-skip-prompt)
    (let ((beg (point)))
      (end-of-line)
      (buffer-substring beg (point)))))

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
(defun comint-copy-old-input ()
  "Insert after prompt old input at point as new input to be edited.
Calls `comint-get-old-input' to get old input."
  (interactive)
  (let ((input (funcall comint-get-old-input))
 	(process (get-buffer-process (current-buffer))))
    (if (not process)
	(error "Current buffer has no process")
      (goto-char (process-mark process))
      (insert input))))

Jim Blandy's avatar
Jim Blandy committed
1247
(defun comint-skip-prompt ()
1248
  "Skip past the text matching regexp `comint-prompt-regexp'.
Jim Blandy's avatar
Jim Blandy committed
1249 1250 1251 1252 1253 1254 1255
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 ()
1256 1257 1258
  "Return t if point is after the process output marker."
  (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
    (<= (marker-position pmark) (point))))
Jim Blandy's avatar
Jim Blandy committed
1259 1260 1261 1262

(defun comint-simple-send (proc string)
  "Default function for sending to PROC input STRING.
This just sends STRING plus a newline. To override this,
1263
set the hook `comint-input-sender'."
Jim Blandy's avatar
Jim Blandy committed
1264 1265
  (comint-send-string proc string)
  (comint-send-string proc "\n"))
David Lawrence's avatar
David Lawrence committed
1266 1267 1268

(defun comint-bol (arg)
  "Goes to the beginning of line, then skips past the prompt, if any.
1269
If prefix argument is given (\\[universal-argument]) the prompt is not skipped. 
David Lawrence's avatar
David Lawrence committed
1270

Jim Blandy's avatar
Jim Blandy committed
1271
The prompt skip is done by skipping text matching the regular expression
1272
`comint-prompt-regexp', a buffer local variable.
Jim Blandy's avatar
Jim Blandy committed
1273

1274 1275
If you don't like this command, bind C-a to `beginning-of-line' 
in your hook, `comint-mode-hook'."
David Lawrence's avatar
David Lawrence committed
1276 1277
  (interactive "P")
  (beginning-of-line)
Jim Blandy's avatar
Jim Blandy committed
1278
  (if (null arg) (comint-skip-prompt)))
David Lawrence's avatar
David Lawrence committed
1279 1280 1281

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

Jim Blandy's avatar
Jim Blandy committed
1284
(defun comint-read-noecho (prompt &optional stars)
Noah Friedman's avatar
Noah Friedman committed
1285 1286 1287 1288
  "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
1289 1290
`inhibit-quit' is set because e.g. this function was called from a process
filter and C-g is pressed, this function returns nil rather than a string).
Noah Friedman's avatar
Noah Friedman committed
1291 1292

Note that the keystrokes comprising the text can still be recovered
1293
\(temporarily) with \\[view-lossage].  This may be a security bug for some
Noah Friedman's avatar
Noah Friedman committed
1294 1295 1296 1297
applications."
  (let ((ans "")
	(c 0)
	(echo-keystrokes 0)
Jim Blandy's avatar
Jim Blandy committed
1298
	(cursor-in-echo-area t)
Noah Friedman's avatar
Noah Friedman committed
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
        (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
1331

David Lawrence's avatar
David Lawrence committed
1332
(defun send-invisible (str)
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1333
  "Read a string without echoing.
1334 1335
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
1336 1337
Security bug: your string can still be temporarily recovered with
\\[view-lossage]."