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

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97 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 <simon@gnu.ai.mit.edu>
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
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
David Lawrence's avatar
David Lawrence committed
25

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

Erik Naggum's avatar
Erik Naggum committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
;; 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)
;;     - Simon Marshall (simon@gnu.ai.mit.edu)

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

;; Several packages are already defined using comint mode:
;; - shell.el defines a shell-in-a-buffer mode.
;; - 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.

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

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


Erik Naggum's avatar
Erik Naggum committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
;; Brief Command Documentation:
;;============================================================================
;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
;; mode)
;;
;; m-p	    comint-previous-input    	    Cycle backwards in input history
;; m-n	    comint-next-input  	    	    Cycle forwards
;; m-r     comint-previous-matching-input  Previous input matching a regexp
;; m-s     comint-next-matching-input      Next input that matches
;; m-c-l   comint-show-output		    Show last batch of process output
;; return  comint-send-input
;; c-d	    comint-delchar-or-maybe-eof     Delete char unless at end of buff
;; c-c c-a comint-bol                      Beginning of line; skip prompt
;; 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
;; c-c c-l comint-dynamic-list-input-ring  List input history
;;
;; Not bound by default in comint-mode (some are in shell mode)
;; comint-run				Run a program under comint-mode
;; send-invisible			Read a line w/o echo, and send to proc
;; 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.
;; comint-replace-by-expanded-filename	Expand and complete filename at point;
;;					replace with expanded/completed name.
;; comint-replace-by-expanded-history	Expand history at point;
;;					replace with expanded name.
;; comint-magic-space                  Expand history and add (a) space(s).
;; comint-kill-subjob			No mercy.
;; comint-show-maximum-output          Show as much output as possible.
;; 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
102

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

Richard M. Stallman's avatar
Richard M. Stallman committed
105
(require 'ring)
David Lawrence's avatar
David Lawrence committed
106

Erik Naggum's avatar
Erik Naggum committed
107 108 109
;; Buffer Local Variables:
;;============================================================================
;; Comint mode buffer local variables:
110 111 112 113 114 115 116 117 118 119 120 121
;;  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
;;  comint-last-input-end		marker	For comint-kill-output command
;;  comint-input-ring-size		integer	For the input history
;;  comint-input-ring			ring	mechanism
;;  comint-input-ring-index		number	...
;;  comint-input-autoexpand		symbol	...
;;  comint-input-ignoredups		boolean	...
;;  comint-last-input-match		string	...
;;  comint-dynamic-complete-functions	hook   For the completion mechanism
;;  comint-completion-fignore		list	...
122
;;  comint-file-name-chars		string	...
123 124 125 126 127 128 129 130 131 132 133
;;  comint-file-name-quote-list		list	...
;;  comint-get-old-input		function Hooks for specific 
;;  comint-input-filter-functions	hook	process-in-a-buffer
;;  comint-output-filter-functions	hook	function modes.
;;  comint-input-filter			function ...
;;  comint-input-sender			function ...
;;  comint-eol-on-send			boolean	...
;;  comint-process-echoes		boolean	...
;;  comint-scroll-to-bottom-on-input	symbol	For scroll behavior
;;  comint-scroll-to-bottom-on-output	symbol	...
;;  comint-scroll-show-maximum-output	boolean	...	
Erik Naggum's avatar
Erik Naggum committed
134 135
;;
;; Comint mode non-buffer local variables:
136 137 138
;;  comint-completion-addsuffix		boolean/cons	For file name
;;  comint-completion-autolist		boolean		completion behavior
;;  comint-completion-recexact		boolean		...
David Lawrence's avatar
David Lawrence committed
139

140 141 142 143 144 145 146 147 148 149 150 151 152 153
(defgroup comint nil
  "General command interpreter in a window stuff."
  :group 'processes)

(defgroup comint-completion nil
  "Completion facilities in comint"
  :group 'comint)

(defgroup comint-source nil
  "Source finding facilities in comint"
  :prefix "comint-"
  :group 'comint)


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

Good choices:
159
  Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
160 161
  Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
  franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
Jim Blandy's avatar
Jim Blandy committed
162
  kcl: \"^>+ *\"
163
  shell: \"^[^#$%>\\n]*[#$%>] *\"
Jim Blandy's avatar
Jim Blandy committed
164
  T: \"^>+ *\"
David Lawrence's avatar
David Lawrence committed
165

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

168 169 170 171 172
(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'.
173
Defaults to the empty list.
174

175
For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
176 177 178

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

179
(defcustom comint-input-autoexpand nil
180
  "*If non-nil, expand input command history references on completion.
181
This mirrors the optional behavior of tcsh (its autoexpand and histlit).
182 183 184 185 186 187

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

188 189 190 191 192 193 194 195
This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const :tag "on" t)
		 (const input)
		 (const history))
  :group 'comint)

(defcustom comint-input-ignoredups nil
196
  "*If non-nil, don't add input matching the last on the input ring.
197
This mirrors the optional behavior of bash.
198

199 200 201
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
202

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

207 208 209
This variable is buffer-local, and is a good thing to set in mode hooks."
  :type 'boolean
  :group 'comint)
210

211
(defcustom comint-scroll-to-bottom-on-input nil
212 213 214 215
  "*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.

216
The default is nil.
217

218 219 220 221 222 223
See `comint-preinput-scroll-to-bottom'.  This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const t)
		 (const all)
		 (const this))
  :group 'comint)
224

225
(defcustom comint-scroll-to-bottom-on-output nil
226 227 228 229
  "*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.
230 231

The default is nil.
232

233
See variable `comint-scroll-show-maximum-output' and function
234 235 236 237 238 239 240 241 242
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const t)
		 (const all)
		 (const this)
		 (const others))
  :group 'comint)

(defcustom comint-scroll-show-maximum-output nil
243 244
  "*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
245

246
See variable `comint-scroll-to-bottom-on-output' and function
247 248 249
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local."
  :type 'boolean
  :group 'comint)
250

251
(defcustom comint-buffer-maximum-size 1024
252 253
  "*The maximum size in lines for comint buffers.
Comint buffers are truncated from the top to be no greater than this number, if
254 255 256
the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
  :type 'integer
  :group 'comint)
257

258
(defvar comint-input-ring-size 32
Jim Blandy's avatar
Jim Blandy committed
259
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
260

261
(defcustom comint-process-echoes nil
262
  "*If non-nil, assume that the subprocess echoes any input.
Noah Friedman's avatar
Noah Friedman committed
263
If so, delete one copy of the input so that only one copy eventually
264
appears in the buffer.
Noah Friedman's avatar
Noah Friedman committed
265

266 267 268
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
Noah Friedman's avatar
Noah Friedman committed
269

270 271
;; AIX puts the name of the person being su'd to in from of the prompt.
(defcustom comint-password-prompt-regexp
272
  "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|^\\)[Pp]assword\\|pass phrase\\):\\s *\\'"
273
  "*Regexp matching prompts for passwords in the inferior process.
274 275 276
This is used by `comint-watch-for-password-prompt'."
  :type 'regexp
  :group 'comint)
277

Erik Naggum's avatar
Erik Naggum committed
278
;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
279
(defvar comint-get-old-input (function comint-get-old-input-default)
280
  "Function that returns old text in comint mode.
David Lawrence's avatar
David Lawrence committed
281 282
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
283 284
`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
285

286 287 288 289 290
(defvar comint-dynamic-complete-functions
  '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
  "List of functions called to perform completion.
Functions should return non-nil if completion was performed.
See also `comint-dynamic-complete'.
291 292 293

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

Jim Blandy's avatar
Jim Blandy committed
294 295 296
(defvar comint-input-filter
  (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
  "Predicate for filtering additions to input history.
297 298 299
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.")

300
(defvar comint-input-filter-functions '()
301 302 303 304 305
  "Functions to call before input is sent to the process.
These functions get one argument, a string containing the text to send.

This variable is buffer-local.")

306
(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom) 
307
  "Functions to call after output is inserted into the buffer.
308
One possible function is `comint-postoutput-scroll-to-bottom'.
309 310 311 312
These functions get one argument, a string containing the text as originally
inserted.  Note that this might not be the same as the buffer contents between
`comint-last-output-start' and the buffer's `process-mark', if other filter
functions have already modified the buffer.
313 314

This variable is buffer-local.")
Jim Blandy's avatar
Jim Blandy committed
315 316 317

(defvar comint-input-sender (function comint-simple-send)
  "Function to actually send to PROCESS the STRING submitted by user.
318 319 320 321
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
322

323
(defcustom comint-eol-on-send t
324
  "*Non-nil means go to the end of the line before sending input.
325 326 327
See `comint-send-input'."
  :type 'boolean
  :group 'comint)
David Lawrence's avatar
David Lawrence committed
328

329
(defcustom comint-mode-hook '()
Jim Blandy's avatar
Jim Blandy committed
330
  "Called upon entry into comint-mode
331 332 333
This is run before the process is cranked up."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
334

335
(defcustom comint-exec-hook '()
336
  "Called each time a process is exec'd by `comint-exec'.
Jim Blandy's avatar
Jim Blandy committed
337
This is called after the process is cranked up.  It is useful for things that
338 339
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
340 341 342
executed once when the buffer is created."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
343 344

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

Richard M. Stallman's avatar
Richard M. Stallman committed
346
(defvar comint-ptyp t
347
  "Non-nil if communications via pty; false if by pipe.  Buffer local.
348
This is to work around a bug in Emacs process signaling.")
Richard M. Stallman's avatar
Richard M. Stallman committed
349

350
(defvar comint-input-ring nil)
351 352
(defvar comint-last-input-start)
(defvar comint-last-input-end)
353
(defvar comint-last-output-start)
354 355 356 357
(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.")
358 359

(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
Richard M. Stallman's avatar
Richard M. Stallman committed
360
(put 'comint-input-ring 'permanent-local t)
361 362
(put 'comint-input-ring-index 'permanent-local t)
(put 'comint-input-autoexpand 'permanent-local t)
363 364
(put 'comint-input-filter-functions 'permanent-local t)
(put 'comint-output-filter-functions 'permanent-local t)
365 366 367
(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
368
(put 'comint-ptyp 'permanent-local t)
369

David Lawrence's avatar
David Lawrence committed
370 371 372 373 374
(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.
375
Setting variable `comint-eol-on-send' means jump to the end of the line
Jim Blandy's avatar
Jim Blandy committed
376
before submitting new input.
David Lawrence's avatar
David Lawrence committed
377

378 379
This mode is customised to create major modes such as Inferior Lisp
mode, Shell mode, etc.  This can be done by setting the hooks
380
`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
381
and `comint-get-old-input' to appropriate functions, and the variable
382
`comint-prompt-regexp' to the appropriate regular expression.
David Lawrence's avatar
David Lawrence committed
383

384
An input history is maintained of size `comint-input-ring-size', and
385 386 387 388 389 390
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'.

391
Commands with no default key bindings include `send-invisible',
392
`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and 
393 394 395
`comint-magic-space'.

Input to, and output from, the subprocess can cause the window to scroll to
396
the end of the buffer.  See variables `comint-output-filter-functions',
397
`comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
David Lawrence's avatar
David Lawrence committed
398 399 400 401 402 403

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

\\{comint-mode-map}

404
Entry to this mode runs the hooks on `comint-mode-hook'."
David Lawrence's avatar
David Lawrence committed
405
  (interactive)
406 407 408 409
  ;; Do not remove this.  All major modes must do this.
  (kill-all-local-variables)
  (setq major-mode 'comint-mode)
  (setq mode-name "Comint")
410
  (setq mode-line-process '(":%s"))
411 412 413
  (use-local-map comint-mode-map)
  (make-local-variable 'comint-last-input-start)
  (setq comint-last-input-start (make-marker))
414
  (set-marker comint-last-input-start (point-min))
415 416
  (make-local-variable 'comint-last-input-end)
  (setq comint-last-input-end (make-marker))
417
  (set-marker comint-last-input-end (point-min))
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  (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)
433
  (make-local-hook 'comint-dynamic-complete-functions)
434
  (make-local-variable 'comint-completion-fignore)
435
  (make-local-variable 'comint-get-old-input)
436
  (make-local-hook 'comint-input-filter-functions)
437 438 439 440 441 442
  (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)
443 444
  (make-local-variable 'pre-command-hook)
  (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom)
445
  (make-local-hook 'comint-output-filter-functions)
446 447 448
  (make-local-variable 'comint-ptyp)
  (make-local-variable 'comint-exec-hook)
  (make-local-variable 'comint-process-echoes)
449
  (make-local-variable 'comint-file-name-chars)
450
  (make-local-variable 'comint-file-name-quote-list)
451
  (run-hooks 'comint-mode-hook))
David Lawrence's avatar
David Lawrence committed
452

Jim Blandy's avatar
Jim Blandy committed
453 454
(if comint-mode-map
    nil
455
  ;; Keys:
Jim Blandy's avatar
Jim Blandy committed
456 457 458
  (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)
459 460
  (define-key comint-mode-map [C-up] 'comint-previous-input)
  (define-key comint-mode-map [C-down] 'comint-next-input)
461 462
  (define-key comint-mode-map "\er" 'comint-previous-matching-input)
  (define-key comint-mode-map "\es" 'comint-next-matching-input)
463 464
  (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)
465
  (define-key comint-mode-map "\e\C-l" 'comint-show-output)
Jim Blandy's avatar
Jim Blandy committed
466 467
  (define-key comint-mode-map "\C-m" 'comint-send-input)
  (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
468
  (define-key comint-mode-map "\C-c\C-a" 'comint-bol)
Jim Blandy's avatar
Jim Blandy committed
469 470 471 472 473
  (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)
474
  (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
Jim Blandy's avatar
Jim Blandy committed
475 476
  (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
  (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
477
  (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
478
  (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
479
  (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
480
  (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
481
  (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
482 483 484
  ;; Menu bars:
  ;; completion:
  (define-key comint-mode-map [menu-bar completion] 
485
    (cons "Complete" (make-sparse-keymap "Complete")))
486 487 488 489 490 491 492 493 494
  (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-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:
495
  (define-key comint-mode-map [menu-bar inout] 
496
    (cons "In/Out" (make-sparse-keymap "In/Out")))
497
  (define-key comint-mode-map [menu-bar inout kill-output]
498
    '("Kill Current Output Group" . comint-kill-output))
499
  (define-key comint-mode-map [menu-bar inout next-prompt]
500
    '("Forward Output Group" . comint-next-prompt))
501
  (define-key comint-mode-map [menu-bar inout previous-prompt]
502
    '("Backward Output Group" . comint-previous-prompt))
503
  (define-key comint-mode-map [menu-bar inout show-maximum-output]
504
    '("Show Maximum Output" . comint-show-maximum-output))
505
  (define-key comint-mode-map [menu-bar inout show-output]
506
    '("Show Current Output Group" . comint-show-output))
507
  (define-key comint-mode-map [menu-bar inout kill-input]
508
    '("Kill Current Input" . comint-kill-input))
509
  (define-key comint-mode-map [menu-bar inout copy-input]
510
    '("Copy Old Input" . comint-copy-old-input))
511
  (define-key comint-mode-map [menu-bar inout forward-matching-history]
512
    '("Forward Matching Input..." . comint-forward-matching-input))
513
  (define-key comint-mode-map [menu-bar inout backward-matching-history]
514
    '("Backward Matching Input..." . comint-backward-matching-input))
515
  (define-key comint-mode-map [menu-bar inout next-matching-history]
516
    '("Next Matching Input..." . comint-next-matching-input))
517
  (define-key comint-mode-map [menu-bar inout previous-matching-history]
518
    '("Previous Matching Input..." . comint-previous-matching-input))
519
  (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
520
    '("Next Matching Current Input" . comint-next-matching-input-from-input))
521
  (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
522
    '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
523
  (define-key comint-mode-map [menu-bar inout next-history]
524
    '("Next Input" . comint-next-input))
525
  (define-key comint-mode-map [menu-bar inout previous-history]
526
    '("Previous Input" . comint-previous-input))
527
  (define-key comint-mode-map [menu-bar inout list-history]
528
    '("List Input History" . comint-dynamic-list-input-ring))
529
  (define-key comint-mode-map [menu-bar inout expand-history]
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
    '("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:
547
  (setq menu-bar-final-items (append '(completion inout signals)
548
				     menu-bar-final-items))
Jim Blandy's avatar
Jim Blandy committed
549 550 551
  )

(defun comint-check-proc (buffer)
552
  "Return t if there is a living process associated w/buffer BUFFER.
553
Living means the status is `open', `run', or `stop'.
554
BUFFER can be either a buffer or the name of one."
Jim Blandy's avatar
Jim Blandy committed
555
  (let ((proc (get-buffer-process buffer)))
556
    (and proc (memq (process-status proc) '(open run stop)))))
David Lawrence's avatar
David Lawrence committed
557

558
;;;###autoload
David Lawrence's avatar
David Lawrence committed
559
(defun make-comint (name program &optional startfile &rest switches)
560 561
  "Make a comint process NAME in a buffer, running PROGRAM.
The name of the buffer is made by surrounding NAME with `*'s.
562 563 564 565 566 567 568
PROGRAM should be either a string denoting an executable program to create
via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
connection to be opened via `open-network-stream'.  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.

If PROGRAM is a string, any more args are arguments to PROGRAM."
569 570
  (or (fboundp 'start-process)
      (error "Multi-processing is not supported for this system"))
Jim Blandy's avatar
Jim Blandy committed
571
  (let ((buffer (get-buffer-create (concat "*" name "*"))))
David Lawrence's avatar
David Lawrence committed
572
    ;; If no process, or nuked process, crank up a new one and put buffer in
573
    ;; comint mode.  Otherwise, leave buffer and existing process alone.
Jim Blandy's avatar
Jim Blandy committed
574
    (cond ((not (comint-check-proc buffer))
Jim Blandy's avatar
Jim Blandy committed
575
	   (save-excursion
David Lawrence's avatar
David Lawrence committed
576 577 578 579 580
	     (set-buffer buffer)
	     (comint-mode)) ; Install local vars, mode, keymap, ...
	   (comint-exec buffer name program startfile switches)))
    buffer))

581
;;;###autoload
582 583 584 585 586 587 588 589 590 591 592
(defun comint-run (program)
  "Run PROGRAM in a comint buffer and switch to it.
The buffer name is made by surrounding the file name of PROGRAM with `*'s.
The file name is used to make a symbol name, such as `comint-sh-hook', and any
hooks on this symbol are run in the buffer.
See `make-comint' and `comint-exec'."
  (interactive "sRun program: ")
  (let ((name (file-name-nondirectory program)))
    (switch-to-buffer (make-comint name program))
    (run-hooks (intern-soft (concat "comint-" name "-hook")))))

David Lawrence's avatar
David Lawrence committed
593
(defun comint-exec (buffer name command startfile switches)
594
  "Start up a process in buffer BUFFER for comint modes.
595
Blasts any old process running in the buffer.  Doesn't set the buffer mode.
Jim Blandy's avatar
Jim Blandy committed
596
You can use this to cheaply run a series of processes in the same comint
597
buffer.  The hook `comint-exec-hook' is run after each exec."
David Lawrence's avatar
David Lawrence committed
598 599 600 601 602
  (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
603 604 605 606
    (let ((proc
	   (if (consp command)
	       (open-network-stream name buffer (car command) (cdr command))
	     (comint-exec-1 name buffer command switches))))
607
      (set-process-filter proc 'comint-output-filter)
Jim Blandy's avatar
Jim Blandy committed
608 609
      (make-local-variable 'comint-ptyp)
      (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
David Lawrence's avatar
David Lawrence committed
610
      ;; Jump to the end, and set the process mark.
Jim Blandy's avatar
Jim Blandy committed
611
      (goto-char (point-max))
Jim Blandy's avatar
Jim Blandy committed
612
      (set-marker (process-mark proc) (point))
David Lawrence's avatar
David Lawrence committed
613 614 615 616 617 618 619 620 621 622 623 624
      ;; 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
625 626
	     (comint-send-string proc startfile)))
    (run-hooks 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
627
    buffer)))
David Lawrence's avatar
David Lawrence committed
628

Erik Naggum's avatar
Erik Naggum committed
629 630
;; This auxiliary function cranks up the process for comint-exec in
;; the appropriate environment.
David Lawrence's avatar
David Lawrence committed
631 632

(defun comint-exec-1 (name buffer command switches)
633
  (let ((process-environment
634
	 (nconc
Richard M. Stallman's avatar
Richard M. Stallman committed
635 636
	  ;; If using termcap, we specify `emacs' as the terminal type
	  ;; because that lets us specify a width.
637
	  ;; If using terminfo, we specify `dumb' because that is
Richard M. Stallman's avatar
Richard M. Stallman committed
638 639 640 641
	  ;; a defined terminal type.  `emacs' is not a defined terminal type
	  ;; and there is no way for us to define it here.
	  ;; Some programs that use terminfo get very confused
	  ;; if TERM is not a valid terminal type.
642
	  (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
643
	      (list "TERM=dumb" "TERMCAP="
644
		    (format "COLUMNS=%d" (frame-width)))
645
	    (list "TERM=emacs"
646
		  (format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
647
	  (if (getenv "EMACS") nil (list "EMACS=t"))
648 649
	  process-environment))
	(default-directory
650
	  (if (file-accessible-directory-p default-directory)
651 652
	      default-directory
	    "/")))
Jim Blandy's avatar
Jim Blandy committed
653
    (apply 'start-process name buffer command switches)))
David Lawrence's avatar
David Lawrence committed
654

Erik Naggum's avatar
Erik Naggum committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
;; Input history processing in a buffer
;; ===========================================================================
;; 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.
;;
;; Three functions:
;; comint-read-input-ring              Read into comint-input-ring...
;; comint-write-input-ring             Write to comint-input-ring-file-name.
;; comint-replace-by-expanded-history-before-point Workhorse function.
677

678
(defun comint-read-input-ring (&optional silent)
679 680 681 682 683
  "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.

684 685
If the optional argument SILENT is non-nil, we say nothing about a
failure to read the history file.
686

687 688 689 690
This function is useful for major mode commands and mode hooks.

The structure of the history file should be one input command per line,
with the most recent command last.
691
See also `comint-input-ignoredups' and `comint-write-input-ring'."
692 693
  (cond ((or (null comint-input-ring-file-name)
	     (equal comint-input-ring-file-name ""))
694 695
	 nil)
	((not (file-readable-p comint-input-ring-file-name))
696 697 698
	 (or silent
	     (message "Cannot read history file %s"
		      comint-input-ring-file-name)))
699
	(t
700 701 702
	 (let ((history-buf (get-buffer-create " *temp*"))
	       (file comint-input-ring-file-name)
	       (count 0)
703
	       (ring (make-ring comint-input-ring-size)))
704 705 706
	   (unwind-protect
	       (save-excursion
		 (set-buffer history-buf)
707
		 (widen)
708 709 710 711 712 713 714 715
		 (erase-buffer)
		 (insert-file-contents file)
		 ;; Save restriction in case file is already visited...
		 ;; Watch for those date stamps in history files!
		 (goto-char (point-max))
		 (while (and (< count comint-input-ring-size)
			     (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
						 nil t))
716 717 718 719 720
		   (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)))
721 722 723
			 (ring-insert-at-beginning ring history)))
		   (setq count (1+ count))))
	     (kill-buffer history-buf))
724 725 726 727 728 729 730 731 732 733 734 735 736
	   (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)
737
	     (equal comint-input-ring-file-name "")
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 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 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 823 824 825 826 827 828 829 830 831 832 833
	     (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
834 835 836 837

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

David Lawrence's avatar
David Lawrence committed
840 841 842 843 844
(defun comint-next-input (arg)
  "Cycle forwards through input history."
  (interactive "*p")
  (comint-previous-input (- arg)))

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

878 879 880 881 882
(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."
883 884 885 886 887 888 889 890 891 892 893 894
  (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)))))
895 896 897 898 899 900

(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."
901
  (interactive (comint-regexp-arg "Next input matching (regexp): "))
902
  (comint-previous-matching-input regexp (- arg)))
David Lawrence's avatar
David Lawrence committed
903

904 905 906 907
(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.
908
If N is negative, search forwards for the -Nth following match."
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
  (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.
924 925 926
\(Following history elements are more recent commands.)
With prefix argument N, search for Nth following match.
If N is negative, search backwards for the -Nth previous match."
927 928 929 930
  (interactive "p")
  (comint-previous-matching-input-from-input (- arg)))


931
(defun comint-replace-by-expanded-history (&optional silent)
932
  "Expand input command history references before point.
933 934
Expansion is dependent on the value of `comint-input-autoexpand'.

935 936 937 938 939 940 941
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.

942 943 944
If the optional argument SILENT is non-nil, never complain
even if history reference seems erroneous.

945 946 947
See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.

Returns t if successful."
948
  (interactive)
949
  (if (and comint-input-autoexpand
950
	   (string-match "!\\|^\\^" (funcall comint-get-old-input))
951 952
	   (save-excursion (beginning-of-line)
			   (looking-at comint-prompt-regexp)))
953 954 955
      ;; Looks like there might be history references in the command.
      (let ((previous-modified-tick (buffer-modified-tick)))
	(message "Expanding history references...")
956
	(comint-replace-by-expanded-history-before-point silent)
957 958 959
	(/= previous-modified-tick (buffer-modified-tick)))))


960
(defun comint-replace-by-expanded-history-before-point (silent)
961 962
  "Expand directory stack reference before point.
See `comint-replace-by-expanded-history'.  Returns t if successful."
963 964 965
  (save-excursion
    (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
	  (start (progn (comint-bol nil) (point))))
966 967 968 969 970 971 972
      (while (progn
	       (skip-chars-forward "^!^"
				   (save-excursion
				     (end-of-line nil) (- (point) toend)))
	       (< (point)
		  (save-excursion
		    (end-of-line nil) (- (point) toend))))
973 974 975 976 977 978 979 980 981 982
	;; 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)
	(cond ((or (= (preceding-char) ?\\)
		   (comint-within-quotes start (point)))
	       ;; The history is quoted, or we're in quotes.
983
	       (goto-char (1+ (point))))
984 985 986 987 988 989 990 991 992 993 994 995 996
	      ((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)
997 998
				     (match-beginning 2) (match-end 2))
			t t)
999 1000 1001 1002 1003 1004 1005 1006
		       (setq comint-input-ring-index number