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