(sweep_weak_table): Fix code taking items out of
[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))))))
ae57d456 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
GM
796 (insert input-str))
797 ;; fall back to the user's previous definition if we aren't
ef779078
SM
798 ;; on previous input region.
799 (let ((fun (lookup-key global-map (this-command-keys))))
800 (if fun (call-interactively fun))))))
814299a7 801
be9b65ac 802\f
b578f267
EN
803;; Input history processing in a buffer
804;; ===========================================================================
805;; Useful input history functions, courtesy of the Ergo group.
806
807;; Eleven commands:
808;; comint-dynamic-list-input-ring List history in help buffer.
809;; comint-previous-input Previous input...
810;; comint-previous-matching-input ...matching a string.
811;; comint-previous-matching-input-from-input ... matching the current input.
812;; comint-next-input Next input...
813;; comint-next-matching-input ...matching a string.
814;; comint-next-matching-input-from-input ... matching the current input.
815;; comint-backward-matching-input Backwards input...
816;; comint-forward-matching-input ...matching a string.
817;; comint-replace-by-expanded-history Expand history at point;
818;; replace with expanded history.
819;; comint-magic-space Expand history and insert space.
820;;
821;; Three functions:
822;; comint-read-input-ring Read into comint-input-ring...
823;; comint-write-input-ring Write to comint-input-ring-file-name.
824;; comint-replace-by-expanded-history-before-point Workhorse function.
3ee91e68 825
d637fa56 826(defun comint-read-input-ring (&optional silent)
3ee91e68
RS
827 "Sets the buffer's `comint-input-ring' from a history file.
828The name of the file is given by the variable `comint-input-ring-file-name'.
829The history ring is of size `comint-input-ring-size', regardless of file size.
830If `comint-input-ring-file-name' is nil this function does nothing.
831
d637fa56
RS
832If the optional argument SILENT is non-nil, we say nothing about a
833failure to read the history file.
3ee91e68 834
d637fa56
RS
835This function is useful for major mode commands and mode hooks.
836
bc29fd5f 837The commands stored in the history file are separated by the
0fddb84c
GM
838`comint-input-ring-separator', and entries that match
839`comint-input-history-ignore' are ignored. The most recent command
840comes last.
bc29fd5f 841
3ee91e68 842See also `comint-input-ignoredups' and `comint-write-input-ring'."
07ccf0bc
RS
843 (cond ((or (null comint-input-ring-file-name)
844 (equal comint-input-ring-file-name ""))
3ee91e68
RS
845 nil)
846 ((not (file-readable-p comint-input-ring-file-name))
d637fa56
RS
847 (or silent
848 (message "Cannot read history file %s"
849 comint-input-ring-file-name)))
3ee91e68 850 (t
cdc4401d
GM
851 (let* ((history-buf (get-buffer-create " *temp*"))
852 (file comint-input-ring-file-name)
853 (count 0)
854 (size comint-input-ring-size)
855 (ring (make-ring size)))
dc0825db
RS
856 (unwind-protect
857 (save-excursion
858 (set-buffer history-buf)
3ee91e68 859 (widen)
dc0825db
RS
860 (erase-buffer)
861 (insert-file-contents file)
862 ;; Save restriction in case file is already visited...
863 ;; Watch for those date stamps in history files!
864 (goto-char (point-max))
3e8abfd3
GM
865 (let (start end history)
866 (while (and (< count comint-input-ring-size)
867 (re-search-backward comint-input-ring-separator nil t)
868 (setq end (match-beginning 0)))
869 (if (re-search-backward comint-input-ring-separator nil t)
870 (setq start (match-end 0))
871 (setq start (point-min)))
872 (setq history (buffer-substring start end))
873 (goto-char start)
0fddb84c
GM
874 (if (and (not (string-match comint-input-history-ignore history))
875 (or (null comint-input-ignoredups)
876 (ring-empty-p ring)
877 (not (string-equal (ring-ref ring 0) history))))
3e8abfd3
GM
878 (progn
879 (ring-insert-at-beginning ring history)
880 (setq count (1+ count)))))))
dc0825db 881 (kill-buffer history-buf))
3ee91e68
RS
882 (setq comint-input-ring ring
883 comint-input-ring-index nil)))))
884
885(defun comint-write-input-ring ()
886 "Writes the buffer's `comint-input-ring' to a history file.
887The name of the file is given by the variable `comint-input-ring-file-name'.
888The original contents of the file are lost if `comint-input-ring' is not empty.
889If `comint-input-ring-file-name' is nil this function does nothing.
890
891Useful within process sentinels.
892
893See also `comint-read-input-ring'."
894 (cond ((or (null comint-input-ring-file-name)
07ccf0bc 895 (equal comint-input-ring-file-name "")
3ee91e68
RS
896 (null comint-input-ring) (ring-empty-p comint-input-ring))
897 nil)
898 ((not (file-writable-p comint-input-ring-file-name))
899 (message "Cannot write history file %s" comint-input-ring-file-name))
900 (t
901 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
902 (ring comint-input-ring)
903 (file comint-input-ring-file-name)
904 (index (ring-length ring)))
905 ;; Write it all out into a buffer first. Much faster, but messier,
906 ;; than writing it one line at a time.
907 (save-excursion
908 (set-buffer history-buf)
909 (erase-buffer)
910 (while (> index 0)
911 (setq index (1- index))
814299a7 912 (insert (ring-ref ring index) comint-input-ring-separator))
3ee91e68
RS
913 (write-region (buffer-string) nil file nil 'no-message)
914 (kill-buffer nil))))))
915
916
917(defun comint-dynamic-list-input-ring ()
918 "List in help buffer the buffer's input history."
919 (interactive)
920 (if (or (not (ring-p comint-input-ring))
921 (ring-empty-p comint-input-ring))
922 (message "No history")
923 (let ((history nil)
924 (history-buffer " *Input History*")
925 (index (1- (ring-length comint-input-ring)))
926 (conf (current-window-configuration)))
927 ;; We have to build up a list ourselves from the ring vector.
928 (while (>= index 0)
929 (setq history (cons (ring-ref comint-input-ring index) history)
930 index (1- index)))
931 ;; Change "completion" to "history reference"
932 ;; to make the display accurate.
933 (with-output-to-temp-buffer history-buffer
934 (display-completion-list history)
935 (set-buffer history-buffer)
936 (forward-line 3)
937 (while (search-backward "completion" nil 'move)
938 (replace-match "history reference")))
939 (sit-for 0)
940 (message "Hit space to flush")
941 (let ((ch (read-event)))
942 (if (eq ch ?\ )
943 (set-window-configuration conf)
944 (setq unread-command-events (list ch)))))))
945
946
947(defun comint-regexp-arg (prompt)
948 ;; Return list of regexp and prefix arg using PROMPT.
9f8ac7f9 949 (let* (;; Don't clobber this.
3ee91e68
RS
950 (last-command last-command)
951 (regexp (read-from-minibuffer prompt nil nil nil
952 'minibuffer-history-search-history)))
953 (list (if (string-equal regexp "")
954 (setcar minibuffer-history-search-history
955 (nth 1 minibuffer-history-search-history))
956 regexp)
957 (prefix-numeric-value current-prefix-arg))))
958
959(defun comint-search-arg (arg)
960 ;; First make sure there is a ring and that we are after the process mark
961 (cond ((not (comint-after-pmark-p))
962 (error "Not at command line"))
963 ((or (null comint-input-ring)
964 (ring-empty-p comint-input-ring))
965 (error "Empty input ring"))
966 ((zerop arg)
967 ;; arg of zero resets search from beginning, and uses arg of 1
968 (setq comint-input-ring-index nil)
969 1)
970 (t
971 arg)))
972
973(defun comint-search-start (arg)
974 ;; Index to start a directional search, starting at comint-input-ring-index
975 (if comint-input-ring-index
976 ;; If a search is running, offset by 1 in direction of arg
977 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
978 (ring-length comint-input-ring))
979 ;; For a new search, start from beginning or end, as appropriate
980 (if (>= arg 0)
981 0 ; First elt for forward search
982 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
983
984(defun comint-previous-input-string (arg)
985 "Return the string ARG places along the input ring.
986Moves relative to `comint-input-ring-index'."
987 (ring-ref comint-input-ring (if comint-input-ring-index
814299a7 988 (mod (+ arg comint-input-ring-index)
3ee91e68
RS
989 (ring-length comint-input-ring))
990 arg)))
be9b65ac
DL
991
992(defun comint-previous-input (arg)
993 "Cycle backwards through input history."
994 (interactive "*p")
3ee91e68 995 (comint-previous-matching-input "." arg))
1586b965 996
be9b65ac
DL
997(defun comint-next-input (arg)
998 "Cycle forwards through input history."
999 (interactive "*p")
1000 (comint-previous-input (- arg)))
1001
3ee91e68
RS
1002(defun comint-previous-matching-input-string (regexp arg)
1003 "Return the string matching REGEXP ARG places along the input ring.
1004Moves relative to `comint-input-ring-index'."
1005 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1006 (if pos (ring-ref comint-input-ring pos))))
1007
1008(defun comint-previous-matching-input-string-position (regexp arg &optional start)
1009 "Return the index matching REGEXP ARG places along the input ring.
1010Moves relative to START, or `comint-input-ring-index'."
1011 (if (or (not (ring-p comint-input-ring))
1012 (ring-empty-p comint-input-ring))
1013 (error "No history"))
1014 (let* ((len (ring-length comint-input-ring))
1015 (motion (if (> arg 0) 1 -1))
1016 (n (mod (- (or start (comint-search-start arg)) motion) len))
1017 (tried-each-ring-item nil)
1018 (prev nil))
1019 ;; Do the whole search as many times as the argument says.
1020 (while (and (/= arg 0) (not tried-each-ring-item))
1021 ;; Step once.
1022 (setq prev n
1023 n (mod (+ n motion) len))
1024 ;; If we haven't reached a match, step some more.
1025 (while (and (< n len) (not tried-each-ring-item)
1026 (not (string-match regexp (ring-ref comint-input-ring n))))
1027 (setq n (mod (+ n motion) len)
1028 ;; If we have gone all the way around in this search.
1029 tried-each-ring-item (= n prev)))
1030 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1031 ;; Now that we know which ring element to use, if we found it, return that.
1032 (if (string-match regexp (ring-ref comint-input-ring n))
1033 n)))
1034
0c5c1f34
RS
1035(defun comint-previous-matching-input (regexp arg)
1036 "Search backwards through input history for match for REGEXP.
1037\(Previous history elements are earlier commands.)
1038With prefix argument N, search for Nth previous match.
1039If N is negative, find the next or Nth next match."
3ee91e68
RS
1040 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1041 (setq arg (comint-search-arg arg))
1042 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
1043 ;; Has a match been found?
1044 (if (null pos)
1045 (error "Not found")
1046 (setq comint-input-ring-index pos)
1047 (message "History item: %d" (1+ pos))
814299a7 1048 (delete-region
3ee91e68 1049 ;; Can't use kill-region as it sets this-command
361ecbf2
RS
1050 (or (marker-position comint-accum-marker)
1051 (process-mark (get-buffer-process (current-buffer))))
1052 (point))
3ee91e68 1053 (insert (ring-ref comint-input-ring pos)))))
0c5c1f34
RS
1054
1055(defun comint-next-matching-input (regexp arg)
1056 "Search forwards through input history for match for REGEXP.
1057\(Later history elements are more recent commands.)
1058With prefix argument N, search for Nth following match.
1059If N is negative, find the previous or Nth previous match."
3ee91e68 1060 (interactive (comint-regexp-arg "Next input matching (regexp): "))
0c5c1f34 1061 (comint-previous-matching-input regexp (- arg)))
be9b65ac 1062
3ee91e68
RS
1063(defun comint-previous-matching-input-from-input (arg)
1064 "Search backwards through input history for match for current input.
1065\(Previous history elements are earlier commands.)
1066With prefix argument N, search for Nth previous match.
3f849529 1067If N is negative, search forwards for the -Nth following match."
3ee91e68
RS
1068 (interactive "p")
1069 (if (not (memq last-command '(comint-previous-matching-input-from-input
1070 comint-next-matching-input-from-input)))
1071 ;; Starting a new search
1072 (setq comint-matching-input-from-input-string
814299a7 1073 (buffer-substring
361ecbf2
RS
1074 (or (marker-position comint-accum-marker)
1075 (process-mark (get-buffer-process (current-buffer))))
3ee91e68
RS
1076 (point))
1077 comint-input-ring-index nil))
1078 (comint-previous-matching-input
1079 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1080 arg))
1081
1082(defun comint-next-matching-input-from-input (arg)
1083 "Search forwards through input history for match for current input.
3f849529
RS
1084\(Following history elements are more recent commands.)
1085With prefix argument N, search for Nth following match.
1086If N is negative, search backwards for the -Nth previous match."
3ee91e68
RS
1087 (interactive "p")
1088 (comint-previous-matching-input-from-input (- arg)))
1089
1090
17ac4966 1091(defun comint-replace-by-expanded-history (&optional silent start)
3ee91e68 1092 "Expand input command history references before point.
1b421826
RS
1093Expansion is dependent on the value of `comint-input-autoexpand'.
1094
3ee91e68
RS
1095This function depends on the buffer's idea of the input history, which may not
1096match the command interpreter's idea, assuming it has one.
1097
1098Assumes history syntax is like typical Un*x shells'. However, since emacs
1099cannot know the interpreter's idea of input line numbers, assuming it has one,
1100it cannot expand absolute input line number references.
1101
d637fa56
RS
1102If the optional argument SILENT is non-nil, never complain
1103even if history reference seems erroneous.
1104
17ac4966
RS
1105If the optional argument START is non-nil, that specifies the
1106start of the text to scan for history references, rather
1107than the logical beginning of line.
1108
1b421826
RS
1109See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1110
1111Returns t if successful."
3ee91e68 1112 (interactive)
1b421826 1113 (if (and comint-input-autoexpand
29533923
MB
1114 (if comint-use-prompt-regexp-instead-of-fields
1115 ;; Use comint-prompt-regexp
1ec321a7
MB
1116 (save-excursion
1117 (beginning-of-line)
1118 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
29533923
MB
1119 ;; Use input fields. User input that hasn't been entered
1120 ;; yet, at the end of the buffer, has a nil `field' property.
1ec321a7
MB
1121 (and (null (get-char-property (point) 'field))
1122 (string-match "!\\|^\\^" (field-string)))))
1b421826
RS
1123 ;; Looks like there might be history references in the command.
1124 (let ((previous-modified-tick (buffer-modified-tick)))
17ac4966 1125 (comint-replace-by-expanded-history-before-point silent start)
1b421826
RS
1126 (/= previous-modified-tick (buffer-modified-tick)))))
1127
1128
17ac4966 1129(defun comint-replace-by-expanded-history-before-point (silent &optional start)
1b421826 1130 "Expand directory stack reference before point.
17ac4966
RS
1131See `comint-replace-by-expanded-history'. Returns t if successful.
1132
1133If the optional argument START is non-nil, that specifies the
1134start of the text to scan for history references, rather
1135than the logical beginning of line."
3ee91e68 1136 (save-excursion
29533923
MB
1137 (let ((toend (- (line-end-position) (point)))
1138 (start (comint-line-beginning-position)))
d637fa56 1139 (while (progn
29533923
MB
1140 (skip-chars-forward "^!^" (- (line-end-position) toend))
1141 (< (point) (- (line-end-position) toend)))
3ee91e68
RS
1142 ;; This seems a bit complex. We look for references such as !!, !-num,
1143 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1144 ;; If that wasn't enough, the plings can be suffixed with argument
1145 ;; range specifiers.
1146 ;; Argument ranges are complex too, so we hive off the input line,
1147 ;; referenced with plings, with the range string to `comint-args'.
1148 (setq comint-input-ring-index nil)
3ee91e68
RS
1149 (cond ((or (= (preceding-char) ?\\)
1150 (comint-within-quotes start (point)))
1151 ;; The history is quoted, or we're in quotes.
d637fa56 1152 (goto-char (1+ (point))))
3ee91e68
RS
1153 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1154 ;; We cannot know the interpreter's idea of input line numbers.
1155 (goto-char (match-end 0))
1156 (message "Absolute reference cannot be expanded"))
1157 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1158 ;; Just a number of args from `number' lines backward.
1159 (let ((number (1- (string-to-number
1160 (buffer-substring (match-beginning 1)
1161 (match-end 1))))))
1162 (if (<= number (ring-length comint-input-ring))
1163 (progn
1164 (replace-match
1165 (comint-args (comint-previous-input-string number)
fb9ab28a
RS
1166 (match-beginning 2) (match-end 2))
1167 t t)
3ee91e68
RS
1168 (setq comint-input-ring-index number)
1169 (message "History item: %d" (1+ number)))
1170 (goto-char (match-end 0))
1171 (message "Relative reference exceeds input history size"))))
1172 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1173 ;; Just a number of args from the previous input line.
1174 (replace-match
1175 (comint-args (comint-previous-input-string 0)
fb9ab28a
RS
1176 (match-beginning 1) (match-end 1))
1177 t t)
1b421826 1178 (message "History item: previous"))
3ee91e68
RS
1179 ((looking-at
1180 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1181 ;; Most recent input starting with or containing (possibly
1182 ;; protected) string, maybe just a number of args. Phew.
1183 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1184 (mb2 (match-beginning 2)) (me2 (match-end 2))
1185 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1186 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1187 (pos (save-match-data
1188 (comint-previous-matching-input-string-position
1189 (concat pref (regexp-quote exp)) 1))))
1190 (if (null pos)
5a336c13
KH
1191 (progn
1192 (goto-char (match-end 0))
1193 (or silent
1194 (progn (message "Not found")
1195 (ding))))
3ee91e68 1196 (setq comint-input-ring-index pos)
3ee91e68
RS
1197 (replace-match
1198 (comint-args (ring-ref comint-input-ring pos)
fb9ab28a
RS
1199 (match-beginning 4) (match-end 4))
1200 t t)
1b421826 1201 (message "History item: %d" (1+ pos)))))
3ee91e68
RS
1202 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1203 ;; Quick substitution on the previous input line.
1204 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1205 (new (buffer-substring (match-beginning 2) (match-end 2)))
1206 (pos nil))
1207 (replace-match (comint-previous-input-string 0) t t)
1208 (setq pos (point))
1209 (goto-char (match-beginning 0))
1b421826
RS
1210 (if (not (search-forward old pos t))
1211 (or silent
1212 (error "Not found"))
1213 (replace-match new t t)
1214 (message "History item: substituted"))))
3ee91e68 1215 (t
2ac86cc0 1216 (forward-char 1)))))))
3ee91e68
RS
1217
1218
1219(defun comint-magic-space (arg)
1220 "Expand input history references before point and insert ARG spaces.
1221A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1222 (interactive "p")
1223 (comint-replace-by-expanded-history)
1224 (self-insert-command arg))
1225\f
1226(defun comint-within-quotes (beg end)
1227 "Return t if the number of quotes between BEG and END is odd.
1228Quotes are single and double."
1229 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1230 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1231 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1232
1233(defun comint-how-many-region (regexp beg end)
1234 "Return number of matches for REGEXP from BEG to END."
1235 (let ((count 0))
1236 (save-excursion
1237 (save-match-data
1238 (goto-char beg)
1239 (while (re-search-forward regexp end t)
1240 (setq count (1+ count)))))
1241 count))
1242
1243(defun comint-args (string begin end)
1244 ;; From STRING, return the args depending on the range specified in the text
1245 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1246 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1247 (save-match-data
1248 (if (null begin)
1249 (comint-arguments string 0 nil)
1250 (let* ((range (buffer-substring
1251 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1252 (nth (cond ((string-match "^[*^]" range) 1)
1253 ((string-match "^-" range) 0)
1254 ((string-equal range "$") nil)
1255 (t (string-to-number range))))
1256 (mth (cond ((string-match "[-*$]$" range) nil)
1257 ((string-match "-" range)
1258 (string-to-number (substring range (match-end 0))))
1259 (t nth))))
1260 (comint-arguments string nth mth)))))
1261
3f4b7c36
RS
1262;; Return a list of arguments from ARG. Break it up at the
1263;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
3ee91e68 1264(defun comint-delim-arg (arg)
3f4b7c36 1265 (if (null comint-delimiter-argument-list)
3ee91e68 1266 (list arg)
3f4b7c36
RS
1267 (let ((args nil)
1268 (pos 0)
1269 (len (length arg)))
1270 (while (< pos len)
1271 (let ((char (aref arg pos))
1272 (start pos))
1273 (if (memq char comint-delimiter-argument-list)
1274 (while (and (< pos len) (eq (aref arg pos) char))
1275 (setq pos (1+ pos)))
1276 (while (and (< pos len)
1277 (not (memq (aref arg pos)
1278 comint-delimiter-argument-list)))
1279 (setq pos (1+ pos))))
1280 (setq args (cons (substring arg start pos) args))))
3ee91e68
RS
1281 args)))
1282
1283(defun comint-arguments (string nth mth)
1284 "Return from STRING the NTH to MTH arguments.
1285NTH and/or MTH can be nil, which means the last argument.
3f4b7c36 1286Returned arguments are separated by single spaces.
e7cfa73f
KH
1287We assume whitespace separates arguments, except within quotes
1288and except for a space or tab that immediately follows a backslash.
3f4b7c36
RS
1289Also, a run of one or more of a single character
1290in `comint-delimiter-argument-list' is a separate argument.
3ee91e68 1291Argument 0 is the command name."
21a003b9
GV
1292 ;; The first line handles ordinary characters and backslash-sequences
1293 ;; (except with w32 msdos-like shells, where backslashes are valid).
ec569127
RS
1294 ;; The second matches "-quoted strings.
1295 ;; The third matches '-quoted strings.
1296 ;; The fourth matches `-quoted strings.
1297 ;; This seems to fit the syntax of BASH 2.0.
814299a7 1298 (let* ((first (if (and (eq system-type 'windows-nt)
21a003b9
GV
1299 (w32-shell-dos-semantics))
1300 "[^ \n\t\"'`]+\\|"
e7cfa73f 1301 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
21a003b9
GV
1302 (argpart (concat first
1303 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
ec569127 1304'[^']*'\\|\
21a003b9
GV
1305`[^`]*`\\)"))
1306 (args ()) (pos 0)
1307 (count 0)
1308 beg str value quotes)
d91f490d
RS
1309 ;; Build a list of all the args until we have as many as we want.
1310 (while (and (or (null mth) (<= count mth))
1311 (string-match argpart string pos))
1312 (if (and beg (= pos (match-beginning 0)))
1313 ;; It's contiguous, part of the same arg.
1314 (setq pos (match-end 0)
1315 quotes (or quotes (match-beginning 1)))
1316 ;; It's a new separate arg.
1317 (if beg
1318 ;; Put the previous arg, if there was one, onto ARGS.
1319 (setq str (substring string beg pos)
1320 args (if quotes (cons str args)
1321 (nconc (comint-delim-arg str) args))
1322 count (1+ count)))
1323 (setq quotes (match-beginning 1))
1324 (setq beg (match-beginning 0))
1325 (setq pos (match-end 0))))
1326 (if beg
1327 (setq str (substring string beg pos)
1328 args (if quotes (cons str args)
1329 (nconc (comint-delim-arg str) args))
1330 count (1+ count)))
1331 (let ((n (or nth (1- count)))
1332 (m (if mth (1- (- count mth)) 0)))
3ee91e68
RS
1333 (mapconcat
1334 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1335\f
b578f267
EN
1336;;
1337;; Input processing stuff
1338;;
936c15f6
EL
1339(defun comint-add-to-input-history (cmd)
1340 "Add CMD to the input history.
1341Ignore duplicates if `comint-input-ignoredups' is non-nil."
1342 (if (and (funcall comint-input-filter cmd)
1343 (or (null comint-input-ignoredups)
1344 (not (ring-p comint-input-ring))
1345 (ring-empty-p comint-input-ring)
1346 (not (string-equal (ring-ref comint-input-ring 0)
1347 cmd))))
1348 (ring-insert comint-input-ring cmd)))
3ee91e68 1349
814299a7 1350(defun comint-send-input ()
c2ced5d8
CZ
1351 "Send input to process.
1352After the process output mark, sends all text from the process mark to
1353point as input to the process. Before the process output mark, calls value
8ae3bc9f 1354of variable `comint-get-old-input' to retrieve old input, copies it to the
cccd719e 1355process mark, and sends it. If variable `comint-process-echoes' is nil,
8ae3bc9f 1356a terminal newline is also inserted into the buffer and sent to the process
cccd719e
RS
1357\(if it is non-nil, all text from the process mark to point is deleted,
1358since it is assumed the remote process will re-echo it).
8ae3bc9f 1359
3ee91e68 1360Any history reference may be expanded depending on the value of the variable
1b421826 1361`comint-input-autoexpand'. The list of function names contained in the value
fb9ab28a 1362of `comint-input-filter-functions' is called on the input before sending it.
1b421826
RS
1363The input is entered into the input history ring, if the value of variable
1364`comint-input-filter' returns non-nil when called on the input.
cccd719e
RS
1365
1366If variable `comint-eol-on-send' is non-nil, then point is moved to the
8ae3bc9f
NF
1367end of line before sending the input.
1368
fb9ab28a 1369The values of `comint-get-old-input', `comint-input-filter-functions', and
1b421826
RS
1370`comint-input-filter' are chosen according to the command interpreter running
1371in the buffer. E.g.,
1372
be9b65ac 1373If the interpreter is the csh,
29533923 1374 comint-get-old-input is the default: either return the current
814299a7
MB
1375 field, or take the current line and discard any
1376 initial string matching regexp `comint-prompt-regexp', depending
29533923 1377 on the value of `comint-use-prompt-regexp-instead-of-fields'.
fb9ab28a 1378 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
814299a7 1379 \"popd\" commands. When it sees one, it cd's the buffer.
3ee91e68 1380 comint-input-filter is the default: returns t if the input isn't all white
49116ac0 1381 space.
be9b65ac 1382
814299a7 1383If the comint is Lucid Common Lisp,
49116ac0 1384 comint-get-old-input snarfs the sexp ending at point.
fb9ab28a 1385 comint-input-filter-functions does nothing.
3ee91e68 1386 comint-input-filter returns nil if the input matches input-filter-regexp,
814299a7 1387 which matches (1) all whitespace (2) :a, :c, etc.
be9b65ac 1388
1586b965 1389Similarly for Soar, Scheme, etc."
be9b65ac
DL
1390 (interactive)
1391 ;; Note that the input string does not include its terminal newline.
49116ac0
JB
1392 (let ((proc (get-buffer-process (current-buffer))))
1393 (if (not proc) (error "Current buffer has no process")
1394 (let* ((pmark (process-mark proc))
3ee91e68 1395 (intxt (if (>= (point) (marker-position pmark))
49116ac0
JB
1396 (progn (if comint-eol-on-send (end-of-line))
1397 (buffer-substring pmark (point)))
87ef29fd
JB
1398 (let ((copy (funcall comint-get-old-input)))
1399 (goto-char pmark)
1400 (insert copy)
3ee91e68
RS
1401 copy)))
1402 (input (if (not (eq comint-input-autoexpand 'input))
1403 ;; Just whatever's already there
1404 intxt
1405 ;; Expand and leave it visible in buffer
17ac4966 1406 (comint-replace-by-expanded-history t pmark)
3ee91e68
RS
1407 (buffer-substring pmark (point))))
1408 (history (if (not (eq comint-input-autoexpand 'history))
5f46b51a 1409 input
3ee91e68
RS
1410 ;; This is messy 'cos ultimately the original
1411 ;; functions used do insertion, rather than return
1412 ;; strings. We have to expand, then insert back.
17ac4966 1413 (comint-replace-by-expanded-history t pmark)
ff6318be
SM
1414 (let ((copy (buffer-substring pmark (point)))
1415 (start (point)))
1416 (insert input)
1417 (delete-region pmark start)
5f46b51a 1418 copy))))
29533923 1419
814299a7
MB
1420 (if comint-process-echoes
1421 (delete-region pmark (point))
b59b731f 1422 (insert ?\n))
29533923 1423
936c15f6 1424 (comint-add-to-input-history history)
29533923 1425
155fd027
KH
1426 (run-hook-with-args 'comint-input-filter-functions
1427 (concat input "\n"))
29533923 1428
ae57d456
GM
1429 (let ((beg (marker-position pmark))
1430 (end (1- (point))))
29533923
MB
1431 (when (not (> beg end)) ; handle a special case
1432 ;; Make an overlay for the input field
22bcff4e 1433 (let ((over (make-overlay beg end nil nil t)))
29533923
MB
1434 (unless comint-use-prompt-regexp-instead-of-fields
1435 ;; Give old user input a field property of `input', to
1436 ;; distinguish it from both process output and unsent
1437 ;; input. The terminating newline is put into a special
1438 ;; `boundary' field to make cursor movement between input
1439 ;; and output fields smoother.
c7c800d8 1440 (overlay-put over 'field 'input))
29533923 1441 (when comint-highlight-input
7ff4fda5 1442 (overlay-put over 'face 'comint-highlight-input)
29533923
MB
1443 (overlay-put over 'mouse-face 'highlight)
1444 (overlay-put over 'evaporate t))))
1445 (unless comint-use-prompt-regexp-instead-of-fields
1446 ;; Make an overlay for the terminating newline
22bcff4e 1447 (let ((over (make-overlay end (1+ end) nil t nil)))
29533923 1448 (overlay-put over 'field 'boundary)
ae57d456 1449 (overlay-put over 'evaporate t))))
29533923 1450
3db4b719
MB
1451 (comint-snapshot-last-prompt)
1452
361ecbf2 1453 (setq comint-save-input-ring-index comint-input-ring-index)
1586b965 1454 (setq comint-input-ring-index nil)
dcdc526c
RS
1455 ;; Update the markers before we send the input
1456 ;; in case we get output amidst sending the input.
87ef29fd
JB
1457 (set-marker comint-last-input-start pmark)
1458 (set-marker comint-last-input-end (point))
3ee91e68 1459 (set-marker (process-mark proc) (point))
361ecbf2
RS
1460 ;; clear the "accumulation" marker
1461 (set-marker comint-accum-marker nil)
dcdc526c 1462 (funcall comint-input-sender proc input)
6aac2ab0
RS
1463 ;; This used to call comint-output-filter-functions,
1464 ;; but that scrolled the buffer in undesirable ways.
1465 (run-hook-with-args 'comint-output-filter-functions "")))))
be9b65ac 1466
814299a7 1467(defvar comint-preoutput-filter-functions nil
c095ddb9
RS
1468 "List of functions to call before inserting Comint output into the buffer.
1469Each function gets one argument, a string containing the text received
1470from the subprocess. It should return the string to insert, perhaps
1471the same string that was received, or perhaps a modified or transformed
1472string.
1473
1474The functions on the list are called sequentially, and each one is
1475given the string returned by the previous one. The string returned by
1476the last function is the text that is actually inserted in the
07c8b450 1477redirection buffer.
c095ddb9 1478
07c8b450 1479This variable is permanent-local.")
d4321160 1480
29533923
MB
1481;; When non-nil, this is the last overlay used for output.
1482;; It is kept around so that we can extend it instead of creating
1483;; multiple contiguous overlays for multiple contiguous output chunks.
1484(defvar comint-last-output-overlay nil)
1485
3db4b719
MB
1486;; When non-nil, this is an overlay over the last recognized prompt in
1487;; the buffer; it is used when highlighting the prompt.
1488(defvar comint-last-prompt-overlay nil)
1489
1490;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1491;; Any further output will then create a new comint-last-prompt-overlay.
1492(defun comint-snapshot-last-prompt ()
1493 (when comint-last-prompt-overlay
1494 (overlay-put comint-last-prompt-overlay 'evaporate t)
1495 (setq comint-last-prompt-overlay nil)))
1496
3ee91e68 1497;; The purpose of using this filter for comint processes
5511e411
RS
1498;; is to keep comint-last-input-end from moving forward
1499;; when output is inserted.
3ee91e68 1500(defun comint-output-filter (process string)
91d75282 1501 (let ((oprocbuf (process-buffer process)))
2c8e6211
GM
1502 ;; First check for killed buffer or no input.
1503 (when (and string oprocbuf (buffer-name oprocbuf))
1504 (with-current-buffer oprocbuf
867102f2 1505 ;; Run preoutput filters
2c8e6211
GM
1506 (let ((functions comint-preoutput-filter-functions))
1507 (while (and functions string)
1508 (setq string (funcall (car functions) string))
1509 (setq functions (cdr functions))))
91d75282 1510
d8d972bf
MB
1511 ;; Insert STRING
1512 (let ((buffer-read-only nil)
1513 ;; Avoid the overhead of save-excursion, since we just
1514 ;; fiddle with the point
5d9045ed 1515 (saved-point (point-marker)))
d8d972bf 1516
5484005d
MB
1517 ;; The point should float after any insertion we do
1518 (set-marker-insertion-type saved-point t)
1519
d8d972bf
MB
1520 ;; We temporarly remove any buffer narrowing, in case the
1521 ;; process mark is outside of the restriction
1522 (save-restriction
1523 (widen)
1524
1525 (goto-char (process-mark process))
1526 (set-marker comint-last-output-start (point))
1527
bdf08678
MB
1528 ;; insert-before-markers is a bad thing. XXX
1529 ;;
1530 ;; It is used here to force window-point markers (used to
1531 ;; store the value of point in non-selected windows) to
1532 ;; advance, but it also screws up any other markers that we
1533 ;; don't _want_ to advance, such as the start-marker of some
1534 ;; of the overlays we create.
1535 ;;
1536 ;; We work around the problem with the overlays by
1537 ;; explicitly adjusting them after we do the insertion, but
1538 ;; in the future this problem should be solved correctly, by
1539 ;; using `insert', and making the insertion-type of
1540 ;; window-point markers settable (via a buffer-local
1541 ;; variable). In comint buffers, this variable would be set
1542 ;; to `t', to cause point in non-select windows to advance.
1543 (insert-before-markers string)
1544 ;; Fixup markers and overlays that got screwed up because we
1545 ;; used `insert-before-markers'.
1546 (let ((old-point (- (point) (length string))))
1e317a4a 1547 ;; comint-last-output-start
bdf08678 1548 (set-marker comint-last-output-start old-point)
1e317a4a
MB
1549 ;; comint-last-input-end
1550 (when (and comint-last-input-end
1551 (equal (marker-position comint-last-input-end)
1552 (point)))
1553 (set-marker comint-last-input-end old-point))
bdf08678
MB
1554 ;; No overlays we create are set to advance upon insertion
1555 ;; (at the start/end), so we assume that any overlay which
1556 ;; is at the current point was incorrectly advanced by
1557 ;; insert-before-markers. First fixup overlays that might
1558 ;; start at point:
1559 (dolist (over (overlays-at (point)))
1560 (when (= (overlay-start over) (point))
1561 (let ((end (overlay-end over)))
1562 (move-overlay over
1563 old-point
1564 (if (= end (point)) old-point end)))))
1565 ;; Then do overlays that might end at point:
1566 (dolist (over (overlays-at (1- (point))))
1567 (when (= (overlay-end over) (point))
1568 (move-overlay over
1569 (min (overlay-start over) old-point)
1570 old-point))))
1571
1572 ;; Advance process-mark
d8d972bf
MB
1573 (set-marker (process-mark process) (point))
1574
1575 (unless comint-use-prompt-regexp-instead-of-fields
1576 ;; We check to see if the last overlay used for output is
1577 ;; adjacent to the new input, and if so, just extend it.
1578 (if (and comint-last-output-overlay
1579 (equal (overlay-end comint-last-output-overlay)
5484005d 1580 (marker-position comint-last-output-start)))
d8d972bf
MB
1581 ;; Extend comint-last-output-overlay to include the
1582 ;; most recent output
1583 (move-overlay comint-last-output-overlay
1584 (overlay-start comint-last-output-overlay)
1585 (point))
1586 ;; Create a new overlay
1587 (let ((over (make-overlay comint-last-output-start (point))))
1588 (overlay-put over 'field 'output)
d8d972bf
MB
1589 (overlay-put over 'inhibit-line-move-field-capture t)
1590 (overlay-put over 'evaporate t)
1591 (setq comint-last-output-overlay over))))
1592
1593 (when comint-highlight-prompt
1594 ;; Highlight the prompt, where we define `prompt' to mean
1595 ;; the most recent output that doesn't end with a newline.
1596 (unless (and (bolp) (null comint-last-prompt-overlay))
1597 ;; Need to create or move the prompt overlay (in the case
1598 ;; where there is no prompt ((bolp) == t), we still do
1599 ;; this if there's already an existing overlay).
1600 (let ((prompt-start (save-excursion (forward-line 0) (point))))
1601 (if comint-last-prompt-overlay
1602 ;; Just move an existing overlay
1603 (move-overlay comint-last-prompt-overlay
1604 prompt-start (point))
1605 ;; Need to create the overlay
c7c800d8
MB
1606 (setq comint-last-prompt-overlay
1607 (make-overlay prompt-start (point)))
1608 (overlay-put comint-last-prompt-overlay
1609 'face 'comint-highlight-prompt)))))
d8d972bf 1610
d8d972bf
MB
1611 (goto-char saved-point)
1612
1613 (run-hook-with-args 'comint-output-filter-functions string)))))))
3ee91e68 1614
c1da5c03 1615(defun comint-preinput-scroll-to-bottom ()
3ee91e68
RS
1616 "Go to the end of buffer in all windows showing it.
1617Movement occurs if point in the selected window is not after the process mark,
1618and `this-command' is an insertion command. Insertion commands recognised
d637fa56 1619are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
3ee91e68
RS
1620Depends on the value of `comint-scroll-to-bottom-on-input'.
1621
c1da5c03 1622This function should be a pre-command hook."
3ee91e68 1623 (if (and comint-scroll-to-bottom-on-input
91d75282 1624 (memq this-command '(self-insert-command comint-magic-space yank
d637fa56 1625 hilit-yank)))
3ee91e68
RS
1626 (let* ((selected (selected-window))
1627 (current (current-buffer))
1628 (process (get-buffer-process current))
1629 (scroll comint-scroll-to-bottom-on-input))
d637fa56 1630 (if (and process (< (point) (process-mark process)))
0744bf64
RS
1631 (if (eq scroll 'this)
1632 (goto-char (point-max))
1633 (walk-windows
1634 (function (lambda (window)
1635 (if (and (eq (window-buffer window) current)
d637fa56 1636 (or (eq scroll t) (eq scroll 'all)))
0744bf64
RS
1637 (progn
1638 (select-window window)
1639 (goto-char (point-max))
1640 (select-window selected)))))
d637fa56 1641 nil t))))))
3ee91e68 1642
c1da5c03 1643(defun comint-postoutput-scroll-to-bottom (string)
3ee91e68
RS
1644 "Go to the end of buffer in all windows showing it.
1645Does not scroll if the current line is the last line in the buffer.
1646Depends on the value of `comint-scroll-to-bottom-on-output' and
1647`comint-scroll-show-maximum-output'.
1648
fb9ab28a 1649This function should be in the list `comint-output-filter-functions'."
3ee91e68
RS
1650 (let* ((selected (selected-window))
1651 (current (current-buffer))
1652 (process (get-buffer-process current))
1653 (scroll comint-scroll-to-bottom-on-output))
d637fa56
RS
1654 (unwind-protect
1655 (if process
1656 (walk-windows
1657 (function (lambda (window)
1658 (if (eq (window-buffer window) current)
1659 (progn
1660 (select-window window)
1661 (if (and (< (point) (process-mark process))
1662 (or (eq scroll t) (eq scroll 'all)
107d7589 1663 ;; Maybe user wants point to jump to end.
d637fa56
RS
1664 (and (eq scroll 'this) (eq selected window))
1665 (and (eq scroll 'others) (not (eq selected window)))
107d7589 1666 ;; If point was at the end, keep it at end.
814299a7
MB
1667 (and (marker-position comint-last-output-start)
1668 (>= (point) comint-last-output-start))))
d637fa56
RS
1669 (goto-char (process-mark process)))
1670 ;; Optionally scroll so that the text
1671 ;; ends at the bottom of the window.
1672 (if (and comint-scroll-show-maximum-output
1673 (>= (point) (process-mark process)))
1674 (save-excursion
1675 (goto-char (point-max))
1676 (recenter -1)))
1677 (select-window selected)))))
1678 nil t))
1679 (set-buffer current))))
3ee91e68 1680
39a185a9
SM
1681(defun comint-truncate-buffer (&optional string)
1682 "Truncate the buffer to `comint-buffer-maximum-size'.
1683This function could be on `comint-output-filter-functions' or bound to a key."
1684 (interactive)
1685 (save-excursion
107d7589 1686 (goto-char (process-mark (get-buffer-process (current-buffer))))
39a185a9
SM
1687 (forward-line (- comint-buffer-maximum-size))
1688 (beginning-of-line)
1689 (delete-region (point-min) (point))))
1690
efcec33f
RS
1691(defun comint-strip-ctrl-m (&optional string)
1692 "Strip trailing `^M' characters from the current output group.
39a185a9 1693This function could be on `comint-output-filter-functions' or bound to a key."
efcec33f
RS
1694 (interactive)
1695 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1696 (save-excursion
71a895c6
KH
1697 (condition-case nil
1698 (goto-char
1699 (if (interactive-p) comint-last-input-end comint-last-output-start))
1700 (error nil))
efcec33f
RS
1701 (while (re-search-forward "\r+$" pmark t)
1702 (replace-match "" t t)))))
1703(defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1704
3ee91e68
RS
1705(defun comint-show-maximum-output ()
1706 "Put the end of the buffer at the bottom of the window."
1707 (interactive)
1708 (goto-char (point-max))
1709 (recenter -1))
5511e411 1710
be9b65ac 1711(defun comint-get-old-input-default ()
cccd719e 1712 "Default for `comint-get-old-input'.
29533923
MB
1713Returns either the current field, or the current line with any initial
1714text matching `comint-prompt-regexp' stripped off, depending on the
1715value of `comint-use-prompt-regexp-instead-of-fields'."
1716 (if comint-use-prompt-regexp-instead-of-fields
1717 (save-excursion
1718 (beginning-of-line)
1719 (comint-skip-prompt)
1720 (let ((beg (point)))
1721 (end-of-line)
1722 (buffer-substring beg (point))))
1723 ;; Return the contents of the field at the current point.
1ec321a7
MB
1724 (let ((pos (field-beginning (point))))
1725 (unless (eq (get-char-property pos 'field) 'input)
20770192 1726 (error "Not an input field"))
1ec321a7 1727 (field-string pos))))
49116ac0 1728
3ee91e68
RS
1729(defun comint-copy-old-input ()
1730 "Insert after prompt old input at point as new input to be edited.
1731Calls `comint-get-old-input' to get old input."
1732 (interactive)
1733 (let ((input (funcall comint-get-old-input))
814299a7 1734 (process (get-buffer-process (current-buffer))))
3ee91e68
RS
1735 (if (not process)
1736 (error "Current buffer has no process")
1737 (goto-char (process-mark process))
1738 (insert input))))
1739
49116ac0 1740(defun comint-skip-prompt ()
cccd719e 1741 "Skip past the text matching regexp `comint-prompt-regexp'.
49116ac0
JB
1742If this takes us past the end of the current line, don't skip at all."
1743 (let ((eol (save-excursion (end-of-line) (point))))
1744 (if (and (looking-at comint-prompt-regexp)
1745 (<= (match-end 0) eol))
1746 (goto-char (match-end 0)))))
1747
49116ac0 1748(defun comint-after-pmark-p ()
3ee91e68
RS
1749 "Return t if point is after the process output marker."
1750 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1751 (<= (marker-position pmark) (point))))
49116ac0
JB
1752
1753(defun comint-simple-send (proc string)
1754 "Default function for sending to PROC input STRING.
1755This just sends STRING plus a newline. To override this,
cccd719e 1756set the hook `comint-input-sender'."
49116ac0
JB
1757 (comint-send-string proc string)
1758 (comint-send-string proc "\n"))
be9b65ac 1759
29533923
MB
1760(defun comint-line-beginning-position ()
1761 "Returns the buffer position of the beginning of the line, after any prompt.
1762If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1763prompt skip is done by skipping text matching the regular expression
1764`comint-prompt-regexp', a buffer local variable."
1765 (if comint-use-prompt-regexp-instead-of-fields
1766 ;; Use comint-prompt-regexp
1767 (save-excursion
1768 (beginning-of-line)
1769 (comint-skip-prompt)
1770 (point))
1771 ;; Use input fields. Note that, unlike the behavior of
1772 ;; `line-beginning-position' inside a field, this function will
1773 ;; return the position of the end of a prompt, even if the point is
1774 ;; already inside the prompt. In order to do this, it assumes that
1775 ;; if there are two fields on a line, then the first one is the
1776 ;; prompt, and the second one is an input field, and is front-sticky
1777 ;; (as input fields should be).
1778 (constrain-to-field (line-beginning-position) (line-end-position))))
1779
1780(defun comint-bol (&optional arg)
be9b65ac 1781 "Goes to the beginning of line, then skips past the prompt, if any.
29533923
MB
1782If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1783If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1784prompt skip is done by skipping text matching the regular expression
a77db92b 1785`comint-prompt-regexp', a buffer local variable."
be9b65ac 1786 (interactive "P")
29533923 1787 (if arg
1cc9bc49
MB
1788 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1789 (forward-line 0)
29533923 1790 (goto-char (comint-line-beginning-position))))
be9b65ac 1791
b578f267
EN
1792;; These three functions are for entering text you don't want echoed or
1793;; saved -- typically passwords to ftp, telnet, or somesuch.
1794;; Just enter m-x send-invisible and type in your line, or add
1795;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
49116ac0 1796
87ef29fd 1797(defun comint-read-noecho (prompt &optional stars)
814299a7 1798 "Read a single line of text from user without echoing, and return it.
4be9a25f
NF
1799Prompt with argument PROMPT, a string. Optional argument STARS causes
1800input to be echoed with '*' characters on the prompt line. Input ends with
1801RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
cccd719e
RS
1802`inhibit-quit' is set because e.g. this function was called from a process
1803filter and C-g is pressed, this function returns nil rather than a string).
4be9a25f
NF
1804
1805Note that the keystrokes comprising the text can still be recovered
dc81e166
RS
1806\(temporarily) with \\[view-lossage]. Some people find this worrysome.
1807Once the caller uses the password, it can erase the password
1808by doing (fillarray STRING 0)."
4be9a25f 1809 (let ((ans "")
dc81e166 1810 (newans nil)
4be9a25f
NF
1811 (c 0)
1812 (echo-keystrokes 0)
87ef29fd 1813 (cursor-in-echo-area t)
23cb053e
KH
1814 (message-log-max nil)
1815 (done nil))
4be9a25f
NF
1816 (while (not done)
1817 (if stars
84a99e73
KH
1818 (message "%s%s" prompt (make-string (length ans) ?*))
1819 (message "%s" prompt))
af171fd0
RS
1820 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1821 (setq c (read-char-exclusive))
4be9a25f 1822 (cond ((= c ?\C-g)
59f36b08
SM
1823 ;; This function may get called from a process filter, where
1824 ;; inhibit-quit is set. In later versions of emacs read-char
1825 ;; may clear quit-flag itself and return C-g. That would make
1826 ;; it impossible to quit this loop in a simple way, so
1827 ;; re-enable it here (for backward-compatibility the check for
1828 ;; quit-flag below would still be necessary, so this seems
1829 ;; like the simplest way to do things).
1830 (setq quit-flag t
1831 done t))
1832 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1833 (setq done t))
1834 ((= c ?\C-u)
dc81e166 1835 (fillarray ans 0)
59f36b08
SM
1836 (setq ans ""))
1837 ((and (/= c ?\b) (/= c ?\177))
dc81e166
RS
1838 (setq newans (concat ans (char-to-string c)))
1839 (fillarray ans 0)
1840 (setq ans newans))
59f36b08 1841 ((> (length ans) 0)
dc81e166 1842 (aset ans (1- (length ans)) 0)
59f36b08 1843 (setq ans (substring ans 0 -1)))))
4be9a25f 1844 (if quit-flag
814299a7
MB
1845 ;; Emulate a true quit, except that we have to return a value.
1846 (prog1
1847 (setq quit-flag nil)
1848 (message "Quit")
1849 (beep t))
4be9a25f
NF
1850 (message "")
1851 ans)))
87ef29fd 1852
be9b65ac 1853(defun send-invisible (str)
c2ced5d8 1854 "Read a string without echoing.
6152f5f0
SM
1855Then send it to the process running in the current buffer.
1856The string is sent using `comint-input-sender'.
49116ac0
JB
1857Security bug: your string can still be temporarily recovered with
1858\\[view-lossage]."
4a11114d 1859 (interactive "P") ; Defeat snooping via C-x ESC ESC
be9b65ac 1860 (let ((proc (get-buffer-process (current-buffer))))
4a11114d
SM
1861 (cond ((not proc)
1862 (error "Current buffer has no process"))
1863 ((stringp str)
3db4b719 1864 (comint-snapshot-last-prompt)
4a11114d
SM
1865 (funcall comint-input-sender proc str))
1866 (t
1867 (let ((str (comint-read-noecho "Non-echoed text: " t)))
1868 (if (stringp str)
1869 (send-invisible str)
1870 (message "Warning: text will be echoed")))))))
21d9bf27 1871
814299a7 1872(defun comint-watch-for-password-prompt (string)
21d9bf27
RS
1873 "Prompt in the minibuffer for password and send without echoing.
1874This function uses `send-invisible' to read and send a password to the buffer's
814299a7 1875process if STRING contains a password prompt defined by
654d89d7 1876`comint-password-prompt-regexp'.
21d9bf27
RS
1877
1878This function could be in the list `comint-output-filter-functions'."
2464210e
MB
1879 (when (string-match comint-password-prompt-regexp string)
1880 (let ((pw (comint-read-noecho string t)))
1881 (send-invisible pw))))
be9b65ac 1882\f
b578f267 1883;; Low-level process communication
be9b65ac 1884
79e8dca7
MB
1885(defun comint-send-string (process string)
1886 "Like `process-send-string', but also does extra bookkeeping for comint mode."
9f626345
MB
1887 (if process
1888 (with-current-buffer (if (processp process)
1889 (process-buffer process)
1890 (get-buffer process))
1891 (comint-snapshot-last-prompt))
79e8dca7
MB
1892 (comint-snapshot-last-prompt))
1893 (process-send-string process string))
1894
1895(defun comint-send-region (process start end)
1896 "Like `process-send-region', but also does extra bookkeeping for comint mode."
9f626345
MB
1897 (if process
1898 (with-current-buffer (if (processp process)
1899 (process-buffer process)
1900 (get-buffer process))
1901 (comint-snapshot-last-prompt))
79e8dca7
MB
1902 (comint-snapshot-last-prompt))
1903 (process-send-region process start end))
be9b65ac 1904\f
b578f267 1905;; Random input hackage
be9b65ac 1906
4e217e50 1907(defun comint-delete-output ()
d134a19f 1908 "Delete all output from interpreter since last input.
3ee91e68 1909Does not delete the prompt."
be9b65ac 1910 (interactive)
a9a6f83f
RS
1911 (let ((proc (get-buffer-process (current-buffer)))
1912 (replacement nil))
1913 (save-excursion
1914 (let ((pmark (progn (goto-char (process-mark proc))
1e317a4a 1915 (forward-line 0)
a9a6f83f
RS
1916 (point-marker))))
1917 (delete-region comint-last-input-end pmark)
37a9a675 1918 (goto-char (process-mark proc))
a9a6f83f
RS
1919 (setq replacement (concat "*** output flushed ***\n"
1920 (buffer-substring pmark (point))))
1921 (delete-region pmark (point))))
1922 ;; Output message and put back prompt
1923 (comint-output-filter proc replacement)))
4e217e50
MB
1924(defalias 'comint-kill-output 'comint-delete-output)
1925(make-obsolete 'comint-kill-output 'comint-delete-output "21.1")
be9b65ac 1926
0da5c14a 1927(defun comint-write-output (filename &optional append mustbenew)
d134a19f
MB
1928 "Write output from interpreter since last input to FILENAME.
1929Any prompt at the end of the output is not written.
1930
0da5c14a
MB
1931If the optional argument APPEND (the prefix argument when interactive)
1932is non-nil, the output is appended to the file instead.
1933
1934If the optional argument MUSTBENEW is non-nil, check for an existing
1935file with the same name. If MUSTBENEW is `excl', that means to get an
1936error if the file already exists; never overwrite. If MUSTBENEW is
1937neither nil nor `excl', that means ask for confirmation before
1938overwriting, but do go ahead and overwrite the file if the user
1939confirms. When interactive, MUSTBENEW is nil when appending, and t
1940otherwise."
1941 (interactive
1942 (list (read-file-name
1943 (if current-prefix-arg
1944 "Append output to file: "
1945 "Write output to file: "))
1946 current-prefix-arg
1947 (not current-prefix-arg)))
d134a19f
MB
1948 (save-excursion
1949 (goto-char (process-mark (get-buffer-process (current-buffer))))
1950 (forward-line 0)
0da5c14a
MB
1951 (write-region comint-last-input-end (point) filename
1952 append nil nil mustbenew)))
d134a19f 1953
44016d25
MB
1954;; This function exists for the benefit of the menu; from the keyboard,
1955;; users can just use `comint-write-output' with a prefix arg.
1956(defun comint-append-output-to-file (filename)
1957 "Append output from interpreter since last input to FILENAME.
1958Any prompt at the end of the output is not written."
1959 (interactive "fAppend output to file: ")
1960 (comint-write-output filename t))
1961
be9b65ac 1962(defun comint-show-output ()
49116ac0 1963 "Display start of this batch of interpreter output at top of window.
21d9bf27 1964Sets mark to the value of point when this command is run."
be9b65ac 1965 (interactive)
815c1a20 1966 (push-mark)
29533923
MB
1967 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
1968 (cond (comint-use-prompt-regexp-instead-of-fields
1969 (goto-char pos)
1970 (beginning-of-line 0)
1971 (set-window-start (selected-window) (point))
1972 (comint-skip-prompt))
1973 (t
1974 (goto-char (field-beginning pos))
1975 (set-window-start (selected-window) (point))))))
1976
be9b65ac
DL
1977
1978(defun comint-interrupt-subjob ()
1a94abea
RS
1979 "Interrupt the current subjob.
1980This command also kills the pending input
1981between the process-mark and point."
be9b65ac 1982 (interactive)
1a94abea 1983 (comint-kill-input)
49116ac0 1984 (interrupt-process nil comint-ptyp))
be9b65ac
DL
1985
1986(defun comint-kill-subjob ()
1a94abea
RS
1987 "Send kill signal to the current subjob.
1988This command also kills the pending input
1989between the process-mark and point."
be9b65ac 1990 (interactive)
1a94abea 1991 (comint-kill-input)
49116ac0 1992 (kill-process nil comint-ptyp))
be9b65ac
DL
1993
1994(defun comint-quit-subjob ()
1a94abea
RS
1995 "Send quit signal to the current subjob.
1996This command also kills the pending input
1997between the process-mark and point."
be9b65ac 1998 (interactive)
1a94abea 1999 (comint-kill-input)
49116ac0 2000 (quit-process nil comint-ptyp))
be9b65ac
DL
2001
2002(defun comint-stop-subjob ()
49116ac0 2003 "Stop the current subjob.
1a94abea
RS
2004This command also kills the pending input
2005between the process-mark and point.
2006
be9b65ac 2007WARNING: if there is no current subjob, you can end up suspending
49116ac0
JB
2008the top-level process running in the buffer. If you accidentally do
2009this, use \\[comint-continue-subjob] to resume the process. (This
2010is not a problem with most shells, since they ignore this signal.)"
be9b65ac 2011 (interactive)
1a94abea 2012 (comint-kill-input)
49116ac0 2013 (stop-process nil comint-ptyp))
be9b65ac
DL
2014
2015(defun comint-continue-subjob ()
49116ac0 2016 "Send CONT signal to process buffer's process group.
be9b65ac
DL
2017Useful if you accidentally suspend the top-level process."
2018 (interactive)
49116ac0 2019 (continue-process nil comint-ptyp))
be9b65ac
DL
2020
2021(defun comint-kill-input ()
49116ac0 2022 "Kill all text from last stuff output by interpreter to point."
be9b65ac 2023 (interactive)
3ee91e68
RS
2024 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2025 (if (> (point) (marker-position pmark))
49116ac0 2026 (kill-region pmark (point)))))
be9b65ac
DL
2027
2028(defun comint-delchar-or-maybe-eof (arg)
4a11114d
SM
2029 "Delete ARG characters forward or send an EOF to subprocess.
2030Sends an EOF only if point is at the end of the buffer and there is no input."
be9b65ac 2031 (interactive "p")
90d6bfb9
KH
2032 (let ((proc (get-buffer-process (current-buffer))))
2033 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
3db4b719 2034 (comint-send-eof)
4a11114d 2035 (delete-char arg))))
49116ac0 2036
1de80a34
RM
2037(defun comint-send-eof ()
2038 "Send an EOF to the current buffer's process."
2039 (interactive)
3db4b719 2040 (comint-snapshot-last-prompt)
1de80a34 2041 (process-send-eof))
49116ac0 2042
3ee91e68
RS
2043
2044(defun comint-backward-matching-input (regexp arg)
29533923
MB
2045 "Search backward through buffer for input fields that match REGEXP.
2046If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2047fields are identified by lines that match `comint-prompt-regexp'.
2048
3ee91e68
RS
2049With prefix argument N, search for Nth previous match.
2050If N is negative, find the next or Nth next match."
2051 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
29533923
MB
2052 (if comint-use-prompt-regexp-instead-of-fields
2053 ;; Use comint-prompt-regexp
2054 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2055 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2056 (if (re-search-backward re nil t arg)
2057 (point)))))
2058 (if (null pos)
2059 (progn (message "Not found")
2060 (ding))
2061 (goto-char pos)
2062 (comint-bol nil)))
2063 ;; Use input fields
2064 (let* ((dir (if (< arg 0) -1 1))
2065 (pos
2066 (save-excursion
2067 (while (/= arg 0)
2068 (unless (re-search-backward regexp nil t dir)
2069 (error "Not found"))
2070 (when (eq (get-char-property (point) 'field) 'input)
2071 (setq arg (- arg dir))))
2072 (field-beginning))))
2073 (goto-char pos))))
2074
3ee91e68
RS
2075
2076(defun comint-forward-matching-input (regexp arg)
29533923
MB
2077 "Search forward through buffer for input fields that match REGEXP.
2078If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2079fields are identified by lines that match `comint-prompt-regexp'.
2080
3ee91e68
RS
2081With prefix argument N, search for Nth following match.
2082If N is negative, find the previous or Nth previous match."
2083 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2084 (comint-backward-matching-input regexp (- arg)))
2085
2086
1de80a34 2087(defun comint-next-prompt (n)
3ee91e68 2088 "Move to end of Nth next prompt in the buffer.
29533923
MB
2089If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2090the beginning of the Nth next `input' field, otherwise, it means the Nth
2091occurance of text matching `comint-prompt-regexp'."
1de80a34 2092 (interactive "p")
29533923
MB
2093 (if comint-use-prompt-regexp-instead-of-fields
2094 ;; Use comint-prompt-regexp
2095 (let ((paragraph-start comint-prompt-regexp))
2096 (end-of-line (if (> n 0) 1 0))
2097 (forward-paragraph n)
2098 (comint-skip-prompt))
2099 ;; Use input fields
2100 (let ((pos (point))
2101 (input-pos nil))
2102 (while (/= n 0)
2103 (setq pos
2104 (if (> n 0)
2105 (next-single-char-property-change pos 'field)
2106 (previous-single-char-property-change pos 'field)))
2107 (cond ((null pos)
2108 ;; Ran off the end of the buffer.
2109 (setq n 0))
2110 ((eq (get-char-property pos 'field) 'input)
2111 (setq n (if (< n 0) (1+ n) (1- n)))
2112 (setq input-pos pos))))
2113 (when input-pos
2114 (goto-char input-pos)))))
2115
49116ac0 2116
3ee91e68
RS
2117(defun comint-previous-prompt (n)
2118 "Move to end of Nth previous prompt in the buffer.
29533923
MB
2119If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2120the beginning of the Nth previous `input' field, otherwise, it means the Nth
2121occurance of text matching `comint-prompt-regexp'."
1de80a34 2122 (interactive "p")
3ee91e68 2123 (comint-next-prompt (- n)))
be9b65ac 2124\f
b578f267
EN
2125;; Support for source-file processing commands.
2126;;============================================================================
2127;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2128;; commands that process files of source text (e.g. loading or compiling
2129;; files). So the corresponding process-in-a-buffer modes have commands
2130;; for doing this (e.g., lisp-load-file). The functions below are useful
2131;; for defining these commands.
2132;;
2133;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2134;; and Soar, in that they don't know anything about file extensions.
2135;; So the compile/load interface gets the wrong default occasionally.
2136;; The load-file/compile-file default mechanism could be smarter -- it
2137;; doesn't know about the relationship between filename extensions and
2138;; whether the file is source or executable. If you compile foo.lisp
2139;; with compile-file, then the next load-file should use foo.bin for
2140;; the default, not foo.lisp. This is tricky to do right, particularly
2141;; because the extension for executable files varies so much (.o, .bin,
2142;; .lbin, .mo, .vo, .ao, ...).
2143
2144
2145;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2146;; commands.
2147;;
2148;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2149;; want to save the buffer before issuing any process requests to the command
2150;; interpreter.
2151;;
2152;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2153;; for the file to process.
2154
2155;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2156;;============================================================================
2157;; This function computes the defaults for the load-file and compile-file
814299a7
MB
2158;; commands for tea, soar, cmulisp, and cmuscheme modes.
2159;;
2160;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
b578f267
EN
2161;; source-file processing command. NIL if there hasn't been one yet.
2162;; - SOURCE-MODES is a list used to determine what buffers contain source
2163;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2164;; Typically, (lisp-mode) or (scheme-mode).
814299a7 2165;;
b578f267
EN
2166;; If the command is given while the cursor is inside a string, *and*
2167;; the string is an existing filename, *and* the filename is not a directory,
2168;; then the string is taken as default. This allows you to just position
2169;; your cursor over a string that's a filename and have it taken as default.
2170;;
2171;; If the command is given in a file buffer whose major mode is in
2172;; SOURCE-MODES, then the the filename is the default file, and the
2173;; file's directory is the default directory.
814299a7 2174;;
b578f267
EN
2175;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2176;; then the default directory & file are what was used in the last source-file
2177;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2178;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2179;; is the cwd, with no default file. (\"no default file\" = nil)
814299a7 2180;;
b578f267
EN
2181;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2182;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2183;; for Soar programs, etc.
814299a7 2184;;
b578f267 2185;; The function returns a pair: (default-directory . default-file).
be9b65ac
DL
2186
2187(defun comint-source-default (previous-dir/file source-modes)
2188 (cond ((and buffer-file-name (memq major-mode source-modes))
2189 (cons (file-name-directory buffer-file-name)
2190 (file-name-nondirectory buffer-file-name)))
2191 (previous-dir/file)
2192 (t
2193 (cons default-directory nil))))
2194
49116ac0 2195
b578f267
EN
2196;; (COMINT-CHECK-SOURCE fname)
2197;;============================================================================
2198;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2199;; process-in-a-buffer modes), this function can be called on the filename.
2200;; If the file is loaded into a buffer, and the buffer is modified, the user
2201;; is queried to see if he wants to save the buffer before proceeding with
2202;; the load or compile.
be9b65ac
DL
2203
2204(defun comint-check-source (fname)
2205 (let ((buff (get-file-buffer fname)))
2206 (if (and buff
2207 (buffer-modified-p buff)
3ee91e68 2208 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
be9b65ac
DL
2209 ;; save BUFF.
2210 (let ((old-buffer (current-buffer)))
2211 (set-buffer buff)
2212 (save-buffer)
2213 (set-buffer old-buffer)))))
2214
49116ac0 2215
b578f267
EN
2216;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2217;;============================================================================
2218;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2219;; commands that process source files (like loading or compiling a file).
2220;; It prompts for the filename, provides a default, if there is one,
2221;; and returns the result filename.
814299a7 2222;;
b578f267 2223;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
814299a7 2224;;
b578f267
EN
2225;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2226;; from the last source processing command. SOURCE-MODES is a list of major
2227;; modes used to determine what file buffers contain source files. (These
2228;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2229;; then the filename reader will only accept a file that exists.
814299a7 2230;;
b578f267
EN
2231;; A typical use:
2232;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2233;; '(lisp-mode) t))
2234
2235;; This is pretty stupid about strings. It decides we're in a string
2236;; if there's a quote on both sides of point on the current line.
be9b65ac 2237(defun comint-extract-string ()
814299a7 2238 "Return string around POINT that starts the current line, or nil."
be9b65ac
DL
2239 (save-excursion
2240 (let* ((point (point))
2241 (bol (progn (beginning-of-line) (point)))
2242 (eol (progn (end-of-line) (point)))
814299a7
MB
2243 (start (progn (goto-char point)
2244 (and (search-backward "\"" bol t)
be9b65ac
DL
2245 (1+ (point)))))
2246 (end (progn (goto-char point)
2247 (and (search-forward "\"" eol t)
2248 (1- (point))))))
2249 (and start end
2250 (buffer-substring start end)))))
2251
2252(defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2253 (let* ((def (comint-source-default prev-dir/file source-modes))
814299a7 2254 (stringfile (comint-extract-string))
be9b65ac 2255 (sfile-p (and stringfile
49116ac0
JB
2256 (condition-case ()
2257 (file-exists-p stringfile)
2258 (error nil))
be9b65ac
DL
2259 (not (file-directory-p stringfile))))
2260 (defdir (if sfile-p (file-name-directory stringfile)
814299a7 2261 (car def)))
be9b65ac 2262 (deffile (if sfile-p (file-name-nondirectory stringfile)
814299a7 2263 (cdr def)))
be9b65ac
DL
2264 (ans (read-file-name (if deffile (format "%s(default %s) "
2265 prompt deffile)
2266 prompt)
2267 defdir
2268 (concat defdir deffile)
2269 mustmatch-p)))
2270 (list (expand-file-name (substitute-in-file-name ans)))))
2271
b578f267
EN
2272;; I am somewhat divided on this string-default feature. It seems
2273;; to violate the principle-of-least-astonishment, in that it makes
2274;; the default harder to predict, so you actually have to look and see
2275;; what the default really is before choosing it. This can trip you up.
2276;; On the other hand, it can be useful, I guess. I would appreciate feedback
2277;; on this.
2278;; -Olin
49116ac0 2279
be9b65ac 2280\f
b578f267
EN
2281;; Simple process query facility.
2282;; ===========================================================================
2283;; This function is for commands that want to send a query to the process
2284;; and show the response to the user. For example, a command to get the
2285;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2286;; to an inferior Common Lisp process.
814299a7 2287;;
b578f267
EN
2288;; This simple facility just sends strings to the inferior process and pops
2289;; up a window for the process buffer so you can see what the process
2290;; responds with. We don't do anything fancy like try to intercept what the
2291;; process responds with and put it in a pop-up window or on the message
2292;; line. We just display the buffer. Low tech. Simple. Works good.
2293
2294;; Send to the inferior process PROC the string STR. Pop-up but do not select
2295;; a window for the inferior process so that its response can be seen.
be9b65ac
DL
2296(defun comint-proc-query (proc str)
2297 (let* ((proc-buf (process-buffer proc))
2298 (proc-mark (process-mark proc)))
2299 (display-buffer proc-buf)
2300 (set-buffer proc-buf) ; but it's not the selected *window*
2301 (let ((proc-win (get-buffer-window proc-buf))
2302 (proc-pt (marker-position proc-mark)))
2303 (comint-send-string proc str) ; send the query
2304 (accept-process-output proc) ; wait for some output
2305 ;; Try to position the proc window so you can see the answer.
2306 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2307 ;; I don't know why. Wizards invited to improve it.
17193f89
SM
2308 (unless (pos-visible-in-window-p proc-pt proc-win)
2309 (let ((opoint (window-point proc-win)))
2310 (set-window-point proc-win proc-mark)
2311 (sit-for 0)
2312 (if (not (pos-visible-in-window-p opoint proc-win))
2313 (push-mark opoint)
2314 (set-window-point proc-win opoint)))))))
be9b65ac
DL
2315
2316\f
b578f267
EN
2317;; Filename/command/history completion in a buffer
2318;; ===========================================================================
2319;; Useful completion functions, courtesy of the Ergo group.
2320
2321;; Six commands:
2322;; comint-dynamic-complete Complete or expand command, filename,
2323;; history at point.
2324;; comint-dynamic-complete-filename Complete filename at point.
2325;; comint-dynamic-list-filename-completions List completions in help buffer.
2326;; comint-replace-by-expanded-filename Expand and complete filename at point;
2327;; replace with expanded/completed name.
2328;; comint-dynamic-simple-complete Complete stub given candidates.
2329
2330;; These are not installed in the comint-mode keymap. But they are
2331;; available for people who want them. Shell-mode installs them:
2332;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2333;; (define-key shell-mode-map "\M-?"
2334;; 'comint-dynamic-list-filename-completions)))
2335;;
2336;; Commands like this are fine things to put in load hooks if you
2337;; want them present in specific modes.
49116ac0 2338
ed366e87 2339(defcustom comint-completion-autolist nil
5ef2f81f 2340 "*If non-nil, automatically list possibilities on partial completion.
ed366e87
RS
2341This mirrors the optional behavior of tcsh."
2342 :type 'boolean
2343 :group 'comint-completion)
3ee91e68 2344
ed366e87 2345(defcustom comint-completion-addsuffix t
3ee91e68 2346 "*If non-nil, add a `/' to completed directories, ` ' to file names.
59f36b08
SM
2347If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2348DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
ed366e87 2349This mirrors the optional behavior of tcsh."
97342eb1 2350 :type '(choice (const :tag "None" nil)
51d001f7 2351 (const :tag "Add /" t)
97342eb1
DL
2352 (cons :tag "Suffix pair"
2353 (string :tag "Directory suffix")
2354 (string :tag "File suffix")))
ed366e87 2355 :group 'comint-completion)
3ee91e68 2356
ed366e87 2357(defcustom comint-completion-recexact nil
3ee91e68 2358 "*If non-nil, use shortest completion if characters cannot be added.
fdb7791d 2359This mirrors the optional behavior of tcsh.
3ee91e68 2360
ed366e87
RS
2361A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2362 :type 'boolean
2363 :group 'comint-completion)
3ee91e68 2364
ed366e87 2365(defcustom comint-completion-fignore nil
497513ad
RS
2366 "*List of suffixes to be disregarded during file completion.
2367This mirrors the optional behavior of bash and tcsh.
2368
ed366e87
RS
2369Note that this applies to `comint-dynamic-complete-filename' only."
2370 :type '(repeat (string :tag "Suffix"))
2371 :group 'comint-completion)
497513ad 2372
3ee91e68
RS
2373(defvar comint-file-name-prefix ""
2374 "Prefix prepended to absolute file names taken from process input.
2375This is used by comint's and shell's completion functions, and by shell's
2376directory tracking functions.")
be9b65ac 2377
2d4382e5 2378(defvar comint-file-name-chars
da418b28
GV
2379 (if (memq system-type '(ms-dos windows-nt))
2380 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2381 "~/A-Za-z0-9+@:_.$#%,={}-")
2d4382e5 2382 "String of characters valid in a file name.
af898b0f
RS
2383Note that all non-ASCII characters are considered valid in a file name
2384regardless of what this variable says.
107d7589
SM
2385
2386This is a good thing to set in mode hooks.")
2387
59f36b08 2388(defvar comint-file-name-quote-list nil
6d2a6ce6 2389 "List of characters to quote with `\\' when in a file name.
59f36b08
SM
2390
2391This is a good thing to set in mode hooks.")
2392
3ee91e68
RS
2393
2394(defun comint-directory (directory)
2395 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2396 (expand-file-name (if (file-name-absolute-p directory)
2397 (concat comint-file-name-prefix directory)
2398 directory)))
2399
2400
1b421826
RS
2401(defun comint-word (word-chars)
2402 "Return the word of WORD-CHARS at point, or nil if non is found.
2403Word constituents are considered to be those in WORD-CHARS, which is like the
af898b0f
RS
2404inside of a \"[...]\" (see `skip-chars-forward'),
2405plus all non-ASCII characters."
3ee91e68 2406 (save-excursion
59f36b08
SM
2407 (let ((non-word-chars (concat "[^\\\\" word-chars "]")) (here (point)))
2408 (while (and (re-search-backward non-word-chars nil 'move)
af898b0f
RS
2409 ;;(memq (char-after (point)) shell-file-name-quote-list)
2410 (or (>= (following-char) 128)
2411 (eq (preceding-char) ?\\)))
59f36b08 2412 (backward-char 1))
4288965c 2413 ;; Don't go forward over a word-char (this can happen if we're at bob).
17193f89
SM
2414 (when (or (not (bobp)) (looking-at non-word-chars))
2415 (forward-char 1))
4288965c 2416 ;; Set match-data to match the entire string.
17193f89 2417 (when (< (point) here)
e4947876 2418 (set-match-data (list (point) here))
17193f89 2419 (match-string 0)))))
3ee91e68 2420
7a35a067
RS
2421(defun comint-substitute-in-file-name (filename)
2422 "Return FILENAME with environment variables substituted.
2423Supports additional environment variable syntax of the command
2424interpreter (e.g., the percent notation of cmd.exe on NT)."
2425 (let ((name (substitute-in-file-name filename)))
2426 (if (memq system-type '(ms-dos windows-nt))
2427 (let (env-var-name
2428 env-var-val)
2429 (save-match-data
2430 (while (string-match "%\\([^\\\\/]*\\)%" name)
814299a7 2431 (setq env-var-name
7a35a067
RS
2432 (substring name (match-beginning 1) (match-end 1)))
2433 (setq env-var-val (if (getenv env-var-name)
2434 (getenv env-var-name)
2435 ""))
db7ae45b 2436 (setq name (replace-match env-var-val t t name))))))
7a35a067 2437 name))
3ee91e68 2438
1b421826
RS
2439(defun comint-match-partial-filename ()
2440 "Return the filename at point, or nil if non is found.
2441Environment variables are substituted. See `comint-word'."
2d4382e5 2442 (let ((filename (comint-word comint-file-name-chars)))
814299a7 2443 (and filename (comint-substitute-in-file-name
7a35a067 2444 (comint-unquote-filename filename)))))
59f36b08
SM
2445
2446
2447(defun comint-quote-filename (filename)
2448 "Return FILENAME with magic characters quoted.
2449Magic characters are those in `comint-file-name-quote-list'."
2450 (if (null comint-file-name-quote-list)
2451 filename
2452 (let ((regexp
2453 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2454 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2455 (save-match-data
2456 (while (string-match regexp filename)
2457 (setq filename (replace-match "\\1\\\\\\2" nil nil filename)))
2458 filename))))
2459
2460(defun comint-unquote-filename (filename)
2461 "Return FILENAME with quoted characters unquoted."
2462 (if (null comint-file-name-quote-list)
2463 filename
2464 (save-match-data
dbdfff7f
RS
2465 (let ((i 0))
2466 (while (string-match "\\\\\\(.\\)" filename i)
2467 (setq filename (replace-match "\\1" nil nil filename))
2468 (setq i (+ 1 (match-beginning 0)))))
59f36b08 2469 filename)))
be9b65ac 2470
49116ac0 2471
be9b65ac 2472(defun comint-dynamic-complete ()
1b421826
RS
2473 "Dynamically perform completion at point.
2474Calls the functions in `comint-dynamic-complete-functions' to perform
2475completion until a function returns non-nil, at which point completion is
2476assumed to have occurred."
3ee91e68 2477 (interactive)
155fd027 2478 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
3ee91e68
RS
2479
2480
2481(defun comint-dynamic-complete-filename ()
49116ac0 2482 "Dynamically complete the filename at point.
1b421826
RS
2483Completes if after a filename. See `comint-match-partial-filename' and
2484`comint-dynamic-complete-as-filename'.
3ee91e68
RS
2485This function is similar to `comint-replace-by-expanded-filename', except that
2486it won't change parts of the filename already entered in the buffer; it just
2487adds completion characters to the end of the filename. A completions listing
2488may be shown in a help buffer if completion is ambiguous.
2489
497513ad
RS
2490Completion is dependent on the value of `comint-completion-addsuffix',
2491`comint-completion-recexact' and `comint-completion-fignore', and the timing of
2492completions listing is dependent on the value of `comint-completion-autolist'.
1b421826
RS
2493
2494Returns t if successful."
3ee91e68 2495 (interactive)
17193f89
SM
2496 (when (comint-match-partial-filename)
2497 (unless (window-minibuffer-p (selected-window))
2498 (message "Completing file name..."))
2499 (comint-dynamic-complete-as-filename)))
1b421826
RS
2500
2501(defun comint-dynamic-complete-as-filename ()
2502 "Dynamically complete at point as a filename.
2503See `comint-dynamic-complete-filename'. Returns t if successful."
107d7589 2504 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
497513ad 2505 (completion-ignored-extensions comint-completion-fignore)
107d7589
SM
2506 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2507 ;; I think it was originally bound to solve file completion problems,
2508 ;; but subsequent changes may have made this unnecessary. sm.
2509 ;;(file-name-handler-alist nil)
81fb2771 2510 (minibuffer-p (window-minibuffer-p (selected-window)))
1b421826 2511 (success t)
17193f89
SM
2512 (dirsuffix (cond ((not comint-completion-addsuffix)
2513 "")
2514 ((not (consp comint-completion-addsuffix))
2515 (char-to-string directory-sep-char))
2516 (t
2517 (car comint-completion-addsuffix))))
2518 (filesuffix (cond ((not comint-completion-addsuffix)
2519 "")
2520 ((not (consp comint-completion-addsuffix))
2521 " ")
2522 (t
2523 (cdr comint-completion-addsuffix))))
f79f58bc
KH
2524 (filename (or (comint-match-partial-filename) ""))
2525 (pathdir (file-name-directory filename))
2526 (pathnondir (file-name-nondirectory filename))
2527 (directory (if pathdir (comint-directory pathdir) default-directory))
81fb2771 2528 (completion (file-name-completion pathnondir directory)))
3ee91e68 2529 (cond ((null completion)
814299a7 2530 (message "No completions of %s" filename)
1b421826 2531 (setq success nil))
814299a7
MB
2532 ((eq completion t) ; Means already completed "file".
2533 (insert filesuffix)
2534 (unless minibuffer-p
17193f89 2535 (message "Sole completion")))
814299a7
MB
2536 ((string-equal completion "") ; Means completion on "directory/".
2537 (comint-dynamic-list-filename-completions))
2538 (t ; Completion string returned.
2539 (let ((file (concat (file-name-as-directory directory) completion)))
59f36b08
SM
2540 (insert (comint-quote-filename
2541 (substring (directory-file-name completion)
2542 (length pathnondir))))
814299a7
MB
2543 (cond ((symbolp (file-name-completion completion directory))
2544 ;; We inserted a unique completion.
59f36b08 2545 (insert (if (file-directory-p file) dirsuffix filesuffix))
814299a7 2546 (unless minibuffer-p
17193f89 2547 (message "Completed")))
814299a7
MB
2548 ((and comint-completion-recexact comint-completion-addsuffix
2549 (string-equal pathnondir completion)
2550 (file-exists-p file))
2551 ;; It's not unique, but user wants shortest match.
2552 (insert (if (file-directory-p file) dirsuffix filesuffix))
2553 (unless minibuffer-p
17193f89 2554 (message "Completed shortest")))
814299a7
MB
2555 ((or comint-completion-autolist
2556 (string-equal pathnondir completion))
2557 ;; It's not unique, list possible completions.
2558 (comint-dynamic-list-filename-completions))
2559 (t
2560 (unless minibuffer-p
17193f89 2561 (message "Partially completed")))))))
1b421826 2562 success))
3ee91e68
RS
2563
2564
2565(defun comint-replace-by-expanded-filename ()
2566 "Dynamically expand and complete the filename at point.
2567Replace the filename with an expanded, canonicalised and completed replacement.
2568\"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2569with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2570removed, and the filename is made absolute instead of relative. For expansion
2571see `expand-file-name' and `substitute-in-file-name'. For completion see
2572`comint-dynamic-complete-filename'."
be9b65ac 2573 (interactive)
3ee91e68
RS
2574 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
2575 (comint-dynamic-complete-filename))
2576
2577
3ee91e68
RS
2578(defun comint-dynamic-simple-complete (stub candidates)
2579 "Dynamically complete STUB from CANDIDATES list.
2580This function inserts completion characters at point by completing STUB from
2581the strings in CANDIDATES. A completions listing may be shown in a help buffer
2582if completion is ambiguous.
2583
1b421826
RS
2584Returns nil if no completion was inserted.
2585Returns `sole' if completed with the only completion match.
2586Returns `shortest' if completed with the shortest of the completion matches.
2587Returns `partial' if completed as far as possible with the completion matches.
2588Returns `listed' if a completion listing was shown.
2589
3ee91e68 2590See also `comint-dynamic-complete-filename'."
107d7589 2591 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
59f36b08
SM
2592 (suffix (cond ((not comint-completion-addsuffix) "")
2593 ((not (consp comint-completion-addsuffix)) " ")
2594 (t (cdr comint-completion-addsuffix))))
3ee91e68
RS
2595 (candidates (mapcar (function (lambda (x) (list x))) candidates))
2596 (completions (all-completions stub candidates)))
be9b65ac 2597 (cond ((null completions)
814299a7 2598 (message "No completions of %s" stub)
1b421826 2599 nil)
814299a7
MB
2600 ((= 1 (length completions)) ; Gotcha!
2601 (let ((completion (car completions)))
2602 (if (string-equal completion stub)
2603 (message "Sole completion")
2604 (insert (substring completion (length stub)))
2605 (message "Completed"))
59f36b08 2606 (insert suffix)
1b421826 2607 'sole))
814299a7
MB
2608 (t ; There's no unique completion.
2609 (let ((completion (try-completion stub candidates)))
2610 ;; Insert the longest substring.
2611 (insert (substring completion (length stub)))
2612 (cond ((and comint-completion-recexact comint-completion-addsuffix
2613 (string-equal stub completion)
2614 (member completion completions))
2615 ;; It's not unique, but user wants shortest match.
2616 (insert suffix)
2617 (message "Completed shortest")
1b421826 2618 'shortest)
814299a7
MB
2619 ((or comint-completion-autolist
2620 (string-equal stub completion))
2621 ;; It's not unique, list possible completions.
2622 (comint-dynamic-list-completions completions)
1b421826 2623 'listed)
814299a7 2624 (t
1b421826
RS
2625 (message "Partially completed")
2626 'partial)))))))
3ee91e68
RS
2627
2628
2629(defun comint-dynamic-list-filename-completions ()
2630 "List in help buffer possible completions of the filename at point."
2631 (interactive)
107d7589
SM
2632 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
2633 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2634 ;; I think it was originally bound to solve file completion problems,
2635 ;; but subsequent changes may have made this unnecessary. sm.
2636 ;;(file-name-handler-alist nil)
1b421826 2637 (filename (or (comint-match-partial-filename) ""))
3ee91e68
RS
2638 (pathdir (file-name-directory filename))
2639 (pathnondir (file-name-nondirectory filename))
2640 (directory (if pathdir (comint-directory pathdir) default-directory))
2641 (completions (file-name-all-completions pathnondir directory)))
59f36b08
SM
2642 (if (not completions)
2643 (message "No completions of %s" filename)
2644 (comint-dynamic-list-completions
2645 (mapcar 'comint-quote-filename completions)))))
3ee91e68
RS
2646
2647
2648(defun comint-dynamic-list-completions (completions)
2649 "List in help buffer sorted COMPLETIONS.
2650Typing SPC flushes the help buffer."
2651 (let ((conf (current-window-configuration)))
dd3038f6 2652 (with-output-to-temp-buffer "*Completions*"
3ee91e68 2653 (display-completion-list (sort completions 'string-lessp)))
3ee91e68 2654 (message "Hit space to flush")
7d5d472e
RS
2655 (let (key first)
2656 (if (save-excursion
dd3038f6 2657 (set-buffer (get-buffer "*Completions*"))
7d5d472e
RS
2658 (setq key (read-key-sequence nil)
2659 first (aref key 0))
eb6c110a 2660 (and (consp first) (consp (event-start first))
7d5d472e 2661 (eq (window-buffer (posn-window (event-start first)))
dd3038f6 2662 (get-buffer "*Completions*"))
7d5d472e
RS
2663 (eq (key-binding key) 'mouse-choose-completion)))
2664 ;; If the user does mouse-choose-completion with the mouse,
2665 ;; execute the command, then delete the completion window.
2666 (progn
2667 (mouse-choose-completion first)
2668 (set-window-configuration conf))
2669 (if (eq first ?\ )
2670 (set-window-configuration conf)
2b5a5ed3 2671 (setq unread-command-events (listify-key-sequence key)))))))
be9b65ac 2672\f
361ecbf2
RS
2673(defun comint-get-next-from-history ()
2674 "After fetching a line from input history, this fetches the following line.
2675In other words, this recalls the input line after the line you recalled last.
2676You can use this to repeat a sequence of input lines."
2677 (interactive)
2678 (if comint-save-input-ring-index
2679 (progn
2680 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2681 (comint-next-input 1))
2682 (message "No previous history command")))
2683
2684(defun comint-accumulate ()
2685 "Accumulate a line to send as input along with more lines.
2686This inserts a newline so that you can enter more text
2687to be sent along with this line. Use \\[comint-send-input]
2688to send all the accumulated input, at once.
2689The entire accumulated text becomes one item in the input history
2690when you send it."
2691 (interactive)
2692 (insert "\n")
2693 (set-marker comint-accum-marker (point))
2694 (if comint-input-ring-index
2695 (setq comint-save-input-ring-index
2696 (- comint-input-ring-index 1))))
2697
2698(defun comint-goto-process-mark ()
2699 "Move point to the process mark.
2700The process mark separates output, and input already sent,
2701from input that has not yet been sent."
2702 (interactive)
2703 (let ((proc (or (get-buffer-process (current-buffer))
2704 (error "Current buffer has no process"))))
2705 (goto-char (process-mark proc))
bec04ade
GM
2706 (when (interactive-p)
2707 (message "Point is now at the process mark"))))
361ecbf2
RS
2708
2709(defun comint-bol-or-process-mark ()
37dbcd5c 2710 "Move point to beginning of line (after prompt) or to the process mark.
361ecbf2
RS
2711The first time you use this command, it moves to the beginning of the line
2712\(but after the prompt, if any). If you repeat it again immediately,
2713it moves point to the process mark.
2714
2715The process mark separates the process output, along with input already sent,
2716from input that has not yet been sent. Ordinarily, the process mark
2717is at the beginning of the current input line; but if you have
2718used \\[comint-accumulate] to send multiple lines at once,
2719the process mark is at the beginning of the accumulated input."
2720 (interactive)
c2705d61 2721 (if (not (eq last-command 'comint-bol-or-process-mark))
361ecbf2
RS
2722 (comint-bol nil)
2723 (comint-goto-process-mark)))
2724
2725(defun comint-set-process-mark ()
2726 "Set the process mark at point."
2727 (interactive)
2728 (let ((proc (or (get-buffer-process (current-buffer))
2729 (error "Current buffer has no process"))))
2730 (set-marker (process-mark proc) (point))
2731 (message "Process mark set")))
2732
2733\f
3965beb0
GM
2734;; Author: Peter Breton <pbreton@ne.mediaone.net>
2735
2736;; This little add-on for comint is intended to make it easy to get
2737;; output from currently active comint buffers into another buffer,
2738;; or buffers, and then go back to using the comint shell.
814299a7 2739;;
3965beb0
GM
2740;; My particular use is SQL interpreters; I want to be able to execute a
2741;; query using the process associated with a comint-buffer, and save that
2742;; somewhere else. Because the process might have state (for example, it
2743;; could be in an uncommitted transaction), just running starting a new
2744;; process and having it execute the query and then finish, would not
2745;; work. I'm sure there are other uses as well, although in many cases
2746;; starting a new process is the simpler, and thus preferable, approach.
814299a7 2747;;
3965beb0
GM
2748;; The basic implementation is as follows: comint-redirect changes the
2749;; preoutput filter functions (comint-preoutput-filter-functions) to use
2750;; its own filter. The filter puts the output into the designated buffer,
2751;; or buffers, until it sees a regexp that tells it to stop (by default,
2752;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2753;; sees the stop regexp, it restores the old filter functions, and runs
2754;; comint-redirect-hook.
2755;;
2756;; Each comint buffer may only use one redirection at a time, but any number
2757;; of different comint buffers may be simultaneously redirected.
2758;;
2759;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2760;; correct prompt for your interpreter, or that you supply a regexp that says
2761;; when the redirection is finished. Otherwise, redirection will continue
2762;; indefinitely. The code now does a sanity check to ensure that it can find
2763;; a prompt in the comint buffer; however, it is still important to ensure that
2764;; this prompt is set correctly.
2765;;
29533923
MB
2766;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2767;; perhaps it should prompt for a terminating string (with an
2768;; appropriate magic default by examining what we think is the prompt)?
2769;;
3965beb0
GM
2770
2771;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2772;; Variables
2773;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2774
2775(defcustom comint-redirect-verbose nil
2776 "*If non-nil, print messages each time the redirection filter is invoked.
2777Also print a message when redirection is completed."
2778 :group 'comint
2779 :type 'boolean)
2780
2781;; Directly analagous to comint-preoutput-filter-functions
2782(defvar comint-redirect-filter-functions nil
2783 "List of functions to call before inserting redirected process output.
2784Each function gets one argument, a string containing the text received
2785from the subprocess. It should return the string to insert, perhaps
2786the same string that was received, or perhaps a modified or transformed
2787string.
2788
2789The functions on the list are called sequentially, and each one is given
2790the string returned by the previous one. The string returned by the
2791last function is the text that is actually inserted in the redirection buffer.")
2792
2793(make-variable-buffer-local 'comint-redirect-filter-functions)
2794
2795;; Internal variables
2796
2797(defvar comint-redirect-output-buffer nil
2798 "The buffer or list of buffers to put output into.")
2799
2800(defvar comint-redirect-finished-regexp nil
2801 "Regular expression that determines when to stop redirection in Comint.
814299a7 2802When the redirection filter function is given output that matches this regexp,
3965beb0
GM
2803the output is inserted as usual, and redirection is completed.")
2804
2805(defvar comint-redirect-insert-matching-regexp nil
2806 "If non-nil, the text that ends a redirection is included in it.
2807More precisely, the text that matches `comint-redirect-finished-regexp'
2808and therefore terminates an output redirection is inserted in the
2809redirection target buffer, along with the preceding output.")
2810
2811(defvar comint-redirect-echo-input nil
2812 "Non-nil means echo input in the process buffer even during redirection.")
2813
2814(defvar comint-redirect-completed nil
2815 "Non-nil if redirection has completed in the current buffer.")
2816
2817(defvar comint-redirect-original-mode-line-process nil
2818 "Original mode line for redirected process.")
2819
2820(defvar comint-redirect-perform-sanity-check t
2821 "If non-nil, check that redirection is likely to complete successfully.
2822More precisely, before starting a redirection, verify that the
2823regular expression `comint-redirect-finished-regexp' that controls
2824when to terminate it actually matches some text already in the process
2825buffer. The idea is that this regular expression should match a prompt
2826string, and that there ought to be at least one copy of your prompt string
2827in the process buffer already.")
2828
2829(defvar comint-redirect-original-filter-function nil
2830 "The process filter that was in place when redirection is started.
2831When redirection is completed, the process filter is restored to
2832this value.")
2833
2834;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2835;; Functions
2836;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2837
814299a7 2838(defun comint-redirect-setup (output-buffer
3965beb0
GM
2839 comint-buffer
2840 finished-regexp
2841 &optional echo-input)
2842 "Set up for output redirection.
2843This function sets local variables that are used by `comint-redirect-filter'
2844to perform redirection.
2845
2846Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
814299a7 2847in the output matches FINISHED-REGEXP.
3965beb0
GM
2848
2849If optional argument ECHO-INPUT is non-nil, output is echoed to the
2850original comint buffer.
2851
2852This function is called by `comint-redirect-send-command-to-process',
2853and does not normally need to be invoked by the end user or programmer."
2854 (with-current-buffer comint-buffer
2855
2856 (make-local-variable 'comint-redirect-original-mode-line-process)
2857 (setq comint-redirect-original-mode-line-process mode-line-process)
2858
2859 (make-local-variable 'comint-redirect-output-buffer)
2860 (setq comint-redirect-output-buffer output-buffer)
2861
2862 (make-local-variable 'comint-redirect-finished-regexp)
2863 (setq comint-redirect-finished-regexp finished-regexp)
2864
2865 (make-local-variable 'comint-redirect-echo-input)
2866 (setq comint-redirect-echo-input echo-input)
2867
2868 (make-local-variable 'comint-redirect-completed)
2869 (setq comint-redirect-completed nil)
2870
814299a7
MB
2871 (setq mode-line-process
2872 (if mode-line-process
3965beb0
GM
2873 (list (concat (elt mode-line-process 0) " Redirection"))
2874 (list ":%s Redirection")))))
2875
2876(defun comint-redirect-cleanup ()
2877 "End a Comint redirection. See `comint-redirect-send-command'."
2878 (interactive)
2879 ;; Restore the process filter
2880 (set-process-filter (get-buffer-process (current-buffer))
2881 comint-redirect-original-filter-function)
2882 ;; Restore the mode line
2883 (setq mode-line-process comint-redirect-original-mode-line-process)
2884 ;; Set the completed flag
2885 (setq comint-redirect-completed t))
2886
2887;; Because the cleanup happens as a callback, it's not easy to guarantee
2888;; that it really occurs.
2889(defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
2890
2891(defun comint-redirect-filter (process input-string)
2892 "Filter function which redirects output from PROCESS to a buffer or buffers.
2893The variable `comint-redirect-output-buffer' says which buffer(s) to
2894place output in.
2895
2896INPUT-STRING is the input from the comint process.
2897
814299a7 2898This function runs as a process filter, and does not need to be invoked by the
3965beb0
GM
2899end user."
2900 (and process
2901 (with-current-buffer (process-buffer process)
2902 (comint-redirect-preoutput-filter input-string)
2903 ;; If we have to echo output, give it to the original filter function
2904 (and comint-redirect-echo-input
2905 comint-redirect-original-filter-function
2906 (funcall comint-redirect-original-filter-function
2907 process input-string)))))
2908
2909
2910(defun comint-redirect-preoutput-filter (input-string)
2911 "Comint filter function which redirects comint output to a buffer or buffers.
2912The variable `comint-redirect-output-buffer' says which buffer(s) to
2913place output in.
2914
2915INPUT-STRING is the input from the comint process.
2916
2917This function does not need to be invoked by the end user."
2918 (let ((output-buffer-list
2919 (if (listp comint-redirect-output-buffer)
2920 comint-redirect-output-buffer
2921 (list comint-redirect-output-buffer)))
2922 (filtered-input-string input-string))
2923
2924 ;; If there are any filter functions, give them a chance to modify the string
2925 (let ((functions comint-redirect-filter-functions))
2926 (while (and functions filtered-input-string)
814299a7 2927 (setq filtered-input-string
3965beb0
GM
2928 (funcall (car functions) filtered-input-string))
2929 (setq functions (cdr functions))))
2930
2931 ;; Clobber `comint-redirect-finished-regexp'
2932 (or comint-redirect-insert-matching-regexp
2933 (and (string-match comint-redirect-finished-regexp filtered-input-string)
2934 (setq filtered-input-string
2935 (replace-match "" nil nil filtered-input-string))))
814299a7 2936
3965beb0
GM
2937 ;; Send output to all registered buffers
2938 (save-excursion
2939 (mapcar
2940 (function (lambda(buf)
2941 ;; Set this buffer to the output buffer
2942 (set-buffer (get-buffer-create buf))
2943 ;; Go to the end of the buffer
2944 (goto-char (point-max))
2945 ;; Insert the output
2946 (insert filtered-input-string)))
2947 output-buffer-list))
2948
2949 ;; Message
2950 (and comint-redirect-verbose
814299a7 2951 (message "Redirected output to buffer(s) %s"
3965beb0
GM
2952 (mapconcat 'identity output-buffer-list " ")))
2953
2954 ;; If we see the prompt, tidy up
2955 ;; We'll look for the prompt in the original string, so nobody can
2956 ;; clobber it
2957 (and (string-match comint-redirect-finished-regexp input-string)
2958 (progn
2959 (and comint-redirect-verbose
2960 (message "Redirection completed"))
2961 (comint-redirect-cleanup)
2962 (run-hooks 'comint-redirect-hook)))
2963 ;; Echo input?
2964 (if comint-redirect-echo-input
2965 filtered-input-string
2966 "")))
2967
2968;;;###autoload
2969(defun comint-redirect-send-command (command output-buffer echo &optional no-display)
2970 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2971With prefix arg, echo output in process buffer.
2972
2973If NO-DISPLAY is non-nil, do not show the output buffer."
2974 (interactive "sCommand: \nBOutput Buffer: \nP")
2975 (let ((process (get-buffer-process (current-buffer))))
2976 (if process
2977 (comint-redirect-send-command-to-process
2978 command output-buffer (current-buffer) echo no-display)
2979 (error "No process for current buffer"))))
2980
2981;;;###autoload
814299a7 2982(defun comint-redirect-send-command-to-process
3965beb0
GM
2983 (command output-buffer process echo &optional no-display)
2984 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2985With prefix arg, echo output in process buffer.
2986
2987If NO-DISPLAY is non-nil, do not show the output buffer."
2988 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
2989 (let* (;; The process buffer
2990 (process-buffer (if (processp process)
2991 (process-buffer process)
2992 process))
2993 (proc (get-buffer-process process-buffer)))
2994 ;; Change to the process buffer
2995 (set-buffer process-buffer)
2996
2997 ;; Make sure there's a prompt in the current process buffer
2998 (and comint-redirect-perform-sanity-check
2999 (save-excursion
3000 (goto-char (point-max))
3001 (or (re-search-backward comint-prompt-regexp nil t)
3002 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3003
3004 ;;;;;;;;;;;;;;;;;;;;;
3005 ;; Set up for redirection
3006 ;;;;;;;;;;;;;;;;;;;;;
814299a7 3007 (comint-redirect-setup
3965beb0 3008 ;; Output Buffer
814299a7 3009 output-buffer
3965beb0 3010 ;; Comint Buffer
814299a7 3011 (current-buffer)
3965beb0
GM
3012 ;; Finished Regexp
3013 comint-prompt-regexp
3014 ;; Echo input
3015 echo)
3016
3017 ;;;;;;;;;;;;;;;;;;;;;
3018 ;; Set the filter
3019 ;;;;;;;;;;;;;;;;;;;;;
3020 ;; Save the old filter
3021 (setq comint-redirect-original-filter-function
3022 (process-filter proc))
3023 (set-process-filter proc 'comint-redirect-filter)
814299a7 3024
3965beb0
GM
3025 ;;;;;;;;;;;;;;;;;;;;;
3026 ;; Send the command
3027 ;;;;;;;;;;;;;;;;;;;;;
814299a7 3028 (process-send-string
3965beb0
GM
3029 (current-buffer)
3030 (concat command "\n"))
3031
3032 ;;;;;;;;;;;;;;;;;;;;;
3033 ;; Show the output
3034 ;;;;;;;;;;;;;;;;;;;;;
3035 (or no-display
814299a7 3036 (display-buffer
3965beb0
GM
3037 (get-buffer-create
3038 (if (listp output-buffer)
3039 (car output-buffer)
3040 output-buffer))))))
3041
3042;;;###autoload
3043(defun comint-redirect-results-list (command regexp regexp-group)
814299a7 3044 "Send COMMAND to current process.
3965beb0
GM
3045Return a list of expressions in the output which match REGEXP.
3046REGEXP-GROUP is the regular expression group in REGEXP to use."
814299a7 3047 (comint-redirect-results-list-from-process
3965beb0
GM
3048 (get-buffer-process (current-buffer))
3049 command regexp regexp-group))
3050
3051;;;###autoload
3052(defun comint-redirect-results-list-from-process (process command regexp regexp-group)
814299a7 3053 "Send COMMAND to PROCESS.
3965beb0
GM
3054Return a list of expressions in the output which match REGEXP.
3055REGEXP-GROUP is the regular expression group in REGEXP to use."
3965beb0
GM
3056 (let ((output-buffer " *Comint Redirect Work Buffer*")
3057 results)
3058 (save-excursion
3059 (set-buffer (get-buffer-create output-buffer))
3060 (erase-buffer)
3061 (comint-redirect-send-command-to-process command
3062 output-buffer process nil t)
3063 ;; Wait for the process to complete
3064 (set-buffer (process-buffer process))
3065 (while (null comint-redirect-completed)
3066 (accept-process-output nil 1))
3067 ;; Collect the output
3068 (set-buffer output-buffer)
3069 (goto-char (point-min))
3070 ;; Skip past the command, if it was echoed
3071 (and (looking-at command)
3072 (forward-line))
814299a7 3073 (while (re-search-forward regexp nil t)
3965beb0
GM
3074 (setq results
3075 (cons (buffer-substring-no-properties
3076 (match-beginning regexp-group)
3077 (match-end regexp-group))
3078 results)))
3079 results)))
3080
f1ed9461
DL
3081(mapc (lambda (x)
3082 (add-to-list 'debug-ignored-errors x))
3083 '("^Not at command line$"
3084 "^Empty input ring$"
3085 "^No history$"
3086 "^Not found$" ; Too common?
3087 "^Current buffer has no process$"))
3965beb0 3088\f
b578f267
EN
3089;; Converting process modes to use comint mode
3090;; ===========================================================================
3091;; The code in the Emacs 19 distribution has all been modified to use comint
3092;; where needed. However, there are `third-party' packages out there that
3093;; still use the old shell mode. Here's a guide to conversion.
3094;;
3095;; Renaming variables
3096;; Most of the work is renaming variables and functions. These are the common
3097;; ones:
3098;; Local variables:
3099;; last-input-start comint-last-input-start
814299a7 3100;; last-input-end comint-last-input-end
b578f267
EN
3101;; shell-prompt-pattern comint-prompt-regexp
3102;; shell-set-directory-error-hook <no equivalent>
3103;; Miscellaneous:
3104;; shell-set-directory <unnecessary>
814299a7 3105;; shell-mode-map comint-mode-map
b578f267
EN
3106;; Commands:
3107;; shell-send-input comint-send-input
3108;; shell-send-eof comint-delchar-or-maybe-eof
814299a7 3109;; kill-shell-input comint-kill-input
b578f267
EN
3110;; interrupt-shell-subjob comint-interrupt-subjob
3111;; stop-shell-subjob comint-stop-subjob
3112;; quit-shell-subjob comint-quit-subjob
3113;; kill-shell-subjob comint-kill-subjob
4e217e50 3114;; kill-output-from-shell comint-delete-output
b578f267
EN
3115;; show-output-from-shell comint-show-output
3116;; copy-last-shell-input Use comint-previous-input/comint-next-input
3117;;
3118;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3119;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3120;; Comint mode does not provide functionality equivalent to
3121;; shell-set-directory-error-hook; it is gone.
3122;;
3123;; comint-last-input-start is provided for modes which want to munge
3124;; the buffer after input is sent, perhaps because the inferior
3125;; insists on echoing the input. The LAST-INPUT-START variable in
3126;; the old shell package was used to implement a history mechanism,
3127;; but you should think twice before using comint-last-input-start
3128;; for this; the input history ring often does the job better.
814299a7 3129;;
b578f267
EN
3130;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3131;; *not* create the comint-mode local variables in your foo-mode function.
3132;; This is not modular. Instead, call comint-mode, and let *it* create the
3133;; necessary comint-specific local variables. Then create the
3134;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3135;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3136;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3137;; get-old-input) that need to be different from the defaults. Call
3138;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3139;; comint-mode will take care of it. The following example, from shell.el,
3140;; is typical:
814299a7 3141;;
b578f267
EN
3142;; (defvar shell-mode-map '())
3143;; (cond ((not shell-mode-map)
3144;; (setq shell-mode-map (copy-keymap comint-mode-map))
3145;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3146;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3147;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3148;; (define-key shell-mode-map "\M-?"
3149;; 'comint-dynamic-list-filename-completions)))
3150;;
3151;; (defun shell-mode ()
3152;; (interactive)
3153;; (comint-mode)
3154;; (setq comint-prompt-regexp shell-prompt-pattern)
3155;; (setq major-mode 'shell-mode)
3156;; (setq mode-name "Shell")
3157;; (use-local-map shell-mode-map)
3158;; (make-local-variable 'shell-directory-stack)
3159;; (setq shell-directory-stack nil)
3160;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3161;; (run-hooks 'shell-mode-hook))
3162;;
3163;;
b578f267 3164;; Completion for comint-mode users
814299a7 3165;;
b578f267
EN
3166;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3167;; hook to add completion functions to. Functions on this list should return
3168;; non-nil if completion occurs (i.e., further completion should not occur).
3169;; You could use comint-dynamic-simple-complete to do the bulk of the
3170;; completion job.
49116ac0 3171\f
49116ac0 3172(provide 'comint)
c0274f38 3173
b578f267 3174;; comint.el ends here