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