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