(Man-mode-line-format): Variable removed.
[bpt/emacs.git] / lisp / comint.el
CommitLineData
c0274f38 1;;; comint.el --- general command interpreter in a window stuff
e41b2db1 2
0fddb84c 3;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
ae57d456 4;; Free Software Foundation, Inc.
c0274f38 5
1cd7adc6 6;; Author: Olin Shivers <shivers@cs.cmu.edu>
5762abec 7;; Simon Marshall <simon@gnu.org>
f8604035 8;; Maintainer: FSF
e9571d2a 9;; Keywords: processes
3a801d0c 10
1586b965 11;; This file is part of GNU Emacs.
be9b65ac 12
1586b965
RS
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
15;; the Free Software Foundation; either version 2, or (at your option)
16;; any later version.
be9b65ac 17
1586b965
RS
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
be9b65ac 22
1586b965 23;; You should have received a copy of the GNU General Public License
b578f267
EN
24;; along with GNU Emacs; see the file COPYING. If not, write to the
25;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26;; Boston, MA 02111-1307, USA.
be9b65ac 27
e5167999
ER
28;;; Commentary:
29
b578f267
EN
30;; Please send me bug reports, bug fixes, and extensions, so that I can
31;; merge them into the master source.
32;; - Olin Shivers (shivers@cs.cmu.edu)
5762abec 33;; - Simon Marshall (simon@gnu.org)
b578f267
EN
34
35;; This file defines a general command-interpreter-in-a-buffer package
36;; (comint mode). The idea is that you can build specific process-in-a-buffer
37;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
814299a7 38;; This way, all these specific packages share a common base functionality,
b578f267
EN
39;; and a common set of bindings, which makes them easier to use (and
40;; saves code, implementation time, etc., etc.).
41
42;; Several packages are already defined using comint mode:
43;; - shell.el defines a shell-in-a-buffer mode.
44;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
45;;
46;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
47;; - The file tea.el tunes scheme and inferior-scheme modes for T.
48;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
49;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
50;; previewers, and printers from within emacs.
51;; - background.el allows csh-like job control inside emacs.
52;; It is pretty easy to make new derived modes for other processes.
53
54;; For documentation on the functionality provided by comint mode, and
55;; the hooks available for customising it, see the comments below.
814299a7 56;; For further information on the standard derived modes (shell,
b578f267
EN
57;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
58
59;; For hints on converting existing process modes (e.g., tex-mode,
60;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
61;; instead of shell-mode, see the notes at the end of this file.
be9b65ac 62
be9b65ac 63\f
b578f267
EN
64;; Brief Command Documentation:
65;;============================================================================
66;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
67;; mode)
68;;
814299a7
MB
69;; m-p comint-previous-input Cycle backwards in input history
70;; m-n comint-next-input Cycle forwards
b578f267
EN
71;; m-r comint-previous-matching-input Previous input matching a regexp
72;; m-s comint-next-matching-input Next input that matches
361ecbf2 73;; m-c-l comint-show-output Show last batch of process output
b578f267 74;; return comint-send-input
361ecbf2
RS
75;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
76;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
77;; second time, move to process-mark.
814299a7
MB
78;; c-c c-u comint-kill-input ^u
79;; c-c c-w backward-kill-word ^w
80;; c-c c-c comint-interrupt-subjob ^c
81;; c-c c-z comint-stop-subjob ^z
82;; c-c c-\ comint-quit-subjob ^\
4e217e50 83;; c-c c-o comint-delete-output Delete last batch of process output
b578f267
EN
84;; c-c c-r comint-show-output Show last batch of process output
85;; c-c c-l comint-dynamic-list-input-ring List input history
86;;
87;; Not bound by default in comint-mode (some are in shell mode)
88;; comint-run Run a program under comint-mode
89;; send-invisible Read a line w/o echo, and send to proc
90;; comint-dynamic-complete-filename Complete filename at point.
b578f267
EN
91;; comint-dynamic-list-filename-completions List completions in help buffer.
92;; comint-replace-by-expanded-filename Expand and complete filename at point;
93;; replace with expanded/completed name.
94;; comint-replace-by-expanded-history Expand history at point;
95;; replace with expanded name.
96;; comint-magic-space Expand history and add (a) space(s).
97;; comint-kill-subjob No mercy.
98;; comint-show-maximum-output Show as much output as possible.
99;; comint-continue-subjob Send CONT signal to buffer's process
100;; group. Useful if you accidentally
101;; suspend your process (with C-c C-z).
361ecbf2
RS
102;; comint-get-next-from-history Fetch successive input history lines
103;; comint-accumulate Combine lines to send them together
104;; as input.
105;; comint-goto-process-mark Move point to where process-mark is.
106;; comint-set-process-mark Set process-mark to point.
b578f267
EN
107
108;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
be9b65ac 109
e5167999
ER
110;;; Code:
111
c9706a52 112(require 'ring)
be9b65ac 113\f
b578f267
EN
114;; Buffer Local Variables:
115;;============================================================================
116;; Comint mode buffer local variables:
814299a7 117;; comint-prompt-regexp string comint-bol uses to match prompt
107d7589
SM
118;; comint-delimiter-argument-list list For delimiters and arguments
119;; comint-last-input-start marker Handy if inferior always echoes
4e217e50 120;; comint-last-input-end marker For comint-delete-output command
107d7589
SM
121;; comint-input-ring-size integer For the input history
122;; comint-input-ring ring mechanism
123;; comint-input-ring-index number ...
361ecbf2 124;; comint-save-input-ring-index number ...
107d7589
SM
125;; comint-input-autoexpand symbol ...
126;; comint-input-ignoredups boolean ...
107d7589
SM
127;; comint-dynamic-complete-functions hook For the completion mechanism
128;; comint-completion-fignore list ...
2d4382e5 129;; comint-file-name-chars string ...
107d7589 130;; comint-file-name-quote-list list ...
814299a7 131;; comint-get-old-input function Hooks for specific
107d7589
SM
132;; comint-input-filter-functions hook process-in-a-buffer
133;; comint-output-filter-functions hook function modes.
d4321160 134;; comint-preoutput-filter-functions hook
107d7589
SM
135;; comint-input-filter function ...
136;; comint-input-sender function ...
137;; comint-eol-on-send boolean ...
138;; comint-process-echoes boolean ...
139;; comint-scroll-to-bottom-on-input symbol For scroll behavior
140;; comint-scroll-to-bottom-on-output symbol ...
814299a7 141;; comint-scroll-show-maximum-output boolean ...
361ecbf2 142;; comint-accum-marker maker For comint-accumulate
29533923 143;; comint-last-output-overlay overlay
b578f267
EN
144;;
145;; Comint mode non-buffer local variables:
107d7589
SM
146;; comint-completion-addsuffix boolean/cons For file name
147;; comint-completion-autolist boolean completion behavior
148;; comint-completion-recexact boolean ...
be9b65ac 149
ed366e87
RS
150(defgroup comint nil
151 "General command interpreter in a window stuff."
152 :group 'processes)
153
154(defgroup comint-completion nil
155 "Completion facilities in comint"
156 :group 'comint)
157
158(defgroup comint-source nil
159 "Source finding facilities in comint"
160 :prefix "comint-"
161 :group 'comint)
162
49116ac0
JB
163(defvar comint-prompt-regexp "^"
164 "Regexp to recognise prompts in the inferior process.
165Defaults to \"^\", the null string at BOL.
be9b65ac 166
29533923
MB
167This variable is only used if the variable
168`comint-use-prompt-regexp-instead-of-fields' is non-nil.
169
be9b65ac 170Good choices:
d637fa56 171 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
41752cf1
JB
172 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
173 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
49116ac0 174 kcl: \"^>+ *\"
d637fa56 175 shell: \"^[^#$%>\\n]*[#$%>] *\"
49116ac0 176 T: \"^>+ *\"
be9b65ac 177
49116ac0 178This is a good thing to set in mode hooks.")
be9b65ac 179
3ee91e68
RS
180(defvar comint-delimiter-argument-list ()
181 "List of characters to recognise as separate arguments in input.
182Strings comprising a character in this list will separate the arguments
183surrounding them, and also be regarded as arguments in their own right (unlike
184whitespace). See `comint-arguments'.
3f4b7c36 185Defaults to the empty list.
3ee91e68 186
3f4b7c36 187For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
3ee91e68
RS
188
189This is a good thing to set in mode hooks.")
190
ed366e87 191(defcustom comint-input-autoexpand nil
3ee91e68 192 "*If non-nil, expand input command history references on completion.
fdb7791d 193This mirrors the optional behavior of tcsh (its autoexpand and histlit).
3ee91e68
RS
194
195If the value is `input', then the expansion is seen on input.
196If the value is `history', then the expansion is only when inserting
197into the buffer's input ring. See also `comint-magic-space' and
198`comint-dynamic-complete'.
199
ed366e87
RS
200This variable is buffer-local."
201 :type '(choice (const :tag "off" nil)
ed366e87 202 (const input)
0560c209
AS
203 (const history)
204 (other :tag "on" t))
ed366e87
RS
205 :group 'comint)
206
ae57d456
GM
207(defcustom comint-highlight-input t
208 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
7ff4fda5 209The face used is `comint-highlight-input'."
ae57d456
GM
210 :type 'boolean
211 :group 'comint)
212
7ff4fda5 213(defface comint-highlight-input '((t (:bold t)))
3db4b719
MB
214 "Face to use to highlight input when `comint-highlight-input' is non-nil."
215 :group 'comint)
216
217(defcustom comint-highlight-prompt t
218 "*If non-nil, highlight program prompts.
7ff4fda5 219The face used is `comint-highlight-prompt'."
053457f4 220 :type 'boolean
3db4b719
MB
221 :group 'comint)
222
7ff4fda5 223(defface comint-highlight-prompt
3db4b719
MB
224 '((((background dark)) (:foreground "cyan"))
225 (t (:foreground "dark blue")))
226 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
ae57d456
GM
227 :group 'comint)
228
ed366e87 229(defcustom comint-input-ignoredups nil
3ee91e68 230 "*If non-nil, don't add input matching the last on the input ring.
fdb7791d 231This mirrors the optional behavior of bash.
3ee91e68 232
ed366e87
RS
233This variable is buffer-local."
234 :type 'boolean
235 :group 'comint)
3ee91e68 236
ed366e87 237(defcustom comint-input-ring-file-name nil
3ee91e68
RS
238 "*If non-nil, name of the file to read/write input history.
239See also `comint-read-input-ring' and `comint-write-input-ring'.
240
ed366e87 241This variable is buffer-local, and is a good thing to set in mode hooks."
ae57d456
GM
242 :type '(choice (const :tag "nil" nil)
243 file)
ed366e87 244 :group 'comint)
3ee91e68 245
ed366e87 246(defcustom comint-scroll-to-bottom-on-input nil
3ee91e68
RS
247 "*Controls whether input to interpreter causes window to scroll.
248If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
249If `this', scroll only the selected window.
250
91d75282 251The default is nil.
f4ef65c7 252
ed366e87
RS
253See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
254 :type '(choice (const :tag "off" nil)
255 (const t)
256 (const all)
257 (const this))
258 :group 'comint)
3ee91e68 259
ed366e87 260(defcustom comint-scroll-to-bottom-on-output nil
3ee91e68
RS
261 "*Controls whether interpreter output causes window to scroll.
262If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
263If `this', scroll only the selected window.
264If `others', scroll only those that are not the selected window.
91d75282
RS
265
266The default is nil.
f4ef65c7 267
3ee91e68 268See variable `comint-scroll-show-maximum-output' and function
ed366e87
RS
269`comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
270 :type '(choice (const :tag "off" nil)
271 (const t)
272 (const all)
273 (const this)
274 (const others))
275 :group 'comint)
276
277(defcustom comint-scroll-show-maximum-output nil
3ee91e68
RS
278 "*Controls how interpreter output causes window to scroll.
279If non-nil, then show the maximum output when the window is scrolled.
91d75282 280
3ee91e68 281See variable `comint-scroll-to-bottom-on-output' and function
ed366e87
RS
282`comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
283 :type 'boolean
284 :group 'comint)
91d75282 285
ed366e87 286(defcustom comint-buffer-maximum-size 1024
39a185a9
SM
287 "*The maximum size in lines for comint buffers.
288Comint buffers are truncated from the top to be no greater than this number, if
ed366e87
RS
289the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
290 :type 'integer
291 :group 'comint)
39a185a9 292
3ee91e68 293(defvar comint-input-ring-size 32
49116ac0 294 "Size of input history ring.")
be9b65ac 295
bc29fd5f
RS
296(defvar comint-input-ring-separator "\n"
297 "Separator between commands in the history file.")
298
0fddb84c
GM
299(defvar comint-input-history-ignore "^#"
300 "Regexp for history entries that should be ignored when comint initializes.")
301
ed366e87 302(defcustom comint-process-echoes nil
cccd719e 303 "*If non-nil, assume that the subprocess echoes any input.
8ae3bc9f 304If so, delete one copy of the input so that only one copy eventually
3ee91e68 305appears in the buffer.
8ae3bc9f 306
ed366e87
RS
307This variable is buffer-local."
308 :type 'boolean
309 :group 'comint)
8ae3bc9f 310
3a320e54 311;; AIX puts the name of the person being su'd to in front of the prompt.
9cc68f10 312;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
163b46fa
JWI
313;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
314;; ssh-add prints a prompt like `Enter passphrase: '.
40c2d410 315;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
ed366e87 316(defcustom comint-password-prompt-regexp
95fa4fd7 317 "\\(\\([Oo]ld \\|[Nn]ew \\|Kerberos \\|'s \\|login \\|CVS \\|^\\)\
40c2d410 318[Pp]assword\\( (again)\\)?\\|pass phrase\\|Enter passphrase\\)\
db4a79ae 319\\( for [^@ \t\n]+@[^@ \t\n]+\\)?:\\s *\\'"
654d89d7 320 "*Regexp matching prompts for passwords in the inferior process.
ed366e87
RS
321This is used by `comint-watch-for-password-prompt'."
322 :type 'regexp
323 :group 'comint)
654d89d7 324
b578f267 325;; Here are the per-interpreter hooks.
49116ac0 326(defvar comint-get-old-input (function comint-get-old-input-default)
3ee91e68 327 "Function that returns old text in comint mode.
29533923
MB
328This function is called when return is typed while the point is in old
329text. It returns the text to be submitted as process input. The
330default is `comint-get-old-input-default', which either grabs the
331current input field or grabs the current line and strips off leading
332text matching `comint-prompt-regexp', depending on the value of
333`comint-use-prompt-regexp-instead-of-fields'.")
be9b65ac 334
1b421826
RS
335(defvar comint-dynamic-complete-functions
336 '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
337 "List of functions called to perform completion.
338Functions should return non-nil if completion was performed.
339See also `comint-dynamic-complete'.
3ee91e68
RS
340
341This is a good thing to set in mode hooks.")
342
49116ac0
JB
343(defvar comint-input-filter
344 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
345 "Predicate for filtering additions to input history.
3ee91e68
RS
346Takes one argument, the input. If non-nil, the input may be saved on the input
347history list. Default is to save anything that isn't all whitespace.")
348
fb9ab28a 349(defvar comint-input-filter-functions '()
1b421826
RS
350 "Functions to call before input is sent to the process.
351These functions get one argument, a string containing the text to send.
352
353This variable is buffer-local.")
354
814299a7 355(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
3ee91e68 356 "Functions to call after output is inserted into the buffer.
c1da5c03 357One possible function is `comint-postoutput-scroll-to-bottom'.
107d7589
SM
358These functions get one argument, a string containing the text as originally
359inserted. Note that this might not be the same as the buffer contents between
360`comint-last-output-start' and the buffer's `process-mark', if other filter
361functions have already modified the buffer.
3ee91e68 362
d4321160
RS
363See also `comint-preoutput-filter-functions'.
364
3ee91e68 365This variable is buffer-local.")
49116ac0
JB
366
367(defvar comint-input-sender (function comint-simple-send)
368 "Function to actually send to PROCESS the STRING submitted by user.
814299a7 369Usually this is just `comint-simple-send', but if your mode needs to
cccd719e
RS
370massage the input string, put a different function here.
371`comint-simple-send' just sends the string plus a newline.
372This is called from the user command `comint-send-input'.")
49116ac0 373
ed366e87 374(defcustom comint-eol-on-send t
3ee91e68 375 "*Non-nil means go to the end of the line before sending input.
ed366e87
RS
376See `comint-send-input'."
377 :type 'boolean
378 :group 'comint)
be9b65ac 379
29533923
MB
380;; Note: If it is decided to purge comint-prompt-regexp from the source
381;; entirely, searching for uses of this variable will help to identify
382;; places that need attention.
383(defcustom comint-use-prompt-regexp-instead-of-fields nil
384 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
385If nil, then program output and user-input are given different `field'
386properties, which emacs commands can use to distinguish them (in
387particular, common movement commands such as begining-of-line respect
388field boundaries in a natural way)."
389 :type 'boolean
390 :group 'comint)
391
ed366e87 392(defcustom comint-mode-hook '()
ef779078 393 "Called upon entry into `comint-mode'
ed366e87
RS
394This is run before the process is cranked up."
395 :type 'hook
396 :group 'comint)
49116ac0 397
ed366e87 398(defcustom comint-exec-hook '()
cccd719e 399 "Called each time a process is exec'd by `comint-exec'.
49116ac0 400This is called after the process is cranked up. It is useful for things that
cccd719e
RS
401must be done each time a process is executed in a comint mode buffer (e.g.,
402`(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
ed366e87
RS
403executed once when the buffer is created."
404 :type 'hook
405 :group 'comint)
49116ac0
JB
406
407(defvar comint-mode-map nil)
be9b65ac 408
c9706a52 409(defvar comint-ptyp t
3ee91e68 410 "Non-nil if communications via pty; false if by pipe. Buffer local.
5ef2f81f 411This is to work around a bug in Emacs process signaling.")
c9706a52 412
0bcb5285 413(defvar comint-input-ring nil)
e6dfdce5
RS
414(defvar comint-last-input-start)
415(defvar comint-last-input-end)
7d5d472e 416(defvar comint-last-output-start)
3ee91e68
RS
417(defvar comint-input-ring-index nil
418 "Index of last matched history element.")
419(defvar comint-matching-input-from-input-string ""
420 "Input previously used to match input history.")
361ecbf2
RS
421(defvar comint-save-input-ring-index
422 "Last input ring index which you copied.
423This is to support the command \\[comint-get-next-from-history].")
424
425(defvar comint-accum-marker nil
426 "Non-nil if you are accumulating input lines to send as input together.
427The command \\[comint-accumulate] sets this.")
21d9bf27
RS
428
429(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
c9706a52 430(put 'comint-input-ring 'permanent-local t)
3ee91e68 431(put 'comint-input-ring-index 'permanent-local t)
361ecbf2 432(put 'comint-save-input-ring-index 'permanent-local t)
3ee91e68 433(put 'comint-input-autoexpand 'permanent-local t)
fb9ab28a
RS
434(put 'comint-input-filter-functions 'permanent-local t)
435(put 'comint-output-filter-functions 'permanent-local t)
d4321160 436(put 'comint-preoutput-filter-functions 'permanent-local t)
3ee91e68
RS
437(put 'comint-scroll-to-bottom-on-input 'permanent-local t)
438(put 'comint-scroll-to-bottom-on-output 'permanent-local t)
439(put 'comint-scroll-show-maximum-output 'permanent-local t)
c9706a52 440(put 'comint-ptyp 'permanent-local t)
e6dfdce5 441
158cfdd2
RS
442(put 'comint-mode 'mode-class 'special)
443
ef779078 444(define-derived-mode comint-mode fundamental-mode "Comint"
be9b65ac
DL
445 "Major mode for interacting with an inferior interpreter.
446Interpreter name is same as buffer name, sans the asterisks.
447Return at end of buffer sends line as input.
448Return not at end copies rest of line to end and sends it.
cccd719e 449Setting variable `comint-eol-on-send' means jump to the end of the line
49116ac0 450before submitting new input.
be9b65ac 451
3ee91e68
RS
452This mode is customised to create major modes such as Inferior Lisp
453mode, Shell mode, etc. This can be done by setting the hooks
fb9ab28a 454`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
3ee91e68 455and `comint-get-old-input' to appropriate functions, and the variable
cccd719e 456`comint-prompt-regexp' to the appropriate regular expression.
be9b65ac 457
cccd719e 458An input history is maintained of size `comint-input-ring-size', and
3ee91e68
RS
459can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
460Input ring history expansion can be achieved with the commands
461\\[comint-replace-by-expanded-history] or \\[comint-magic-space].
462Input ring expansion is controlled by the variable `comint-input-autoexpand',
463and addition is controlled by the variable `comint-input-ignoredups'.
464
cccd719e 465Commands with no default key bindings include `send-invisible',
814299a7 466`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
3ee91e68
RS
467`comint-magic-space'.
468
469Input to, and output from, the subprocess can cause the window to scroll to
fb9ab28a 470the end of the buffer. See variables `comint-output-filter-functions',
d4321160
RS
471`comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
472and `comint-scroll-to-bottom-on-output'.
be9b65ac
DL
473
474If you accidentally suspend your process, use \\[comint-continue-subjob]
475to continue it.
476
477\\{comint-mode-map}
478
3ee91e68 479Entry to this mode runs the hooks on `comint-mode-hook'."
baae3c4e 480 (setq mode-line-process '(":%s"))
3ee91e68
RS
481 (make-local-variable 'comint-last-input-start)
482 (setq comint-last-input-start (make-marker))
a9a6f83f 483 (set-marker comint-last-input-start (point-min))
3ee91e68
RS
484 (make-local-variable 'comint-last-input-end)
485 (setq comint-last-input-end (make-marker))
a9a6f83f 486 (set-marker comint-last-input-end (point-min))
3ee91e68
RS
487 (make-local-variable 'comint-last-output-start)
488 (setq comint-last-output-start (make-marker))
29533923 489 (make-local-variable 'comint-last-output-overlay)
3db4b719 490 (make-local-variable 'comint-last-prompt-overlay)
3ee91e68
RS
491 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
492 (make-local-variable 'comint-input-ring-size) ; ...to global val.
493 (make-local-variable 'comint-input-ring)
494 (make-local-variable 'comint-input-ring-file-name)
495 (or (and (boundp 'comint-input-ring) comint-input-ring)
496 (setq comint-input-ring (make-ring comint-input-ring-size)))
497 (make-local-variable 'comint-input-ring-index)
361ecbf2 498 (make-local-variable 'comint-save-input-ring-index)
3ee91e68
RS
499 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
500 (setq comint-input-ring-index nil))
361ecbf2
RS
501 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
502 (setq comint-save-input-ring-index nil))
3ee91e68
RS
503 (make-local-variable 'comint-matching-input-from-input-string)
504 (make-local-variable 'comint-input-autoexpand)
505 (make-local-variable 'comint-input-ignoredups)
506 (make-local-variable 'comint-delimiter-argument-list)
155fd027 507 (make-local-hook 'comint-dynamic-complete-functions)
497513ad 508 (make-local-variable 'comint-completion-fignore)
3ee91e68 509 (make-local-variable 'comint-get-old-input)
155fd027 510 (make-local-hook 'comint-input-filter-functions)
3ee91e68
RS
511 (make-local-variable 'comint-input-filter)
512 (make-local-variable 'comint-input-sender)
513 (make-local-variable 'comint-eol-on-send)
514 (make-local-variable 'comint-scroll-to-bottom-on-input)
515 (make-local-variable 'comint-scroll-to-bottom-on-output)
516 (make-local-variable 'comint-scroll-show-maximum-output)
d2b251aa 517 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
155fd027 518 (make-local-hook 'comint-output-filter-functions)
d2b251aa 519 (make-local-hook 'comint-exec-hook)
3ee91e68 520 (make-local-variable 'comint-ptyp)
3ee91e68 521 (make-local-variable 'comint-process-echoes)
2d4382e5 522 (make-local-variable 'comint-file-name-chars)
59f36b08 523 (make-local-variable 'comint-file-name-quote-list)
361ecbf2
RS
524 (make-local-variable 'comint-accum-marker)
525 (setq comint-accum-marker (make-marker))
44016d25
MB
526 (set-marker comint-accum-marker nil)
527 ;; This behavior is not useful in comint buffers, and is annoying
528 (set (make-local-variable 'next-line-add-newlines) nil))
be9b65ac 529
49116ac0
JB
530(if comint-mode-map
531 nil
3ee91e68 532 ;; Keys:
49116ac0
JB
533 (setq comint-mode-map (make-sparse-keymap))
534 (define-key comint-mode-map "\ep" 'comint-previous-input)
535 (define-key comint-mode-map "\en" 'comint-next-input)
cf7c8463
RS
536 (define-key comint-mode-map [C-up] 'comint-previous-input)
537 (define-key comint-mode-map [C-down] 'comint-next-input)
0c5c1f34
RS
538 (define-key comint-mode-map "\er" 'comint-previous-matching-input)
539 (define-key comint-mode-map "\es" 'comint-next-matching-input)
fb597fe8
RS
540 (define-key comint-mode-map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
541 (define-key comint-mode-map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
d637fa56 542 (define-key comint-mode-map "\e\C-l" 'comint-show-output)
49116ac0
JB
543 (define-key comint-mode-map "\C-m" 'comint-send-input)
544 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
361ecbf2 545 (define-key comint-mode-map "\C-c " 'comint-accumulate)
fb597fe8 546 (define-key comint-mode-map "\C-c\C-x" 'comint-get-next-from-history)
361ecbf2 547 (define-key comint-mode-map "\C-c\C-a" 'comint-bol-or-process-mark)
49116ac0
JB
548 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
549 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
550 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
551 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
552 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
3ee91e68 553 (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
4e217e50 554 (define-key comint-mode-map "\C-c\C-o" 'comint-delete-output)
49116ac0 555 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
3ee91e68 556 (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
4bec19b2 557 (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
1de80a34 558 (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
3ee91e68 559 (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
1de80a34 560 (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
dd749c1f 561 (define-key comint-mode-map "\C-c\C-s" 'comint-write-output)
ae57d456 562 ;; Mouse Buttons:
ae57d456 563 (define-key comint-mode-map [mouse-2] 'comint-insert-clicked-input)
3ee91e68
RS
564 ;; Menu bars:
565 ;; completion:
814299a7 566 (define-key comint-mode-map [menu-bar completion]
dcab7fbd 567 (cons "Complete" (make-sparse-keymap "Complete")))
3ee91e68
RS
568 (define-key comint-mode-map [menu-bar completion complete-expand]
569 '("Expand File Name" . comint-replace-by-expanded-filename))
570 (define-key comint-mode-map [menu-bar completion complete-listing]
571 '("File Completion Listing" . comint-dynamic-list-filename-completions))
3ee91e68
RS
572 (define-key comint-mode-map [menu-bar completion complete-file]
573 '("Complete File Name" . comint-dynamic-complete-filename))
574 (define-key comint-mode-map [menu-bar completion complete]
575 '("Complete Before Point" . comint-dynamic-complete))
576 ;; Input history:
814299a7 577 (define-key comint-mode-map [menu-bar inout]
dcab7fbd 578 (cons "In/Out" (make-sparse-keymap "In/Out")))
4e217e50
MB
579 (define-key comint-mode-map [menu-bar inout delete-output]
580 '("Delete Current Output Group" . comint-delete-output))
d134a19f
MB
581 (define-key comint-mode-map [menu-bar inout append-output-to-file]
582 '("Append Current Output Group to File" . comint-append-output-to-file))
44016d25
MB
583 (define-key comint-mode-map [menu-bar inout write-output]
584 '("Write Current Output Group to File" . comint-write-output))
5c07a950 585 (define-key comint-mode-map [menu-bar inout next-prompt]
dcab7fbd 586 '("Forward Output Group" . comint-next-prompt))
5c07a950 587 (define-key comint-mode-map [menu-bar inout previous-prompt]
dcab7fbd 588 '("Backward Output Group" . comint-previous-prompt))
5c07a950 589 (define-key comint-mode-map [menu-bar inout show-maximum-output]
dcab7fbd 590 '("Show Maximum Output" . comint-show-maximum-output))
5c07a950 591 (define-key comint-mode-map [menu-bar inout show-output]
dcab7fbd 592 '("Show Current Output Group" . comint-show-output))
5c07a950 593 (define-key comint-mode-map [menu-bar inout kill-input]
3ee91e68 594 '("Kill Current Input" . comint-kill-input))
5c07a950 595 (define-key comint-mode-map [menu-bar inout copy-input]
3ee91e68 596 '("Copy Old Input" . comint-copy-old-input))
5c07a950 597 (define-key comint-mode-map [menu-bar inout forward-matching-history]
dcab7fbd 598 '("Forward Matching Input..." . comint-forward-matching-input))
5c07a950 599 (define-key comint-mode-map [menu-bar inout backward-matching-history]
dcab7fbd 600 '("Backward Matching Input..." . comint-backward-matching-input))
5c07a950 601 (define-key comint-mode-map [menu-bar inout next-matching-history]
3ee91e68 602 '("Next Matching Input..." . comint-next-matching-input))
5c07a950 603 (define-key comint-mode-map [menu-bar inout previous-matching-history]
3ee91e68 604 '("Previous Matching Input..." . comint-previous-matching-input))
5c07a950 605 (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
3ee91e68 606 '("Next Matching Current Input" . comint-next-matching-input-from-input))
5c07a950 607 (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
3ee91e68 608 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
5c07a950 609 (define-key comint-mode-map [menu-bar inout next-history]
3ee91e68 610 '("Next Input" . comint-next-input))
5c07a950 611 (define-key comint-mode-map [menu-bar inout previous-history]
3ee91e68 612 '("Previous Input" . comint-previous-input))
5c07a950 613 (define-key comint-mode-map [menu-bar inout list-history]
3ee91e68 614 '("List Input History" . comint-dynamic-list-input-ring))
5c07a950 615 (define-key comint-mode-map [menu-bar inout expand-history]
3ee91e68 616 '("Expand History Before Point" . comint-replace-by-expanded-history))
3ee91e68
RS
617 ;; Signals
618 (define-key comint-mode-map [menu-bar signals]
619 (cons "Signals" (make-sparse-keymap "Signals")))
620 (define-key comint-mode-map [menu-bar signals eof]
621 '("EOF" . comint-send-eof))
622 (define-key comint-mode-map [menu-bar signals kill]
623 '("KILL" . comint-kill-subjob))
624 (define-key comint-mode-map [menu-bar signals quit]
625 '("QUIT" . comint-quit-subjob))
626 (define-key comint-mode-map [menu-bar signals cont]
627 '("CONT" . comint-continue-subjob))
628 (define-key comint-mode-map [menu-bar signals stop]
629 '("STOP" . comint-stop-subjob))
630 (define-key comint-mode-map [menu-bar signals break]
631 '("BREAK" . comint-interrupt-subjob))
632 ;; Put them in the menu bar:
5c07a950 633 (setq menu-bar-final-items (append '(completion inout signals)
3ee91e68 634 menu-bar-final-items))
49116ac0
JB
635 )
636
49116ac0 637(defun comint-check-proc (buffer)
3ee91e68 638 "Return t if there is a living process associated w/buffer BUFFER.
1a4086d2 639Living means the status is `open', `run', or `stop'.
cccd719e 640BUFFER can be either a buffer or the name of one."
49116ac0 641 (let ((proc (get-buffer-process buffer)))
1a4086d2 642 (and proc (memq (process-status proc) '(open run stop)))))
be9b65ac 643
a7fd458a
MB
644;;;###autoload
645(defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
646 "Make a comint process NAME in BUFFER, running PROGRAM.
647If BUFFER is nil, it defaults to NAME surrounded by `*'s.
648PROGRAM should be either a string denoting an executable program to create
649via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
650connection to be opened via `open-network-stream'. If there is already a
651running process in that buffer, it is not restarted. Optional third arg
652STARTFILE is the name of a file to send the contents of to the process.
653
654If PROGRAM is a string, any more args are arguments to PROGRAM."
655 (or (fboundp 'start-process)
656 (error "Multi-processing is not supported for this system"))
657 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
658 ;; If no process, or nuked process, crank up a new one and put buffer in
659 ;; comint mode. Otherwise, leave buffer and existing process alone.
660 (unless (comint-check-proc buffer)
661 (with-current-buffer buffer
662 (comint-mode)) ; Install local vars, mode, keymap, ...
663 (comint-exec buffer name program startfile switches))
664 buffer)
665
87206843 666;;;###autoload
be9b65ac 667(defun make-comint (name program &optional startfile &rest switches)
14a08856
RM
668 "Make a comint process NAME in a buffer, running PROGRAM.
669The name of the buffer is made by surrounding NAME with `*'s.
1a4086d2
RS
670PROGRAM should be either a string denoting an executable program to create
671via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
672connection to be opened via `open-network-stream'. If there is already a
673running process in that buffer, it is not restarted. Optional third arg
674STARTFILE is the name of a file to send the contents of to the process.
675
676If PROGRAM is a string, any more args are arguments to PROGRAM."
a7fd458a 677 (apply #'make-comint-in-buffer name nil program startfile switches))
be9b65ac 678
87206843 679;;;###autoload
21d9bf27
RS
680(defun comint-run (program)
681 "Run PROGRAM in a comint buffer and switch to it.
682The buffer name is made by surrounding the file name of PROGRAM with `*'s.
683The file name is used to make a symbol name, such as `comint-sh-hook', and any
684hooks on this symbol are run in the buffer.
685See `make-comint' and `comint-exec'."
686 (interactive "sRun program: ")
687 (let ((name (file-name-nondirectory program)))
688 (switch-to-buffer (make-comint name program))
689 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
690
be9b65ac 691(defun comint-exec (buffer name command startfile switches)
cccd719e 692 "Start up a process in buffer BUFFER for comint modes.
14a08856 693Blasts any old process running in the buffer. Doesn't set the buffer mode.
49116ac0 694You can use this to cheaply run a series of processes in the same comint
cccd719e 695buffer. The hook `comint-exec-hook' is run after each exec."
be9b65ac
DL
696 (save-excursion
697 (set-buffer buffer)
698 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
699 (if proc (delete-process proc)))
700 ;; Crank up a new process
1a4086d2
RS
701 (let ((proc
702 (if (consp command)
703 (open-network-stream name buffer (car command) (cdr command))
704 (comint-exec-1 name buffer command switches))))
3ee91e68 705 (set-process-filter proc 'comint-output-filter)
49116ac0
JB
706 (make-local-variable 'comint-ptyp)
707 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
be9b65ac 708 ;; Jump to the end, and set the process mark.
49116ac0 709 (goto-char (point-max))
87ef29fd 710 (set-marker (process-mark proc) (point))
be9b65ac
DL
711 ;; Feed it the startfile.
712 (cond (startfile
713 ;;This is guaranteed to wait long enough
714 ;;but has bad results if the comint does not prompt at all
715 ;; (while (= size (buffer-size))
716 ;; (sleep-for 1))
717 ;;I hope 1 second is enough!
718 (sleep-for 1)
719 (goto-char (point-max))
720 (insert-file-contents startfile)
721 (setq startfile (buffer-substring (point) (point-max)))
722 (delete-region (point) (point-max))
49116ac0
JB
723 (comint-send-string proc startfile)))
724 (run-hooks 'comint-exec-hook)
87ef29fd 725 buffer)))
be9b65ac 726
b578f267
EN
727;; This auxiliary function cranks up the process for comint-exec in
728;; the appropriate environment.
be9b65ac
DL
729
730(defun comint-exec-1 (name buffer command switches)
1b421826 731 (let ((process-environment
1f9e761d 732 (nconc
a4ab7e69
RS
733 ;; If using termcap, we specify `emacs' as the terminal type
734 ;; because that lets us specify a width.
36990caa 735 ;; If using terminfo, we specify `dumb' because that is
a4ab7e69
RS
736 ;; a defined terminal type. `emacs' is not a defined terminal type
737 ;; and there is no way for us to define it here.
738 ;; Some programs that use terminfo get very confused
739 ;; if TERM is not a valid terminal type.
1f9e761d 740 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
4a11114d 741 (list "TERM=dumb" "TERMCAP="
a91ad7c9 742 (format "COLUMNS=%d" (window-width)))
f3b0a431 743 (list "TERM=emacs"
a91ad7c9 744 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
f3b0a431 745 (if (getenv "EMACS") nil (list "EMACS=t"))
1347899b
RS
746 process-environment))
747 (default-directory
e1d409fe 748 (if (file-accessible-directory-p default-directory)
1347899b 749 default-directory
33ba5485
RS
750 (char-to-string directory-sep-char)))
751 proc decoding encoding changed)
433d16a1
SM
752 (let ((exec-path (if (file-name-directory command)
753 ;; If the command has slashes, make sure we
754 ;; first look relative to the current directory.
755 (cons default-directory exec-path) exec-path)))
756 (setq proc (apply 'start-process name buffer command switches)))
33ba5485
RS
757 (let ((coding-systems (process-coding-system proc)))
758 (setq decoding (car coding-systems)
759 encoding (cdr coding-systems)))
760 ;; If start-process decided to use some coding system for decoding
433d16a1 761 ;; data sent from the process and the coding system doesn't
33ba5485
RS
762 ;; specify EOL conversion, we had better convert CRLF to LF.
763 (if (vectorp (coding-system-eol-type decoding))
764 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
765 changed t))
766 ;; Even if start-process left the coding system for encoding data
767 ;; sent from the process undecided, we had better use the same one
768 ;; as what we use for decoding. But, we should suppress EOL
769 ;; conversion.
770 (if (and decoding (not encoding))
771 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
772 changed t))
773 (if changed
774 (set-process-coding-system proc decoding encoding))
775 proc))
ae57d456
GM
776
777
778(defun comint-insert-clicked-input (event)
779 "In a comint buffer, set the current input to the clicked-on previous input."
780 (interactive "e")
ef779078
SM
781 (let ((over (catch 'found
782 ;; Ignore non-input overlays
783 (dolist (ov (overlays-at (posn-point (event-end event))))
784 (when (eq (overlay-get ov 'field) 'input)
785 (throw 'found ov))))))
909a9182 786 ;; Do we have input in this area?
ef779078
SM
787 (if over
788 (let ((input-str (buffer-substring (overlay-start over)
789 (overlay-end over))))
790 (delete-region
ae57d456
GM
791 ;; Can't use kill-region as it sets this-command
792 (or (marker-position comint-accum-marker)
793 (process-mark (get-buffer-process (current-buffer))))
ef779078 794 (point))
ae57d456 795 (insert input-str))
909a9182
GM
796 ;; Fall back to the global definition.
797 (let* ((keys (this-command-keys))
798 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
799 (fun (and last-key (lookup-key global-map (vector last-key)))))
ef779078 800 (if fun (call-interactively fun))))))
814299a7 801
be9b65ac 802\f
b578f267
EN
803;; Input history processing in a buffer
804;; ===========================================================================
805;; Useful input history functions, courtesy of the Ergo group.
806
807;; Eleven commands:
808;; comint-dynamic-list-input-ring List history in help buffer.
809;; comint-previous-input Previous input...
810;; comint-previous-matching-input ...matching a string.
811;; comint-previous-matching-input-from-input ... matching the current input.
812;; comint-next-input Next input...
813;; comint-next-matching-input ...matching a string.
814;; comint-next-matching-input-from-input ... matching the current input.
815;; comint-backward-matching-input Backwards input...
816;; comint-forward-matching-input ...matching a string.
817;; comint-replace-by-expanded-history Expand history at point;
818;; replace with expanded history.
819;; comint-magic-space Expand history and insert space.
820;;
821;; Three functions:
822;; comint-read-input-ring Read into comint-input-ring...
823;; comint-write-input-ring Write to comint-input-ring-file-name.
824;; comint-replace-by-expanded-history-before-point Workhorse function.
3ee91e68 825
d637fa56 826(defun comint-read-input-ring (&optional silent)
3ee91e68
RS
827 "Sets the buffer's `comint-input-ring' from a history file.
828The name of the file is given by the variable `comint-input-ring-file-name'.
829The history ring is of size `comint-input-ring-size', regardless of file size.
830If `comint-input-ring-file-name' is nil this function does nothing.
831
d637fa56
RS
832If the optional argument SILENT is non-nil, we say nothing about a
833failure to read the history file.
3ee91e68 834
d637fa56
RS
835This function is useful for major mode commands and mode hooks.
836
bc29fd5f 837The commands stored in the history file are separated by the
0fddb84c
GM
838`comint-input-ring-separator', and entries that match
839`comint-input-history-ignore' are ignored. The most recent command
840comes last.
bc29fd5f 841
3ee91e68 842See also `comint-input-ignoredups' and `comint-write-input-ring'."
07ccf0bc
RS
843 (cond ((or (null comint-input-ring-file-name)
844 (equal comint-input-ring-file-name ""))
3ee91e68
RS
845 nil)
846 ((not (file-readable-p comint-input-ring-file-name))
d637fa56
RS
847 (or silent
848 (message "Cannot read history file %s"
849 comint-input-ring-file-name)))
3ee91e68 850 (t
cdc4401d
GM
851 (let* ((history-buf (get-buffer-create " *temp*"))
852 (file comint-input-ring-file-name)
853 (count 0)
854 (size comint-input-ring-size)
855 (ring (make-ring size)))
dc0825db
RS
856 (unwind-protect
857 (save-excursion
858 (set-buffer history-buf)
3ee91e68 859 (widen)
dc0825db
RS
860 (erase-buffer)
861 (insert-file-contents file)
862 ;; Save restriction in case file is already visited...
863 ;; Watch for those date stamps in history files!
864 (goto-char (point-max))
3e8abfd3
GM
865 (let (start end history)
866 (while (and (< count comint-input-ring-size)
867 (re-search-backward comint-input-ring-separator nil t)
868 (setq end (match-beginning 0)))
869 (if (re-search-backward comint-input-ring-separator nil t)
870 (setq start (match-end 0))
871 (setq start (point-min)))
872 (setq history (buffer-substring start end))
873 (goto-char start)
0fddb84c
GM
874 (if (and (not (string-match comint-input-history-ignore history))
875 (or (null comint-input-ignoredups)
876 (ring-empty-p ring)
877 (not (string-equal (ring-ref ring 0) history))))
3e8abfd3
GM
878 (progn
879 (ring-insert-at-beginning ring history)
880 (setq count (1+ count)))))))
dc0825db 881 (kill-buffer history-buf))
3ee91e68
RS
882 (setq comint-input-ring ring
883 comint-input-ring-index nil)))))
884
885(defun comint-write-input-ring ()
886 "Writes the buffer's `comint-input-ring' to a history file.
887The name of the file is given by the variable `comint-input-ring-file-name'.
888The original contents of the file are lost if `comint-input-ring' is not empty.
889If `comint-input-ring-file-name' is nil this function does nothing.
890
891Useful within process sentinels.
892
893See also `comint-read-input-ring'."
894 (cond ((or (null comint-input-ring-file-name)
07ccf0bc 895 (equal comint-input-ring-file-name "")
3ee91e68
RS
896 (null comint-input-ring) (ring-empty-p comint-input-ring))
897 nil)
898 ((not (file-writable-p comint-input-ring-file-name))
899 (message "Cannot write history file %s" comint-input-ring-file-name))
900 (t
901 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
902 (ring comint-input-ring)
903 (file comint-input-ring-file-name)
904 (index (ring-length ring)))
905 ;; Write it all out into a buffer first. Much faster, but messier,
906 ;; than writing it one line at a time.
907 (save-excursion
908 (set-buffer history-buf)
909 (erase-buffer)
910 (while (> index 0)
911 (setq index (1- index))
814299a7 912 (insert (ring-ref ring index) comint-input-ring-separator))
3ee91e68
RS
913 (write-region (buffer-string) nil file nil 'no-message)
914 (kill-buffer nil))))))
915
916
917(defun comint-dynamic-list-input-ring ()
918 "List in help buffer the buffer's input history."
919 (interactive)
920 (if (or (not (ring-p comint-input-ring))
921 (ring-empty-p comint-input-ring))
922 (message "No history")
923 (let ((history nil)
924 (history-buffer " *Input History*")
925 (index (1- (ring-length comint-input-ring)))
926 (conf (current-window-configuration)))
927 ;; We have to build up a list ourselves from the ring vector.
928 (while (>= index 0)
929 (setq history (cons (ring-ref comint-input-ring index) history)
930 index (1- index)))
931 ;; Change "completion" to "history reference"
932 ;; to make the display accurate.
933 (with-output-to-temp-buffer history-buffer
934 (display-completion-list history)
935 (set-buffer history-buffer)
936 (forward-line 3)
937 (while (search-backward "completion" nil 'move)
938 (replace-match "history reference")))
939 (sit-for 0)
940 (message "Hit space to flush")
941 (let ((ch (read-event)))
942 (if (eq ch ?\ )
943 (set-window-configuration conf)
944 (setq unread-command-events (list ch)))))))
945
946
947(defun comint-regexp-arg (prompt)
948 ;; Return list of regexp and prefix arg using PROMPT.
9f8ac7f9 949 (let* (;; Don't clobber this.
3ee91e68
RS
950 (last-command last-command)
951 (regexp (read-from-minibuffer prompt nil nil nil
952 'minibuffer-history-search-history)))
953 (list (if (string-equal regexp "")
954 (setcar minibuffer-history-search-history
955 (nth 1 minibuffer-history-search-history))
956 regexp)
957 (prefix-numeric-value current-prefix-arg))))
958
959(defun comint-search-arg (arg)
960 ;; First make sure there is a ring and that we are after the process mark
961 (cond ((not (comint-after-pmark-p))
962 (error "Not at command line"))
963 ((or (null comint-input-ring)
964 (ring-empty-p comint-input-ring))
965 (error "Empty input ring"))
966 ((zerop arg)
967 ;; arg of zero resets search from beginning, and uses arg of 1
968 (setq comint-input-ring-index nil)
969 1)
970 (t
971 arg)))
972
973(defun comint-search-start (arg)
974 ;; Index to start a directional search, starting at comint-input-ring-index
975 (if comint-input-ring-index
976 ;; If a search is running, offset by 1 in direction of arg
977 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
978 (ring-length comint-input-ring))
979 ;; For a new search, start from beginning or end, as appropriate
980 (if (>= arg 0)
981 0 ; First elt for forward search
982 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
983
984(defun comint-previous-input-string (arg)
985 "Return the string ARG places along the input ring.
986Moves relative to `comint-input-ring-index'."
987 (ring-ref comint-input-ring (if comint-input-ring-index
814299a7 988 (mod (+ arg comint-input-ring-index)
3ee91e68
RS
989 (ring-length comint-input-ring))
990 arg)))
be9b65ac
DL
991
992(defun comint-previous-input (arg)
993 "Cycle backwards through input history."
994 (interactive "*p")
3ee91e68 995 (comint-previous-matching-input "." arg))
1586b965 996
be9b65ac
DL
997(defun comint-next-input (arg)
998 "Cycle forwards through input history."
999 (interactive "*p")
1000 (comint-previous-input (- arg)))
1001
3ee91e68
RS
1002(defun comint-previous-matching-input-string (regexp arg)
1003 "Return the string matching REGEXP ARG places along the input ring.
1004Moves relative to `comint-input-ring-index'."
1005 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1006 (if pos (ring-ref comint-input-ring pos))))
1007
1008(defun comint-previous-matching-input-string-position (regexp arg &optional start)
1009 "Return the index matching REGEXP ARG places along the input ring.
1010Moves relative to START, or `comint-input-ring-index'."
1011 (if (or (not (ring-p comint-input-ring))
1012 (ring-empty-p comint-input-ring))
1013 (error "No history"))
1014 (let* ((len (ring-length comint-input-ring))
1015 (motion (if (> arg 0) 1 -1))
1016 (n (mod (- (or start (comint-search-start arg)) motion) len))
1017 (tried-each-ring-item nil)
1018 (prev nil))
1019 ;; Do the whole search as many times as the argument says.
1020 (while (and (/= arg 0) (not tried-each-ring-item))
1021 ;; Step once.
1022 (setq prev n
1023 n (mod (+ n motion) len))
1024 ;; If we haven't reached a match, step some more.
1025 (while (and (< n len) (not tried-each-ring-item)
1026 (not (string-match regexp (ring-ref comint-input-ring n))))
1027 (setq n (mod (+ n motion) len)
1028 ;; If we have gone all the way around in this search.
1029 tried-each-ring-item (= n prev)))
1030 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1031 ;; Now that we know which ring element to use, if we found it, return that.
1032 (if (string-match regexp (ring-ref comint-input-ring n))
1033 n)))
1034
0c5c1f34
RS
1035(defun comint-previous-matching-input (regexp arg)
1036 "Search backwards through input history for match for REGEXP.
1037\(Previous history elements are earlier commands.)
1038With prefix argument N, search for Nth previous match.
1039If N is negative, find the next or Nth next match."
3ee91e68
RS
1040 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1041 (setq arg (comint-search-arg arg))
1042 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
1043 ;; Has a match been found?
1044 (if (null pos)
1045 (error "Not found")
1046 (setq comint-input-ring-index pos)
1047 (message "History item: %d" (1+ pos))
814299a7 1048 (delete-region
3ee91e68 1049 ;; Can't use kill-region as it sets this-command
361ecbf2
RS
1050 (or (marker-position comint-accum-marker)
1051 (process-mark (get-buffer-process (current-buffer))))
1052 (point))
3ee91e68 1053 (insert (ring-ref comint-input-ring pos)))))
0c5c1f34
RS
1054
1055(defun comint-next-matching-input (regexp arg)
1056 "Search forwards through input history for match for REGEXP.
1057\(Later history elements are more recent commands.)
1058With prefix argument N, search for Nth following match.
1059If N is negative, find the previous or Nth previous match."
3ee91e68 1060 (interactive (comint-regexp-arg "Next input matching (regexp): "))
0c5c1f34 1061 (comint-previous-matching-input regexp (- arg)))
be9b65ac 1062
3ee91e68
RS
1063(defun comint-previous-matching-input-from-input (arg)
1064 "Search backwards through input history for match for current input.
1065\(Previous history elements are earlier commands.)
1066With prefix argument N, search for Nth previous match.
3f849529 1067If N is negative, search forwards for the -Nth following match."
3ee91e68
RS
1068 (interactive "p")
1069 (if (not (memq last-command '(comint-previous-matching-input-from-input
1070 comint-next-matching-input-from-input)))
1071 ;; Starting a new search
1072 (setq comint-matching-input-from-input-string
814299a7 1073 (buffer-substring
361ecbf2
RS
1074 (or (marker-position comint-accum-marker)
1075 (process-mark (get-buffer-process (current-buffer))))
3ee91e68
RS
1076 (point))
1077 comint-input-ring-index nil))
1078 (comint-previous-matching-input
1079 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1080 arg))
1081
1082(defun comint-next-matching-input-from-input (arg)
1083 "Search forwards through input history for match for current input.
3f849529
RS
1084\(Following history elements are more recent commands.)
1085With prefix argument N, search for Nth following match.
1086If N is negative, search backwards for the -Nth previous match."
3ee91e68
RS
1087 (interactive "p")
1088 (comint-previous-matching-input-from-input (- arg)))
1089
1090
17ac4966 1091(defun comint-replace-by-expanded-history (&optional silent start)
3ee91e68 1092 "Expand input command history references before point.
1b421826
RS
1093Expansion is dependent on the value of `comint-input-autoexpand'.
1094
3ee91e68
RS
1095This function depends on the buffer's idea of the input history, which may not
1096match the command interpreter's idea, assuming it has one.
1097
1098Assumes history syntax is like typical Un*x shells'. However, since emacs
1099cannot know the interpreter's idea of input line numbers, assuming it has one,
1100it cannot expand absolute input line number references.
1101
d637fa56
RS
1102If the optional argument SILENT is non-nil, never complain
1103even if history reference seems erroneous.
1104
17ac4966
RS
1105If the optional argument START is non-nil, that specifies the
1106start of the text to scan for history references, rather
1107than the logical beginning of line.
1108
1b421826
RS
1109See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1110
1111Returns t if successful."
3ee91e68 1112 (interactive)
1b421826 1113 (if (and comint-input-autoexpand
29533923
MB
1114 (if comint-use-prompt-regexp-instead-of-fields
1115 ;; Use comint-prompt-regexp
1ec321a7
MB
1116 (save-excursion
1117 (beginning-of-line)
1118 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
29533923
MB
1119 ;; Use input fields. User input that hasn't been entered
1120 ;; yet, at the end of the buffer, has a nil `field' property.
1ec321a7
MB
1121 (and (null (get-char-property (point) 'field))
1122 (string-match "!\\|^\\^" (field-string)))))
1b421826
RS
1123 ;; Looks like there might be history references in the command.
1124 (let ((previous-modified-tick (buffer-modified-tick)))
17ac4966 1125 (comint-replace-by-expanded-history-before-point silent start)
1b421826
RS
1126 (/= previous-modified-tick (buffer-modified-tick)))))
1127
1128
17ac4966 1129(defun comint-replace-by-expanded-history-before-point (silent &optional start)
1b421826 1130 "Expand directory stack reference before point.
17ac4966
RS
1131See `comint-replace-by-expanded-history'. Returns t if successful.
1132
1133If the optional argument START is non-nil, that specifies the
1134start of the text to scan for history references, rather
1135than the logical beginning of line."
3ee91e68 1136 (save-excursion
29533923
MB
1137 (let ((toend (- (line-end-position) (point)))
1138 (start (comint-line-beginning-position)))
7e4f9cf4 1139 (goto-char start)
d637fa56 1140 (while (progn
29533923
MB
1141 (skip-chars-forward "^!^" (- (line-end-position) toend))
1142 (< (point) (- (line-end-position) toend)))
3ee91e68
RS
1143 ;; This seems a bit complex. We look for references such as !!, !-num,
1144 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1145 ;; If that wasn't enough, the plings can be suffixed with argument
1146 ;; range specifiers.
1147 ;; Argument ranges are complex too, so we hive off the input line,
1148 ;; referenced with plings, with the range string to `comint-args'.
1149 (setq comint-input-ring-index nil)
3ee91e68
RS
1150 (cond ((or (= (preceding-char) ?\\)
1151 (comint-within-quotes start (point)))
1152 ;; The history is quoted, or we're in quotes.
d637fa56 1153 (goto-char (1+ (point))))
3ee91e68
RS
1154 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1155 ;; We cannot know the interpreter's idea of input line numbers.
1156 (goto-char (match-end 0))
1157 (message "Absolute reference cannot be expanded"))
1158 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1159 ;; Just a number of args from `number' lines backward.
1160 (let ((number (1- (string-to-number
1161 (buffer-substring (match-beginning 1)
1162 (match-end 1))))))
1163 (if (<= number (ring-length comint-input-ring))
1164 (progn
1165 (replace-match
1166 (comint-args (comint-previous-input-string number)
fb9ab28a
RS
1167 (match-beginning 2) (match-end 2))
1168 t t)
3ee91e68
RS
1169 (setq comint-input-ring-index number)
1170 (message "History item: %d" (1+ number)))
1171 (goto-char (match-end 0))
1172 (message "Relative reference exceeds input history size"))))
1173 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1174 ;; Just a number of args from the previous input line.
1175 (replace-match
1176 (comint-args (comint-previous-input-string 0)
fb9ab28a
RS
1177 (match-beginning 1) (match-end 1))
1178 t t)
1b421826 1179 (message "History item: previous"))
3ee91e68
RS
1180 ((looking-at
1181 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1182 ;; Most recent input starting with or containing (possibly
1183 ;; protected) string, maybe just a number of args. Phew.
1184 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1185 (mb2 (match-beginning 2)) (me2 (match-end 2))
1186 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1187 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1188 (pos (save-match-data
1189 (comint-previous-matching-input-string-position
1190 (concat pref (regexp-quote exp)) 1))))
1191 (if (null pos)
5a336c13
KH
1192 (progn
1193 (goto-char (match-end 0))
1194 (or silent
1195 (progn (message "Not found")
1196 (ding))))
3ee91e68 1197 (setq comint-input-ring-index pos)
3ee91e68
RS
1198 (replace-match
1199 (comint-args (ring-ref comint-input-ring pos)
fb9ab28a
RS
1200 (match-beginning 4) (match-end 4))
1201 t t)
1b421826 1202 (message "History item: %d" (1+ pos)))))
3ee91e68
RS
1203 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1204 ;; Quick substitution on the previous input line.
1205 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1206 (new (buffer-substring (match-beginning 2) (match-end 2)))
1207 (pos nil))
1208 (replace-match (comint-previous-input-string 0) t t)
1209 (setq pos (point))
1210 (goto-char (match-beginning 0))
1b421826
RS
1211 (if (not (search-forward old pos t))
1212 (or silent
1213 (error "Not found"))
1214 (replace-match new t t)
1215 (message "History item: substituted"))))
3ee91e68 1216 (t
2ac86cc0 1217 (forward-char 1)))))))
3ee91e68
RS
1218
1219
1220(defun comint-magic-space (arg)
1221 "Expand input history references before point and insert ARG spaces.
1222A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1223 (interactive "p")
1224 (comint-replace-by-expanded-history)
1225 (self-insert-command arg))
1226\f
1227(defun comint-within-quotes (beg end)
1228 "Return t if the number of quotes between BEG and END is odd.
1229Quotes are single and double."
1230 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1231 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1232 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1233
1234(defun comint-how-many-region (regexp beg end)
1235 "Return number of matches for REGEXP from BEG to END."
1236 (let ((count 0))
1237 (save-excursion
1238 (save-match-data
1239 (goto-char beg)
1240 (while (re-search-forward regexp end t)
1241 (setq count (1+ count)))))
1242 count))
1243
1244(defun comint-args (string begin end)
1245 ;; From STRING, return the args depending on the range specified in the text
1246 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1247 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1248 (save-match-data
1249 (if (null begin)
1250 (comint-arguments string 0 nil)
1251 (let* ((range (buffer-substring
1252 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1253 (nth (cond ((string-match "^[*^]" range) 1)
1254 ((string-match "^-" range) 0)
1255 ((string-equal range "$") nil)
1256 (t (string-to-number range))))
1257 (mth (cond ((string-match "[-*$]$" range) nil)
1258 ((string-match "-" range)
1259 (string-to-number (substring range (match-end 0))))
1260 (t nth))))
1261 (comint-arguments string nth mth)))))
1262
3f4b7c36
RS
1263;; Return a list of arguments from ARG. Break it up at the
1264;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
3ee91e68 1265(defun comint-delim-arg (arg)
3f4b7c36 1266 (if (null comint-delimiter-argument-list)
3ee91e68 1267 (list arg)
3f4b7c36
RS
1268 (let ((args nil)
1269 (pos 0)
1270 (len (length arg)))
1271 (while (< pos len)
1272 (let ((char (aref arg pos))
1273 (start pos))
1274 (if (memq char comint-delimiter-argument-list)
1275 (while (and (< pos len) (eq (aref arg pos) char))
1276 (setq pos (1+ pos)))
1277 (while (and (< pos len)
1278 (not (memq (aref arg pos)
1279 comint-delimiter-argument-list)))
1280 (setq pos (1+ pos))))
1281 (setq args (cons (substring arg start pos) args))))
3ee91e68
RS
1282 args)))
1283
1284(defun comint-arguments (string nth mth)
1285 "Return from STRING the NTH to MTH arguments.
1286NTH and/or MTH can be nil, which means the last argument.
3f4b7c36 1287Returned arguments are separated by single spaces.
e7cfa73f
KH
1288We assume whitespace separates arguments, except within quotes
1289and except for a space or tab that immediately follows a backslash.
3f4b7c36
RS
1290Also, a run of one or more of a single character
1291in `comint-delimiter-argument-list' is a separate argument.
3ee91e68 1292Argument 0 is the command name."
21a003b9
GV
1293 ;; The first line handles ordinary characters and backslash-sequences
1294 ;; (except with w32 msdos-like shells, where backslashes are valid).
ec569127
RS
1295 ;; The second matches "-quoted strings.
1296 ;; The third matches '-quoted strings.
1297 ;; The fourth matches `-quoted strings.
1298 ;; This seems to fit the syntax of BASH 2.0.
814299a7 1299 (let* ((first (if (and (eq system-type 'windows-nt)
21a003b9
GV
1300 (w32-shell-dos-semantics))
1301 "[^ \n\t\"'`]+\\|"
e7cfa73f 1302 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
21a003b9
GV
1303 (argpart (concat first
1304 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
ec569127 1305'[^']*'\\|\
21a003b9
GV
1306`[^`]*`\\)"))
1307 (args ()) (pos 0)
1308 (count 0)
1309 beg str value quotes)
d91f490d
RS
1310 ;; Build a list of all the args until we have as many as we want.
1311 (while (and (or (null mth) (<= count mth))
1312 (string-match argpart string pos))
1313 (if (and beg (= pos (match-beginning 0)))
1314 ;; It's contiguous, part of the same arg.
1315 (setq pos (match-end 0)
1316 quotes (or quotes (match-beginning 1)))
1317 ;; It's a new separate arg.
1318 (if beg
1319 ;; Put the previous arg, if there was one, onto ARGS.
1320 (setq str (substring string beg pos)
1321 args (if quotes (cons str args)
1322 (nconc (comint-delim-arg str) args))
1323 count (1+ count)))
1324 (setq quotes (match-beginning 1))
1325 (setq beg (match-beginning 0))
1326 (setq pos (match-end 0))))
1327 (if beg
1328 (setq str (substring string beg pos)
1329 args (if quotes (cons str args)
1330 (nconc (comint-delim-arg str) args))
1331 count (1+ count)))
1332 (let ((n (or nth (1- count)))
1333 (m (if mth (1- (- count mth)) 0)))
3ee91e68
RS
1334 (mapconcat
1335 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1336\f
b578f267
EN
1337;;
1338;; Input processing stuff
1339;;
936c15f6
EL
1340(defun comint-add-to-input-history (cmd)
1341 "Add CMD to the input history.
1342Ignore duplicates if `comint-input-ignoredups' is non-nil."
1343 (if (and (funcall comint-input-filter cmd)
1344 (or (null comint-input-ignoredups)
1345 (not (ring-p comint-input-ring))
1346 (ring-empty-p comint-input-ring)
1347 (not (string-equal (ring-ref comint-input-ring 0)
1348 cmd))))
1349 (ring-insert comint-input-ring cmd)))
3ee91e68 1350
814299a7 1351(defun comint-send-input ()
c2ced5d8
CZ
1352 "Send input to process.
1353After the process output mark, sends all text from the process mark to
1354point as input to the process. Before the process output mark, calls value
8ae3bc9f 1355of variable `comint-get-old-input' to retrieve old input, copies it to the
cccd719e 1356process mark, and sends it. If variable `comint-process-echoes' is nil,
8ae3bc9f 1357a terminal newline is also inserted into the buffer and sent to the process
cccd719e
RS
1358\(if it is non-nil, all text from the process mark to point is deleted,
1359since it is assumed the remote process will re-echo it).
8ae3bc9f 1360
3ee91e68 1361Any history reference may be expanded depending on the value of the variable
1b421826 1362`comint-input-autoexpand'. The list of function names contained in the value
fb9ab28a 1363of `comint-input-filter-functions' is called on the input before sending it.
1b421826
RS
1364The input is entered into the input history ring, if the value of variable
1365`comint-input-filter' returns non-nil when called on the input.
cccd719e
RS
1366
1367If variable `comint-eol-on-send' is non-nil, then point is moved to the
8ae3bc9f
NF
1368end of line before sending the input.
1369
fb9ab28a 1370The values of `comint-get-old-input', `comint-input-filter-functions', and
1b421826
RS
1371`comint-input-filter' are chosen according to the command interpreter running
1372in the buffer. E.g.,
1373
be9b65ac 1374If the interpreter is the csh,
29533923 1375 comint-get-old-input is the default: either return the current
814299a7
MB
1376 field, or take the current line and discard any
1377 initial string matching regexp `comint-prompt-regexp', depending
29533923 1378 on the value of `comint-use-prompt-regexp-instead-of-fields'.
fb9ab28a 1379 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
814299a7 1380 \"popd\" commands. When it sees one, it cd's the buffer.
3ee91e68 1381 comint-input-filter is the default: returns t if the input isn't all white
49116ac0 1382 space.
be9b65ac 1383
814299a7 1384If the comint is Lucid Common Lisp,
49116ac0 1385 comint-get-old-input snarfs the sexp ending at point.
fb9ab28a 1386 comint-input-filter-functions does nothing.
3ee91e68 1387 comint-input-filter returns nil if the input matches input-filter-regexp,
814299a7 1388 which matches (1) all whitespace (2) :a, :c, etc.
be9b65ac 1389
1586b965 1390Similarly for Soar, Scheme, etc."
be9b65ac
DL
1391 (interactive)
1392 ;; Note that the input string does not include its terminal newline.
49116ac0
JB
1393 (let ((proc (get-buffer-process (current-buffer))))
1394 (if (not proc) (error "Current buffer has no process")
1395 (let* ((pmark (process-mark proc))
3ee91e68 1396 (intxt (if (>= (point) (marker-position pmark))
49116ac0
JB
1397 (progn (if comint-eol-on-send (end-of-line))
1398 (buffer-substring pmark (point)))
87ef29fd
JB
1399 (let ((copy (funcall comint-get-old-input)))
1400 (goto-char pmark)
1401 (insert copy)
3ee91e68
RS
1402 copy)))
1403 (input (if (not (eq comint-input-autoexpand 'input))
1404 ;; Just whatever's already there
1405 intxt
1406 ;; Expand and leave it visible in buffer
17ac4966 1407 (comint-replace-by-expanded-history t pmark)
3ee91e68
RS
1408 (buffer-substring pmark (point))))
1409 (history (if (not (eq comint-input-autoexpand 'history))
5f46b51a 1410 input
3ee91e68
RS
1411 ;; This is messy 'cos ultimately the original
1412 ;; functions used do insertion, rather than return
1413 ;; strings. We have to expand, then insert back.
17ac4966 1414 (comint-replace-by-expanded-history t pmark)
ff6318be
SM
1415 (let ((copy (buffer-substring pmark (point)))
1416 (start (point)))
1417 (insert input)
1418 (delete-region pmark start)
5f46b51a 1419 copy))))
29533923 1420
814299a7
MB
1421 (if comint-process-echoes
1422 (delete-region pmark (point))
b59b731f 1423 (insert ?\n))
29533923 1424
936c15f6 1425 (comint-add-to-input-history history)
29533923 1426
155fd027
KH
1427 (run-hook-with-args 'comint-input-filter-functions
1428 (concat input "\n"))
29533923 1429
ae57d456
GM
1430 (let ((beg (marker-position pmark))
1431 (end (1- (point))))
29533923
MB
1432 (when (not (> beg end)) ; handle a special case
1433 ;; Make an overlay for the input field
22bcff4e 1434 (let ((over (make-overlay beg end nil nil t)))
29533923
MB
1435 (unless comint-use-prompt-regexp-instead-of-fields
1436 ;; Give old user input a field property of `input', to
1437 ;; distinguish it from both process output and unsent
1438 ;; input. The terminating newline is put into a special
1439 ;; `boundary' field to make cursor movement between input
1440 ;; and output fields smoother.
c7c800d8 1441 (overlay-put over 'field 'input))
29533923 1442 (when comint-highlight-input
7ff4fda5 1443 (overlay-put over 'face 'comint-highlight-input)
29533923 1444 (overlay-put over 'mouse-face 'highlight)
e20e70c3
EZ
1445 (overlay-put over
1446 'help-echo
1447 "mouse-2: insert previous clicked-on input")
29533923
MB
1448 (overlay-put over 'evaporate t))))
1449 (unless comint-use-prompt-regexp-instead-of-fields
1450 ;; Make an overlay for the terminating newline
22bcff4e 1451 (let ((over (make-overlay end (1+ end) nil t nil)))
29533923 1452 (overlay-put over 'field 'boundary)
8c24e65b 1453 (overlay-put over 'inhibit-line-move-field-capture t)
ae57d456 1454 (overlay-put over 'evaporate t))))
29533923 1455
3db4b719
MB
1456 (comint-snapshot-last-prompt)
1457
361ecbf2 1458 (setq comint-save-input-ring-index comint-input-ring-index)
1586b965 1459 (setq comint-input-ring-index nil)
dcdc526c
RS
1460 ;; Update the markers before we send the input
1461 ;; in case we get output amidst sending the input.
87ef29fd
JB
1462 (set-marker comint-last-input-start pmark)
1463 (set-marker comint-last-input-end (point))
3ee91e68 1464 (set-marker (process-mark proc) (point))
361ecbf2
RS
1465 ;; clear the "accumulation" marker
1466 (set-marker comint-accum-marker nil)
dcdc526c 1467 (funcall comint-input-sender proc input)
6aac2ab0
RS
1468 ;; This used to call comint-output-filter-functions,
1469 ;; but that scrolled the buffer in undesirable ways.
1470 (run-hook-with-args 'comint-output-filter-functions "")))))
be9b65ac 1471
814299a7 1472(defvar comint-preoutput-filter-functions nil
c095ddb9
RS
1473 "List of functions to call before inserting Comint output into the buffer.
1474Each function gets one argument, a string containing the text received
1475from the subprocess. It should return the string to insert, perhaps
1476the same string that was received, or perhaps a modified or transformed
1477string.
1478
1479The functions on the list are called sequentially, and each one is
1480given the string returned by the previous one. The string returned by
1481the last function is the text that is actually inserted in the
07c8b450 1482redirection buffer.
c095ddb9 1483
07c8b450 1484This variable is permanent-local.")
d4321160 1485
29533923
MB
1486;; When non-nil, this is the last overlay used for output.
1487;; It is kept around so that we can extend it instead of creating
1488;; multiple contiguous overlays for multiple contiguous output chunks.
1489(defvar comint-last-output-overlay nil)
1490
3db4b719
MB
1491;; When non-nil, this is an overlay over the last recognized prompt in
1492;; the buffer; it is used when highlighting the prompt.
1493(defvar comint-last-prompt-overlay nil)
1494
1495;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1496;; Any further output will then create a new comint-last-prompt-overlay.
1497(defun comint-snapshot-last-prompt ()
1498 (when comint-last-prompt-overlay
1499 (overlay-put comint-last-prompt-overlay 'evaporate t)
1500 (setq comint-last-prompt-overlay nil)))
1501
3db6f8ca 1502(defun comint-carriage-motion (string)
8e3f3781
MB
1503 "Handle carriage control characters in comint output.
1504Translate carriage return/linefeed sequences to linefeeds.
1505Make single carriage returns delete to the beginning of the line.
1506Make backspaces delete the previous character.
3db6f8ca
GM
1507
1508This function should be in the list `comint-output-filter-functions'."
80c40c6f 1509 (save-match-data
3db6f8ca
GM
1510 ;; We first check to see if STRING contains any magic characters, to
1511 ;; avoid overhead in the common case where it does not
1512 (when (string-match "[\r\b]" string)
1513 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1514 (save-excursion
1515 (save-restriction
1516 (widen)
1517 (let ((inhibit-field-text-motion t)
1518 (buffer-read-only nil))
1519 ;; CR LF -> LF
1520 ;; Note that this won't work properly when the CR and LF
1521 ;; are in different output chunks, but this is probably an
1522 ;; exceedingly rare case (because they are generally
1523 ;; written as a unit), and to delay interpretation of a
1524 ;; trailing CR in a chunk would result in odd interactive
1525 ;; behavior (and this case is probably far more common).
1526 (goto-char comint-last-output-start)
1527 (while (re-search-forward "\r$" pmark t)
1528 (delete-char -1))
1529 ;; bare CR -> delete preceding line
1530 (goto-char comint-last-output-start)
1531 (while (search-forward "\r" pmark t)
1532 (delete-region (point) (line-beginning-position)))
1533 ;; BS -> delete preceding character
1534 (goto-char comint-last-output-start)
1535 (while (search-forward "\b" pmark t)
1536 (delete-char -2)))))))))
1537
1538(add-hook 'comint-output-filter-functions 'comint-carriage-motion)
80c40c6f 1539
3ee91e68 1540;; The purpose of using this filter for comint processes
5511e411
RS
1541;; is to keep comint-last-input-end from moving forward
1542;; when output is inserted.
3ee91e68 1543(defun comint-output-filter (process string)
91d75282 1544 (let ((oprocbuf (process-buffer process)))
2c8e6211
GM
1545 ;; First check for killed buffer or no input.
1546 (when (and string oprocbuf (buffer-name oprocbuf))
1547 (with-current-buffer oprocbuf
867102f2 1548 ;; Run preoutput filters
2c8e6211
GM
1549 (let ((functions comint-preoutput-filter-functions))
1550 (while (and functions string)
1551 (setq string (funcall (car functions) string))
1552 (setq functions (cdr functions))))
91d75282 1553
d8d972bf
MB
1554 ;; Insert STRING
1555 (let ((buffer-read-only nil)
1556 ;; Avoid the overhead of save-excursion, since we just
1557 ;; fiddle with the point
5d9045ed 1558 (saved-point (point-marker)))
d8d972bf 1559
5484005d
MB
1560 ;; The point should float after any insertion we do
1561 (set-marker-insertion-type saved-point t)
1562
d8d972bf
MB
1563 ;; We temporarly remove any buffer narrowing, in case the
1564 ;; process mark is outside of the restriction
1565 (save-restriction
1566 (widen)
1567
1568 (goto-char (process-mark process))
1569 (set-marker comint-last-output-start (point))
1570
bdf08678
MB
1571 ;; insert-before-markers is a bad thing. XXX
1572 ;;
1573 ;; It is used here to force window-point markers (used to
1574 ;; store the value of point in non-selected windows) to
1575 ;; advance, but it also screws up any other markers that we
1576 ;; don't _want_ to advance, such as the start-marker of some
1577 ;; of the overlays we create.
1578 ;;
1579 ;; We work around the problem with the overlays by
1580 ;; explicitly adjusting them after we do the insertion, but
1581 ;; in the future this problem should be solved correctly, by
1582 ;; using `insert', and making the insertion-type of
1583 ;; window-point markers settable (via a buffer-local
1584 ;; variable). In comint buffers, this variable would be set
1585 ;; to `t', to cause point in non-select windows to advance.
1586 (insert-before-markers string)
1587 ;; Fixup markers and overlays that got screwed up because we
1588 ;; used `insert-before-markers'.
1589 (let ((old-point (- (point) (length string))))
1e317a4a 1590 ;; comint-last-output-start
bdf08678 1591 (set-marker comint-last-output-start old-point)
1e317a4a
MB
1592 ;; comint-last-input-end
1593 (when (and comint-last-input-end
1594 (equal (marker-position comint-last-input-end)
1595 (point)))
1596 (set-marker comint-last-input-end old-point))
bdf08678
MB
1597 ;; No overlays we create are set to advance upon insertion
1598 ;; (at the start/end), so we assume that any overlay which
1599 ;; is at the current point was incorrectly advanced by
1600 ;; insert-before-markers. First fixup overlays that might
1601 ;; start at point:
1602 (dolist (over (overlays-at (point)))
1603 (when (= (overlay-start over) (point))
1604 (let ((end (overlay-end over)))
1605 (move-overlay over
1606 old-point
1607 (if (= end (point)) old-point end)))))
1608 ;; Then do overlays that might end at point:
1609 (dolist (over (overlays-at (1- (point))))
1610 (when (= (overlay-end over) (point))
1611 (move-overlay over
1612 (min (overlay-start over) old-point)
1613 old-point))))
1614
1615 ;; Advance process-mark
d8d972bf
MB
1616 (set-marker (process-mark process) (point))
1617
1618 (unless comint-use-prompt-regexp-instead-of-fields
1619 ;; We check to see if the last overlay used for output is
1620 ;; adjacent to the new input, and if so, just extend it.
1621 (if (and comint-last-output-overlay
1622 (equal (overlay-end comint-last-output-overlay)
5484005d 1623 (marker-position comint-last-output-start)))
d8d972bf
MB
1624 ;; Extend comint-last-output-overlay to include the
1625 ;; most recent output
1626 (move-overlay comint-last-output-overlay
1627 (overlay-start comint-last-output-overlay)
1628 (point))
1629 ;; Create a new overlay
1630 (let ((over (make-overlay comint-last-output-start (point))))
1631 (overlay-put over 'field 'output)
d8d972bf
MB
1632 (overlay-put over 'inhibit-line-move-field-capture t)
1633 (overlay-put over 'evaporate t)
1634 (setq comint-last-output-overlay over))))
1635
1636 (when comint-highlight-prompt
1637 ;; Highlight the prompt, where we define `prompt' to mean
1638 ;; the most recent output that doesn't end with a newline.
1639 (unless (and (bolp) (null comint-last-prompt-overlay))
1640 ;; Need to create or move the prompt overlay (in the case
1641 ;; where there is no prompt ((bolp) == t), we still do
1642 ;; this if there's already an existing overlay).
1643 (let ((prompt-start (save-excursion (forward-line 0) (point))))
1644 (if comint-last-prompt-overlay
1645 ;; Just move an existing overlay
1646 (move-overlay comint-last-prompt-overlay
1647 prompt-start (point))
1648 ;; Need to create the overlay
c7c800d8
MB
1649 (setq comint-last-prompt-overlay
1650 (make-overlay prompt-start (point)))
1651 (overlay-put comint-last-prompt-overlay
1652 'face 'comint-highlight-prompt)))))
d8d972bf 1653
d8d972bf
MB
1654 (goto-char saved-point)
1655
1656 (run-hook-with-args 'comint-output-filter-functions string)))))))
3ee91e68 1657
c1da5c03 1658(defun comint-preinput-scroll-to-bottom ()
3ee91e68
RS
1659 "Go to the end of buffer in all windows showing it.
1660Movement occurs if point in the selected window is not after the process mark,
1661and `this-command' is an insertion command. Insertion commands recognised
d637fa56 1662are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
3ee91e68
RS
1663Depends on the value of `comint-scroll-to-bottom-on-input'.
1664
c1da5c03 1665This function should be a pre-command hook."
3ee91e68 1666 (if (and comint-scroll-to-bottom-on-input
91d75282 1667 (memq this-command '(self-insert-command comint-magic-space yank
d637fa56 1668 hilit-yank)))
3ee91e68
RS
1669 (let* ((selected (selected-window))
1670 (current (current-buffer))
1671 (process (get-buffer-process current))
1672 (scroll comint-scroll-to-bottom-on-input))
d637fa56 1673 (if (and process (< (point) (process-mark process)))
0744bf64
RS
1674 (if (eq scroll 'this)
1675 (goto-char (point-max))
1676 (walk-windows
1677 (function (lambda (window)
1678 (if (and (eq (window-buffer window) current)
d637fa56 1679 (or (eq scroll t) (eq scroll 'all)))
0744bf64
RS
1680 (progn
1681 (select-window window)
1682 (goto-char (point-max))
1683 (select-window selected)))))
d637fa56 1684 nil t))))))
3ee91e68 1685
c1da5c03 1686(defun comint-postoutput-scroll-to-bottom (string)
3ee91e68
RS
1687 "Go to the end of buffer in all windows showing it.
1688Does not scroll if the current line is the last line in the buffer.
1689Depends on the value of `comint-scroll-to-bottom-on-output' and
1690`comint-scroll-show-maximum-output'.
1691
fb9ab28a 1692This function should be in the list `comint-output-filter-functions'."
3ee91e68
RS
1693 (let* ((selected (selected-window))
1694 (current (current-buffer))
1695 (process (get-buffer-process current))
1696 (scroll comint-scroll-to-bottom-on-output))
d637fa56
RS
1697 (unwind-protect
1698 (if process
1699 (walk-windows
1700 (function (lambda (window)
1701 (if (eq (window-buffer window) current)
1702 (progn
1703 (select-window window)
1704 (if (and (< (point) (process-mark process))
1705 (or (eq scroll t) (eq scroll 'all)
107d7589 1706 ;; Maybe user wants point to jump to end.
d637fa56
RS
1707 (and (eq scroll 'this) (eq selected window))
1708 (and (eq scroll 'others) (not (eq selected window)))
107d7589 1709 ;; If point was at the end, keep it at end.
814299a7
MB
1710 (and (marker-position comint-last-output-start)
1711 (>= (point) comint-last-output-start))))
d637fa56
RS
1712 (goto-char (process-mark process)))
1713 ;; Optionally scroll so that the text
1714 ;; ends at the bottom of the window.
1715 (if (and comint-scroll-show-maximum-output
1716 (>= (point) (process-mark process)))
1717 (save-excursion
1718 (goto-char (point-max))
1719 (recenter -1)))
1720 (select-window selected)))))
1721 nil t))
1722 (set-buffer current))))
3ee91e68 1723
39a185a9
SM
1724(defun comint-truncate-buffer (&optional string)
1725 "Truncate the buffer to `comint-buffer-maximum-size'.
1726This function could be on `comint-output-filter-functions' or bound to a key."
1727 (interactive)
1728 (save-excursion
107d7589 1729 (goto-char (process-mark (get-buffer-process (current-buffer))))
39a185a9
SM
1730 (forward-line (- comint-buffer-maximum-size))
1731 (beginning-of-line)
1732 (delete-region (point-min) (point))))
1733
efcec33f
RS
1734(defun comint-strip-ctrl-m (&optional string)
1735 "Strip trailing `^M' characters from the current output group.
39a185a9 1736This function could be on `comint-output-filter-functions' or bound to a key."
efcec33f
RS
1737 (interactive)
1738 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1739 (save-excursion
71a895c6
KH
1740 (condition-case nil
1741 (goto-char
1742 (if (interactive-p) comint-last-input-end comint-last-output-start))
1743 (error nil))
efcec33f
RS
1744 (while (re-search-forward "\r+$" pmark t)
1745 (replace-match "" t t)))))
1746(defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1747
3ee91e68
RS
1748(defun comint-show-maximum-output ()
1749 "Put the end of the buffer at the bottom of the window."
1750 (interactive)
1751 (goto-char (point-max))
1752 (recenter -1))
5511e411 1753
be9b65ac 1754(defun comint-get-old-input-default ()
cccd719e 1755 "Default for `comint-get-old-input'.
29533923
MB
1756Returns either the current field, or the current line with any initial
1757text matching `comint-prompt-regexp' stripped off, depending on the
1758value of `comint-use-prompt-regexp-instead-of-fields'."
1759 (if comint-use-prompt-regexp-instead-of-fields
1760 (save-excursion
1761 (beginning-of-line)
1762 (comint-skip-prompt)
1763 (let ((beg (point)))
1764 (end-of-line)
1765 (buffer-substring beg (point))))
1766 ;; Return the contents of the field at the current point.
1ec321a7
MB
1767 (let ((pos (field-beginning (point))))
1768 (unless (eq (get-char-property pos 'field) 'input)
20770192 1769 (error "Not an input field"))
1ec321a7 1770 (field-string pos))))
49116ac0 1771
3ee91e68
RS
1772(defun comint-copy-old-input ()
1773 "Insert after prompt old input at point as new input to be edited.
1774Calls `comint-get-old-input' to get old input."
1775 (interactive)
1776 (let ((input (funcall comint-get-old-input))
814299a7 1777 (process (get-buffer-process (current-buffer))))
3ee91e68
RS
1778 (if (not process)
1779 (error "Current buffer has no process")
1780 (goto-char (process-mark process))
1781 (insert input))))
1782
49116ac0 1783(defun comint-skip-prompt ()
cccd719e 1784 "Skip past the text matching regexp `comint-prompt-regexp'.
49116ac0
JB
1785If this takes us past the end of the current line, don't skip at all."
1786 (let ((eol (save-excursion (end-of-line) (point))))
1787 (if (and (looking-at comint-prompt-regexp)
1788 (<= (match-end 0) eol))
1789 (goto-char (match-end 0)))))
1790
49116ac0 1791(defun comint-after-pmark-p ()
3ee91e68
RS
1792 "Return t if point is after the process output marker."
1793 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1794 (<= (marker-position pmark) (point))))
49116ac0
JB
1795
1796(defun comint-simple-send (proc string)
1797 "Default function for sending to PROC input STRING.
1798This just sends STRING plus a newline. To override this,
cccd719e 1799set the hook `comint-input-sender'."
49116ac0
JB
1800 (comint-send-string proc string)
1801 (comint-send-string proc "\n"))
be9b65ac 1802
29533923
MB
1803(defun comint-line-beginning-position ()
1804 "Returns the buffer position of the beginning of the line, after any prompt.
1805If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1806prompt skip is done by skipping text matching the regular expression
1807`comint-prompt-regexp', a buffer local variable."
1808 (if comint-use-prompt-regexp-instead-of-fields
1809 ;; Use comint-prompt-regexp
1810 (save-excursion
1811 (beginning-of-line)
1812 (comint-skip-prompt)
1813 (point))
1814 ;; Use input fields. Note that, unlike the behavior of
1815 ;; `line-beginning-position' inside a field, this function will
1816 ;; return the position of the end of a prompt, even if the point is
1817 ;; already inside the prompt. In order to do this, it assumes that
1818 ;; if there are two fields on a line, then the first one is the
1819 ;; prompt, and the second one is an input field, and is front-sticky
1820 ;; (as input fields should be).
1821 (constrain-to-field (line-beginning-position) (line-end-position))))
1822
1823(defun comint-bol (&optional arg)
be9b65ac 1824 "Goes to the beginning of line, then skips past the prompt, if any.
29533923
MB
1825If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1826If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1827prompt skip is done by skipping text matching the regular expression
a77db92b 1828`comint-prompt-regexp', a buffer local variable."
be9b65ac 1829 (interactive "P")
29533923 1830 (if arg
1cc9bc49
MB
1831 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1832 (forward-line 0)
29533923 1833 (goto-char (comint-line-beginning-position))))
be9b65ac 1834
b578f267
EN
1835;; These three functions are for entering text you don't want echoed or
1836;; saved -- typically passwords to ftp, telnet, or somesuch.
1837;; Just enter m-x send-invisible and type in your line, or add
1838;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
49116ac0 1839
87ef29fd 1840(defun comint-read-noecho (prompt &optional stars)
814299a7 1841 "Read a single line of text from user without echoing, and return it.
4be9a25f
NF
1842Prompt with argument PROMPT, a string. Optional argument STARS causes
1843input to be echoed with '*' characters on the prompt line. Input ends with
1844RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
cccd719e
RS
1845`inhibit-quit' is set because e.g. this function was called from a process
1846filter and C-g is pressed, this function returns nil rather than a string).
4be9a25f
NF
1847
1848Note that the keystrokes comprising the text can still be recovered
dc81e166
RS
1849\(temporarily) with \\[view-lossage]. Some people find this worrysome.
1850Once the caller uses the password, it can erase the password
1851by doing (fillarray STRING 0)."
4be9a25f 1852 (let ((ans "")
dc81e166 1853 (newans nil)
4be9a25f
NF
1854 (c 0)
1855 (echo-keystrokes 0)
87ef29fd 1856 (cursor-in-echo-area t)
23cb053e
KH
1857 (message-log-max nil)
1858 (done nil))
4be9a25f
NF
1859 (while (not done)
1860 (if stars
84a99e73
KH
1861 (message "%s%s" prompt (make-string (length ans) ?*))
1862 (message "%s" prompt))
af171fd0
RS
1863 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1864 (setq c (read-char-exclusive))
4be9a25f 1865 (cond ((= c ?\C-g)
59f36b08
SM
1866 ;; This function may get called from a process filter, where
1867 ;; inhibit-quit is set. In later versions of emacs read-char
1868 ;; may clear quit-flag itself and return C-g. That would make
1869 ;; it impossible to quit this loop in a simple way, so
1870 ;; re-enable it here (for backward-compatibility the check for
1871 ;; quit-flag below would still be necessary, so this seems
1872 ;; like the simplest way to do things).
1873 (setq quit-flag t
1874 done t))
1875 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1876 (setq done t))
1877 ((= c ?\C-u)
dc81e166 1878 (fillarray ans 0)
59f36b08
SM
1879 (setq ans ""))
1880 ((and (/= c ?\b) (/= c ?\177))
dc81e166
RS
1881 (setq newans (concat ans (char-to-string c)))
1882 (fillarray ans 0)
1883 (setq ans newans))
59f36b08 1884 ((> (length ans) 0)
dc81e166 1885 (aset ans (1- (length ans)) 0)
59f36b08 1886 (setq ans (substring ans 0 -1)))))
4be9a25f 1887 (if quit-flag
814299a7
MB
1888 ;; Emulate a true quit, except that we have to return a value.
1889 (prog1
1890 (setq quit-flag nil)
1891 (message "Quit")
1892 (beep t))
4be9a25f
NF
1893 (message "")
1894 ans)))
87ef29fd 1895
be9b65ac 1896(defun send-invisible (str)
c2ced5d8 1897 "Read a string without echoing.
6152f5f0
SM
1898Then send it to the process running in the current buffer.
1899The string is sent using `comint-input-sender'.
49116ac0
JB
1900Security bug: your string can still be temporarily recovered with
1901\\[view-lossage]."
4a11114d 1902 (interactive "P") ; Defeat snooping via C-x ESC ESC
be9b65ac 1903 (let ((proc (get-buffer-process (current-buffer))))
4a11114d
SM
1904 (cond ((not proc)
1905 (error "Current buffer has no process"))
1906 ((stringp str)
3db4b719 1907 (comint-snapshot-last-prompt)
4a11114d
SM
1908 (funcall comint-input-sender proc str))
1909 (t
1910 (let ((str (comint-read-noecho "Non-echoed text: " t)))
1911 (if (stringp str)
1912 (send-invisible str)
1913 (message "Warning: text will be echoed")))))))
21d9bf27 1914
814299a7 1915(defun comint-watch-for-password-prompt (string)
21d9bf27
RS
1916 "Prompt in the minibuffer for password and send without echoing.
1917This function uses `send-invisible' to read and send a password to the buffer's
814299a7 1918process if STRING contains a password prompt defined by
654d89d7 1919`comint-password-prompt-regexp'.
21d9bf27
RS
1920
1921This function could be in the list `comint-output-filter-functions'."
2464210e
MB
1922 (when (string-match comint-password-prompt-regexp string)
1923 (let ((pw (comint-read-noecho string t)))
1924 (send-invisible pw))))
be9b65ac 1925\f
b578f267 1926;; Low-level process communication
be9b65ac 1927
79e8dca7
MB
1928(defun comint-send-string (process string)
1929 "Like `process-send-string', but also does extra bookkeeping for comint mode."
9f626345
MB
1930 (if process
1931 (with-current-buffer (if (processp process)
1932 (process-buffer process)
1933 (get-buffer process))
1934 (comint-snapshot-last-prompt))
79e8dca7
MB
1935 (comint-snapshot-last-prompt))
1936 (process-send-string process string))
1937
1938(defun comint-send-region (process start end)
1939 "Like `process-send-region', but also does extra bookkeeping for comint mode."
9f626345
MB
1940 (if process
1941 (with-current-buffer (if (processp process)
1942 (process-buffer process)
1943 (get-buffer process))
1944 (comint-snapshot-last-prompt))
79e8dca7
MB
1945 (comint-snapshot-last-prompt))
1946 (process-send-region process start end))
be9b65ac 1947\f
b578f267 1948;; Random input hackage
be9b65ac 1949
4e217e50 1950(defun comint-delete-output ()
d134a19f 1951 "Delete all output from interpreter since last input.
3ee91e68 1952Does not delete the prompt."
be9b65ac 1953 (interactive)
a9a6f83f
RS
1954 (let ((proc (get-buffer-process (current-buffer)))
1955 (replacement nil))
1956 (save-excursion
1957 (let ((pmark (progn (goto-char (process-mark proc))
1e317a4a 1958 (forward-line 0)
a9a6f83f
RS
1959 (point-marker))))
1960 (delete-region comint-last-input-end pmark)
37a9a675 1961 (goto-char (process-mark proc))
a9a6f83f
RS
1962 (setq replacement (concat "*** output flushed ***\n"
1963 (buffer-substring pmark (point))))
1964 (delete-region pmark (point))))
1965 ;; Output message and put back prompt
1966 (comint-output-filter proc replacement)))
4e217e50
MB
1967(defalias 'comint-kill-output 'comint-delete-output)
1968(make-obsolete 'comint-kill-output 'comint-delete-output "21.1")
be9b65ac 1969
0da5c14a 1970(defun comint-write-output (filename &optional append mustbenew)
d134a19f
MB
1971 "Write output from interpreter since last input to FILENAME.
1972Any prompt at the end of the output is not written.
1973
0da5c14a
MB
1974If the optional argument APPEND (the prefix argument when interactive)
1975is non-nil, the output is appended to the file instead.
1976
1977If the optional argument MUSTBENEW is non-nil, check for an existing
1978file with the same name. If MUSTBENEW is `excl', that means to get an
1979error if the file already exists; never overwrite. If MUSTBENEW is
1980neither nil nor `excl', that means ask for confirmation before
1981overwriting, but do go ahead and overwrite the file if the user
1982confirms. When interactive, MUSTBENEW is nil when appending, and t
1983otherwise."
1984 (interactive
1985 (list (read-file-name
1986 (if current-prefix-arg
1987 "Append output to file: "
1988 "Write output to file: "))
1989 current-prefix-arg
1990 (not current-prefix-arg)))
d134a19f
MB
1991 (save-excursion
1992 (goto-char (process-mark (get-buffer-process (current-buffer))))
1993 (forward-line 0)
0da5c14a
MB
1994 (write-region comint-last-input-end (point) filename
1995 append nil nil mustbenew)))
d134a19f 1996
44016d25
MB
1997;; This function exists for the benefit of the menu; from the keyboard,
1998;; users can just use `comint-write-output' with a prefix arg.
1999(defun comint-append-output-to-file (filename)
2000 "Append output from interpreter since last input to FILENAME.
2001Any prompt at the end of the output is not written."
2002 (interactive "fAppend output to file: ")
2003 (comint-write-output filename t))
2004
be9b65ac 2005(defun comint-show-output ()
49116ac0 2006 "Display start of this batch of interpreter output at top of window.
21d9bf27 2007Sets mark to the value of point when this command is run."
be9b65ac 2008 (interactive)
815c1a20 2009 (push-mark)
29533923
MB
2010 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2011 (cond (comint-use-prompt-regexp-instead-of-fields
2012 (goto-char pos)
2013 (beginning-of-line 0)
2014 (set-window-start (selected-window) (point))
2015 (comint-skip-prompt))
2016 (t
2017 (goto-char (field-beginning pos))
2018 (set-window-start (selected-window) (point))))))
2019
be9b65ac
DL
2020
2021(defun comint-interrupt-subjob ()
1a94abea
RS
2022 "Interrupt the current subjob.
2023This command also kills the pending input
2024between the process-mark and point."
be9b65ac 2025 (interactive)
1a94abea 2026 (comint-kill-input)
49116ac0 2027 (interrupt-process nil comint-ptyp))
be9b65ac
DL
2028
2029(defun comint-kill-subjob ()
1a94abea
RS
2030 "Send kill signal to the current subjob.
2031This command also kills the pending input
2032between the process-mark and point."
be9b65ac 2033 (interactive)
1a94abea 2034 (comint-kill-input)
49116ac0 2035 (kill-process nil comint-ptyp))
be9b65ac
DL
2036
2037(defun comint-quit-subjob ()
1a94abea
RS
2038 "Send quit signal to the current subjob.
2039This command also kills the pending input
2040between the process-mark and point."
be9b65ac 2041 (interactive)
1a94abea 2042 (comint-kill-input)
49116ac0 2043 (quit-process nil comint-ptyp))
be9b65ac
DL
2044
2045(defun comint-stop-subjob ()
49116ac0 2046 "Stop the current subjob.
1a94abea
RS
2047This command also kills the pending input
2048between the process-mark and point.
2049
be9b65ac 2050WARNING: if there is no current subjob, you can end up suspending
49116ac0
JB
2051the top-level process running in the buffer. If you accidentally do
2052this, use \\[comint-continue-subjob] to resume the process. (This
2053is not a problem with most shells, since they ignore this signal.)"
be9b65ac 2054 (interactive)
1a94abea 2055 (comint-kill-input)
49116ac0 2056 (stop-process nil comint-ptyp))
be9b65ac
DL
2057
2058(defun comint-continue-subjob ()
49116ac0 2059 "Send CONT signal to process buffer's process group.
be9b65ac
DL
2060Useful if you accidentally suspend the top-level process."
2061 (interactive)
49116ac0 2062 (continue-process nil comint-ptyp))
be9b65ac
DL
2063
2064(defun comint-kill-input ()
49116ac0 2065 "Kill all text from last stuff output by interpreter to point."
be9b65ac 2066 (interactive)
3ee91e68
RS
2067 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2068 (if (> (point) (marker-position pmark))
49116ac0 2069 (kill-region pmark (point)))))
be9b65ac
DL
2070
2071(defun comint-delchar-or-maybe-eof (arg)
4a11114d
SM
2072 "Delete ARG characters forward or send an EOF to subprocess.
2073Sends an EOF only if point is at the end of the buffer and there is no input."
be9b65ac 2074 (interactive "p")
90d6bfb9
KH
2075 (let ((proc (get-buffer-process (current-buffer))))
2076 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
3db4b719 2077 (comint-send-eof)
4a11114d 2078 (delete-char arg))))
49116ac0 2079
1de80a34
RM
2080(defun comint-send-eof ()
2081 "Send an EOF to the current buffer's process."
2082 (interactive)
3db4b719 2083 (comint-snapshot-last-prompt)
1de80a34 2084 (process-send-eof))
49116ac0 2085
3ee91e68
RS
2086
2087(defun comint-backward-matching-input (regexp arg)
29533923
MB
2088 "Search backward through buffer for input fields that match REGEXP.
2089If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2090fields are identified by lines that match `comint-prompt-regexp'.
2091
3ee91e68
RS
2092With prefix argument N, search for Nth previous match.
2093If N is negative, find the next or Nth next match."
2094 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
29533923
MB
2095 (if comint-use-prompt-regexp-instead-of-fields
2096 ;; Use comint-prompt-regexp
2097 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2098 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2099 (if (re-search-backward re nil t arg)
2100 (point)))))
2101 (if (null pos)
2102 (progn (message "Not found")
2103 (ding))
2104 (goto-char pos)
2105 (comint-bol nil)))
2106 ;; Use input fields
2107 (let* ((dir (if (< arg 0) -1 1))
2108 (pos
2109 (save-excursion
2110 (while (/= arg 0)
2111 (unless (re-search-backward regexp nil t dir)
2112 (error "Not found"))
2113 (when (eq (get-char-property (point) 'field) 'input)
2114 (setq arg (- arg dir))))
2115 (field-beginning))))
2116 (goto-char pos))))
2117
3ee91e68
RS
2118
2119(defun comint-forward-matching-input (regexp arg)
29533923
MB
2120 "Search forward through buffer for input fields that match REGEXP.
2121If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2122fields are identified by lines that match `comint-prompt-regexp'.
2123
3ee91e68
RS
2124With prefix argument N, search for Nth following match.
2125If N is negative, find the previous or Nth previous match."
2126 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2127 (comint-backward-matching-input regexp (- arg)))
2128
2129
1de80a34 2130(defun comint-next-prompt (n)
3ee91e68 2131 "Move to end of Nth next prompt in the buffer.
29533923
MB
2132If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2133the beginning of the Nth next `input' field, otherwise, it means the Nth
2134occurance of text matching `comint-prompt-regexp'."
1de80a34 2135 (interactive "p")
29533923
MB
2136 (if comint-use-prompt-regexp-instead-of-fields
2137 ;; Use comint-prompt-regexp
2138 (let ((paragraph-start comint-prompt-regexp))
2139 (end-of-line (if (> n 0) 1 0))
2140 (forward-paragraph n)
2141 (comint-skip-prompt))
2142 ;; Use input fields
2143 (let ((pos (point))
2144 (input-pos nil))
2145 (while (/= n 0)
2146 (setq pos
2147 (if (> n 0)
2148 (next-single-char-property-change pos 'field)
2149 (previous-single-char-property-change pos 'field)))
2150 (cond ((null pos)
2151 ;; Ran off the end of the buffer.
2152 (setq n 0))
2153 ((eq (get-char-property pos 'field) 'input)
2154 (setq n (if (< n 0) (1+ n) (1- n)))
2155 (setq input-pos pos))))
2156 (when input-pos
2157 (goto-char input-pos)))))
2158
49116ac0 2159
3ee91e68
RS
2160(defun comint-previous-prompt (n)
2161 "Move to end of Nth previous prompt in the buffer.
29533923
MB
2162If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2163the beginning of the Nth previous `input' field, otherwise, it means the Nth
2164occurance of text matching `comint-prompt-regexp'."
1de80a34 2165 (interactive "p")
3ee91e68 2166 (comint-next-prompt (- n)))
be9b65ac 2167\f
b578f267
EN
2168;; Support for source-file processing commands.
2169;;============================================================================
2170;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2171;; commands that process files of source text (e.g. loading or compiling
2172;; files). So the corresponding process-in-a-buffer modes have commands
2173;; for doing this (e.g., lisp-load-file). The functions below are useful
2174;; for defining these commands.
2175;;
2176;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2177;; and Soar, in that they don't know anything about file extensions.
2178;; So the compile/load interface gets the wrong default occasionally.
2179;; The load-file/compile-file default mechanism could be smarter -- it
2180;; doesn't know about the relationship between filename extensions and
2181;; whether the file is source or executable. If you compile foo.lisp
2182;; with compile-file, then the next load-file should use foo.bin for
2183;; the default, not foo.lisp. This is tricky to do right, particularly
2184;; because the extension for executable files varies so much (.o, .bin,
2185;; .lbin, .mo, .vo, .ao, ...).
2186
2187
2188;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2189;; commands.
2190;;
2191;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2192;; want to save the buffer before issuing any process requests to the command
2193;; interpreter.
2194;;
2195;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2196;; for the file to process.
2197
2198;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2199;;============================================================================
2200;; This function computes the defaults for the load-file and compile-file
814299a7
MB
2201;; commands for tea, soar, cmulisp, and cmuscheme modes.
2202;;
2203;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
b578f267
EN
2204;; source-file processing command. NIL if there hasn't been one yet.
2205;; - SOURCE-MODES is a list used to determine what buffers contain source
2206;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2207;; Typically, (lisp-mode) or (scheme-mode).
814299a7 2208;;
b578f267
EN
2209;; If the command is given while the cursor is inside a string, *and*
2210;; the string is an existing filename, *and* the filename is not a directory,
2211;; then the string is taken as default. This allows you to just position
2212;; your cursor over a string that's a filename and have it taken as default.
2213;;
2214;; If the command is given in a file buffer whose major mode is in
2215;; SOURCE-MODES, then the the filename is the default file, and the
2216;; file's directory is the default directory.
814299a7 2217;;
b578f267
EN
2218;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2219;; then the default directory & file are what was used in the last source-file
2220;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2221;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2222;; is the cwd, with no default file. (\"no default file\" = nil)
814299a7 2223;;
b578f267
EN
2224;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2225;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2226;; for Soar programs, etc.
814299a7 2227;;
b578f267 2228;; The function returns a pair: (default-directory . default-file).
be9b65ac
DL
2229
2230(defun comint-source-default (previous-dir/file source-modes)
2231 (cond ((and buffer-file-name (memq major-mode source-modes))
2232 (cons (file-name-directory buffer-file-name)
2233 (file-name-nondirectory buffer-file-name)))
2234 (previous-dir/file)
2235 (t
2236 (cons default-directory nil))))
2237
49116ac0 2238
b578f267
EN
2239;; (COMINT-CHECK-SOURCE fname)
2240;;============================================================================
2241;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2242;; process-in-a-buffer modes), this function can be called on the filename.
2243;; If the file is loaded into a buffer, and the buffer is modified, the user
2244;; is queried to see if he wants to save the buffer before proceeding with
2245;; the load or compile.
be9b65ac
DL
2246
2247(defun comint-check-source (fname)
2248 (let ((buff (get-file-buffer fname)))
2249 (if (and buff
2250 (buffer-modified-p buff)
3ee91e68 2251 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
be9b65ac
DL
2252 ;; save BUFF.
2253 (let ((old-buffer (current-buffer)))
2254 (set-buffer buff)
2255 (save-buffer)
2256 (set-buffer old-buffer)))))
2257
49116ac0 2258
b578f267
EN
2259;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2260;;============================================================================
2261;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2262;; commands that process source files (like loading or compiling a file).
2263;; It prompts for the filename, provides a default, if there is one,
2264;; and returns the result filename.
814299a7 2265;;
b578f267 2266;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
814299a7 2267;;
b578f267
EN
2268;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2269;; from the last source processing command. SOURCE-MODES is a list of major
2270;; modes used to determine what file buffers contain source files. (These
2271;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2272;; then the filename reader will only accept a file that exists.
814299a7 2273;;
b578f267
EN
2274;; A typical use:
2275;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2276;; '(lisp-mode) t))
2277
2278;; This is pretty stupid about strings. It decides we're in a string
2279;; if there's a quote on both sides of point on the current line.
be9b65ac 2280(defun comint-extract-string ()
814299a7 2281 "Return string around POINT that starts the current line, or nil."
be9b65ac
DL
2282 (save-excursion
2283 (let* ((point (point))
2284 (bol (progn (beginning-of-line) (point)))
2285 (eol (progn (end-of-line) (point)))
814299a7
MB
2286 (start (progn (goto-char point)
2287 (and (search-backward "\"" bol t)
be9b65ac
DL
2288 (1+ (point)))))
2289 (end (progn (goto-char point)
2290 (and (search-forward "\"" eol t)
2291 (1- (point))))))
2292 (and start end
2293 (buffer-substring start end)))))
2294
2295(defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2296 (let* ((def (comint-source-default prev-dir/file source-modes))
814299a7 2297 (stringfile (comint-extract-string))
be9b65ac 2298 (sfile-p (and stringfile
49116ac0
JB
2299 (condition-case ()
2300 (file-exists-p stringfile)
2301 (error nil))
be9b65ac
DL
2302 (not (file-directory-p stringfile))))
2303 (defdir (if sfile-p (file-name-directory stringfile)
814299a7 2304 (car def)))
be9b65ac 2305 (deffile (if sfile-p (file-name-nondirectory stringfile)
814299a7 2306 (cdr def)))
be9b65ac
DL
2307 (ans (read-file-name (if deffile (format "%s(default %s) "
2308 prompt deffile)
2309 prompt)
2310 defdir
2311 (concat defdir deffile)
2312 mustmatch-p)))
2313 (list (expand-file-name (substitute-in-file-name ans)))))
2314
b578f267
EN
2315;; I am somewhat divided on this string-default feature. It seems
2316;; to violate the principle-of-least-astonishment, in that it makes
2317;; the default harder to predict, so you actually have to look and see
2318;; what the default really is before choosing it. This can trip you up.
2319;; On the other hand, it can be useful, I guess. I would appreciate feedback
2320;; on this.
2321;; -Olin
49116ac0 2322
be9b65ac 2323\f
b578f267
EN
2324;; Simple process query facility.
2325;; ===========================================================================
2326;; This function is for commands that want to send a query to the process
2327;; and show the response to the user. For example, a command to get the
2328;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2329;; to an inferior Common Lisp process.
814299a7 2330;;
b578f267
EN
2331;; This simple facility just sends strings to the inferior process and pops
2332;; up a window for the process buffer so you can see what the process
2333;; responds with. We don't do anything fancy like try to intercept what the
2334;; process responds with and put it in a pop-up window or on the message
2335;; line. We just display the buffer. Low tech. Simple. Works good.
2336
2337;; Send to the inferior process PROC the string STR. Pop-up but do not select
2338;; a window for the inferior process so that its response can be seen.
be9b65ac
DL
2339(defun comint-proc-query (proc str)
2340 (let* ((proc-buf (process-buffer proc))
2341 (proc-mark (process-mark proc)))
2342 (display-buffer proc-buf)
2343 (set-buffer proc-buf) ; but it's not the selected *window*
2344 (let ((proc-win (get-buffer-window proc-buf))
2345 (proc-pt (marker-position proc-mark)))
2346 (comint-send-string proc str) ; send the query
2347 (accept-process-output proc) ; wait for some output
2348 ;; Try to position the proc window so you can see the answer.
2349 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2350 ;; I don't know why. Wizards invited to improve it.
17193f89
SM
2351 (unless (pos-visible-in-window-p proc-pt proc-win)
2352 (let ((opoint (window-point proc-win)))
2353 (set-window-point proc-win proc-mark)
2354 (sit-for 0)
2355 (if (not (pos-visible-in-window-p opoint proc-win))
2356 (push-mark opoint)
2357 (set-window-point proc-win opoint)))))))
be9b65ac
DL
2358
2359\f
b578f267
EN
2360;; Filename/command/history completion in a buffer
2361;; ===========================================================================
2362;; Useful completion functions, courtesy of the Ergo group.
2363
2364;; Six commands:
2365;; comint-dynamic-complete Complete or expand command, filename,
2366;; history at point.
2367;; comint-dynamic-complete-filename Complete filename at point.
2368;; comint-dynamic-list-filename-completions List completions in help buffer.
2369;; comint-replace-by-expanded-filename Expand and complete filename at point;
2370;; replace with expanded/completed name.
2371;; comint-dynamic-simple-complete Complete stub given candidates.
2372
2373;; These are not installed in the comint-mode keymap. But they are
2374;; available for people who want them. Shell-mode installs them:
2375;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2376;; (define-key shell-mode-map "\M-?"
2377;; 'comint-dynamic-list-filename-completions)))
2378;;
2379;; Commands like this are fine things to put in load hooks if you
2380;; want them present in specific modes.
49116ac0 2381
ed366e87 2382(defcustom comint-completion-autolist nil
5ef2f81f 2383 "*If non-nil, automatically list possibilities on partial completion.
ed366e87
RS
2384This mirrors the optional behavior of tcsh."
2385 :type 'boolean
2386 :group 'comint-completion)
3ee91e68 2387
ed366e87 2388(defcustom comint-completion-addsuffix t
3ee91e68 2389 "*If non-nil, add a `/' to completed directories, ` ' to file names.
59f36b08
SM
2390If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2391DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
ed366e87 2392This mirrors the optional behavior of tcsh."
97342eb1 2393 :type '(choice (const :tag "None" nil)
51d001f7 2394 (const :tag "Add /" t)
97342eb1
DL
2395 (cons :tag "Suffix pair"
2396 (string :tag "Directory suffix")
2397 (string :tag "File suffix")))
ed366e87 2398 :group 'comint-completion)
3ee91e68 2399
ed366e87 2400(defcustom comint-completion-recexact nil
3ee91e68 2401 "*If non-nil, use shortest completion if characters cannot be added.
fdb7791d 2402This mirrors the optional behavior of tcsh.
3ee91e68 2403
ed366e87
RS
2404A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2405 :type 'boolean
2406 :group 'comint-completion)
3ee91e68 2407
ed366e87 2408(defcustom comint-completion-fignore nil
497513ad
RS
2409 "*List of suffixes to be disregarded during file completion.
2410This mirrors the optional behavior of bash and tcsh.
2411
ed366e87
RS
2412Note that this applies to `comint-dynamic-complete-filename' only."
2413 :type '(repeat (string :tag "Suffix"))
2414 :group 'comint-completion)
497513ad 2415
3ee91e68
RS
2416(defvar comint-file-name-prefix ""
2417 "Prefix prepended to absolute file names taken from process input.
2418This is used by comint's and shell's completion functions, and by shell's
2419directory tracking functions.")
be9b65ac 2420
2d4382e5 2421(defvar comint-file-name-chars
da418b28
GV
2422 (if (memq system-type '(ms-dos windows-nt))
2423 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2424 "~/A-Za-z0-9+@:_.$#%,={}-")
2d4382e5 2425 "String of characters valid in a file name.
af898b0f
RS
2426Note that all non-ASCII characters are considered valid in a file name
2427regardless of what this variable says.
107d7589
SM
2428
2429This is a good thing to set in mode hooks.")
2430
59f36b08 2431(defvar comint-file-name-quote-list nil
6d2a6ce6 2432 "List of characters to quote with `\\' when in a file name.
59f36b08
SM
2433
2434This is a good thing to set in mode hooks.")
2435
3ee91e68
RS
2436
2437(defun comint-directory (directory)
2438 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2439 (expand-file-name (if (file-name-absolute-p directory)
2440 (concat comint-file-name-prefix directory)
2441 directory)))
2442
2443
1b421826
RS
2444(defun comint-word (word-chars)
2445 "Return the word of WORD-CHARS at point, or nil if non is found.
2446Word constituents are considered to be those in WORD-CHARS, which is like the
af898b0f
RS
2447inside of a \"[...]\" (see `skip-chars-forward'),
2448plus all non-ASCII characters."
3ee91e68 2449 (save-excursion
59f36b08
SM
2450 (let ((non-word-chars (concat "[^\\\\" word-chars "]")) (here (point)))
2451 (while (and (re-search-backward non-word-chars nil 'move)
af898b0f
RS
2452 ;;(memq (char-after (point)) shell-file-name-quote-list)
2453 (or (>= (following-char) 128)
2454 (eq (preceding-char) ?\\)))
59f36b08 2455 (backward-char 1))
4288965c 2456 ;; Don't go forward over a word-char (this can happen if we're at bob).
17193f89
SM
2457 (when (or (not (bobp)) (looking-at non-word-chars))
2458 (forward-char 1))
4288965c 2459 ;; Set match-data to match the entire string.
17193f89 2460 (when (< (point) here)
e4947876 2461 (set-match-data (list (point) here))
17193f89 2462 (match-string 0)))))
3ee91e68 2463
7a35a067
RS
2464(defun comint-substitute-in-file-name (filename)
2465 "Return FILENAME with environment variables substituted.
2466Supports additional environment variable syntax of the command
2467interpreter (e.g., the percent notation of cmd.exe on NT)."
2468 (let ((name (substitute-in-file-name filename)))
2469 (if (memq system-type '(ms-dos windows-nt))
2470 (let (env-var-name
2471 env-var-val)
2472 (save-match-data
2473 (while (string-match "%\\([^\\\\/]*\\)%" name)
814299a7 2474 (setq env-var-name
7a35a067
RS
2475 (substring name (match-beginning 1) (match-end 1)))
2476 (setq env-var-val (if (getenv env-var-name)
2477 (getenv env-var-name)
2478 ""))
db7ae45b 2479 (setq name (replace-match env-var-val t t name))))))
7a35a067 2480 name))
3ee91e68 2481
1b421826
RS
2482(defun comint-match-partial-filename ()
2483 "Return the filename at point, or nil if non is found.
2484Environment variables are substituted. See `comint-word'."
2d4382e5 2485 (let ((filename (comint-word comint-file-name-chars)))
814299a7 2486 (and filename (comint-substitute-in-file-name
7a35a067 2487 (comint-unquote-filename filename)))))
59f36b08
SM
2488
2489
2490(defun comint-quote-filename (filename)
2491 "Return FILENAME with magic characters quoted.
2492Magic characters are those in `comint-file-name-quote-list'."
2493 (if (null comint-file-name-quote-list)
2494 filename
2495 (let ((regexp
2496 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2497 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2498 (save-match-data
2499 (while (string-match regexp filename)
2500 (setq filename (replace-match "\\1\\\\\\2" nil nil filename)))
2501 filename))))
2502
2503(defun comint-unquote-filename (filename)
2504 "Return FILENAME with quoted characters unquoted."
2505 (if (null comint-file-name-quote-list)
2506 filename
2507 (save-match-data
dbdfff7f
RS
2508 (let ((i 0))
2509 (while (string-match "\\\\\\(.\\)" filename i)
2510 (setq filename (replace-match "\\1" nil nil filename))
2511 (setq i (+ 1 (match-beginning 0)))))
59f36b08 2512 filename)))
be9b65ac 2513
49116ac0 2514
be9b65ac 2515(defun comint-dynamic-complete ()
1b421826
RS
2516 "Dynamically perform completion at point.
2517Calls the functions in `comint-dynamic-complete-functions' to perform
2518completion until a function returns non-nil, at which point completion is
2519assumed to have occurred."
3ee91e68 2520 (interactive)
155fd027 2521 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
3ee91e68
RS
2522
2523
2524(defun comint-dynamic-complete-filename ()
49116ac0 2525 "Dynamically complete the filename at point.
1b421826
RS
2526Completes if after a filename. See `comint-match-partial-filename' and
2527`comint-dynamic-complete-as-filename'.
3ee91e68
RS
2528This function is similar to `comint-replace-by-expanded-filename', except that
2529it won't change parts of the filename already entered in the buffer; it just
2530adds completion characters to the end of the filename. A completions listing
2531may be shown in a help buffer if completion is ambiguous.
2532
497513ad
RS
2533Completion is dependent on the value of `comint-completion-addsuffix',
2534`comint-completion-recexact' and `comint-completion-fignore', and the timing of
2535completions listing is dependent on the value of `comint-completion-autolist'.
1b421826
RS
2536
2537Returns t if successful."
3ee91e68 2538 (interactive)
17193f89
SM
2539 (when (comint-match-partial-filename)
2540 (unless (window-minibuffer-p (selected-window))
2541 (message "Completing file name..."))
2542 (comint-dynamic-complete-as-filename)))
1b421826
RS
2543
2544(defun comint-dynamic-complete-as-filename ()
2545 "Dynamically complete at point as a filename.
2546See `comint-dynamic-complete-filename'. Returns t if successful."
107d7589 2547 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
497513ad 2548 (completion-ignored-extensions comint-completion-fignore)
107d7589
SM
2549 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2550 ;; I think it was originally bound to solve file completion problems,
2551 ;; but subsequent changes may have made this unnecessary. sm.
2552 ;;(file-name-handler-alist nil)
81fb2771 2553 (minibuffer-p (window-minibuffer-p (selected-window)))
1b421826 2554 (success t)
17193f89
SM
2555 (dirsuffix (cond ((not comint-completion-addsuffix)
2556 "")
2557 ((not (consp comint-completion-addsuffix))
2558 (char-to-string directory-sep-char))
2559 (t
2560 (car comint-completion-addsuffix))))
2561 (filesuffix (cond ((not comint-completion-addsuffix)
2562 "")
2563 ((not (consp comint-completion-addsuffix))
2564 " ")
2565 (t
2566 (cdr comint-completion-addsuffix))))
f79f58bc
KH
2567 (filename (or (comint-match-partial-filename) ""))
2568 (pathdir (file-name-directory filename))
2569 (pathnondir (file-name-nondirectory filename))
2570 (directory (if pathdir (comint-directory pathdir) default-directory))
81fb2771 2571 (completion (file-name-completion pathnondir directory)))
3ee91e68 2572 (cond ((null completion)
814299a7 2573 (message "No completions of %s" filename)
1b421826 2574 (setq success nil))
814299a7
MB
2575 ((eq completion t) ; Means already completed "file".
2576 (insert filesuffix)
2577 (unless minibuffer-p
17193f89 2578 (message "Sole completion")))
814299a7
MB
2579 ((string-equal completion "") ; Means completion on "directory/".
2580 (comint-dynamic-list-filename-completions))
2581 (t ; Completion string returned.
2582 (let ((file (concat (file-name-as-directory directory) completion)))
59f36b08
SM
2583 (insert (comint-quote-filename
2584 (substring (directory-file-name completion)
2585 (length pathnondir))))
814299a7
MB
2586 (cond ((symbolp (file-name-completion completion directory))
2587 ;; We inserted a unique completion.
59f36b08 2588 (insert (if (file-directory-p file) dirsuffix filesuffix))
814299a7 2589 (unless minibuffer-p
17193f89 2590 (message "Completed")))
814299a7
MB
2591 ((and comint-completion-recexact comint-completion-addsuffix
2592 (string-equal pathnondir completion)
2593 (file-exists-p file))
2594 ;; It's not unique, but user wants shortest match.
2595 (insert (if (file-directory-p file) dirsuffix filesuffix))
2596 (unless minibuffer-p
17193f89 2597 (message "Completed shortest")))
814299a7
MB
2598 ((or comint-completion-autolist
2599 (string-equal pathnondir completion))
2600 ;; It's not unique, list possible completions.
2601 (comint-dynamic-list-filename-completions))
2602 (t
2603 (unless minibuffer-p
17193f89 2604 (message "Partially completed")))))))
1b421826 2605 success))
3ee91e68
RS
2606
2607
2608(defun comint-replace-by-expanded-filename ()
2609 "Dynamically expand and complete the filename at point.
2610Replace the filename with an expanded, canonicalised and completed replacement.
2611\"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2612with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2613removed, and the filename is made absolute instead of relative. For expansion
2614see `expand-file-name' and `substitute-in-file-name'. For completion see
2615`comint-dynamic-complete-filename'."
be9b65ac 2616 (interactive)
3ee91e68
RS
2617 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
2618 (comint-dynamic-complete-filename))
2619
2620
3ee91e68
RS
2621(defun comint-dynamic-simple-complete (stub candidates)
2622 "Dynamically complete STUB from CANDIDATES list.
2623This function inserts completion characters at point by completing STUB from
2624the strings in CANDIDATES. A completions listing may be shown in a help buffer
2625if completion is ambiguous.
2626
1b421826
RS
2627Returns nil if no completion was inserted.
2628Returns `sole' if completed with the only completion match.
2629Returns `shortest' if completed with the shortest of the completion matches.
2630Returns `partial' if completed as far as possible with the completion matches.
2631Returns `listed' if a completion listing was shown.
2632
3ee91e68 2633See also `comint-dynamic-complete-filename'."
107d7589 2634 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
59f36b08
SM
2635 (suffix (cond ((not comint-completion-addsuffix) "")
2636 ((not (consp comint-completion-addsuffix)) " ")
2637 (t (cdr comint-completion-addsuffix))))
3ee91e68
RS
2638 (candidates (mapcar (function (lambda (x) (list x))) candidates))
2639 (completions (all-completions stub candidates)))
be9b65ac 2640 (cond ((null completions)
814299a7 2641 (message "No completions of %s" stub)
1b421826 2642 nil)
814299a7
MB
2643 ((= 1 (length completions)) ; Gotcha!
2644 (let ((completion (car completions)))
2645 (if (string-equal completion stub)
2646 (message "Sole completion")
2647 (insert (substring completion (length stub)))
2648 (message "Completed"))
59f36b08 2649 (insert suffix)
1b421826 2650 'sole))
814299a7
MB
2651 (t ; There's no unique completion.
2652 (let ((completion (try-completion stub candidates)))
2653 ;; Insert the longest substring.
2654 (insert (substring completion (length stub)))
2655 (cond ((and comint-completion-recexact comint-completion-addsuffix
2656 (string-equal stub completion)
2657 (member completion completions))
2658 ;; It's not unique, but user wants shortest match.
2659 (insert suffix)
2660 (message "Completed shortest")
1b421826 2661 'shortest)
814299a7
MB
2662 ((or comint-completion-autolist
2663 (string-equal stub completion))
2664 ;; It's not unique, list possible completions.
2665 (comint-dynamic-list-completions completions)
1b421826 2666 'listed)
814299a7 2667 (t
1b421826
RS
2668 (message "Partially completed")
2669 'partial)))))))
3ee91e68
RS
2670
2671
2672(defun comint-dynamic-list-filename-completions ()
2673 "List in help buffer possible completions of the filename at point."
2674 (interactive)
107d7589
SM
2675 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
2676 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2677 ;; I think it was originally bound to solve file completion problems,
2678 ;; but subsequent changes may have made this unnecessary. sm.
2679 ;;(file-name-handler-alist nil)
1b421826 2680 (filename (or (comint-match-partial-filename) ""))
3ee91e68
RS
2681 (pathdir (file-name-directory filename))
2682 (pathnondir (file-name-nondirectory filename))
2683 (directory (if pathdir (comint-directory pathdir) default-directory))
2684 (completions (file-name-all-completions pathnondir directory)))
59f36b08
SM
2685 (if (not completions)
2686 (message "No completions of %s" filename)
2687 (comint-dynamic-list-completions
2688 (mapcar 'comint-quote-filename completions)))))
3ee91e68
RS
2689
2690
2691(defun comint-dynamic-list-completions (completions)
2692 "List in help buffer sorted COMPLETIONS.
2693Typing SPC flushes the help buffer."
2694 (let ((conf (current-window-configuration)))
dd3038f6 2695 (with-output-to-temp-buffer "*Completions*"
3ee91e68 2696 (display-completion-list (sort completions 'string-lessp)))
3ee91e68 2697 (message "Hit space to flush")
7d5d472e
RS
2698 (let (key first)
2699 (if (save-excursion
dd3038f6 2700 (set-buffer (get-buffer "*Completions*"))
7d5d472e
RS
2701 (setq key (read-key-sequence nil)
2702 first (aref key 0))
eb6c110a 2703 (and (consp first) (consp (event-start first))
7d5d472e 2704 (eq (window-buffer (posn-window (event-start first)))
dd3038f6 2705 (get-buffer "*Completions*"))
7d5d472e
RS
2706 (eq (key-binding key) 'mouse-choose-completion)))
2707 ;; If the user does mouse-choose-completion with the mouse,
2708 ;; execute the command, then delete the completion window.
2709 (progn
2710 (mouse-choose-completion first)
2711 (set-window-configuration conf))
2712 (if (eq first ?\ )
2713 (set-window-configuration conf)
2b5a5ed3 2714 (setq unread-command-events (listify-key-sequence key)))))))
be9b65ac 2715\f
361ecbf2
RS
2716(defun comint-get-next-from-history ()
2717 "After fetching a line from input history, this fetches the following line.
2718In other words, this recalls the input line after the line you recalled last.
2719You can use this to repeat a sequence of input lines."
2720 (interactive)
2721 (if comint-save-input-ring-index
2722 (progn
2723 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2724 (comint-next-input 1))
2725 (message "No previous history command")))
2726
2727(defun comint-accumulate ()
2728 "Accumulate a line to send as input along with more lines.
2729This inserts a newline so that you can enter more text
2730to be sent along with this line. Use \\[comint-send-input]
2731to send all the accumulated input, at once.
2732The entire accumulated text becomes one item in the input history
2733when you send it."
2734 (interactive)
2735 (insert "\n")
2736 (set-marker comint-accum-marker (point))
2737 (if comint-input-ring-index
2738 (setq comint-save-input-ring-index
2739 (- comint-input-ring-index 1))))
2740
2741(defun comint-goto-process-mark ()
2742 "Move point to the process mark.
2743The process mark separates output, and input already sent,
2744from input that has not yet been sent."
2745 (interactive)
2746 (let ((proc (or (get-buffer-process (current-buffer))
2747 (error "Current buffer has no process"))))
2748 (goto-char (process-mark proc))
bec04ade
GM
2749 (when (interactive-p)
2750 (message "Point is now at the process mark"))))
361ecbf2
RS
2751
2752(defun comint-bol-or-process-mark ()
37dbcd5c 2753 "Move point to beginning of line (after prompt) or to the process mark.
361ecbf2
RS
2754The first time you use this command, it moves to the beginning of the line
2755\(but after the prompt, if any). If you repeat it again immediately,
2756it moves point to the process mark.
2757
2758The process mark separates the process output, along with input already sent,
2759from input that has not yet been sent. Ordinarily, the process mark
2760is at the beginning of the current input line; but if you have
2761used \\[comint-accumulate] to send multiple lines at once,
2762the process mark is at the beginning of the accumulated input."
2763 (interactive)
c2705d61 2764 (if (not (eq last-command 'comint-bol-or-process-mark))
361ecbf2
RS
2765 (comint-bol nil)
2766 (comint-goto-process-mark)))
2767
2768(defun comint-set-process-mark ()
2769 "Set the process mark at point."
2770 (interactive)
2771 (let ((proc (or (get-buffer-process (current-buffer))
2772 (error "Current buffer has no process"))))
2773 (set-marker (process-mark proc) (point))
2774 (message "Process mark set")))
2775
2776\f
3965beb0
GM
2777;; Author: Peter Breton <pbreton@ne.mediaone.net>
2778
2779;; This little add-on for comint is intended to make it easy to get
2780;; output from currently active comint buffers into another buffer,
2781;; or buffers, and then go back to using the comint shell.
814299a7 2782;;
3965beb0
GM
2783;; My particular use is SQL interpreters; I want to be able to execute a
2784;; query using the process associated with a comint-buffer, and save that
2785;; somewhere else. Because the process might have state (for example, it
2786;; could be in an uncommitted transaction), just running starting a new
2787;; process and having it execute the query and then finish, would not
2788;; work. I'm sure there are other uses as well, although in many cases
2789;; starting a new process is the simpler, and thus preferable, approach.
814299a7 2790;;
3965beb0
GM
2791;; The basic implementation is as follows: comint-redirect changes the
2792;; preoutput filter functions (comint-preoutput-filter-functions) to use
2793;; its own filter. The filter puts the output into the designated buffer,
2794;; or buffers, until it sees a regexp that tells it to stop (by default,
2795;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2796;; sees the stop regexp, it restores the old filter functions, and runs
2797;; comint-redirect-hook.
2798;;
2799;; Each comint buffer may only use one redirection at a time, but any number
2800;; of different comint buffers may be simultaneously redirected.
2801;;
2802;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2803;; correct prompt for your interpreter, or that you supply a regexp that says
2804;; when the redirection is finished. Otherwise, redirection will continue
2805;; indefinitely. The code now does a sanity check to ensure that it can find
2806;; a prompt in the comint buffer; however, it is still important to ensure that
2807;; this prompt is set correctly.
2808;;
29533923
MB
2809;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2810;; perhaps it should prompt for a terminating string (with an
2811;; appropriate magic default by examining what we think is the prompt)?
2812;;
3965beb0
GM
2813
2814;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2815;; Variables
2816;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2817
2818(defcustom comint-redirect-verbose nil
2819 "*If non-nil, print messages each time the redirection filter is invoked.
2820Also print a message when redirection is completed."
2821 :group 'comint
2822 :type 'boolean)
2823
2824;; Directly analagous to comint-preoutput-filter-functions
2825(defvar comint-redirect-filter-functions nil
2826 "List of functions to call before inserting redirected process output.
2827Each function gets one argument, a string containing the text received
2828from the subprocess. It should return the string to insert, perhaps
2829the same string that was received, or perhaps a modified or transformed
2830string.
2831
2832The functions on the list are called sequentially, and each one is given
2833the string returned by the previous one. The string returned by the
2834last function is the text that is actually inserted in the redirection buffer.")
2835
2836(make-variable-buffer-local 'comint-redirect-filter-functions)
2837
2838;; Internal variables
2839
2840(defvar comint-redirect-output-buffer nil
2841 "The buffer or list of buffers to put output into.")
2842
2843(defvar comint-redirect-finished-regexp nil
2844 "Regular expression that determines when to stop redirection in Comint.
814299a7 2845When the redirection filter function is given output that matches this regexp,
3965beb0
GM
2846the output is inserted as usual, and redirection is completed.")
2847
2848(defvar comint-redirect-insert-matching-regexp nil
2849 "If non-nil, the text that ends a redirection is included in it.
2850More precisely, the text that matches `comint-redirect-finished-regexp'
2851and therefore terminates an output redirection is inserted in the
2852redirection target buffer, along with the preceding output.")
2853
2854(defvar comint-redirect-echo-input nil
2855 "Non-nil means echo input in the process buffer even during redirection.")
2856
2857(defvar comint-redirect-completed nil
2858 "Non-nil if redirection has completed in the current buffer.")
2859
2860(defvar comint-redirect-original-mode-line-process nil
2861 "Original mode line for redirected process.")
2862
2863(defvar comint-redirect-perform-sanity-check t
2864 "If non-nil, check that redirection is likely to complete successfully.
2865More precisely, before starting a redirection, verify that the
2866regular expression `comint-redirect-finished-regexp' that controls
2867when to terminate it actually matches some text already in the process
2868buffer. The idea is that this regular expression should match a prompt
2869string, and that there ought to be at least one copy of your prompt string
2870in the process buffer already.")
2871
2872(defvar comint-redirect-original-filter-function nil
2873 "The process filter that was in place when redirection is started.
2874When redirection is completed, the process filter is restored to
2875this value.")
2876
2877;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2878;; Functions
2879;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2880
814299a7 2881(defun comint-redirect-setup (output-buffer
3965beb0
GM
2882 comint-buffer
2883 finished-regexp
2884 &optional echo-input)
2885 "Set up for output redirection.
2886This function sets local variables that are used by `comint-redirect-filter'
2887to perform redirection.
2888
2889Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
814299a7 2890in the output matches FINISHED-REGEXP.
3965beb0
GM
2891
2892If optional argument ECHO-INPUT is non-nil, output is echoed to the
2893original comint buffer.
2894
2895This function is called by `comint-redirect-send-command-to-process',
2896and does not normally need to be invoked by the end user or programmer."
2897 (with-current-buffer comint-buffer
2898
2899 (make-local-variable 'comint-redirect-original-mode-line-process)
2900 (setq comint-redirect-original-mode-line-process mode-line-process)
2901
2902 (make-local-variable 'comint-redirect-output-buffer)
2903 (setq comint-redirect-output-buffer output-buffer)
2904
2905 (make-local-variable 'comint-redirect-finished-regexp)
2906 (setq comint-redirect-finished-regexp finished-regexp)
2907
2908 (make-local-variable 'comint-redirect-echo-input)
2909 (setq comint-redirect-echo-input echo-input)
2910
2911 (make-local-variable 'comint-redirect-completed)
2912 (setq comint-redirect-completed nil)
2913
814299a7
MB
2914 (setq mode-line-process
2915 (if mode-line-process
3965beb0
GM
2916 (list (concat (elt mode-line-process 0) " Redirection"))
2917 (list ":%s Redirection")))))
2918
2919(defun comint-redirect-cleanup ()
2920 "End a Comint redirection. See `comint-redirect-send-command'."
2921 (interactive)
2922 ;; Restore the process filter
2923 (set-process-filter (get-buffer-process (current-buffer))
2924 comint-redirect-original-filter-function)
2925 ;; Restore the mode line
2926 (setq mode-line-process comint-redirect-original-mode-line-process)
2927 ;; Set the completed flag
2928 (setq comint-redirect-completed t))
2929
2930;; Because the cleanup happens as a callback, it's not easy to guarantee
2931;; that it really occurs.
2932(defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
2933
2934(defun comint-redirect-filter (process input-string)
2935 "Filter function which redirects output from PROCESS to a buffer or buffers.
2936The variable `comint-redirect-output-buffer' says which buffer(s) to
2937place output in.
2938
2939INPUT-STRING is the input from the comint process.
2940
814299a7 2941This function runs as a process filter, and does not need to be invoked by the
3965beb0
GM
2942end user."
2943 (and process
2944 (with-current-buffer (process-buffer process)
2945 (comint-redirect-preoutput-filter input-string)
2946 ;; If we have to echo output, give it to the original filter function
2947 (and comint-redirect-echo-input
2948 comint-redirect-original-filter-function
2949 (funcall comint-redirect-original-filter-function
2950 process input-string)))))
2951
2952
2953(defun comint-redirect-preoutput-filter (input-string)
2954 "Comint filter function which redirects comint output to a buffer or buffers.
2955The variable `comint-redirect-output-buffer' says which buffer(s) to
2956place output in.
2957
2958INPUT-STRING is the input from the comint process.
2959
2960This function does not need to be invoked by the end user."
2961 (let ((output-buffer-list
2962 (if (listp comint-redirect-output-buffer)
2963 comint-redirect-output-buffer
2964 (list comint-redirect-output-buffer)))
2965 (filtered-input-string input-string))
2966
2967 ;; If there are any filter functions, give them a chance to modify the string
2968 (let ((functions comint-redirect-filter-functions))
2969 (while (and functions filtered-input-string)
814299a7 2970 (setq filtered-input-string
3965beb0
GM
2971 (funcall (car functions) filtered-input-string))
2972 (setq functions (cdr functions))))
2973
2974 ;; Clobber `comint-redirect-finished-regexp'
2975 (or comint-redirect-insert-matching-regexp
2976 (and (string-match comint-redirect-finished-regexp filtered-input-string)
2977 (setq filtered-input-string
2978 (replace-match "" nil nil filtered-input-string))))
814299a7 2979
3965beb0
GM
2980 ;; Send output to all registered buffers
2981 (save-excursion
2982 (mapcar
2983 (function (lambda(buf)
2984 ;; Set this buffer to the output buffer
2985 (set-buffer (get-buffer-create buf))
2986 ;; Go to the end of the buffer
2987 (goto-char (point-max))
2988 ;; Insert the output
2989 (insert filtered-input-string)))
2990 output-buffer-list))
2991
2992 ;; Message
2993 (and comint-redirect-verbose
814299a7 2994 (message "Redirected output to buffer(s) %s"
3965beb0
GM
2995 (mapconcat 'identity output-buffer-list " ")))
2996
2997 ;; If we see the prompt, tidy up
2998 ;; We'll look for the prompt in the original string, so nobody can
2999 ;; clobber it
3000 (and (string-match comint-redirect-finished-regexp input-string)
3001 (progn
3002 (and comint-redirect-verbose
3003 (message "Redirection completed"))
3004 (comint-redirect-cleanup)
3005 (run-hooks 'comint-redirect-hook)))
3006 ;; Echo input?
3007 (if comint-redirect-echo-input
3008 filtered-input-string
3009 "")))
3010
3011;;;###autoload
3012(defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3013 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3014With prefix arg, echo output in process buffer.
3015
3016If NO-DISPLAY is non-nil, do not show the output buffer."
3017 (interactive "sCommand: \nBOutput Buffer: \nP")
3018 (let ((process (get-buffer-process (current-buffer))))
3019 (if process
3020 (comint-redirect-send-command-to-process
3021 command output-buffer (current-buffer) echo no-display)
3022 (error "No process for current buffer"))))
3023
3024;;;###autoload
814299a7 3025(defun comint-redirect-send-command-to-process
3965beb0
GM
3026 (command output-buffer process echo &optional no-display)
3027 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3028With prefix arg, echo output in process buffer.
3029
3030If NO-DISPLAY is non-nil, do not show the output buffer."
3031 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3032 (let* (;; The process buffer
3033 (process-buffer (if (processp process)
3034 (process-buffer process)
3035 process))
3036 (proc (get-buffer-process process-buffer)))
3037 ;; Change to the process buffer
3038 (set-buffer process-buffer)
3039
3040 ;; Make sure there's a prompt in the current process buffer
3041 (and comint-redirect-perform-sanity-check
3042 (save-excursion
3043 (goto-char (point-max))
3044 (or (re-search-backward comint-prompt-regexp nil t)
3045 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3046
3047 ;;;;;;;;;;;;;;;;;;;;;
3048 ;; Set up for redirection
3049 ;;;;;;;;;;;;;;;;;;;;;
814299a7 3050 (comint-redirect-setup
3965beb0 3051 ;; Output Buffer
814299a7 3052 output-buffer
3965beb0 3053 ;; Comint Buffer
814299a7 3054 (current-buffer)
3965beb0
GM
3055 ;; Finished Regexp
3056 comint-prompt-regexp
3057 ;; Echo input
3058 echo)
3059
3060 ;;;;;;;;;;;;;;;;;;;;;
3061 ;; Set the filter
3062 ;;;;;;;;;;;;;;;;;;;;;
3063 ;; Save the old filter
3064 (setq comint-redirect-original-filter-function
3065 (process-filter proc))
3066 (set-process-filter proc 'comint-redirect-filter)
814299a7 3067
3965beb0
GM
3068 ;;;;;;;;;;;;;;;;;;;;;
3069 ;; Send the command
3070 ;;;;;;;;;;;;;;;;;;;;;
814299a7 3071 (process-send-string
3965beb0
GM
3072 (current-buffer)
3073 (concat command "\n"))
3074
3075 ;;;;;;;;;;;;;;;;;;;;;
3076 ;; Show the output
3077 ;;;;;;;;;;;;;;;;;;;;;
3078 (or no-display
814299a7 3079 (display-buffer
3965beb0
GM
3080 (get-buffer-create
3081 (if (listp output-buffer)
3082 (car output-buffer)
3083 output-buffer))))))
3084
3085;;;###autoload
3086(defun comint-redirect-results-list (command regexp regexp-group)
814299a7 3087 "Send COMMAND to current process.
3965beb0
GM
3088Return a list of expressions in the output which match REGEXP.
3089REGEXP-GROUP is the regular expression group in REGEXP to use."
814299a7 3090 (comint-redirect-results-list-from-process
3965beb0
GM
3091 (get-buffer-process (current-buffer))
3092 command regexp regexp-group))
3093
3094;;;###autoload
3095(defun comint-redirect-results-list-from-process (process command regexp regexp-group)
814299a7 3096 "Send COMMAND to PROCESS.
3965beb0
GM
3097Return a list of expressions in the output which match REGEXP.
3098REGEXP-GROUP is the regular expression group in REGEXP to use."
3965beb0
GM
3099 (let ((output-buffer " *Comint Redirect Work Buffer*")
3100 results)
3101 (save-excursion
3102 (set-buffer (get-buffer-create output-buffer))
3103 (erase-buffer)
3104 (comint-redirect-send-command-to-process command
3105 output-buffer process nil t)
3106 ;; Wait for the process to complete
3107 (set-buffer (process-buffer process))
3108 (while (null comint-redirect-completed)
3109 (accept-process-output nil 1))
3110 ;; Collect the output
3111 (set-buffer output-buffer)
3112 (goto-char (point-min))
3113 ;; Skip past the command, if it was echoed
3114 (and (looking-at command)
3115 (forward-line))
814299a7 3116 (while (re-search-forward regexp nil t)
3965beb0
GM
3117 (setq results
3118 (cons (buffer-substring-no-properties
3119 (match-beginning regexp-group)
3120 (match-end regexp-group))
3121 results)))
3122 results)))
3123
f1ed9461
DL
3124(mapc (lambda (x)
3125 (add-to-list 'debug-ignored-errors x))
3126 '("^Not at command line$"
3127 "^Empty input ring$"
3128 "^No history$"
3129 "^Not found$" ; Too common?
3130 "^Current buffer has no process$"))
3965beb0 3131\f
b578f267
EN
3132;; Converting process modes to use comint mode
3133;; ===========================================================================
3134;; The code in the Emacs 19 distribution has all been modified to use comint
3135;; where needed. However, there are `third-party' packages out there that
3136;; still use the old shell mode. Here's a guide to conversion.
3137;;
3138;; Renaming variables
3139;; Most of the work is renaming variables and functions. These are the common
3140;; ones:
3141;; Local variables:
3142;; last-input-start comint-last-input-start
814299a7 3143;; last-input-end comint-last-input-end
b578f267
EN
3144;; shell-prompt-pattern comint-prompt-regexp
3145;; shell-set-directory-error-hook <no equivalent>
3146;; Miscellaneous:
3147;; shell-set-directory <unnecessary>
814299a7 3148;; shell-mode-map comint-mode-map
b578f267
EN
3149;; Commands:
3150;; shell-send-input comint-send-input
3151;; shell-send-eof comint-delchar-or-maybe-eof
814299a7 3152;; kill-shell-input comint-kill-input
b578f267
EN
3153;; interrupt-shell-subjob comint-interrupt-subjob
3154;; stop-shell-subjob comint-stop-subjob
3155;; quit-shell-subjob comint-quit-subjob
3156;; kill-shell-subjob comint-kill-subjob
4e217e50 3157;; kill-output-from-shell comint-delete-output
b578f267
EN
3158;; show-output-from-shell comint-show-output
3159;; copy-last-shell-input Use comint-previous-input/comint-next-input
3160;;
3161;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3162;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3163;; Comint mode does not provide functionality equivalent to
3164;; shell-set-directory-error-hook; it is gone.
3165;;
3166;; comint-last-input-start is provided for modes which want to munge
3167;; the buffer after input is sent, perhaps because the inferior
3168;; insists on echoing the input. The LAST-INPUT-START variable in
3169;; the old shell package was used to implement a history mechanism,
3170;; but you should think twice before using comint-last-input-start
3171;; for this; the input history ring often does the job better.
814299a7 3172;;
b578f267
EN
3173;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3174;; *not* create the comint-mode local variables in your foo-mode function.
3175;; This is not modular. Instead, call comint-mode, and let *it* create the
3176;; necessary comint-specific local variables. Then create the
3177;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3178;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3179;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3180;; get-old-input) that need to be different from the defaults. Call
3181;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3182;; comint-mode will take care of it. The following example, from shell.el,
3183;; is typical:
814299a7 3184;;
b578f267
EN
3185;; (defvar shell-mode-map '())
3186;; (cond ((not shell-mode-map)
3187;; (setq shell-mode-map (copy-keymap comint-mode-map))
3188;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3189;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3190;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3191;; (define-key shell-mode-map "\M-?"
3192;; 'comint-dynamic-list-filename-completions)))
3193;;
3194;; (defun shell-mode ()
3195;; (interactive)
3196;; (comint-mode)
3197;; (setq comint-prompt-regexp shell-prompt-pattern)
3198;; (setq major-mode 'shell-mode)
3199;; (setq mode-name "Shell")
3200;; (use-local-map shell-mode-map)
3201;; (make-local-variable 'shell-directory-stack)
3202;; (setq shell-directory-stack nil)
3203;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3204;; (run-hooks 'shell-mode-hook))
3205;;
3206;;
b578f267 3207;; Completion for comint-mode users
814299a7 3208;;
b578f267
EN
3209;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3210;; hook to add completion functions to. Functions on this list should return
3211;; non-nil if completion occurs (i.e., further completion should not occur).
3212;; You could use comint-dynamic-simple-complete to do the bulk of the
3213;; completion job.
49116ac0 3214\f
49116ac0 3215(provide 'comint)
c0274f38 3216
1cd7adc6 3217;;; comint.el ends here