comint.el 129 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
4
;;	Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Simon Marshall's avatar
Simon Marshall committed
6
;; Author: Olin Shivers <shivers@cs.cmu.edu> then
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 102
;; 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).
103 104 105 106 107
;; 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
108 109

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

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

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

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

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

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

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

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

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

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

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

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

208 209
(defcustom comint-highlight-input t
  "*If non-nil, highlight input; also allow choosing previous input with a mouse.
210
The face used is `comint-highlight-input'."
211 212 213
  :type 'boolean
  :group 'comint)

214
(defface comint-highlight-input '((t (:bold t)))
215 216 217 218 219
  "Face to use to highlight input when `comint-highlight-input' is non-nil."
  :group 'comint)

(defcustom comint-highlight-prompt t
  "*If non-nil, highlight program prompts.
220
The face used is `comint-highlight-prompt'."
221
  :type 'boolean
222 223
  :group 'comint)

224
(defface comint-highlight-prompt
225 226 227
  '((((background dark)) (:foreground "cyan"))
    (t (:foreground "dark blue")))
  "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
228 229
  :group 'comint)

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

234 235 236
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
237

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

242
This variable is buffer-local, and is a good thing to set in mode hooks."
243 244
  :type '(choice (const :tag "nil" nil)
		 file)
245
  :group 'comint)
246

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

252
The default is nil.
253

254 255 256 257 258 259
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)
260

261
(defcustom comint-scroll-to-bottom-on-output nil
262 263 264 265
  "*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.
266 267

The default is nil.
268

269
See variable `comint-scroll-show-maximum-output' and function
270 271 272 273 274 275 276 277 278
`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
279 280
  "*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
281

282
See variable `comint-scroll-to-bottom-on-output' and function
283 284 285
`comint-postoutput-scroll-to-bottom'.  This variable is buffer-local."
  :type 'boolean
  :group 'comint)
286

287
(defcustom comint-buffer-maximum-size 1024
288 289
  "*The maximum size in lines for comint buffers.
Comint buffers are truncated from the top to be no greater than this number, if
290 291 292
the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
  :type 'integer
  :group 'comint)
293

294
(defvar comint-input-ring-size 32
Jim Blandy's avatar
Jim Blandy committed
295
  "Size of input history ring.")
David Lawrence's avatar
David Lawrence committed
296

297 298 299
(defvar comint-input-ring-separator "\n"
  "Separator between commands in the history file.")

300 301 302
(defvar comint-input-history-ignore "^#"
  "Regexp for history entries that should be ignored when comint initializes.")

303
(defcustom comint-process-echoes nil
304
  "*If non-nil, assume that the subprocess echoes any input.
Noah Friedman's avatar
Noah Friedman committed
305
If so, delete one copy of the input so that only one copy eventually
306
appears in the buffer.
Noah Friedman's avatar
Noah Friedman committed
307

308 309 310
This variable is buffer-local."
  :type 'boolean
  :group 'comint)
Noah Friedman's avatar
Noah Friedman committed
311

312
;; AIX puts the name of the person being su'd to in front of the prompt.
313
;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
314 315
;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
;; ssh-add prints a prompt like `Enter passphrase: '.
316
;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
317
(defcustom comint-password-prompt-regexp
318
  "\\(\\([Oo]ld \\|[Nn]ew \\|Kerberos \\|'s \\|login \\|CVS \\|^\\)\
319
[Pp]assword\\( (again)\\)?\\|pass phrase\\|Enter passphrase\\)\
320
\\( for [^@ \t\n]+@[^@ \t\n]+\\)?:\\s *\\'"
321
  "*Regexp matching prompts for passwords in the inferior process.
322 323 324
This is used by `comint-watch-for-password-prompt'."
  :type 'regexp
  :group 'comint)
325

Erik Naggum's avatar
Erik Naggum committed
326
;; Here are the per-interpreter hooks.
Jim Blandy's avatar
Jim Blandy committed
327
(defvar comint-get-old-input (function comint-get-old-input-default)
328
  "Function that returns old text in comint mode.
329 330 331 332 333 334
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
335

336 337 338 339 340
(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'.
341 342 343

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

Jim Blandy's avatar
Jim Blandy committed
344 345 346
(defvar comint-input-filter
  (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
  "Predicate for filtering additions to input history.
347 348 349
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.")

350
(defvar comint-input-filter-functions '()
351 352 353 354 355
  "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.")

Miles Bader's avatar
Miles Bader committed
356
(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
357
  "Functions to call after output is inserted into the buffer.
358
One possible function is `comint-postoutput-scroll-to-bottom'.
359 360 361 362
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.
363

364 365
See also `comint-preoutput-filter-functions'.

366
This variable is buffer-local.")
Jim Blandy's avatar
Jim Blandy committed
367 368 369

(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
370
Usually this is just `comint-simple-send', but if your mode needs to
371 372 373
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
374

375
(defcustom comint-eol-on-send t
376
  "*Non-nil means go to the end of the line before sending input.
377 378 379
See `comint-send-input'."
  :type 'boolean
  :group 'comint)
David Lawrence's avatar
David Lawrence committed
380

381 382 383 384 385 386 387 388 389 390 391 392
;; 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)

393
(defcustom comint-mode-hook '()
394
  "Called upon entry into `comint-mode'
395 396 397
This is run before the process is cranked up."
  :type 'hook
  :group 'comint)
Jim Blandy's avatar
Jim Blandy committed
398

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

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

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

414
(defvar comint-input-ring nil)
415 416
(defvar comint-last-input-start)
(defvar comint-last-input-end)
417
(defvar comint-last-output-start)
418 419 420 421
(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.")
422 423 424 425 426 427 428
(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.")
429 430

(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
Richard M. Stallman's avatar
Richard M. Stallman committed
431
(put 'comint-input-ring 'permanent-local t)
432
(put 'comint-input-ring-index 'permanent-local t)
433
(put 'comint-save-input-ring-index 'permanent-local t)
434
(put 'comint-input-autoexpand 'permanent-local t)
435 436
(put 'comint-input-filter-functions 'permanent-local t)
(put 'comint-output-filter-functions 'permanent-local t)
437
(put 'comint-preoutput-filter-functions 'permanent-local t)
438 439 440
(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
441
(put 'comint-ptyp 'permanent-local t)
442

443 444
(put 'comint-mode 'mode-class 'special)

445
(define-derived-mode comint-mode fundamental-mode "Comint"
David Lawrence's avatar
David Lawrence committed
446 447 448 449
  "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.
450
Setting variable `comint-eol-on-send' means jump to the end of the line
Jim Blandy's avatar
Jim Blandy committed
451
before submitting new input.
David Lawrence's avatar
David Lawrence committed
452

453 454
This mode is customised to create major modes such as Inferior Lisp
mode, Shell mode, etc.  This can be done by setting the hooks
455
`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
456
and `comint-get-old-input' to appropriate functions, and the variable
457
`comint-prompt-regexp' to the appropriate regular expression.
David Lawrence's avatar
David Lawrence committed
458

459
An input history is maintained of size `comint-input-ring-size', and
460 461 462 463 464 465
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'.

466
Commands with no default key bindings include `send-invisible',
Miles Bader's avatar
Miles Bader committed
467
`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
468 469 470
`comint-magic-space'.

Input to, and output from, the subprocess can cause the window to scroll to
471
the end of the buffer.  See variables `comint-output-filter-functions',
472 473
`comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
and `comint-scroll-to-bottom-on-output'.
David Lawrence's avatar
David Lawrence committed
474 475 476 477 478 479

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

\\{comint-mode-map}

480
Entry to this mode runs the hooks on `comint-mode-hook'."
481
  (setq mode-line-process '(":%s"))
482 483
  (make-local-variable 'comint-last-input-start)
  (setq comint-last-input-start (make-marker))
484
  (set-marker comint-last-input-start (point-min))
485 486
  (make-local-variable 'comint-last-input-end)
  (setq comint-last-input-end (make-marker))
487
  (set-marker comint-last-input-end (point-min))
488 489
  (make-local-variable 'comint-last-output-start)
  (setq comint-last-output-start (make-marker))
490
  (make-local-variable 'comint-last-output-overlay)
491
  (make-local-variable 'comint-last-prompt-overlay)
492 493 494 495 496 497 498
  (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)
499
  (make-local-variable 'comint-save-input-ring-index)
500 501
  (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
      (setq comint-input-ring-index nil))
502 503
  (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
      (setq comint-save-input-ring-index nil))
504 505 506 507
  (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)
508
  (make-local-hook 'comint-dynamic-complete-functions)
509
  (make-local-variable 'comint-completion-fignore)
510
  (make-local-variable 'comint-get-old-input)
511
  (make-local-hook 'comint-input-filter-functions)
512 513 514 515 516 517
  (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)
518
  (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
519
  (make-local-hook 'comint-output-filter-functions)
520
  (make-local-hook 'comint-exec-hook)
521 522
  (make-local-variable 'comint-ptyp)
  (make-local-variable 'comint-process-echoes)
523
  (make-local-variable 'comint-file-name-chars)
524
  (make-local-variable 'comint-file-name-quote-list)
525 526
  (make-local-variable 'comint-accum-marker)
  (setq comint-accum-marker (make-marker))
527 528 529
  (set-marker comint-accum-marker nil)
  ;; 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
530

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

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

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
;;;###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
      (comint-mode)) ; Install local vars, mode, keymap, ...
    (comint-exec buffer name program startfile switches))
  buffer)

667
;;;###autoload
David Lawrence's avatar
David Lawrence committed
668
(defun make-comint (name program &optional startfile &rest switches)
669 670
  "Make a comint process NAME in a buffer, running PROGRAM.
The name of the buffer is made by surrounding NAME with `*'s.
671 672 673 674 675 676 677
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."
678
  (apply #'make-comint-in-buffer name nil program startfile switches))
David Lawrence's avatar
David Lawrence committed
679

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

Erik Naggum's avatar
Erik Naggum committed
728 729
;; This auxiliary function cranks up the process for comint-exec in
;; the appropriate environment.
David Lawrence's avatar
David Lawrence committed
730 731

(defun comint-exec-1 (name buffer command switches)
732
  (let ((process-environment
733
	 (nconc
Richard M. Stallman's avatar
Richard M. Stallman committed
734 735
	  ;; If using termcap, we specify `emacs' as the terminal type
	  ;; because that lets us specify a width.
736
	  ;; If using terminfo, we specify `dumb' because that is
Richard M. Stallman's avatar
Richard M. Stallman committed
737 738 739 740
	  ;; 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.
741
	  (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
742
	      (list "TERM=dumb" "TERMCAP="
743
		    (format "COLUMNS=%d" (frame-width)))
744
	    (list "TERM=emacs"
745
		  (format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
746
	  (if (getenv "EMACS") nil (list "EMACS=t"))
747 748
	  process-environment))
	(default-directory
749
	  (if (file-accessible-directory-p default-directory)
750
	      default-directory
751 752
	    (char-to-string directory-sep-char)))
	proc decoding encoding changed)
753 754 755 756 757
    (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)))
758 759 760 761
    (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
762
    ;; data sent from the process and the coding system doesn't
763 764 765 766 767 768 769 770 771 772 773 774 775 776
    ;; 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))
777 778 779 780 781


(defun comint-insert-clicked-input (event)
  "In a comint buffer, set the current input to the clicked-on previous input."
  (interactive "e")
782 783 784 785 786
  (let ((over (catch 'found
		;; Ignore non-input overlays
		(dolist (ov (overlays-at (posn-point (event-end event))))
		  (when (eq (overlay-get ov 'field) 'input)
		    (throw 'found ov))))))
787
    ;; Do we have input in this area?
788 789 790 791
    (if over
	(let ((input-str (buffer-substring (overlay-start over)
					   (overlay-end over))))
	  (delete-region
792 793 794
	   ;; Can't use kill-region as it sets this-command
	   (or  (marker-position comint-accum-marker)
		(process-mark (get-buffer-process (current-buffer))))
795
	   (point))
796
	  (insert input-str))
797 798 799 800
      ;; 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)))))
801
	(if fun (call-interactively fun))))))
Miles Bader's avatar
Miles Bader committed
802

David Lawrence's avatar
David Lawrence committed
803

Erik Naggum's avatar
Erik Naggum committed
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
;; 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.
826

827
(defun comint-read-input-ring (&optional silent)
828 829 830 831 832
  "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.

833 834
If the optional argument SILENT is non-nil, we say nothing about a
failure to read the history file.
835

836 837
This function is useful for major mode commands and mode hooks.

838
The commands stored in the history file are separated by the
839 840 841
`comint-input-ring-separator', and entries that match
`comint-input-history-ignore' are ignored.  The most recent command
comes last.
842

843
See also `comint-input-ignoredups' and `comint-write-input-ring'."
844 845
  (cond ((or (null comint-input-ring-file-name)
	     (equal comint-input-ring-file-name ""))
846 847
	 nil)
	((not (file-readable-p comint-input-ring-file-name))
848 849 850
	 (or silent
	     (message "Cannot read history file %s"
		      comint-input-ring-file-name)))
851
	(t
852 853 854 855 856
	 (let* ((history-buf (get-buffer-create " *temp*"))
		(file comint-input-ring-file-name)
		(count 0)
		(size comint-input-ring-size)
		(ring (make-ring size)))
857 858 859
	   (unwind-protect
	       (save-excursion
		 (set-buffer history-buf)
860
		 (widen)