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