comint.el 138 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, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4
;;	Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Author: Olin Shivers <shivers@cs.cmu.edu>
Karl Heuer's avatar
Karl Heuer committed
7
;;	Simon Marshall <simon@gnu.org>
Simon Marshall's avatar
Simon Marshall committed
8
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
9
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
10

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

13 14 15 16
;; 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
17

18 19 20 21
;; 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
22

23
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
24 25 26
;; 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
27

Eric S. Raymond's avatar
Eric S. Raymond committed
28 29
;;; Commentary:

Erik Naggum's avatar
Erik Naggum committed
30 31 32
;; 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)
Karl Heuer's avatar
Karl Heuer committed
33
;;     - Simon Marshall (simon@gnu.org)
Erik Naggum's avatar
Erik Naggum committed
34 35 36 37

;; 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, ....
Miles Bader's avatar
Miles Bader committed
38
;; This way, all these specific packages share a common base functionality,
Erik Naggum's avatar
Erik Naggum committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
;; 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.
Miles Bader's avatar
Miles Bader committed
56
;; For further information on the standard derived modes (shell,
Erik Naggum's avatar
Erik Naggum committed
57 58 59 60 61
;; 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
62 63


Erik Naggum's avatar
Erik Naggum committed
64 65 66 67 68
;; Brief Command Documentation:
;;============================================================================
;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
;; mode)
;;
Miles Bader's avatar
Miles Bader committed
69 70
;; m-p	   comint-previous-input	   Cycle backwards in input history
;; m-n	   comint-next-input		   Cycle forwards
Erik Naggum's avatar
Erik Naggum committed
71 72
;; m-r     comint-previous-matching-input  Previous input matching a regexp
;; m-s     comint-next-matching-input      Next input that matches
73
;; m-c-l   comint-show-output		   Show last batch of process output
Erik Naggum's avatar
Erik Naggum committed
74
;; return  comint-send-input
75 76 77
;; c-d	   comint-delchar-or-maybe-eof     Delete char unless at end of buff
;; c-c c-a comint-bol-or-process-mark      First time, move point to bol;
;;					    second time, move to process-mark.
Miles Bader's avatar
Miles Bader committed
78 79 80 81 82
;; 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		    ^\
83
;; c-c c-o comint-delete-output		    Delete last batch of process output
Erik Naggum's avatar
Erik Naggum committed
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
;; 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-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).
102 103 104 105 106
;; comint-get-next-from-history        Fetch successive input history lines
;; comint-accumulate		       Combine lines to send them together
;;					as input.
;; comint-goto-process-mark	       Move point to where process-mark is.
;; comint-set-process-mark	       Set process-mark to point.
Erik Naggum's avatar
Erik Naggum committed
107 108

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
112
(require 'ring)
David Lawrence's avatar
David Lawrence committed
113

Erik Naggum's avatar
Erik Naggum committed
114 115 116
;; Buffer Local Variables:
;;============================================================================
;; Comint mode buffer local variables:
Miles Bader's avatar
Miles Bader committed
117
;;  comint-prompt-regexp		string	comint-bol uses to match prompt
118 119
;;  comint-delimiter-argument-list	list	For delimiters and arguments
;;  comint-last-input-start		marker	Handy if inferior always echoes
120
;;  comint-last-input-end		marker	For comint-delete-output command
121 122 123
;;  comint-input-ring-size		integer	For the input history
;;  comint-input-ring			ring	mechanism
;;  comint-input-ring-index		number	...
124
;;  comint-save-input-ring-index	number	...
125 126 127 128
;;  comint-input-autoexpand		symbol	...
;;  comint-input-ignoredups		boolean	...
;;  comint-dynamic-complete-functions	hook   For the completion mechanism
;;  comint-completion-fignore		list	...
129
;;  comint-file-name-chars		string	...
130
;;  comint-file-name-quote-list		list	...
Miles Bader's avatar
Miles Bader committed
131
;;  comint-get-old-input		function Hooks for specific
132 133
;;  comint-input-filter-functions	hook	process-in-a-buffer
;;  comint-output-filter-functions	hook	function modes.
134
;;  comint-preoutput-filter-functions   hook
135 136 137 138 139 140
;;  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	...
Miles Bader's avatar
Miles Bader committed
141
;;  comint-scroll-show-maximum-output	boolean	...
142
;;  comint-accum-marker			maker	  For comint-accumulate
Erik Naggum's avatar
Erik Naggum committed
143 144
;;
;; Comint mode non-buffer local variables:
145 146 147
;;  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
148

149 150 151 152 153 154 155 156 157 158 159 160 161
(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
162 163 164
(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
165

166 167 168
This variable is only used if the variable
`comint-use-prompt-regexp-instead-of-fields' is non-nil.

David Lawrence's avatar
David Lawrence committed
169
Good choices:
170
  Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
171 172
  Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
  franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
Jim Blandy's avatar
Jim Blandy committed
173
  kcl: \"^>+ *\"
174
  shell: \"^[^#$%>\\n]*[#$%>] *\"
Jim Blandy's avatar
Jim Blandy committed
175
  T: \"^>+ *\"
David Lawrence's avatar
David Lawrence committed
176

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

179 180 181 182 183
(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'.
184
Defaults to the empty list.
185

186
For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
187 188 189

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

190
(defcustom comint-input-autoexpand nil
191
  "*If non-nil, expand input command history references on completion.
192
This mirrors the optional behavior of tcsh (its autoexpand and histlit).
193 194 195 196 197 198

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

199 200 201
This variable is buffer-local."
  :type '(choice (const :tag "off" nil)
		 (const input)
202 203
		 (const history)
		 (other :tag "on" t))
204 205
  :group 'comint)

206
(defface comint-highlight-input '((t (:weight bold)))
207
  "Face to use to highlight user input."
208 209
  :group 'comint)

210
(defface comint-highlight-prompt
211 212
  '((((background dark)) (:foreground "cyan"))
    (t (:foreground "dark blue")))
213
  "Face to use to highlight prompts."
214 215
  :group 'comint)

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

220 221 222
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
223

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

228
This variable is buffer-local, and is a good thing to set in mode hooks."
229 230
  :type '(choice (const :tag "nil" nil)
		 file)
231
  :group 'comint)
232

233
(defcustom comint-scroll-to-bottom-on-input nil
234 235 236 237
  "*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.

238
The default is nil.
239

240 241 242 243 244 245
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)
246

247
(defcustom comint-scroll-to-bottom-on-output nil
248 249 250 251
  "*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.
252 253

The default is nil.
254

255
See variable `comint-scroll-show-maximum-output' and function
256 257 258 259 260 261 262 263
`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)

264
(defcustom comint-scroll-show-maximum-output t
265 266
  "*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
267

268
See variable `comint-scroll-to-bottom-on-output' and function
269 270 271
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local."
  :type 'boolean
  :group 'comint)
272

273
(defcustom comint-buffer-maximum-size 1024
274 275
  "*The maximum size in lines for comint buffers.
Comint buffers are truncated from the top to be no greater than this number, if
276 277 278
the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
  :type 'integer
  :group 'comint)
279

280
(defvar comint-input-ring-size 32
Jim Blandy's avatar
Jim Blandy committed
281
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
282

283 284 285
(defvar comint-input-ring-separator "\n"
  "Separator between commands in the history file.")

286 287 288
(defvar comint-input-history-ignore "^#"
  "Regexp for history entries that should be ignored when comint initializes.")

289
(defcustom comint-process-echoes nil
290
  "*If non-nil, assume that the subprocess echoes any input.
Noah Friedman's avatar
Noah Friedman committed
291
If so, delete one copy of the input so that only one copy eventually
292
appears in the buffer.
Noah Friedman's avatar
Noah Friedman committed
293

294 295 296
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
Noah Friedman's avatar
Noah Friedman committed
297

298
;; AIX puts the name of the person being su'd to in front of the prompt.
299
;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
300 301
;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
;; ssh-add prints a prompt like `Enter passphrase: '.
302
;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
303
(defcustom comint-password-prompt-regexp
304
  "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|\
305 306 307
Kerberos \\|CVS \\|UNIX \\| SMB \\|^\\)\
[Pp]assword\\( (again)\\)?\\|\
pass phrase\\|\\(Enter\\|Repeat\\) passphrase\\)\
308
\\( for [^:]+\\)?:\\s *\\'"
309
  "*Regexp matching prompts for passwords in the inferior process.
310 311 312
This is used by `comint-watch-for-password-prompt'."
  :type 'regexp
  :group 'comint)
313

Erik Naggum's avatar
Erik Naggum committed
314
;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
315
(defvar comint-get-old-input (function comint-get-old-input-default)
316
  "Function that returns old text in comint mode.
317 318 319 320 321 322
This function is called when return is typed while the point is in old
text.  It returns the text to be submitted as process input.  The
default is `comint-get-old-input-default', which either grabs the
current input field or grabs the current line and strips off leading
text matching `comint-prompt-regexp', depending on the value of
`comint-use-prompt-regexp-instead-of-fields'.")
David Lawrence's avatar
David Lawrence committed
323

324 325 326 327 328
(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'.
329 330 331

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

Jim Blandy's avatar
Jim Blandy committed
332 333 334
(defvar comint-input-filter
  (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
  "Predicate for filtering additions to input history.
335 336 337
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.")

338
(defvar comint-input-filter-functions '()
339 340 341
  "Functions to call before input is sent to the process.
These functions get one argument, a string containing the text to send.

342 343
You can use `add-hook' to add functions to this list
either globally or locally.")
344

Miles Bader's avatar
Miles Bader committed
345
(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
346
  "Functions to call after output is inserted into the buffer.
347
One possible function is `comint-postoutput-scroll-to-bottom'.
348 349 350 351
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.
352

353 354
See also `comint-preoutput-filter-functions'.

355 356
You can use `add-hook' to add functions to this list
either globally or locally.")
Jim Blandy's avatar
Jim Blandy committed
357

358 359 360
(defvar comint-input-sender-no-newline nil
  "Non-nil directs the `comint-input-sender' function not to send a newline.")

Jim Blandy's avatar
Jim Blandy committed
361 362
(defvar comint-input-sender (function comint-simple-send)
  "Function to actually send to PROCESS the STRING submitted by user.
Miles Bader's avatar
Miles Bader committed
363
Usually this is just `comint-simple-send', but if your mode needs to
364 365
massage the input string, put a different function here.
`comint-simple-send' just sends the string plus a newline.
366
\(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
367
This is called from the user command `comint-send-input'.")
Jim Blandy's avatar
Jim Blandy committed
368

369
(defcustom comint-eol-on-send t
370
  "*Non-nil means go to the end of the line before sending input.
371 372 373
See `comint-send-input'."
  :type 'boolean
  :group 'comint)
David Lawrence's avatar
David Lawrence committed
374

375 376 377 378 379 380 381 382 383 384 385 386
;; Note: If it is decided to purge comint-prompt-regexp from the source
;; entirely, searching for uses of this variable will help to identify
;; places that need attention.
(defcustom comint-use-prompt-regexp-instead-of-fields nil
  "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
If nil, then program output and user-input are given different `field'
properties, which emacs commands can use to distinguish them (in
particular, common movement commands such as begining-of-line respect
field boundaries in a natural way)."
  :type 'boolean
  :group 'comint)

387
(defcustom comint-mode-hook '(turn-on-font-lock)
388
  "Called upon entry into `comint-mode'
389 390 391
This is run before the process is cranked up."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
392

393
(defcustom comint-exec-hook '()
394
  "Called each time a process is exec'd by `comint-exec'.
Jim Blandy's avatar
Jim Blandy committed
395
This is called after the process is cranked up.  It is useful for things that
396 397
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
398 399 400
executed once when the buffer is created."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
401 402

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

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

408
(defvar comint-input-ring nil)
409 410
(defvar comint-last-input-start)
(defvar comint-last-input-end)
411
(defvar comint-last-output-start)
412 413 414 415
(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.")
416 417 418 419 420 421 422
(defvar comint-save-input-ring-index
  "Last input ring index which you copied.
This is to support the command \\[comint-get-next-from-history].")

(defvar comint-accum-marker nil
  "Non-nil if you are accumulating input lines to send as input together.
The command \\[comint-accumulate] sets this.")
423 424

(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
Richard M. Stallman's avatar
Richard M. Stallman committed
425
(put 'comint-input-ring 'permanent-local t)
426
(put 'comint-input-ring-index 'permanent-local t)
427
(put 'comint-save-input-ring-index 'permanent-local t)
428
(put 'comint-input-autoexpand 'permanent-local t)
429 430
(put 'comint-input-filter-functions 'permanent-local t)
(put 'comint-output-filter-functions 'permanent-local t)
431
(put 'comint-preoutput-filter-functions 'permanent-local t)
432 433 434
(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
435
(put 'comint-ptyp 'permanent-local t)
436

437 438
(put 'comint-mode 'mode-class 'special)

439
(define-derived-mode comint-mode fundamental-mode "Comint"
David Lawrence's avatar
David Lawrence committed
440 441 442 443
  "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.
444
Setting variable `comint-eol-on-send' means jump to the end of the line
Jim Blandy's avatar
Jim Blandy committed
445
before submitting new input.
David Lawrence's avatar
David Lawrence committed
446

447 448
This mode is customised to create major modes such as Inferior Lisp
mode, Shell mode, etc.  This can be done by setting the hooks
449
`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
450
and `comint-get-old-input' to appropriate functions, and the variable
451
`comint-prompt-regexp' to the appropriate regular expression.
David Lawrence's avatar
David Lawrence committed
452

453
An input history is maintained of size `comint-input-ring-size', and
454 455 456 457 458 459
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'.

460
Commands with no default key bindings include `send-invisible',
Miles Bader's avatar
Miles Bader committed
461
`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
462 463 464
`comint-magic-space'.

Input to, and output from, the subprocess can cause the window to scroll to
465
the end of the buffer.  See variables `comint-output-filter-functions',
466 467
`comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
and `comint-scroll-to-bottom-on-output'.
David Lawrence's avatar
David Lawrence committed
468 469 470 471 472 473

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

\\{comint-mode-map}

474
Entry to this mode runs the hooks on `comint-mode-hook'."
475
  (setq mode-line-process '(":%s"))
Stefan Monnier's avatar
Stefan Monnier committed
476 477 478
  (set (make-local-variable 'comint-last-input-start) (point-min-marker))
  (set (make-local-variable 'comint-last-input-end) (point-min-marker))
  (set (make-local-variable 'comint-last-output-start) (make-marker))
479
  (make-local-variable 'comint-last-prompt-overlay)
480 481 482 483 484 485 486
  (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)
487
  (make-local-variable 'comint-save-input-ring-index)
488 489
  (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
      (setq comint-input-ring-index nil))
490 491
  (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
      (setq comint-save-input-ring-index nil))
492 493 494 495
  (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)
496
  (make-local-variable 'comint-completion-fignore)
497 498 499 500 501 502 503
  (make-local-variable 'comint-get-old-input)
  (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)
504 505 506
  ;; This makes it really work to keep point at the bottom.
  (make-local-variable 'scroll-conservatively)
  (setq scroll-conservatively 10000)
507
  (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
508 509
  (make-local-variable 'comint-ptyp)
  (make-local-variable 'comint-process-echoes)
510
  (make-local-variable 'comint-file-name-chars)
511
  (make-local-variable 'comint-file-name-quote-list)
Stefan Monnier's avatar
Stefan Monnier committed
512
  (set (make-local-variable 'comint-accum-marker) (make-marker))
513
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
514 515
  ;; This behavior is not useful in comint buffers, and is annoying
  (set (make-local-variable 'next-line-add-newlines) nil))
David Lawrence's avatar
David Lawrence committed
516

Jim Blandy's avatar
Jim Blandy committed
517 518
(if comint-mode-map
    nil
519
  ;; Keys:
Jim Blandy's avatar
Jim Blandy committed
520 521 522
  (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)
523 524
  (define-key comint-mode-map [C-up] 'comint-previous-input)
  (define-key comint-mode-map [C-down] 'comint-next-input)
525 526
  (define-key comint-mode-map "\er" 'comint-previous-matching-input)
  (define-key comint-mode-map "\es" 'comint-next-matching-input)
527 528
  (define-key comint-mode-map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
  (define-key comint-mode-map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
529
  (define-key comint-mode-map "\e\C-l" 'comint-show-output)
Jim Blandy's avatar
Jim Blandy committed
530 531
  (define-key comint-mode-map "\C-m" 'comint-send-input)
  (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
532
  (define-key comint-mode-map "\C-c " 'comint-accumulate)
533
  (define-key comint-mode-map "\C-c\C-x" 'comint-get-next-from-history)
534
  (define-key comint-mode-map "\C-c\C-a" 'comint-bol-or-process-mark)
Jim Blandy's avatar
Jim Blandy committed
535 536 537 538 539
  (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)
540
  (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
541
  (define-key comint-mode-map "\C-c\C-o" 'comint-delete-output)
Jim Blandy's avatar
Jim Blandy committed
542
  (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
543
  (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
544
  (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
545
  (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
546
  (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
547
  (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
548
  (define-key comint-mode-map "\C-c\C-s" 'comint-write-output)
549
  (define-key comint-mode-map "\C-c." 'comint-insert-previous-argument)
550 551
  ;; Mouse Buttons:
  (define-key comint-mode-map [mouse-2] 'comint-insert-clicked-input)
552 553
  ;; Menu bars:
  ;; completion:
Miles Bader's avatar
Miles Bader committed
554
  (define-key comint-mode-map [menu-bar completion]
555
    (cons "Complete" (make-sparse-keymap "Complete")))
556 557 558 559 560 561 562 563 564
  (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:
Miles Bader's avatar
Miles Bader committed
565
  (define-key comint-mode-map [menu-bar inout]
566
    (cons "In/Out" (make-sparse-keymap "In/Out")))
567 568
  (define-key comint-mode-map [menu-bar inout delete-output]
    '("Delete Current Output Group" . comint-delete-output))
569 570
  (define-key comint-mode-map [menu-bar inout append-output-to-file]
    '("Append Current Output Group to File" . comint-append-output-to-file))
571 572
  (define-key comint-mode-map [menu-bar inout write-output]
    '("Write Current Output Group to File" . comint-write-output))
573
  (define-key comint-mode-map [menu-bar inout next-prompt]
574
    '("Forward Output Group" . comint-next-prompt))
575
  (define-key comint-mode-map [menu-bar inout previous-prompt]
576
    '("Backward Output Group" . comint-previous-prompt))
577
  (define-key comint-mode-map [menu-bar inout show-maximum-output]
578
    '("Show Maximum Output" . comint-show-maximum-output))
579
  (define-key comint-mode-map [menu-bar inout show-output]
580
    '("Show Current Output Group" . comint-show-output))
581
  (define-key comint-mode-map [menu-bar inout kill-input]
582
    '("Kill Current Input" . comint-kill-input))
583
  (define-key comint-mode-map [menu-bar inout copy-input]
584
    '("Copy Old Input" . comint-copy-old-input))
585
  (define-key comint-mode-map [menu-bar inout forward-matching-history]
586
    '("Forward Matching Input..." . comint-forward-matching-input))
587
  (define-key comint-mode-map [menu-bar inout backward-matching-history]
588
    '("Backward Matching Input..." . comint-backward-matching-input))
589
  (define-key comint-mode-map [menu-bar inout next-matching-history]
590
    '("Next Matching Input..." . comint-next-matching-input))
591
  (define-key comint-mode-map [menu-bar inout previous-matching-history]
592
    '("Previous Matching Input..." . comint-previous-matching-input))
593
  (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
594
    '("Next Matching Current Input" . comint-next-matching-input-from-input))
595
  (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
596
    '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
597
  (define-key comint-mode-map [menu-bar inout next-history]
598
    '("Next Input" . comint-next-input))
599
  (define-key comint-mode-map [menu-bar inout previous-history]
600
    '("Previous Input" . comint-previous-input))
601
  (define-key comint-mode-map [menu-bar inout list-history]
602
    '("List Input History" . comint-dynamic-list-input-ring))
603
  (define-key comint-mode-map [menu-bar inout expand-history]
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
    '("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:
621
  (setq menu-bar-final-items (append '(completion inout signals)
622
				     menu-bar-final-items))
Jim Blandy's avatar
Jim Blandy committed
623 624 625
  )

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

632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
;;;###autoload
(defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
  "Make a comint process NAME in BUFFER, running PROGRAM.
If BUFFER is nil, it defaults to NAME surrounded by `*'s.
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."
  (or (fboundp 'start-process)
      (error "Multi-processing is not supported for this system"))
  (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
  ;; If no process, or nuked process, crank up a new one and put buffer in
  ;; comint mode.  Otherwise, leave buffer and existing process alone.
  (unless (comint-check-proc buffer)
    (with-current-buffer buffer
Stefan Monnier's avatar
Stefan Monnier committed
650 651
      (unless (derived-mode-p 'comint-mode)
	(comint-mode))) ; Install local vars, mode, keymap, ...
652 653 654
    (comint-exec buffer name program startfile switches))
  buffer)

655
;;;###autoload
David Lawrence's avatar
David Lawrence committed
656
(defun make-comint (name program &optional startfile &rest switches)
657 658
  "Make a comint process NAME in a buffer, running PROGRAM.
The name of the buffer is made by surrounding NAME with `*'s.
659 660 661 662 663 664 665
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."
666
  (apply #'make-comint-in-buffer name nil program startfile switches))
David Lawrence's avatar
David Lawrence committed
667

668
;;;###autoload
669 670 671 672 673 674 675 676 677 678 679
(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
680
(defun comint-exec (buffer name command startfile switches)
681
  "Start up a process in buffer BUFFER for comint modes.
682
Blasts any old process running in the buffer.  Doesn't set the buffer mode.
Jim Blandy's avatar
Jim Blandy committed
683
You can use this to cheaply run a series of processes in the same comint
684
buffer.  The hook `comint-exec-hook' is run after each exec."
David Lawrence's avatar
David Lawrence committed
685 686 687 688 689
  (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
690 691 692 693
    (let ((proc
	   (if (consp command)
	       (open-network-stream name buffer (car command) (cdr command))
	     (comint-exec-1 name buffer command switches))))
694
      (set-process-filter proc 'comint-output-filter)
Jim Blandy's avatar
Jim Blandy committed
695
      (make-local-variable 'comint-ptyp)
Pavel Janík's avatar
Pavel Janík committed
696
      (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
David Lawrence's avatar
David Lawrence committed
697
      ;; Jump to the end, and set the process mark.
Jim Blandy's avatar
Jim Blandy committed
698
      (goto-char (point-max))
Jim Blandy's avatar
Jim Blandy committed
699
      (set-marker (process-mark proc) (point))
David Lawrence's avatar
David Lawrence committed
700 701 702 703 704 705 706 707 708 709 710 711
      ;; 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
712 713
	     (comint-send-string proc startfile)))
    (run-hooks 'comint-exec-hook)
Jim Blandy's avatar
Jim Blandy committed
714
    buffer)))
David Lawrence's avatar
David Lawrence committed
715

Erik Naggum's avatar
Erik Naggum committed
716 717
;; This auxiliary function cranks up the process for comint-exec in
;; the appropriate environment.
David Lawrence's avatar
David Lawrence committed
718 719

(defun comint-exec-1 (name buffer command switches)
720
  (let ((process-environment
721
	 (nconc
Richard M. Stallman's avatar
Richard M. Stallman committed
722 723
	  ;; If using termcap, we specify `emacs' as the terminal type
	  ;; because that lets us specify a width.
724
	  ;; If using terminfo, we specify `dumb' because that is
Richard M. Stallman's avatar
Richard M. Stallman committed
725 726 727 728
	  ;; 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.
Richard M. Stallman's avatar
Richard M. Stallman committed
729
	  ;; ;; There is similar code in compile.el.
730
	  (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
731
	      (list "TERM=dumb" "TERMCAP="
732
		    (format "COLUMNS=%d" (window-width)))
733
	    (list "TERM=emacs"
734
		  (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
735
	  (if (getenv "EMACS") nil (list "EMACS=t"))
736 737
	  process-environment))
	(default-directory
738
	  (if (file-accessible-directory-p default-directory)
739
	      default-directory
740 741
	    (char-to-string directory-sep-char)))
	proc decoding encoding changed)
742 743 744 745 746
    (let ((exec-path (if (file-name-directory command)
			 ;; If the command has slashes, make sure we
			 ;; first look relative to the current directory.
			 (cons default-directory exec-path) exec-path)))
      (setq proc (apply 'start-process name buffer command switches)))
747 748 749 750
    (let ((coding-systems (process-coding-system proc)))
      (setq decoding (car coding-systems)
	    encoding (cdr coding-systems)))
    ;; If start-process decided to use some coding system for decoding
751
    ;; data sent from the process and the coding system doesn't
752 753 754 755 756 757 758 759 760 761 762 763 764 765
    ;; specify EOL conversion, we had better convert CRLF to LF.
    (if (vectorp (coding-system-eol-type decoding))
	(setq decoding (coding-system-change-eol-conversion decoding 'dos)
	      changed t))
    ;; Even if start-process left the coding system for encoding data
    ;; sent from the process undecided, we had better use the same one
    ;; as what we use for decoding.  But, we should suppress EOL
    ;; conversion.
    (if (and decoding (not encoding))
	(setq encoding (coding-system-change-eol-conversion decoding 'unix)
	      changed t))
    (if changed
	(set-process-coding-system proc decoding encoding))
    proc))
766 767 768 769 770


(defun comint-insert-clicked-input (event)
  "In a comint buffer, set the current input to the clicked-on previous input."
  (interactive "e")
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
  (let ((pos (posn-point (event-end event))))
    (if (not (eq (get-char-property pos 'field) 'input))
	;; No input at POS, fall back to the global definition.
	(let* ((keys (this-command-keys))
	       (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
	       (fun (and last-key (lookup-key global-map (vector last-key)))))
	  (and fun (call-interactively fun)))
      ;; There's previous input at POS, insert it at the end of the buffer.
      (goto-char (point-max))
      ;; First delete any old unsent input at the end
      (delete-region
       (or (marker-position comint-accum-marker)
	   (process-mark (get-buffer-process (current-buffer))))
       (point))
      ;; Insert the clicked-upon input
786 787 788
      (insert (buffer-substring-no-properties
	       (previous-single-char-property-change (1+ pos) 'field)
	       (next-single-char-property-change pos 'field))))))
789

Miles Bader's avatar
Miles Bader committed
790

David Lawrence's avatar
David Lawrence committed
791

Erik Naggum's avatar
Erik Naggum committed
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
;; 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.
814

815
(defun comint-read-input-ring (&optional silent)
816 817 818 819 820
  "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.

821 822
If the optional argument SILENT is non-nil, we say nothing about a
failure to read the history file.
823

824 825
This function is useful for major mode commands and mode hooks.

826
The commands stored in the history file are separated by the
827 828 829
`comint-input-ring-separator', and entries that match
`comint-input-history-ignore' are ignored.  The most recent command
comes last.
830

831
See also `comint-input-ignoredups' and `comint-write-input-ring'."
832 833
  (cond ((or (null comint-input-ring-file-name)
	     (equal comint-input-ring-file-name ""))
834 835
	 nil)
	((not (file-readable-p comint-input-ring-file-name))
836 837 838
	 (or silent
	     (message "Cannot read history file %s"
		      comint-input-ring-file-name)))
839
	(t
840 841 842 843 844
	 (let* ((history-buf (get-buffer-create " *temp*"))
		(file comint-input-ring-file-name)
		(count 0)
		(size comint-input-ring-size)
		(ring (make-ring size)))
845 846 847
	   (unwind-protect
	       (save-excursion
		 (set-buffer history-buf)
848
		 (widen)
849 850 851 852 853
		 (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))
854 855 856 857 858 859 860 861 862
		 (let (start end history)
		   (while (and (< count comint-input-ring-size)
			       (re-search-backward comint-input-ring-separator nil t)
			       (setq end (match-beginning 0)))
		     (if (re-search-backward comint-input-ring-separator nil t)
			 (setq start (match-end 0))
		       (setq start (point-min)))
		     (setq history (buffer-substring start end))
		     (goto-char start)
863 864 865 866
		     (if (and (not (string-match comint-input-history-ignore history))
			      (or (null comint-input-ignoredups)
				  (ring-empty-p ring)
				  (not (string-equal (ring-ref ring 0) history))))
867 868 869
			 (progn
			   (ring-insert-at-beginning ring history)
			   (setq count (1+ count)))))))
870
	     (kill-buffer history-buf))
871 872 873 874 875 876 877 878 879 880 881 882 883
	   (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)
884
	     (equal comint-input-ring-file-name "")
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
	     (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))
Miles Bader's avatar
Miles Bader committed
901
	       (insert (ring-ref ring index) comint-input-ring-separator))
902 903 904 905
	     (write-region (buffer-string) nil file nil 'no-message)
	     (kill-buffer nil))))))


906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
(defvar comint-dynamic-list-input-ring-window-conf)

(defun comint-dynamic-list-input-ring-select ()
  "Choose the input history entry that point is in or next to."
  (interactive)
  (let (beg end completion (buffer completion-reference-buffer)
	(base-size completion-base-size))
    (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
	(setq end (point) beg (1+ (point))))
    (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
	(setq end (1- (point)) beg (point)))
    (if (null beg)
	(error "No history entry here"))
    (setq beg (previous-single-property-change beg 'mouse-face))
    (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
    (setq completion (buffer-substring beg end))