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