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