(with-temp-message): Fix the other call to message to use %s.
[bpt/emacs.git] / lisp / comint.el
CommitLineData
c0274f38 1;;; comint.el --- general command interpreter in a window stuff
e41b2db1 2
9cc68f10 3;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99 Free Software Foundation, Inc.
c0274f38 4
f8604035
SM
5;; Author: Olin Shivers <shivers@cs.cmu.edu> then
6;; Simon Marshall <simon@gnu.ai.mit.edu>
7;; Maintainer: FSF
e9571d2a 8;; Keywords: processes
3a801d0c 9
1586b965 10;; This file is part of GNU Emacs.
be9b65ac 11
1586b965
RS
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
be9b65ac 16
1586b965
RS
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
be9b65ac 21
1586b965 22;; You should have received a copy of the GNU General Public License
b578f267
EN
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
be9b65ac 26
e5167999
ER
27;;; Commentary:
28
b578f267
EN
29;; Please send me bug reports, bug fixes, and extensions, so that I can
30;; merge them into the master source.
31;; - Olin Shivers (shivers@cs.cmu.edu)
32;; - Simon Marshall (simon@gnu.ai.mit.edu)
33
34;; This file defines a general command-interpreter-in-a-buffer package
35;; (comint mode). The idea is that you can build specific process-in-a-buffer
36;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
37;; This way, all these specific packages share a common base functionality,
38;; and a common set of bindings, which makes them easier to use (and
39;; saves code, implementation time, etc., etc.).
40
41;; Several packages are already defined using comint mode:
42;; - shell.el defines a shell-in-a-buffer mode.
43;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
44;;
45;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
46;; - The file tea.el tunes scheme and inferior-scheme modes for T.
47;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
48;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
49;; previewers, and printers from within emacs.
50;; - background.el allows csh-like job control inside emacs.
51;; It is pretty easy to make new derived modes for other processes.
52
53;; For documentation on the functionality provided by comint mode, and
54;; the hooks available for customising it, see the comments below.
55;; For further information on the standard derived modes (shell,
56;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
57
58;; For hints on converting existing process modes (e.g., tex-mode,
59;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
60;; instead of shell-mode, see the notes at the end of this file.
be9b65ac 61
be9b65ac 62\f
b578f267
EN
63;; Brief Command Documentation:
64;;============================================================================
65;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
66;; mode)
67;;
361ecbf2
RS
68;; m-p comint-previous-input Cycle backwards in input history
69;; m-n comint-next-input Cycle forwards
b578f267
EN
70;; m-r comint-previous-matching-input Previous input matching a regexp
71;; m-s comint-next-matching-input Next input that matches
361ecbf2 72;; m-c-l comint-show-output Show last batch of process output
b578f267 73;; return comint-send-input
361ecbf2
RS
74;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
75;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
76;; second time, move to process-mark.
b578f267
EN
77;; c-c c-u comint-kill-input ^u
78;; c-c c-w backward-kill-word ^w
79;; c-c c-c comint-interrupt-subjob ^c
80;; c-c c-z comint-stop-subjob ^z
81;; c-c c-\ comint-quit-subjob ^\
82;; c-c c-o comint-kill-output Delete last batch of process output
83;; c-c c-r comint-show-output Show last batch of process output
84;; c-c c-l comint-dynamic-list-input-ring List input history
85;;
86;; Not bound by default in comint-mode (some are in shell mode)
87;; comint-run Run a program under comint-mode
88;; send-invisible Read a line w/o echo, and send to proc
89;; comint-dynamic-complete-filename Complete filename at point.
90;; comint-dynamic-complete-variable Complete variable name at point.
91;; comint-dynamic-list-filename-completions List completions in help buffer.
92;; comint-replace-by-expanded-filename Expand and complete filename at point;
93;; replace with expanded/completed name.
94;; comint-replace-by-expanded-history Expand history at point;
95;; replace with expanded name.
96;; comint-magic-space Expand history and add (a) space(s).
97;; comint-kill-subjob No mercy.
98;; comint-show-maximum-output Show as much output as possible.
99;; comint-continue-subjob Send CONT signal to buffer's process
100;; group. Useful if you accidentally
101;; suspend your process (with C-c C-z).
361ecbf2
RS
102;; comint-get-next-from-history Fetch successive input history lines
103;; comint-accumulate Combine lines to send them together
104;; as input.
105;; comint-goto-process-mark Move point to where process-mark is.
106;; comint-set-process-mark Set process-mark to point.
b578f267
EN
107
108;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
be9b65ac 109
e5167999
ER
110;;; Code:
111
c9706a52 112(require 'ring)
be9b65ac 113\f
b578f267
EN
114;; Buffer Local Variables:
115;;============================================================================
116;; Comint mode buffer local variables:
107d7589
SM
117;; comint-prompt-regexp string comint-bol uses to match prompt
118;; comint-delimiter-argument-list list For delimiters and arguments
119;; comint-last-input-start marker Handy if inferior always echoes
120;; comint-last-input-end marker For comint-kill-output command
121;; comint-input-ring-size integer For the input history
122;; comint-input-ring ring mechanism
123;; comint-input-ring-index number ...
361ecbf2 124;; comint-save-input-ring-index number ...
107d7589
SM
125;; comint-input-autoexpand symbol ...
126;; comint-input-ignoredups boolean ...
127;; comint-last-input-match string ...
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
b578f267
EN
144;;
145;; Comint mode non-buffer local variables:
107d7589
SM
146;; comint-completion-addsuffix boolean/cons For file name
147;; comint-completion-autolist boolean completion behavior
148;; comint-completion-recexact boolean ...
be9b65ac 149
ed366e87
RS
150(defgroup comint nil
151 "General command interpreter in a window stuff."
152 :group 'processes)
153
154(defgroup comint-completion nil
155 "Completion facilities in comint"
156 :group 'comint)
157
158(defgroup comint-source nil
159 "Source finding facilities in comint"
160 :prefix "comint-"
161 :group 'comint)
162
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
DL
167
168Good choices:
d637fa56 169 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
41752cf1
JB
170 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
171 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
49116ac0 172 kcl: \"^>+ *\"
d637fa56 173 shell: \"^[^#$%>\\n]*[#$%>] *\"
49116ac0 174 T: \"^>+ *\"
be9b65ac 175
49116ac0 176This is a good thing to set in mode hooks.")
be9b65ac 177
3ee91e68
RS
178(defvar comint-delimiter-argument-list ()
179 "List of characters to recognise as separate arguments in input.
180Strings comprising a character in this list will separate the arguments
181surrounding them, and also be regarded as arguments in their own right (unlike
182whitespace). See `comint-arguments'.
3f4b7c36 183Defaults to the empty list.
3ee91e68 184
3f4b7c36 185For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
3ee91e68
RS
186
187This is a good thing to set in mode hooks.")
188
ed366e87 189(defcustom comint-input-autoexpand nil
3ee91e68 190 "*If non-nil, expand input command history references on completion.
fdb7791d 191This mirrors the optional behavior of tcsh (its autoexpand and histlit).
3ee91e68
RS
192
193If the value is `input', then the expansion is seen on input.
194If the value is `history', then the expansion is only when inserting
195into the buffer's input ring. See also `comint-magic-space' and
196`comint-dynamic-complete'.
197
ed366e87
RS
198This variable is buffer-local."
199 :type '(choice (const :tag "off" nil)
ed366e87 200 (const input)
0560c209
AS
201 (const history)
202 (other :tag "on" t))
ed366e87
RS
203 :group 'comint)
204
ed366e87 205(defcustom comint-input-ignoredups nil
3ee91e68 206 "*If non-nil, don't add input matching the last on the input ring.
fdb7791d 207This mirrors the optional behavior of bash.
3ee91e68 208
ed366e87
RS
209This variable is buffer-local."
210 :type 'boolean
211 :group 'comint)
3ee91e68 212
ed366e87 213(defcustom comint-input-ring-file-name nil
3ee91e68
RS
214 "*If non-nil, name of the file to read/write input history.
215See also `comint-read-input-ring' and `comint-write-input-ring'.
216
ed366e87
RS
217This variable is buffer-local, and is a good thing to set in mode hooks."
218 :type 'boolean
219 :group 'comint)
3ee91e68 220
ed366e87 221(defcustom comint-scroll-to-bottom-on-input nil
3ee91e68
RS
222 "*Controls whether input to interpreter causes window to scroll.
223If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
224If `this', scroll only the selected window.
225
91d75282 226The default is nil.
f4ef65c7 227
ed366e87
RS
228See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
229 :type '(choice (const :tag "off" nil)
230 (const t)
231 (const all)
232 (const this))
233 :group 'comint)
3ee91e68 234
ed366e87 235(defcustom comint-scroll-to-bottom-on-output nil
3ee91e68
RS
236 "*Controls whether interpreter output causes window to scroll.
237If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
238If `this', scroll only the selected window.
239If `others', scroll only those that are not the selected window.
91d75282
RS
240
241The default is nil.
f4ef65c7 242
3ee91e68 243See variable `comint-scroll-show-maximum-output' and function
ed366e87
RS
244`comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
245 :type '(choice (const :tag "off" nil)
246 (const t)
247 (const all)
248 (const this)
249 (const others))
250 :group 'comint)
251
252(defcustom comint-scroll-show-maximum-output nil
3ee91e68
RS
253 "*Controls how interpreter output causes window to scroll.
254If non-nil, then show the maximum output when the window is scrolled.
91d75282 255
3ee91e68 256See variable `comint-scroll-to-bottom-on-output' and function
ed366e87
RS
257`comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
258 :type 'boolean
259 :group 'comint)
91d75282 260
ed366e87 261(defcustom comint-buffer-maximum-size 1024
39a185a9
SM
262 "*The maximum size in lines for comint buffers.
263Comint buffers are truncated from the top to be no greater than this number, if
ed366e87
RS
264the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
265 :type 'integer
266 :group 'comint)
39a185a9 267
3ee91e68 268(defvar comint-input-ring-size 32
49116ac0 269 "Size of input history ring.")
be9b65ac 270
ed366e87 271(defcustom comint-process-echoes nil
cccd719e 272 "*If non-nil, assume that the subprocess echoes any input.
8ae3bc9f 273If so, delete one copy of the input so that only one copy eventually
3ee91e68 274appears in the buffer.
8ae3bc9f 275
ed366e87
RS
276This variable is buffer-local."
277 :type 'boolean
278 :group 'comint)
8ae3bc9f 279
3a320e54 280;; AIX puts the name of the person being su'd to in front of the prompt.
9cc68f10 281;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
ed366e87 282(defcustom comint-password-prompt-regexp
9cc68f10 283 "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|^\\)[Pp]assword\\|pass phrase\\).*:\\s *\\'"
654d89d7 284 "*Regexp matching prompts for passwords in the inferior process.
ed366e87
RS
285This is used by `comint-watch-for-password-prompt'."
286 :type 'regexp
287 :group 'comint)
654d89d7 288
b578f267 289;; Here are the per-interpreter hooks.
49116ac0 290(defvar comint-get-old-input (function comint-get-old-input-default)
3ee91e68 291 "Function that returns old text in comint mode.
be9b65ac
DL
292This function is called when return is typed while the point is in old text.
293It returns the text to be submitted as process input. The default is
cccd719e
RS
294`comint-get-old-input-default', which grabs the current line, and strips off
295leading text matching `comint-prompt-regexp'.")
be9b65ac 296
1b421826
RS
297(defvar comint-dynamic-complete-functions
298 '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
299 "List of functions called to perform completion.
300Functions should return non-nil if completion was performed.
301See also `comint-dynamic-complete'.
3ee91e68
RS
302
303This is a good thing to set in mode hooks.")
304
49116ac0
JB
305(defvar comint-input-filter
306 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
307 "Predicate for filtering additions to input history.
3ee91e68
RS
308Takes one argument, the input. If non-nil, the input may be saved on the input
309history list. Default is to save anything that isn't all whitespace.")
310
fb9ab28a 311(defvar comint-input-filter-functions '()
1b421826
RS
312 "Functions to call before input is sent to the process.
313These functions get one argument, a string containing the text to send.
314
315This variable is buffer-local.")
316
fb9ab28a 317(defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
3ee91e68 318 "Functions to call after output is inserted into the buffer.
c1da5c03 319One possible function is `comint-postoutput-scroll-to-bottom'.
107d7589
SM
320These functions get one argument, a string containing the text as originally
321inserted. Note that this might not be the same as the buffer contents between
322`comint-last-output-start' and the buffer's `process-mark', if other filter
323functions have already modified the buffer.
3ee91e68 324
d4321160
RS
325See also `comint-preoutput-filter-functions'.
326
3ee91e68 327This variable is buffer-local.")
49116ac0
JB
328
329(defvar comint-input-sender (function comint-simple-send)
330 "Function to actually send to PROCESS the STRING submitted by user.
cccd719e
RS
331Usually this is just `comint-simple-send', but if your mode needs to
332massage the input string, put a different function here.
333`comint-simple-send' just sends the string plus a newline.
334This is called from the user command `comint-send-input'.")
49116ac0 335
ed366e87 336(defcustom comint-eol-on-send t
3ee91e68 337 "*Non-nil means go to the end of the line before sending input.
ed366e87
RS
338See `comint-send-input'."
339 :type 'boolean
340 :group 'comint)
be9b65ac 341
ed366e87 342(defcustom comint-mode-hook '()
49116ac0 343 "Called upon entry into comint-mode
ed366e87
RS
344This is run before the process is cranked up."
345 :type 'hook
346 :group 'comint)
49116ac0 347
ed366e87 348(defcustom comint-exec-hook '()
cccd719e 349 "Called each time a process is exec'd by `comint-exec'.
49116ac0 350This is called after the process is cranked up. It is useful for things that
cccd719e
RS
351must be done each time a process is executed in a comint mode buffer (e.g.,
352`(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
ed366e87
RS
353executed once when the buffer is created."
354 :type 'hook
355 :group 'comint)
49116ac0
JB
356
357(defvar comint-mode-map nil)
be9b65ac 358
c9706a52 359(defvar comint-ptyp t
3ee91e68 360 "Non-nil if communications via pty; false if by pipe. Buffer local.
5ef2f81f 361This is to work around a bug in Emacs process signaling.")
c9706a52 362
0bcb5285 363(defvar comint-input-ring nil)
e6dfdce5
RS
364(defvar comint-last-input-start)
365(defvar comint-last-input-end)
7d5d472e 366(defvar comint-last-output-start)
3ee91e68
RS
367(defvar comint-input-ring-index nil
368 "Index of last matched history element.")
369(defvar comint-matching-input-from-input-string ""
370 "Input previously used to match input history.")
361ecbf2
RS
371(defvar comint-save-input-ring-index
372 "Last input ring index which you copied.
373This is to support the command \\[comint-get-next-from-history].")
374
375(defvar comint-accum-marker nil
376 "Non-nil if you are accumulating input lines to send as input together.
377The command \\[comint-accumulate] sets this.")
21d9bf27
RS
378
379(put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
c9706a52 380(put 'comint-input-ring 'permanent-local t)
3ee91e68 381(put 'comint-input-ring-index 'permanent-local t)
361ecbf2 382(put 'comint-save-input-ring-index 'permanent-local t)
3ee91e68 383(put 'comint-input-autoexpand 'permanent-local t)
fb9ab28a
RS
384(put 'comint-input-filter-functions 'permanent-local t)
385(put 'comint-output-filter-functions 'permanent-local t)
d4321160 386(put 'comint-preoutput-filter-functions 'permanent-local t)
3ee91e68
RS
387(put 'comint-scroll-to-bottom-on-input 'permanent-local t)
388(put 'comint-scroll-to-bottom-on-output 'permanent-local t)
389(put 'comint-scroll-show-maximum-output 'permanent-local t)
c9706a52 390(put 'comint-ptyp 'permanent-local t)
e6dfdce5 391
158cfdd2
RS
392(put 'comint-mode 'mode-class 'special)
393
be9b65ac
DL
394(defun comint-mode ()
395 "Major mode for interacting with an inferior interpreter.
396Interpreter name is same as buffer name, sans the asterisks.
397Return at end of buffer sends line as input.
398Return not at end copies rest of line to end and sends it.
cccd719e 399Setting variable `comint-eol-on-send' means jump to the end of the line
49116ac0 400before submitting new input.
be9b65ac 401
3ee91e68
RS
402This mode is customised to create major modes such as Inferior Lisp
403mode, Shell mode, etc. This can be done by setting the hooks
fb9ab28a 404`comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
3ee91e68 405and `comint-get-old-input' to appropriate functions, and the variable
cccd719e 406`comint-prompt-regexp' to the appropriate regular expression.
be9b65ac 407
cccd719e 408An input history is maintained of size `comint-input-ring-size', and
3ee91e68
RS
409can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
410Input ring history expansion can be achieved with the commands
411\\[comint-replace-by-expanded-history] or \\[comint-magic-space].
412Input ring expansion is controlled by the variable `comint-input-autoexpand',
413and addition is controlled by the variable `comint-input-ignoredups'.
414
cccd719e 415Commands with no default key bindings include `send-invisible',
21d9bf27 416`comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
3ee91e68
RS
417`comint-magic-space'.
418
419Input to, and output from, the subprocess can cause the window to scroll to
fb9ab28a 420the end of the buffer. See variables `comint-output-filter-functions',
d4321160
RS
421`comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
422and `comint-scroll-to-bottom-on-output'.
be9b65ac
DL
423
424If you accidentally suspend your process, use \\[comint-continue-subjob]
425to continue it.
426
427\\{comint-mode-map}
428
3ee91e68 429Entry to this mode runs the hooks on `comint-mode-hook'."
be9b65ac 430 (interactive)
3ee91e68
RS
431 ;; Do not remove this. All major modes must do this.
432 (kill-all-local-variables)
433 (setq major-mode 'comint-mode)
434 (setq mode-name "Comint")
baae3c4e 435 (setq mode-line-process '(":%s"))
3ee91e68
RS
436 (use-local-map comint-mode-map)
437 (make-local-variable 'comint-last-input-start)
438 (setq comint-last-input-start (make-marker))
a9a6f83f 439 (set-marker comint-last-input-start (point-min))
3ee91e68
RS
440 (make-local-variable 'comint-last-input-end)
441 (setq comint-last-input-end (make-marker))
a9a6f83f 442 (set-marker comint-last-input-end (point-min))
3ee91e68
RS
443 (make-local-variable 'comint-last-output-start)
444 (setq comint-last-output-start (make-marker))
445 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
446 (make-local-variable 'comint-input-ring-size) ; ...to global val.
447 (make-local-variable 'comint-input-ring)
448 (make-local-variable 'comint-input-ring-file-name)
449 (or (and (boundp 'comint-input-ring) comint-input-ring)
450 (setq comint-input-ring (make-ring comint-input-ring-size)))
451 (make-local-variable 'comint-input-ring-index)
361ecbf2 452 (make-local-variable 'comint-save-input-ring-index)
3ee91e68
RS
453 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
454 (setq comint-input-ring-index nil))
361ecbf2
RS
455 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
456 (setq comint-save-input-ring-index nil))
3ee91e68
RS
457 (make-local-variable 'comint-matching-input-from-input-string)
458 (make-local-variable 'comint-input-autoexpand)
459 (make-local-variable 'comint-input-ignoredups)
460 (make-local-variable 'comint-delimiter-argument-list)
155fd027 461 (make-local-hook 'comint-dynamic-complete-functions)
497513ad 462 (make-local-variable 'comint-completion-fignore)
3ee91e68 463 (make-local-variable 'comint-get-old-input)
155fd027 464 (make-local-hook 'comint-input-filter-functions)
3ee91e68
RS
465 (make-local-variable 'comint-input-filter)
466 (make-local-variable 'comint-input-sender)
467 (make-local-variable 'comint-eol-on-send)
468 (make-local-variable 'comint-scroll-to-bottom-on-input)
469 (make-local-variable 'comint-scroll-to-bottom-on-output)
470 (make-local-variable 'comint-scroll-show-maximum-output)
d2b251aa
SM
471 (make-local-hook 'pre-command-hook)
472 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
155fd027 473 (make-local-hook 'comint-output-filter-functions)
d2b251aa 474 (make-local-hook 'comint-exec-hook)
3ee91e68 475 (make-local-variable 'comint-ptyp)
3ee91e68 476 (make-local-variable 'comint-process-echoes)
2d4382e5 477 (make-local-variable 'comint-file-name-chars)
59f36b08 478 (make-local-variable 'comint-file-name-quote-list)
361ecbf2
RS
479 (make-local-variable 'comint-accum-marker)
480 (setq comint-accum-marker (make-marker))
481 (set-marker comint-accum-marker nil)
3ee91e68 482 (run-hooks 'comint-mode-hook))
be9b65ac 483
49116ac0
JB
484(if comint-mode-map
485 nil
3ee91e68 486 ;; Keys:
49116ac0
JB
487 (setq comint-mode-map (make-sparse-keymap))
488 (define-key comint-mode-map "\ep" 'comint-previous-input)
489 (define-key comint-mode-map "\en" 'comint-next-input)
cf7c8463
RS
490 (define-key comint-mode-map [C-up] 'comint-previous-input)
491 (define-key comint-mode-map [C-down] 'comint-next-input)
0c5c1f34
RS
492 (define-key comint-mode-map "\er" 'comint-previous-matching-input)
493 (define-key comint-mode-map "\es" 'comint-next-matching-input)
fb597fe8
RS
494 (define-key comint-mode-map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
495 (define-key comint-mode-map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
d637fa56 496 (define-key comint-mode-map "\e\C-l" 'comint-show-output)
49116ac0
JB
497 (define-key comint-mode-map "\C-m" 'comint-send-input)
498 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
361ecbf2 499 (define-key comint-mode-map "\C-c " 'comint-accumulate)
fb597fe8 500 (define-key comint-mode-map "\C-c\C-x" 'comint-get-next-from-history)
361ecbf2 501 (define-key comint-mode-map "\C-c\C-a" 'comint-bol-or-process-mark)
49116ac0
JB
502 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
503 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
504 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
505 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
506 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
3ee91e68 507 (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
49116ac0 508 (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
49116ac0 509 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
3ee91e68 510 (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
4bec19b2 511 (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
1de80a34 512 (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
3ee91e68 513 (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
1de80a34 514 (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
3ee91e68
RS
515 ;; Menu bars:
516 ;; completion:
517 (define-key comint-mode-map [menu-bar completion]
dcab7fbd 518 (cons "Complete" (make-sparse-keymap "Complete")))
3ee91e68
RS
519 (define-key comint-mode-map [menu-bar completion complete-expand]
520 '("Expand File Name" . comint-replace-by-expanded-filename))
521 (define-key comint-mode-map [menu-bar completion complete-listing]
522 '("File Completion Listing" . comint-dynamic-list-filename-completions))
3ee91e68
RS
523 (define-key comint-mode-map [menu-bar completion complete-file]
524 '("Complete File Name" . comint-dynamic-complete-filename))
525 (define-key comint-mode-map [menu-bar completion complete]
526 '("Complete Before Point" . comint-dynamic-complete))
527 ;; Input history:
5c07a950 528 (define-key comint-mode-map [menu-bar inout]
dcab7fbd 529 (cons "In/Out" (make-sparse-keymap "In/Out")))
5c07a950 530 (define-key comint-mode-map [menu-bar inout kill-output]
dcab7fbd 531 '("Kill Current Output Group" . comint-kill-output))
5c07a950 532 (define-key comint-mode-map [menu-bar inout next-prompt]
dcab7fbd 533 '("Forward Output Group" . comint-next-prompt))
5c07a950 534 (define-key comint-mode-map [menu-bar inout previous-prompt]
dcab7fbd 535 '("Backward Output Group" . comint-previous-prompt))
5c07a950 536 (define-key comint-mode-map [menu-bar inout show-maximum-output]
dcab7fbd 537 '("Show Maximum Output" . comint-show-maximum-output))
5c07a950 538 (define-key comint-mode-map [menu-bar inout show-output]
dcab7fbd 539 '("Show Current Output Group" . comint-show-output))
5c07a950 540 (define-key comint-mode-map [menu-bar inout kill-input]
3ee91e68 541 '("Kill Current Input" . comint-kill-input))
5c07a950 542 (define-key comint-mode-map [menu-bar inout copy-input]
3ee91e68 543 '("Copy Old Input" . comint-copy-old-input))
5c07a950 544 (define-key comint-mode-map [menu-bar inout forward-matching-history]
dcab7fbd 545 '("Forward Matching Input..." . comint-forward-matching-input))
5c07a950 546 (define-key comint-mode-map [menu-bar inout backward-matching-history]
dcab7fbd 547 '("Backward Matching Input..." . comint-backward-matching-input))
5c07a950 548 (define-key comint-mode-map [menu-bar inout next-matching-history]
3ee91e68 549 '("Next Matching Input..." . comint-next-matching-input))
5c07a950 550 (define-key comint-mode-map [menu-bar inout previous-matching-history]
3ee91e68 551 '("Previous Matching Input..." . comint-previous-matching-input))
5c07a950 552 (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
3ee91e68 553 '("Next Matching Current Input" . comint-next-matching-input-from-input))
5c07a950 554 (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
3ee91e68 555 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
5c07a950 556 (define-key comint-mode-map [menu-bar inout next-history]
3ee91e68 557 '("Next Input" . comint-next-input))
5c07a950 558 (define-key comint-mode-map [menu-bar inout previous-history]
3ee91e68 559 '("Previous Input" . comint-previous-input))
5c07a950 560 (define-key comint-mode-map [menu-bar inout list-history]
3ee91e68 561 '("List Input History" . comint-dynamic-list-input-ring))
5c07a950 562 (define-key comint-mode-map [menu-bar inout expand-history]
3ee91e68 563 '("Expand History Before Point" . comint-replace-by-expanded-history))
3ee91e68
RS
564 ;; Signals
565 (define-key comint-mode-map [menu-bar signals]
566 (cons "Signals" (make-sparse-keymap "Signals")))
567 (define-key comint-mode-map [menu-bar signals eof]
568 '("EOF" . comint-send-eof))
569 (define-key comint-mode-map [menu-bar signals kill]
570 '("KILL" . comint-kill-subjob))
571 (define-key comint-mode-map [menu-bar signals quit]
572 '("QUIT" . comint-quit-subjob))
573 (define-key comint-mode-map [menu-bar signals cont]
574 '("CONT" . comint-continue-subjob))
575 (define-key comint-mode-map [menu-bar signals stop]
576 '("STOP" . comint-stop-subjob))
577 (define-key comint-mode-map [menu-bar signals break]
578 '("BREAK" . comint-interrupt-subjob))
579 ;; Put them in the menu bar:
5c07a950 580 (setq menu-bar-final-items (append '(completion inout signals)
3ee91e68 581 menu-bar-final-items))
49116ac0
JB
582 )
583
49116ac0 584(defun comint-check-proc (buffer)
3ee91e68 585 "Return t if there is a living process associated w/buffer BUFFER.
1a4086d2 586Living means the status is `open', `run', or `stop'.
cccd719e 587BUFFER can be either a buffer or the name of one."
49116ac0 588 (let ((proc (get-buffer-process buffer)))
1a4086d2 589 (and proc (memq (process-status proc) '(open run stop)))))
be9b65ac 590
87206843 591;;;###autoload
be9b65ac 592(defun make-comint (name program &optional startfile &rest switches)
14a08856
RM
593 "Make a comint process NAME in a buffer, running PROGRAM.
594The name of the buffer is made by surrounding NAME with `*'s.
1a4086d2
RS
595PROGRAM should be either a string denoting an executable program to create
596via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
597connection to be opened via `open-network-stream'. If there is already a
598running process in that buffer, it is not restarted. Optional third arg
599STARTFILE is the name of a file to send the contents of to the process.
600
601If PROGRAM is a string, any more args are arguments to PROGRAM."
af37b2e6
RS
602 (or (fboundp 'start-process)
603 (error "Multi-processing is not supported for this system"))
49116ac0 604 (let ((buffer (get-buffer-create (concat "*" name "*"))))
be9b65ac 605 ;; If no process, or nuked process, crank up a new one and put buffer in
14a08856 606 ;; comint mode. Otherwise, leave buffer and existing process alone.
1ff6cf10 607 (cond ((not (comint-check-proc buffer))
49116ac0 608 (save-excursion
be9b65ac
DL
609 (set-buffer buffer)
610 (comint-mode)) ; Install local vars, mode, keymap, ...
611 (comint-exec buffer name program startfile switches)))
612 buffer))
613
87206843 614;;;###autoload
21d9bf27
RS
615(defun comint-run (program)
616 "Run PROGRAM in a comint buffer and switch to it.
617The buffer name is made by surrounding the file name of PROGRAM with `*'s.
618The file name is used to make a symbol name, such as `comint-sh-hook', and any
619hooks on this symbol are run in the buffer.
620See `make-comint' and `comint-exec'."
621 (interactive "sRun program: ")
622 (let ((name (file-name-nondirectory program)))
623 (switch-to-buffer (make-comint name program))
624 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
625
be9b65ac 626(defun comint-exec (buffer name command startfile switches)
cccd719e 627 "Start up a process in buffer BUFFER for comint modes.
14a08856 628Blasts any old process running in the buffer. Doesn't set the buffer mode.
49116ac0 629You can use this to cheaply run a series of processes in the same comint
cccd719e 630buffer. The hook `comint-exec-hook' is run after each exec."
be9b65ac
DL
631 (save-excursion
632 (set-buffer buffer)
633 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
634 (if proc (delete-process proc)))
635 ;; Crank up a new process
1a4086d2
RS
636 (let ((proc
637 (if (consp command)
638 (open-network-stream name buffer (car command) (cdr command))
639 (comint-exec-1 name buffer command switches))))
3ee91e68 640 (set-process-filter proc 'comint-output-filter)
49116ac0
JB
641 (make-local-variable 'comint-ptyp)
642 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
be9b65ac 643 ;; Jump to the end, and set the process mark.
49116ac0 644 (goto-char (point-max))
87ef29fd 645 (set-marker (process-mark proc) (point))
be9b65ac
DL
646 ;; Feed it the startfile.
647 (cond (startfile
648 ;;This is guaranteed to wait long enough
649 ;;but has bad results if the comint does not prompt at all
650 ;; (while (= size (buffer-size))
651 ;; (sleep-for 1))
652 ;;I hope 1 second is enough!
653 (sleep-for 1)
654 (goto-char (point-max))
655 (insert-file-contents startfile)
656 (setq startfile (buffer-substring (point) (point-max)))
657 (delete-region (point) (point-max))
49116ac0
JB
658 (comint-send-string proc startfile)))
659 (run-hooks 'comint-exec-hook)
87ef29fd 660 buffer)))
be9b65ac 661
b578f267
EN
662;; This auxiliary function cranks up the process for comint-exec in
663;; the appropriate environment.
be9b65ac
DL
664
665(defun comint-exec-1 (name buffer command switches)
1b421826 666 (let ((process-environment
1f9e761d 667 (nconc
a4ab7e69
RS
668 ;; If using termcap, we specify `emacs' as the terminal type
669 ;; because that lets us specify a width.
36990caa 670 ;; If using terminfo, we specify `dumb' because that is
a4ab7e69
RS
671 ;; a defined terminal type. `emacs' is not a defined terminal type
672 ;; and there is no way for us to define it here.
673 ;; Some programs that use terminfo get very confused
674 ;; if TERM is not a valid terminal type.
1f9e761d 675 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
4a11114d 676 (list "TERM=dumb" "TERMCAP="
1f9e761d 677 (format "COLUMNS=%d" (frame-width)))
f3b0a431 678 (list "TERM=emacs"
9dbfa8cf 679 (format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
f3b0a431 680 (if (getenv "EMACS") nil (list "EMACS=t"))
1347899b
RS
681 process-environment))
682 (default-directory
e1d409fe 683 (if (file-accessible-directory-p default-directory)
1347899b 684 default-directory
33ba5485
RS
685 (char-to-string directory-sep-char)))
686 proc decoding encoding changed)
687 (setq proc (apply 'start-process name buffer command switches))
688 (let ((coding-systems (process-coding-system proc)))
689 (setq decoding (car coding-systems)
690 encoding (cdr coding-systems)))
691 ;; If start-process decided to use some coding system for decoding
692 ;; data sent form the process and the coding system doesn't
693 ;; specify EOL conversion, we had better convert CRLF to LF.
694 (if (vectorp (coding-system-eol-type decoding))
695 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
696 changed t))
697 ;; Even if start-process left the coding system for encoding data
698 ;; sent from the process undecided, we had better use the same one
699 ;; as what we use for decoding. But, we should suppress EOL
700 ;; conversion.
701 (if (and decoding (not encoding))
702 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
703 changed t))
704 (if changed
705 (set-process-coding-system proc decoding encoding))
706 proc))
be9b65ac 707\f
b578f267
EN
708;; Input history processing in a buffer
709;; ===========================================================================
710;; Useful input history functions, courtesy of the Ergo group.
711
712;; Eleven commands:
713;; comint-dynamic-list-input-ring List history in help buffer.
714;; comint-previous-input Previous input...
715;; comint-previous-matching-input ...matching a string.
716;; comint-previous-matching-input-from-input ... matching the current input.
717;; comint-next-input Next input...
718;; comint-next-matching-input ...matching a string.
719;; comint-next-matching-input-from-input ... matching the current input.
720;; comint-backward-matching-input Backwards input...
721;; comint-forward-matching-input ...matching a string.
722;; comint-replace-by-expanded-history Expand history at point;
723;; replace with expanded history.
724;; comint-magic-space Expand history and insert space.
725;;
726;; Three functions:
727;; comint-read-input-ring Read into comint-input-ring...
728;; comint-write-input-ring Write to comint-input-ring-file-name.
729;; comint-replace-by-expanded-history-before-point Workhorse function.
3ee91e68 730
d637fa56 731(defun comint-read-input-ring (&optional silent)
3ee91e68
RS
732 "Sets the buffer's `comint-input-ring' from a history file.
733The name of the file is given by the variable `comint-input-ring-file-name'.
734The history ring is of size `comint-input-ring-size', regardless of file size.
735If `comint-input-ring-file-name' is nil this function does nothing.
736
d637fa56
RS
737If the optional argument SILENT is non-nil, we say nothing about a
738failure to read the history file.
3ee91e68 739
d637fa56
RS
740This function is useful for major mode commands and mode hooks.
741
742The structure of the history file should be one input command per line,
743with the most recent command last.
3ee91e68 744See also `comint-input-ignoredups' and `comint-write-input-ring'."
07ccf0bc
RS
745 (cond ((or (null comint-input-ring-file-name)
746 (equal comint-input-ring-file-name ""))
3ee91e68
RS
747 nil)
748 ((not (file-readable-p comint-input-ring-file-name))
d637fa56
RS
749 (or silent
750 (message "Cannot read history file %s"
751 comint-input-ring-file-name)))
3ee91e68 752 (t
dc0825db
RS
753 (let ((history-buf (get-buffer-create " *temp*"))
754 (file comint-input-ring-file-name)
755 (count 0)
3ee91e68 756 (ring (make-ring comint-input-ring-size)))
dc0825db
RS
757 (unwind-protect
758 (save-excursion
759 (set-buffer history-buf)
3ee91e68 760 (widen)
dc0825db
RS
761 (erase-buffer)
762 (insert-file-contents file)
763 ;; Save restriction in case file is already visited...
764 ;; Watch for those date stamps in history files!
765 (goto-char (point-max))
766 (while (and (< count comint-input-ring-size)
767 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
768 nil t))
3ee91e68
RS
769 (let ((history (buffer-substring (match-beginning 1)
770 (match-end 1))))
771 (if (or (null comint-input-ignoredups)
772 (ring-empty-p ring)
773 (not (string-equal (ring-ref ring 0) history)))
dc0825db
RS
774 (ring-insert-at-beginning ring history)))
775 (setq count (1+ count))))
776 (kill-buffer history-buf))
3ee91e68
RS
777 (setq comint-input-ring ring
778 comint-input-ring-index nil)))))
779
780(defun comint-write-input-ring ()
781 "Writes the buffer's `comint-input-ring' to a history file.
782The name of the file is given by the variable `comint-input-ring-file-name'.
783The original contents of the file are lost if `comint-input-ring' is not empty.
784If `comint-input-ring-file-name' is nil this function does nothing.
785
786Useful within process sentinels.
787
788See also `comint-read-input-ring'."
789 (cond ((or (null comint-input-ring-file-name)
07ccf0bc 790 (equal comint-input-ring-file-name "")
3ee91e68
RS
791 (null comint-input-ring) (ring-empty-p comint-input-ring))
792 nil)
793 ((not (file-writable-p comint-input-ring-file-name))
794 (message "Cannot write history file %s" comint-input-ring-file-name))
795 (t
796 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
797 (ring comint-input-ring)
798 (file comint-input-ring-file-name)
799 (index (ring-length ring)))
800 ;; Write it all out into a buffer first. Much faster, but messier,
801 ;; than writing it one line at a time.
802 (save-excursion
803 (set-buffer history-buf)
804 (erase-buffer)
805 (while (> index 0)
806 (setq index (1- index))
807 (insert (ring-ref ring index) ?\n))
808 (write-region (buffer-string) nil file nil 'no-message)
809 (kill-buffer nil))))))
810
811
812(defun comint-dynamic-list-input-ring ()
813 "List in help buffer the buffer's input history."
814 (interactive)
815 (if (or (not (ring-p comint-input-ring))
816 (ring-empty-p comint-input-ring))
817 (message "No history")
818 (let ((history nil)
819 (history-buffer " *Input History*")
820 (index (1- (ring-length comint-input-ring)))
821 (conf (current-window-configuration)))
822 ;; We have to build up a list ourselves from the ring vector.
823 (while (>= index 0)
824 (setq history (cons (ring-ref comint-input-ring index) history)
825 index (1- index)))
826 ;; Change "completion" to "history reference"
827 ;; to make the display accurate.
828 (with-output-to-temp-buffer history-buffer
829 (display-completion-list history)
830 (set-buffer history-buffer)
831 (forward-line 3)
832 (while (search-backward "completion" nil 'move)
833 (replace-match "history reference")))
834 (sit-for 0)
835 (message "Hit space to flush")
836 (let ((ch (read-event)))
837 (if (eq ch ?\ )
838 (set-window-configuration conf)
839 (setq unread-command-events (list ch)))))))
840
841
842(defun comint-regexp-arg (prompt)
843 ;; Return list of regexp and prefix arg using PROMPT.
9f8ac7f9 844 (let* (;; Don't clobber this.
3ee91e68
RS
845 (last-command last-command)
846 (regexp (read-from-minibuffer prompt nil nil nil
847 'minibuffer-history-search-history)))
848 (list (if (string-equal regexp "")
849 (setcar minibuffer-history-search-history
850 (nth 1 minibuffer-history-search-history))
851 regexp)
852 (prefix-numeric-value current-prefix-arg))))
853
854(defun comint-search-arg (arg)
855 ;; First make sure there is a ring and that we are after the process mark
856 (cond ((not (comint-after-pmark-p))
857 (error "Not at command line"))
858 ((or (null comint-input-ring)
859 (ring-empty-p comint-input-ring))
860 (error "Empty input ring"))
861 ((zerop arg)
862 ;; arg of zero resets search from beginning, and uses arg of 1
863 (setq comint-input-ring-index nil)
864 1)
865 (t
866 arg)))
867
868(defun comint-search-start (arg)
869 ;; Index to start a directional search, starting at comint-input-ring-index
870 (if comint-input-ring-index
871 ;; If a search is running, offset by 1 in direction of arg
872 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
873 (ring-length comint-input-ring))
874 ;; For a new search, start from beginning or end, as appropriate
875 (if (>= arg 0)
876 0 ; First elt for forward search
877 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
878
879(defun comint-previous-input-string (arg)
880 "Return the string ARG places along the input ring.
881Moves relative to `comint-input-ring-index'."
882 (ring-ref comint-input-ring (if comint-input-ring-index
883 (mod (+ arg comint-input-ring-index)
884 (ring-length comint-input-ring))
885 arg)))
be9b65ac
DL
886
887(defun comint-previous-input (arg)
888 "Cycle backwards through input history."
889 (interactive "*p")
3ee91e68 890 (comint-previous-matching-input "." arg))
1586b965 891
be9b65ac
DL
892(defun comint-next-input (arg)
893 "Cycle forwards through input history."
894 (interactive "*p")
895 (comint-previous-input (- arg)))
896
3ee91e68
RS
897(defun comint-previous-matching-input-string (regexp arg)
898 "Return the string matching REGEXP ARG places along the input ring.
899Moves relative to `comint-input-ring-index'."
900 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
901 (if pos (ring-ref comint-input-ring pos))))
902
903(defun comint-previous-matching-input-string-position (regexp arg &optional start)
904 "Return the index matching REGEXP ARG places along the input ring.
905Moves relative to START, or `comint-input-ring-index'."
906 (if (or (not (ring-p comint-input-ring))
907 (ring-empty-p comint-input-ring))
908 (error "No history"))
909 (let* ((len (ring-length comint-input-ring))
910 (motion (if (> arg 0) 1 -1))
911 (n (mod (- (or start (comint-search-start arg)) motion) len))
912 (tried-each-ring-item nil)
913 (prev nil))
914 ;; Do the whole search as many times as the argument says.
915 (while (and (/= arg 0) (not tried-each-ring-item))
916 ;; Step once.
917 (setq prev n
918 n (mod (+ n motion) len))
919 ;; If we haven't reached a match, step some more.
920 (while (and (< n len) (not tried-each-ring-item)
921 (not (string-match regexp (ring-ref comint-input-ring n))))
922 (setq n (mod (+ n motion) len)
923 ;; If we have gone all the way around in this search.
924 tried-each-ring-item (= n prev)))
925 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
926 ;; Now that we know which ring element to use, if we found it, return that.
927 (if (string-match regexp (ring-ref comint-input-ring n))
928 n)))
929
0c5c1f34
RS
930(defun comint-previous-matching-input (regexp arg)
931 "Search backwards through input history for match for REGEXP.
932\(Previous history elements are earlier commands.)
933With prefix argument N, search for Nth previous match.
934If N is negative, find the next or Nth next match."
3ee91e68
RS
935 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
936 (setq arg (comint-search-arg arg))
937 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
938 ;; Has a match been found?
939 (if (null pos)
940 (error "Not found")
941 (setq comint-input-ring-index pos)
942 (message "History item: %d" (1+ pos))
943 (delete-region
944 ;; Can't use kill-region as it sets this-command
361ecbf2
RS
945 (or (marker-position comint-accum-marker)
946 (process-mark (get-buffer-process (current-buffer))))
947 (point))
3ee91e68 948 (insert (ring-ref comint-input-ring pos)))))
0c5c1f34
RS
949
950(defun comint-next-matching-input (regexp arg)
951 "Search forwards through input history for match for REGEXP.
952\(Later history elements are more recent commands.)
953With prefix argument N, search for Nth following match.
954If N is negative, find the previous or Nth previous match."
3ee91e68 955 (interactive (comint-regexp-arg "Next input matching (regexp): "))
0c5c1f34 956 (comint-previous-matching-input regexp (- arg)))
be9b65ac 957
3ee91e68
RS
958(defun comint-previous-matching-input-from-input (arg)
959 "Search backwards through input history for match for current input.
960\(Previous history elements are earlier commands.)
961With prefix argument N, search for Nth previous match.
3f849529 962If N is negative, search forwards for the -Nth following match."
3ee91e68
RS
963 (interactive "p")
964 (if (not (memq last-command '(comint-previous-matching-input-from-input
965 comint-next-matching-input-from-input)))
966 ;; Starting a new search
967 (setq comint-matching-input-from-input-string
968 (buffer-substring
361ecbf2
RS
969 (or (marker-position comint-accum-marker)
970 (process-mark (get-buffer-process (current-buffer))))
3ee91e68
RS
971 (point))
972 comint-input-ring-index nil))
973 (comint-previous-matching-input
974 (concat "^" (regexp-quote comint-matching-input-from-input-string))
975 arg))
976
977(defun comint-next-matching-input-from-input (arg)
978 "Search forwards through input history for match for current input.
3f849529
RS
979\(Following history elements are more recent commands.)
980With prefix argument N, search for Nth following match.
981If N is negative, search backwards for the -Nth previous match."
3ee91e68
RS
982 (interactive "p")
983 (comint-previous-matching-input-from-input (- arg)))
984
985
17ac4966 986(defun comint-replace-by-expanded-history (&optional silent start)
3ee91e68 987 "Expand input command history references before point.
1b421826
RS
988Expansion is dependent on the value of `comint-input-autoexpand'.
989
3ee91e68
RS
990This function depends on the buffer's idea of the input history, which may not
991match the command interpreter's idea, assuming it has one.
992
993Assumes history syntax is like typical Un*x shells'. However, since emacs
994cannot know the interpreter's idea of input line numbers, assuming it has one,
995it cannot expand absolute input line number references.
996
d637fa56
RS
997If the optional argument SILENT is non-nil, never complain
998even if history reference seems erroneous.
999
17ac4966
RS
1000If the optional argument START is non-nil, that specifies the
1001start of the text to scan for history references, rather
1002than the logical beginning of line.
1003
1b421826
RS
1004See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1005
1006Returns t if successful."
3ee91e68 1007 (interactive)
1b421826 1008 (if (and comint-input-autoexpand
107d7589 1009 (string-match "!\\|^\\^" (funcall comint-get-old-input))
8d3d2a0c
KH
1010 (save-excursion (beginning-of-line)
1011 (looking-at comint-prompt-regexp)))
1b421826
RS
1012 ;; Looks like there might be history references in the command.
1013 (let ((previous-modified-tick (buffer-modified-tick)))
17ac4966 1014 (comint-replace-by-expanded-history-before-point silent start)
1b421826
RS
1015 (/= previous-modified-tick (buffer-modified-tick)))))
1016
1017
17ac4966 1018(defun comint-replace-by-expanded-history-before-point (silent &optional start)
1b421826 1019 "Expand directory stack reference before point.
17ac4966
RS
1020See `comint-replace-by-expanded-history'. Returns t if successful.
1021
1022If the optional argument START is non-nil, that specifies the
1023start of the text to scan for history references, rather
1024than the logical beginning of line."
3ee91e68
RS
1025 (save-excursion
1026 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
17ac4966 1027 (start (or start (progn (comint-bol nil) (point)))))
d637fa56
RS
1028 (while (progn
1029 (skip-chars-forward "^!^"
1030 (save-excursion
1031 (end-of-line nil) (- (point) toend)))
1032 (< (point)
1033 (save-excursion
1034 (end-of-line nil) (- (point) toend))))
3ee91e68
RS
1035 ;; This seems a bit complex. We look for references such as !!, !-num,
1036 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1037 ;; If that wasn't enough, the plings can be suffixed with argument
1038 ;; range specifiers.
1039 ;; Argument ranges are complex too, so we hive off the input line,
1040 ;; referenced with plings, with the range string to `comint-args'.
1041 (setq comint-input-ring-index nil)
3ee91e68
RS
1042 (cond ((or (= (preceding-char) ?\\)
1043 (comint-within-quotes start (point)))
1044 ;; The history is quoted, or we're in quotes.
d637fa56 1045 (goto-char (1+ (point))))
3ee91e68
RS
1046 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1047 ;; We cannot know the interpreter's idea of input line numbers.
1048 (goto-char (match-end 0))
1049 (message "Absolute reference cannot be expanded"))
1050 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1051 ;; Just a number of args from `number' lines backward.
1052 (let ((number (1- (string-to-number
1053 (buffer-substring (match-beginning 1)
1054 (match-end 1))))))
1055 (if (<= number (ring-length comint-input-ring))
1056 (progn
1057 (replace-match
1058 (comint-args (comint-previous-input-string number)
fb9ab28a
RS
1059 (match-beginning 2) (match-end 2))
1060 t t)
3ee91e68
RS
1061 (setq comint-input-ring-index number)
1062 (message "History item: %d" (1+ number)))
1063 (goto-char (match-end 0))
1064 (message "Relative reference exceeds input history size"))))
1065 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1066 ;; Just a number of args from the previous input line.
1067 (replace-match
1068 (comint-args (comint-previous-input-string 0)
fb9ab28a
RS
1069 (match-beginning 1) (match-end 1))
1070 t t)
1b421826 1071 (message "History item: previous"))
3ee91e68
RS
1072 ((looking-at
1073 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1074 ;; Most recent input starting with or containing (possibly
1075 ;; protected) string, maybe just a number of args. Phew.
1076 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1077 (mb2 (match-beginning 2)) (me2 (match-end 2))
1078 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1079 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1080 (pos (save-match-data
1081 (comint-previous-matching-input-string-position
1082 (concat pref (regexp-quote exp)) 1))))
1083 (if (null pos)
5a336c13
KH
1084 (progn
1085 (goto-char (match-end 0))
1086 (or silent
1087 (progn (message "Not found")
1088 (ding))))
3ee91e68 1089 (setq comint-input-ring-index pos)
3ee91e68
RS
1090 (replace-match
1091 (comint-args (ring-ref comint-input-ring pos)
fb9ab28a
RS
1092 (match-beginning 4) (match-end 4))
1093 t t)
1b421826 1094 (message "History item: %d" (1+ pos)))))
3ee91e68
RS
1095 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1096 ;; Quick substitution on the previous input line.
1097 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1098 (new (buffer-substring (match-beginning 2) (match-end 2)))
1099 (pos nil))
1100 (replace-match (comint-previous-input-string 0) t t)
1101 (setq pos (point))
1102 (goto-char (match-beginning 0))
1b421826
RS
1103 (if (not (search-forward old pos t))
1104 (or silent
1105 (error "Not found"))
1106 (replace-match new t t)
1107 (message "History item: substituted"))))
3ee91e68 1108 (t
2ac86cc0 1109 (forward-char 1)))))))
3ee91e68
RS
1110
1111
1112(defun comint-magic-space (arg)
1113 "Expand input history references before point and insert ARG spaces.
1114A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1115 (interactive "p")
1116 (comint-replace-by-expanded-history)
1117 (self-insert-command arg))
1118\f
1119(defun comint-within-quotes (beg end)
1120 "Return t if the number of quotes between BEG and END is odd.
1121Quotes are single and double."
1122 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1123 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1124 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1125
1126(defun comint-how-many-region (regexp beg end)
1127 "Return number of matches for REGEXP from BEG to END."
1128 (let ((count 0))
1129 (save-excursion
1130 (save-match-data
1131 (goto-char beg)
1132 (while (re-search-forward regexp end t)
1133 (setq count (1+ count)))))
1134 count))
1135
1136(defun comint-args (string begin end)
1137 ;; From STRING, return the args depending on the range specified in the text
1138 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1139 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1140 (save-match-data
1141 (if (null begin)
1142 (comint-arguments string 0 nil)
1143 (let* ((range (buffer-substring
1144 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1145 (nth (cond ((string-match "^[*^]" range) 1)
1146 ((string-match "^-" range) 0)
1147 ((string-equal range "$") nil)
1148 (t (string-to-number range))))
1149 (mth (cond ((string-match "[-*$]$" range) nil)
1150 ((string-match "-" range)
1151 (string-to-number (substring range (match-end 0))))
1152 (t nth))))
1153 (comint-arguments string nth mth)))))
1154
3f4b7c36
RS
1155;; Return a list of arguments from ARG. Break it up at the
1156;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
3ee91e68 1157(defun comint-delim-arg (arg)
3f4b7c36 1158 (if (null comint-delimiter-argument-list)
3ee91e68 1159 (list arg)
3f4b7c36
RS
1160 (let ((args nil)
1161 (pos 0)
1162 (len (length arg)))
1163 (while (< pos len)
1164 (let ((char (aref arg pos))
1165 (start pos))
1166 (if (memq char comint-delimiter-argument-list)
1167 (while (and (< pos len) (eq (aref arg pos) char))
1168 (setq pos (1+ pos)))
1169 (while (and (< pos len)
1170 (not (memq (aref arg pos)
1171 comint-delimiter-argument-list)))
1172 (setq pos (1+ pos))))
1173 (setq args (cons (substring arg start pos) args))))
3ee91e68
RS
1174 args)))
1175
1176(defun comint-arguments (string nth mth)
1177 "Return from STRING the NTH to MTH arguments.
1178NTH and/or MTH can be nil, which means the last argument.
3f4b7c36
RS
1179Returned arguments are separated by single spaces.
1180We assume whitespace separates arguments, except within quotes.
1181Also, a run of one or more of a single character
1182in `comint-delimiter-argument-list' is a separate argument.
3ee91e68 1183Argument 0 is the command name."
21a003b9
GV
1184 ;; The first line handles ordinary characters and backslash-sequences
1185 ;; (except with w32 msdos-like shells, where backslashes are valid).
ec569127
RS
1186 ;; The second matches "-quoted strings.
1187 ;; The third matches '-quoted strings.
1188 ;; The fourth matches `-quoted strings.
1189 ;; This seems to fit the syntax of BASH 2.0.
21a003b9
GV
1190 (let* ((first (if (and (eq system-type 'windows-nt)
1191 (w32-shell-dos-semantics))
1192 "[^ \n\t\"'`]+\\|"
1193 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\]+\\|"))
1194 (argpart (concat first
1195 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
ec569127 1196'[^']*'\\|\
21a003b9
GV
1197`[^`]*`\\)"))
1198 (args ()) (pos 0)
1199 (count 0)
1200 beg str value quotes)
d91f490d
RS
1201 ;; Build a list of all the args until we have as many as we want.
1202 (while (and (or (null mth) (<= count mth))
1203 (string-match argpart string pos))
1204 (if (and beg (= pos (match-beginning 0)))
1205 ;; It's contiguous, part of the same arg.
1206 (setq pos (match-end 0)
1207 quotes (or quotes (match-beginning 1)))
1208 ;; It's a new separate arg.
1209 (if beg
1210 ;; Put the previous arg, if there was one, onto ARGS.
1211 (setq str (substring string beg pos)
1212 args (if quotes (cons str args)
1213 (nconc (comint-delim-arg str) args))
1214 count (1+ count)))
1215 (setq quotes (match-beginning 1))
1216 (setq beg (match-beginning 0))
1217 (setq pos (match-end 0))))
1218 (if beg
1219 (setq str (substring string beg pos)
1220 args (if quotes (cons str args)
1221 (nconc (comint-delim-arg str) args))
1222 count (1+ count)))
1223 (let ((n (or nth (1- count)))
1224 (m (if mth (1- (- count mth)) 0)))
3ee91e68
RS
1225 (mapconcat
1226 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1227\f
b578f267
EN
1228;;
1229;; Input processing stuff
1230;;
3ee91e68 1231
49116ac0 1232(defun comint-send-input ()
c2ced5d8
CZ
1233 "Send input to process.
1234After the process output mark, sends all text from the process mark to
1235point as input to the process. Before the process output mark, calls value
8ae3bc9f 1236of variable `comint-get-old-input' to retrieve old input, copies it to the
cccd719e 1237process mark, and sends it. If variable `comint-process-echoes' is nil,
8ae3bc9f 1238a terminal newline is also inserted into the buffer and sent to the process
cccd719e
RS
1239\(if it is non-nil, all text from the process mark to point is deleted,
1240since it is assumed the remote process will re-echo it).
8ae3bc9f 1241
3ee91e68 1242Any history reference may be expanded depending on the value of the variable
1b421826 1243`comint-input-autoexpand'. The list of function names contained in the value
fb9ab28a 1244of `comint-input-filter-functions' is called on the input before sending it.
1b421826
RS
1245The input is entered into the input history ring, if the value of variable
1246`comint-input-filter' returns non-nil when called on the input.
cccd719e
RS
1247
1248If variable `comint-eol-on-send' is non-nil, then point is moved to the
8ae3bc9f
NF
1249end of line before sending the input.
1250
fb9ab28a 1251The values of `comint-get-old-input', `comint-input-filter-functions', and
1b421826
RS
1252`comint-input-filter' are chosen according to the command interpreter running
1253in the buffer. E.g.,
1254
be9b65ac 1255If the interpreter is the csh,
49116ac0
JB
1256 comint-get-old-input is the default: take the current line, discard any
1257 initial string matching regexp comint-prompt-regexp.
fb9ab28a 1258 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1b421826 1259 \"popd\" commands. When it sees one, it cd's the buffer.
3ee91e68 1260 comint-input-filter is the default: returns t if the input isn't all white
49116ac0 1261 space.
be9b65ac
DL
1262
1263If the comint is Lucid Common Lisp,
49116ac0 1264 comint-get-old-input snarfs the sexp ending at point.
fb9ab28a 1265 comint-input-filter-functions does nothing.
3ee91e68 1266 comint-input-filter returns nil if the input matches input-filter-regexp,
be9b65ac
DL
1267 which matches (1) all whitespace (2) :a, :c, etc.
1268
1586b965 1269Similarly for Soar, Scheme, etc."
be9b65ac
DL
1270 (interactive)
1271 ;; Note that the input string does not include its terminal newline.
49116ac0
JB
1272 (let ((proc (get-buffer-process (current-buffer))))
1273 (if (not proc) (error "Current buffer has no process")
1274 (let* ((pmark (process-mark proc))
3ee91e68 1275 (intxt (if (>= (point) (marker-position pmark))
49116ac0
JB
1276 (progn (if comint-eol-on-send (end-of-line))
1277 (buffer-substring pmark (point)))
87ef29fd
JB
1278 (let ((copy (funcall comint-get-old-input)))
1279 (goto-char pmark)
1280 (insert copy)
3ee91e68
RS
1281 copy)))
1282 (input (if (not (eq comint-input-autoexpand 'input))
1283 ;; Just whatever's already there
1284 intxt
1285 ;; Expand and leave it visible in buffer
17ac4966 1286 (comint-replace-by-expanded-history t pmark)
3ee91e68
RS
1287 (buffer-substring pmark (point))))
1288 (history (if (not (eq comint-input-autoexpand 'history))
5f46b51a 1289 input
3ee91e68
RS
1290 ;; This is messy 'cos ultimately the original
1291 ;; functions used do insertion, rather than return
1292 ;; strings. We have to expand, then insert back.
17ac4966 1293 (comint-replace-by-expanded-history t pmark)
ff6318be
SM
1294 (let ((copy (buffer-substring pmark (point)))
1295 (start (point)))
1296 (insert input)
1297 (delete-region pmark start)
5f46b51a 1298 copy))))
8ae3bc9f
NF
1299 (if comint-process-echoes
1300 (delete-region pmark (point))
d2a49350 1301 (insert-before-markers ?\n))
3ee91e68
RS
1302 (if (and (funcall comint-input-filter history)
1303 (or (null comint-input-ignoredups)
1304 (not (ring-p comint-input-ring))
1305 (ring-empty-p comint-input-ring)
1306 (not (string-equal (ring-ref comint-input-ring 0)
1307 history))))
1308 (ring-insert comint-input-ring history))
155fd027
KH
1309 (run-hook-with-args 'comint-input-filter-functions
1310 (concat input "\n"))
361ecbf2 1311 (setq comint-save-input-ring-index comint-input-ring-index)
1586b965 1312 (setq comint-input-ring-index nil)
dcdc526c
RS
1313 ;; Update the markers before we send the input
1314 ;; in case we get output amidst sending the input.
87ef29fd
JB
1315 (set-marker comint-last-input-start pmark)
1316 (set-marker comint-last-input-end (point))
3ee91e68 1317 (set-marker (process-mark proc) (point))
361ecbf2
RS
1318 ;; clear the "accumulation" marker
1319 (set-marker comint-accum-marker nil)
dcdc526c 1320 (funcall comint-input-sender proc input)
6aac2ab0
RS
1321 ;; This used to call comint-output-filter-functions,
1322 ;; but that scrolled the buffer in undesirable ways.
1323 (run-hook-with-args 'comint-output-filter-functions "")))))
be9b65ac 1324
d4321160 1325(defvar comint-preoutput-filter-functions nil
e7654b4a 1326 "Functions to call before output is inserted into the buffer.
d4321160
RS
1327These functions get one argument, a string containing the text to be
1328inserted. They return the string as it should be inserted.
1329
1330This variable is buffer-local.")
1331
3ee91e68 1332;; The purpose of using this filter for comint processes
5511e411
RS
1333;; is to keep comint-last-input-end from moving forward
1334;; when output is inserted.
3ee91e68
RS
1335(defun comint-output-filter (process string)
1336 ;; First check for killed buffer
91d75282 1337 (let ((oprocbuf (process-buffer process)))
d4321160
RS
1338 (let ((functions comint-preoutput-filter-functions))
1339 (while (and functions string)
1340 (setq string (funcall (car functions) string))
1341 (setq functions (cdr functions))))
1342 (if (and string oprocbuf (buffer-name oprocbuf))
91d75282
RS
1343 (let ((obuf (current-buffer))
1344 (opoint nil) (obeg nil) (oend nil))
1345 (set-buffer oprocbuf)
1346 (setq opoint (point))
1347 (setq obeg (point-min))
1348 (setq oend (point-max))
1349 (let ((buffer-read-only nil)
1350 (nchars (length string))
1351 (ostart nil))
1352 (widen)
1353 (goto-char (process-mark process))
1354 (setq ostart (point))
1355 (if (<= (point) opoint)
1356 (setq opoint (+ opoint nchars)))
1357 ;; Insert after old_begv, but before old_zv.
1358 (if (< (point) obeg)
1359 (setq obeg (+ obeg nchars)))
1360 (if (<= (point) oend)
1361 (setq oend (+ oend nchars)))
1362 (insert-before-markers string)
1363 ;; Don't insert initial prompt outside the top of the window.
1364 (if (= (window-start (selected-window)) (point))
1365 (set-window-start (selected-window) (- (point) (length string))))
1366 (if (and comint-last-input-end
1367 (marker-buffer comint-last-input-end)
1368 (= (point) comint-last-input-end))
1369 (set-marker comint-last-input-end (- comint-last-input-end nchars)))
1370 (set-marker comint-last-output-start ostart)
1371 (set-marker (process-mark process) (point))
1372 (force-mode-line-update))
1373
1374 (narrow-to-region obeg oend)
1375 (goto-char opoint)
155fd027 1376 (run-hook-with-args 'comint-output-filter-functions string)
91d75282 1377 (set-buffer obuf)))))
3ee91e68 1378
c1da5c03 1379(defun comint-preinput-scroll-to-bottom ()
3ee91e68
RS
1380 "Go to the end of buffer in all windows showing it.
1381Movement occurs if point in the selected window is not after the process mark,
1382and `this-command' is an insertion command. Insertion commands recognised
d637fa56 1383are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
3ee91e68
RS
1384Depends on the value of `comint-scroll-to-bottom-on-input'.
1385
c1da5c03 1386This function should be a pre-command hook."
3ee91e68 1387 (if (and comint-scroll-to-bottom-on-input
91d75282 1388 (memq this-command '(self-insert-command comint-magic-space yank
d637fa56 1389 hilit-yank)))
3ee91e68
RS
1390 (let* ((selected (selected-window))
1391 (current (current-buffer))
1392 (process (get-buffer-process current))
1393 (scroll comint-scroll-to-bottom-on-input))
d637fa56 1394 (if (and process (< (point) (process-mark process)))
0744bf64
RS
1395 (if (eq scroll 'this)
1396 (goto-char (point-max))
1397 (walk-windows
1398 (function (lambda (window)
1399 (if (and (eq (window-buffer window) current)
d637fa56 1400 (or (eq scroll t) (eq scroll 'all)))
0744bf64
RS
1401 (progn
1402 (select-window window)
1403 (goto-char (point-max))
1404 (select-window selected)))))
d637fa56 1405 nil t))))))
3ee91e68 1406
c1da5c03 1407(defun comint-postoutput-scroll-to-bottom (string)
3ee91e68
RS
1408 "Go to the end of buffer in all windows showing it.
1409Does not scroll if the current line is the last line in the buffer.
1410Depends on the value of `comint-scroll-to-bottom-on-output' and
1411`comint-scroll-show-maximum-output'.
1412
fb9ab28a 1413This function should be in the list `comint-output-filter-functions'."
3ee91e68
RS
1414 (let* ((selected (selected-window))
1415 (current (current-buffer))
1416 (process (get-buffer-process current))
1417 (scroll comint-scroll-to-bottom-on-output))
d637fa56
RS
1418 (unwind-protect
1419 (if process
1420 (walk-windows
1421 (function (lambda (window)
1422 (if (eq (window-buffer window) current)
1423 (progn
1424 (select-window window)
1425 (if (and (< (point) (process-mark process))
1426 (or (eq scroll t) (eq scroll 'all)
107d7589 1427 ;; Maybe user wants point to jump to end.
d637fa56
RS
1428 (and (eq scroll 'this) (eq selected window))
1429 (and (eq scroll 'others) (not (eq selected window)))
107d7589 1430 ;; If point was at the end, keep it at end.
2c3d5985
RS
1431 (and (marker-position comint-last-output-start)
1432 (>= (point) comint-last-output-start))))
d637fa56
RS
1433 (goto-char (process-mark process)))
1434 ;; Optionally scroll so that the text
1435 ;; ends at the bottom of the window.
1436 (if (and comint-scroll-show-maximum-output
1437 (>= (point) (process-mark process)))
1438 (save-excursion
1439 (goto-char (point-max))
1440 (recenter -1)))
1441 (select-window selected)))))
1442 nil t))
1443 (set-buffer current))))
3ee91e68 1444
39a185a9
SM
1445(defun comint-truncate-buffer (&optional string)
1446 "Truncate the buffer to `comint-buffer-maximum-size'.
1447This function could be on `comint-output-filter-functions' or bound to a key."
1448 (interactive)
1449 (save-excursion
107d7589 1450 (goto-char (process-mark (get-buffer-process (current-buffer))))
39a185a9
SM
1451 (forward-line (- comint-buffer-maximum-size))
1452 (beginning-of-line)
1453 (delete-region (point-min) (point))))
1454
efcec33f
RS
1455(defun comint-strip-ctrl-m (&optional string)
1456 "Strip trailing `^M' characters from the current output group.
39a185a9 1457This function could be on `comint-output-filter-functions' or bound to a key."
efcec33f
RS
1458 (interactive)
1459 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1460 (save-excursion
71a895c6
KH
1461 (condition-case nil
1462 (goto-char
1463 (if (interactive-p) comint-last-input-end comint-last-output-start))
1464 (error nil))
efcec33f
RS
1465 (while (re-search-forward "\r+$" pmark t)
1466 (replace-match "" t t)))))
1467(defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1468
3ee91e68
RS
1469(defun comint-show-maximum-output ()
1470 "Put the end of the buffer at the bottom of the window."
1471 (interactive)
1472 (goto-char (point-max))
1473 (recenter -1))
5511e411 1474
be9b65ac 1475(defun comint-get-old-input-default ()
cccd719e 1476 "Default for `comint-get-old-input'.
c2ced5d8 1477Take the current line, and discard any initial text matching
cccd719e 1478`comint-prompt-regexp'."
be9b65ac 1479 (save-excursion
49116ac0
JB
1480 (beginning-of-line)
1481 (comint-skip-prompt)
1482 (let ((beg (point)))
1483 (end-of-line)
1484 (buffer-substring beg (point)))))
1485
3ee91e68
RS
1486(defun comint-copy-old-input ()
1487 "Insert after prompt old input at point as new input to be edited.
1488Calls `comint-get-old-input' to get old input."
1489 (interactive)
1490 (let ((input (funcall comint-get-old-input))
1491 (process (get-buffer-process (current-buffer))))
1492 (if (not process)
1493 (error "Current buffer has no process")
1494 (goto-char (process-mark process))
1495 (insert input))))
1496
49116ac0 1497(defun comint-skip-prompt ()
cccd719e 1498 "Skip past the text matching regexp `comint-prompt-regexp'.
49116ac0
JB
1499If this takes us past the end of the current line, don't skip at all."
1500 (let ((eol (save-excursion (end-of-line) (point))))
1501 (if (and (looking-at comint-prompt-regexp)
1502 (<= (match-end 0) eol))
1503 (goto-char (match-end 0)))))
1504
49116ac0 1505(defun comint-after-pmark-p ()
3ee91e68
RS
1506 "Return t if point is after the process output marker."
1507 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1508 (<= (marker-position pmark) (point))))
49116ac0
JB
1509
1510(defun comint-simple-send (proc string)
1511 "Default function for sending to PROC input STRING.
1512This just sends STRING plus a newline. To override this,
cccd719e 1513set the hook `comint-input-sender'."
49116ac0
JB
1514 (comint-send-string proc string)
1515 (comint-send-string proc "\n"))
be9b65ac
DL
1516
1517(defun comint-bol (arg)
1518 "Goes to the beginning of line, then skips past the prompt, if any.
3ee91e68 1519If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
be9b65ac 1520
49116ac0 1521The prompt skip is done by skipping text matching the regular expression
a77db92b 1522`comint-prompt-regexp', a buffer local variable."
be9b65ac
DL
1523 (interactive "P")
1524 (beginning-of-line)
49116ac0 1525 (if (null arg) (comint-skip-prompt)))
be9b65ac 1526
b578f267
EN
1527;; These three functions are for entering text you don't want echoed or
1528;; saved -- typically passwords to ftp, telnet, or somesuch.
1529;; Just enter m-x send-invisible and type in your line, or add
1530;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
49116ac0 1531
87ef29fd 1532(defun comint-read-noecho (prompt &optional stars)
4be9a25f
NF
1533 "Read a single line of text from user without echoing, and return it.
1534Prompt with argument PROMPT, a string. Optional argument STARS causes
1535input to be echoed with '*' characters on the prompt line. Input ends with
1536RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
cccd719e
RS
1537`inhibit-quit' is set because e.g. this function was called from a process
1538filter and C-g is pressed, this function returns nil rather than a string).
4be9a25f
NF
1539
1540Note that the keystrokes comprising the text can still be recovered
dc81e166
RS
1541\(temporarily) with \\[view-lossage]. Some people find this worrysome.
1542Once the caller uses the password, it can erase the password
1543by doing (fillarray STRING 0)."
4be9a25f 1544 (let ((ans "")
dc81e166 1545 (newans nil)
4be9a25f
NF
1546 (c 0)
1547 (echo-keystrokes 0)
87ef29fd 1548 (cursor-in-echo-area t)
23cb053e
KH
1549 (message-log-max nil)
1550 (done nil))
4be9a25f
NF
1551 (while (not done)
1552 (if stars
84a99e73
KH
1553 (message "%s%s" prompt (make-string (length ans) ?*))
1554 (message "%s" prompt))
af171fd0
RS
1555 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1556 (setq c (read-char-exclusive))
4be9a25f 1557 (cond ((= c ?\C-g)
59f36b08
SM
1558 ;; This function may get called from a process filter, where
1559 ;; inhibit-quit is set. In later versions of emacs read-char
1560 ;; may clear quit-flag itself and return C-g. That would make
1561 ;; it impossible to quit this loop in a simple way, so
1562 ;; re-enable it here (for backward-compatibility the check for
1563 ;; quit-flag below would still be necessary, so this seems
1564 ;; like the simplest way to do things).
1565 (setq quit-flag t
1566 done t))
1567 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1568 (setq done t))
1569 ((= c ?\C-u)
dc81e166 1570 (fillarray ans 0)
59f36b08
SM
1571 (setq ans ""))
1572 ((and (/= c ?\b) (/= c ?\177))
dc81e166
RS
1573 (setq newans (concat ans (char-to-string c)))
1574 (fillarray ans 0)
1575 (setq ans newans))
59f36b08 1576 ((> (length ans) 0)
dc81e166 1577 (aset ans (1- (length ans)) 0)
59f36b08 1578 (setq ans (substring ans 0 -1)))))
4be9a25f
NF
1579 (if quit-flag
1580 ;; Emulate a true quit, except that we have to return a value.
1581 (prog1
1582 (setq quit-flag nil)
1583 (message "Quit")
1584 (beep t))
1585 (message "")
1586 ans)))
87ef29fd 1587
be9b65ac 1588(defun send-invisible (str)
c2ced5d8 1589 "Read a string without echoing.
6152f5f0
SM
1590Then send it to the process running in the current buffer.
1591The string is sent using `comint-input-sender'.
49116ac0
JB
1592Security bug: your string can still be temporarily recovered with
1593\\[view-lossage]."
4a11114d 1594 (interactive "P") ; Defeat snooping via C-x ESC ESC
be9b65ac 1595 (let ((proc (get-buffer-process (current-buffer))))
4a11114d
SM
1596 (cond ((not proc)
1597 (error "Current buffer has no process"))
1598 ((stringp str)
1599 (funcall comint-input-sender proc str))
1600 (t
1601 (let ((str (comint-read-noecho "Non-echoed text: " t)))
1602 (if (stringp str)
1603 (send-invisible str)
1604 (message "Warning: text will be echoed")))))))
21d9bf27
RS
1605
1606(defun comint-watch-for-password-prompt (string)
1607 "Prompt in the minibuffer for password and send without echoing.
1608This function uses `send-invisible' to read and send a password to the buffer's
654d89d7
NF
1609process if STRING contains a password prompt defined by
1610`comint-password-prompt-regexp'.
21d9bf27
RS
1611
1612This function could be in the list `comint-output-filter-functions'."
654d89d7 1613 (if (string-match comint-password-prompt-regexp string)
21d9bf27 1614 (send-invisible nil)))
be9b65ac 1615\f
b578f267 1616;; Low-level process communication
be9b65ac 1617
7df7d5b3
RS
1618(defalias 'comint-send-string 'process-send-string)
1619(defalias 'comint-send-region 'process-send-region)
be9b65ac 1620\f
b578f267 1621;; Random input hackage
be9b65ac 1622
49116ac0 1623(defun comint-kill-output ()
3ee91e68
RS
1624 "Kill all output from interpreter since last input.
1625Does not delete the prompt."
be9b65ac 1626 (interactive)
a9a6f83f
RS
1627 (let ((proc (get-buffer-process (current-buffer)))
1628 (replacement nil))
1629 (save-excursion
1630 (let ((pmark (progn (goto-char (process-mark proc))
1631 (beginning-of-line nil)
1632 (point-marker))))
1633 (delete-region comint-last-input-end pmark)
37a9a675 1634 (goto-char (process-mark proc))
a9a6f83f
RS
1635 (setq replacement (concat "*** output flushed ***\n"
1636 (buffer-substring pmark (point))))
1637 (delete-region pmark (point))))
1638 ;; Output message and put back prompt
1639 (comint-output-filter proc replacement)))
be9b65ac
DL
1640
1641(defun comint-show-output ()
49116ac0 1642 "Display start of this batch of interpreter output at top of window.
21d9bf27 1643Sets mark to the value of point when this command is run."
be9b65ac 1644 (interactive)
815c1a20 1645 (push-mark)
3ee91e68 1646 (let ((pos (point)))
42453245 1647 (goto-char (or (marker-position comint-last-input-end) (point-max)))
3ee91e68
RS
1648 (beginning-of-line 0)
1649 (set-window-start (selected-window) (point))
815c1a20 1650 (comint-skip-prompt)))
be9b65ac
DL
1651
1652(defun comint-interrupt-subjob ()
1a94abea
RS
1653 "Interrupt the current subjob.
1654This command also kills the pending input
1655between the process-mark and point."
be9b65ac 1656 (interactive)
1a94abea 1657 (comint-kill-input)
49116ac0 1658 (interrupt-process nil comint-ptyp))
be9b65ac
DL
1659
1660(defun comint-kill-subjob ()
1a94abea
RS
1661 "Send kill signal to the current subjob.
1662This command also kills the pending input
1663between the process-mark and point."
be9b65ac 1664 (interactive)
1a94abea 1665 (comint-kill-input)
49116ac0 1666 (kill-process nil comint-ptyp))
be9b65ac
DL
1667
1668(defun comint-quit-subjob ()
1a94abea
RS
1669 "Send quit signal to the current subjob.
1670This command also kills the pending input
1671between the process-mark and point."
be9b65ac 1672 (interactive)
1a94abea 1673 (comint-kill-input)
49116ac0 1674 (quit-process nil comint-ptyp))
be9b65ac
DL
1675
1676(defun comint-stop-subjob ()
49116ac0 1677 "Stop the current subjob.
1a94abea
RS
1678This command also kills the pending input
1679between the process-mark and point.
1680
be9b65ac 1681WARNING: if there is no current subjob, you can end up suspending
49116ac0
JB
1682the top-level process running in the buffer. If you accidentally do
1683this, use \\[comint-continue-subjob] to resume the process. (This
1684is not a problem with most shells, since they ignore this signal.)"
be9b65ac 1685 (interactive)
1a94abea 1686 (comint-kill-input)
49116ac0 1687 (stop-process nil comint-ptyp))
be9b65ac
DL
1688
1689(defun comint-continue-subjob ()
49116ac0 1690 "Send CONT signal to process buffer's process group.
be9b65ac
DL
1691Useful if you accidentally suspend the top-level process."
1692 (interactive)
49116ac0 1693 (continue-process nil comint-ptyp))
be9b65ac
DL
1694
1695(defun comint-kill-input ()
49116ac0 1696 "Kill all text from last stuff output by interpreter to point."
be9b65ac 1697 (interactive)
3ee91e68
RS
1698 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1699 (if (> (point) (marker-position pmark))
49116ac0 1700 (kill-region pmark (point)))))
be9b65ac
DL
1701
1702(defun comint-delchar-or-maybe-eof (arg)
4a11114d
SM
1703 "Delete ARG characters forward or send an EOF to subprocess.
1704Sends an EOF only if point is at the end of the buffer and there is no input."
be9b65ac 1705 (interactive "p")
90d6bfb9
KH
1706 (let ((proc (get-buffer-process (current-buffer))))
1707 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
4a11114d
SM
1708 (process-send-eof)
1709 (delete-char arg))))
49116ac0 1710
1de80a34
RM
1711(defun comint-send-eof ()
1712 "Send an EOF to the current buffer's process."
1713 (interactive)
1714 (process-send-eof))
49116ac0 1715
3ee91e68
RS
1716
1717(defun comint-backward-matching-input (regexp arg)
1718 "Search backward through buffer for match for REGEXP.
1719Matches are searched for on lines that match `comint-prompt-regexp'.
1720With prefix argument N, search for Nth previous match.
1721If N is negative, find the next or Nth next match."
1722 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
1723 (let* ((re (concat comint-prompt-regexp ".*" regexp))
1724 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
1725 (if (re-search-backward re nil t arg)
1726 (point)))))
1727 (if (null pos)
1728 (progn (message "Not found")
1729 (ding))
1730 (goto-char pos)
1731 (comint-bol nil))))
1732
1733(defun comint-forward-matching-input (regexp arg)
1734 "Search forward through buffer for match for REGEXP.
1735Matches are searched for on lines that match `comint-prompt-regexp'.
1736With prefix argument N, search for Nth following match.
1737If N is negative, find the previous or Nth previous match."
1738 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
1739 (comint-backward-matching-input regexp (- arg)))
1740
1741
1de80a34 1742(defun comint-next-prompt (n)
3ee91e68 1743 "Move to end of Nth next prompt in the buffer.
1de80a34
RM
1744See `comint-prompt-regexp'."
1745 (interactive "p")
3ee91e68
RS
1746 (let ((paragraph-start comint-prompt-regexp))
1747 (end-of-line (if (> n 0) 1 0))
1748 (forward-paragraph n)
1749 (comint-skip-prompt)))
49116ac0 1750
3ee91e68
RS
1751(defun comint-previous-prompt (n)
1752 "Move to end of Nth previous prompt in the buffer.
1de80a34
RM
1753See `comint-prompt-regexp'."
1754 (interactive "p")
3ee91e68 1755 (comint-next-prompt (- n)))
be9b65ac 1756\f
b578f267
EN
1757;; Support for source-file processing commands.
1758;;============================================================================
1759;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1760;; commands that process files of source text (e.g. loading or compiling
1761;; files). So the corresponding process-in-a-buffer modes have commands
1762;; for doing this (e.g., lisp-load-file). The functions below are useful
1763;; for defining these commands.
1764;;
1765;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1766;; and Soar, in that they don't know anything about file extensions.
1767;; So the compile/load interface gets the wrong default occasionally.
1768;; The load-file/compile-file default mechanism could be smarter -- it
1769;; doesn't know about the relationship between filename extensions and
1770;; whether the file is source or executable. If you compile foo.lisp
1771;; with compile-file, then the next load-file should use foo.bin for
1772;; the default, not foo.lisp. This is tricky to do right, particularly
1773;; because the extension for executable files varies so much (.o, .bin,
1774;; .lbin, .mo, .vo, .ao, ...).
1775
1776
1777;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1778;; commands.
1779;;
1780;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1781;; want to save the buffer before issuing any process requests to the command
1782;; interpreter.
1783;;
1784;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1785;; for the file to process.
1786
1787;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1788;;============================================================================
1789;; This function computes the defaults for the load-file and compile-file
1790;; commands for tea, soar, cmulisp, and cmuscheme modes.
1791;;
1792;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1793;; source-file processing command. NIL if there hasn't been one yet.
1794;; - SOURCE-MODES is a list used to determine what buffers contain source
1795;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1796;; Typically, (lisp-mode) or (scheme-mode).
1797;;
1798;; If the command is given while the cursor is inside a string, *and*
1799;; the string is an existing filename, *and* the filename is not a directory,
1800;; then the string is taken as default. This allows you to just position
1801;; your cursor over a string that's a filename and have it taken as default.
1802;;
1803;; If the command is given in a file buffer whose major mode is in
1804;; SOURCE-MODES, then the the filename is the default file, and the
1805;; file's directory is the default directory.
1806;;
1807;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1808;; then the default directory & file are what was used in the last source-file
1809;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1810;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1811;; is the cwd, with no default file. (\"no default file\" = nil)
1812;;
1813;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1814;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1815;; for Soar programs, etc.
1816;;
1817;; The function returns a pair: (default-directory . default-file).
be9b65ac
DL
1818
1819(defun comint-source-default (previous-dir/file source-modes)
1820 (cond ((and buffer-file-name (memq major-mode source-modes))
1821 (cons (file-name-directory buffer-file-name)
1822 (file-name-nondirectory buffer-file-name)))
1823 (previous-dir/file)
1824 (t
1825 (cons default-directory nil))))
1826
49116ac0 1827
b578f267
EN
1828;; (COMINT-CHECK-SOURCE fname)
1829;;============================================================================
1830;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1831;; process-in-a-buffer modes), this function can be called on the filename.
1832;; If the file is loaded into a buffer, and the buffer is modified, the user
1833;; is queried to see if he wants to save the buffer before proceeding with
1834;; the load or compile.
be9b65ac
DL
1835
1836(defun comint-check-source (fname)
1837 (let ((buff (get-file-buffer fname)))
1838 (if (and buff
1839 (buffer-modified-p buff)
3ee91e68 1840 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
be9b65ac
DL
1841 ;; save BUFF.
1842 (let ((old-buffer (current-buffer)))
1843 (set-buffer buff)
1844 (save-buffer)
1845 (set-buffer old-buffer)))))
1846
49116ac0 1847
b578f267
EN
1848;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1849;;============================================================================
1850;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1851;; commands that process source files (like loading or compiling a file).
1852;; It prompts for the filename, provides a default, if there is one,
1853;; and returns the result filename.
1854;;
1855;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1856;;
1857;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1858;; from the last source processing command. SOURCE-MODES is a list of major
1859;; modes used to determine what file buffers contain source files. (These
1860;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1861;; then the filename reader will only accept a file that exists.
1862;;
1863;; A typical use:
1864;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1865;; '(lisp-mode) t))
1866
1867;; This is pretty stupid about strings. It decides we're in a string
1868;; if there's a quote on both sides of point on the current line.
be9b65ac 1869(defun comint-extract-string ()
cccd719e 1870 "Return string around POINT that starts the current line, or nil."
be9b65ac
DL
1871 (save-excursion
1872 (let* ((point (point))
1873 (bol (progn (beginning-of-line) (point)))
1874 (eol (progn (end-of-line) (point)))
1875 (start (progn (goto-char point)
1876 (and (search-backward "\"" bol t)
1877 (1+ (point)))))
1878 (end (progn (goto-char point)
1879 (and (search-forward "\"" eol t)
1880 (1- (point))))))
1881 (and start end
1882 (buffer-substring start end)))))
1883
1884(defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
1885 (let* ((def (comint-source-default prev-dir/file source-modes))
1886 (stringfile (comint-extract-string))
1887 (sfile-p (and stringfile
49116ac0
JB
1888 (condition-case ()
1889 (file-exists-p stringfile)
1890 (error nil))
be9b65ac
DL
1891 (not (file-directory-p stringfile))))
1892 (defdir (if sfile-p (file-name-directory stringfile)
1893 (car def)))
1894 (deffile (if sfile-p (file-name-nondirectory stringfile)
1895 (cdr def)))
1896 (ans (read-file-name (if deffile (format "%s(default %s) "
1897 prompt deffile)
1898 prompt)
1899 defdir
1900 (concat defdir deffile)
1901 mustmatch-p)))
1902 (list (expand-file-name (substitute-in-file-name ans)))))
1903
b578f267
EN
1904;; I am somewhat divided on this string-default feature. It seems
1905;; to violate the principle-of-least-astonishment, in that it makes
1906;; the default harder to predict, so you actually have to look and see
1907;; what the default really is before choosing it. This can trip you up.
1908;; On the other hand, it can be useful, I guess. I would appreciate feedback
1909;; on this.
1910;; -Olin
49116ac0 1911
be9b65ac 1912\f
b578f267
EN
1913;; Simple process query facility.
1914;; ===========================================================================
1915;; This function is for commands that want to send a query to the process
1916;; and show the response to the user. For example, a command to get the
1917;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1918;; to an inferior Common Lisp process.
1919;;
1920;; This simple facility just sends strings to the inferior process and pops
1921;; up a window for the process buffer so you can see what the process
1922;; responds with. We don't do anything fancy like try to intercept what the
1923;; process responds with and put it in a pop-up window or on the message
1924;; line. We just display the buffer. Low tech. Simple. Works good.
1925
1926;; Send to the inferior process PROC the string STR. Pop-up but do not select
1927;; a window for the inferior process so that its response can be seen.
be9b65ac
DL
1928(defun comint-proc-query (proc str)
1929 (let* ((proc-buf (process-buffer proc))
1930 (proc-mark (process-mark proc)))
1931 (display-buffer proc-buf)
1932 (set-buffer proc-buf) ; but it's not the selected *window*
1933 (let ((proc-win (get-buffer-window proc-buf))
1934 (proc-pt (marker-position proc-mark)))
1935 (comint-send-string proc str) ; send the query
1936 (accept-process-output proc) ; wait for some output
1937 ;; Try to position the proc window so you can see the answer.
1938 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1939 ;; I don't know why. Wizards invited to improve it.
17193f89
SM
1940 (unless (pos-visible-in-window-p proc-pt proc-win)
1941 (let ((opoint (window-point proc-win)))
1942 (set-window-point proc-win proc-mark)
1943 (sit-for 0)
1944 (if (not (pos-visible-in-window-p opoint proc-win))
1945 (push-mark opoint)
1946 (set-window-point proc-win opoint)))))))
be9b65ac
DL
1947
1948\f
b578f267
EN
1949;; Filename/command/history completion in a buffer
1950;; ===========================================================================
1951;; Useful completion functions, courtesy of the Ergo group.
1952
1953;; Six commands:
1954;; comint-dynamic-complete Complete or expand command, filename,
1955;; history at point.
1956;; comint-dynamic-complete-filename Complete filename at point.
1957;; comint-dynamic-list-filename-completions List completions in help buffer.
1958;; comint-replace-by-expanded-filename Expand and complete filename at point;
1959;; replace with expanded/completed name.
1960;; comint-dynamic-simple-complete Complete stub given candidates.
1961
1962;; These are not installed in the comint-mode keymap. But they are
1963;; available for people who want them. Shell-mode installs them:
1964;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1965;; (define-key shell-mode-map "\M-?"
1966;; 'comint-dynamic-list-filename-completions)))
1967;;
1968;; Commands like this are fine things to put in load hooks if you
1969;; want them present in specific modes.
49116ac0 1970
ed366e87 1971(defcustom comint-completion-autolist nil
5ef2f81f 1972 "*If non-nil, automatically list possibilities on partial completion.
ed366e87
RS
1973This mirrors the optional behavior of tcsh."
1974 :type 'boolean
1975 :group 'comint-completion)
3ee91e68 1976
ed366e87 1977(defcustom comint-completion-addsuffix t
3ee91e68 1978 "*If non-nil, add a `/' to completed directories, ` ' to file names.
59f36b08
SM
1979If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
1980DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
ed366e87
RS
1981This mirrors the optional behavior of tcsh."
1982 :type 'boolean
1983 :group 'comint-completion)
3ee91e68 1984
ed366e87 1985(defcustom comint-completion-recexact nil
3ee91e68 1986 "*If non-nil, use shortest completion if characters cannot be added.
fdb7791d 1987This mirrors the optional behavior of tcsh.
3ee91e68 1988
ed366e87
RS
1989A non-nil value is useful if `comint-completion-autolist' is non-nil too."
1990 :type 'boolean
1991 :group 'comint-completion)
3ee91e68 1992
ed366e87 1993(defcustom comint-completion-fignore nil
497513ad
RS
1994 "*List of suffixes to be disregarded during file completion.
1995This mirrors the optional behavior of bash and tcsh.
1996
ed366e87
RS
1997Note that this applies to `comint-dynamic-complete-filename' only."
1998 :type '(repeat (string :tag "Suffix"))
1999 :group 'comint-completion)
497513ad 2000
3ee91e68
RS
2001(defvar comint-file-name-prefix ""
2002 "Prefix prepended to absolute file names taken from process input.
2003This is used by comint's and shell's completion functions, and by shell's
2004directory tracking functions.")
be9b65ac 2005
2d4382e5 2006(defvar comint-file-name-chars
da418b28
GV
2007 (if (memq system-type '(ms-dos windows-nt))
2008 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2009 "~/A-Za-z0-9+@:_.$#%,={}-")
2d4382e5 2010 "String of characters valid in a file name.
af898b0f
RS
2011Note that all non-ASCII characters are considered valid in a file name
2012regardless of what this variable says.
107d7589
SM
2013
2014This is a good thing to set in mode hooks.")
2015
59f36b08 2016(defvar comint-file-name-quote-list nil
6d2a6ce6 2017 "List of characters to quote with `\\' when in a file name.
59f36b08
SM
2018
2019This is a good thing to set in mode hooks.")
2020
3ee91e68
RS
2021
2022(defun comint-directory (directory)
2023 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2024 (expand-file-name (if (file-name-absolute-p directory)
2025 (concat comint-file-name-prefix directory)
2026 directory)))
2027
2028
1b421826
RS
2029(defun comint-word (word-chars)
2030 "Return the word of WORD-CHARS at point, or nil if non is found.
2031Word constituents are considered to be those in WORD-CHARS, which is like the
af898b0f
RS
2032inside of a \"[...]\" (see `skip-chars-forward'),
2033plus all non-ASCII characters."
3ee91e68 2034 (save-excursion
59f36b08
SM
2035 (let ((non-word-chars (concat "[^\\\\" word-chars "]")) (here (point)))
2036 (while (and (re-search-backward non-word-chars nil 'move)
af898b0f
RS
2037 ;;(memq (char-after (point)) shell-file-name-quote-list)
2038 (or (>= (following-char) 128)
2039 (eq (preceding-char) ?\\)))
59f36b08 2040 (backward-char 1))
4288965c 2041 ;; Don't go forward over a word-char (this can happen if we're at bob).
17193f89
SM
2042 (when (or (not (bobp)) (looking-at non-word-chars))
2043 (forward-char 1))
4288965c 2044 ;; Set match-data to match the entire string.
17193f89 2045 (when (< (point) here)
e4947876 2046 (set-match-data (list (point) here))
17193f89 2047 (match-string 0)))))
3ee91e68 2048
7a35a067
RS
2049(defun comint-substitute-in-file-name (filename)
2050 "Return FILENAME with environment variables substituted.
2051Supports additional environment variable syntax of the command
2052interpreter (e.g., the percent notation of cmd.exe on NT)."
2053 (let ((name (substitute-in-file-name filename)))
2054 (if (memq system-type '(ms-dos windows-nt))
2055 (let (env-var-name
2056 env-var-val)
2057 (save-match-data
2058 (while (string-match "%\\([^\\\\/]*\\)%" name)
2059 (setq env-var-name
2060 (substring name (match-beginning 1) (match-end 1)))
2061 (setq env-var-val (if (getenv env-var-name)
2062 (getenv env-var-name)
2063 ""))
2064 (setq name (replace-match env-var-val nil nil name))))))
2065 name))
3ee91e68 2066
1b421826
RS
2067(defun comint-match-partial-filename ()
2068 "Return the filename at point, or nil if non is found.
2069Environment variables are substituted. See `comint-word'."
2d4382e5 2070 (let ((filename (comint-word comint-file-name-chars)))
7a35a067
RS
2071 (and filename (comint-substitute-in-file-name
2072 (comint-unquote-filename filename)))))
59f36b08
SM
2073
2074
2075(defun comint-quote-filename (filename)
2076 "Return FILENAME with magic characters quoted.
2077Magic characters are those in `comint-file-name-quote-list'."
2078 (if (null comint-file-name-quote-list)
2079 filename
2080 (let ((regexp
2081 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2082 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2083 (save-match-data
2084 (while (string-match regexp filename)
2085 (setq filename (replace-match "\\1\\\\\\2" nil nil filename)))
2086 filename))))
2087
2088(defun comint-unquote-filename (filename)
2089 "Return FILENAME with quoted characters unquoted."
2090 (if (null comint-file-name-quote-list)
2091 filename
2092 (save-match-data
dbdfff7f
RS
2093 (let ((i 0))
2094 (while (string-match "\\\\\\(.\\)" filename i)
2095 (setq filename (replace-match "\\1" nil nil filename))
2096 (setq i (+ 1 (match-beginning 0)))))
59f36b08 2097 filename)))
be9b65ac 2098
49116ac0 2099
be9b65ac 2100(defun comint-dynamic-complete ()
1b421826
RS
2101 "Dynamically perform completion at point.
2102Calls the functions in `comint-dynamic-complete-functions' to perform
2103completion until a function returns non-nil, at which point completion is
2104assumed to have occurred."
3ee91e68 2105 (interactive)
155fd027 2106 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
3ee91e68
RS
2107
2108
2109(defun comint-dynamic-complete-filename ()
49116ac0 2110 "Dynamically complete the filename at point.
1b421826
RS
2111Completes if after a filename. See `comint-match-partial-filename' and
2112`comint-dynamic-complete-as-filename'.
3ee91e68
RS
2113This function is similar to `comint-replace-by-expanded-filename', except that
2114it won't change parts of the filename already entered in the buffer; it just
2115adds completion characters to the end of the filename. A completions listing
2116may be shown in a help buffer if completion is ambiguous.
2117
497513ad
RS
2118Completion is dependent on the value of `comint-completion-addsuffix',
2119`comint-completion-recexact' and `comint-completion-fignore', and the timing of
2120completions listing is dependent on the value of `comint-completion-autolist'.
1b421826
RS
2121
2122Returns t if successful."
3ee91e68 2123 (interactive)
17193f89
SM
2124 (when (comint-match-partial-filename)
2125 (unless (window-minibuffer-p (selected-window))
2126 (message "Completing file name..."))
2127 (comint-dynamic-complete-as-filename)))
1b421826
RS
2128
2129(defun comint-dynamic-complete-as-filename ()
2130 "Dynamically complete at point as a filename.
2131See `comint-dynamic-complete-filename'. Returns t if successful."
107d7589 2132 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
497513ad 2133 (completion-ignored-extensions comint-completion-fignore)
107d7589
SM
2134 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2135 ;; I think it was originally bound to solve file completion problems,
2136 ;; but subsequent changes may have made this unnecessary. sm.
2137 ;;(file-name-handler-alist nil)
81fb2771 2138 (minibuffer-p (window-minibuffer-p (selected-window)))
1b421826 2139 (success t)
17193f89
SM
2140 (dirsuffix (cond ((not comint-completion-addsuffix)
2141 "")
2142 ((not (consp comint-completion-addsuffix))
2143 (char-to-string directory-sep-char))
2144 (t
2145 (car comint-completion-addsuffix))))
2146 (filesuffix (cond ((not comint-completion-addsuffix)
2147 "")
2148 ((not (consp comint-completion-addsuffix))
2149 " ")
2150 (t
2151 (cdr comint-completion-addsuffix))))
f79f58bc
KH
2152 (filename (or (comint-match-partial-filename) ""))
2153 (pathdir (file-name-directory filename))
2154 (pathnondir (file-name-nondirectory filename))
2155 (directory (if pathdir (comint-directory pathdir) default-directory))
81fb2771 2156 (completion (file-name-completion pathnondir directory)))
3ee91e68
RS
2157 (cond ((null completion)
2158 (message "No completions of %s" filename)
1b421826 2159 (setq success nil))
3ee91e68 2160 ((eq completion t) ; Means already completed "file".
59f36b08 2161 (insert filesuffix)
17193f89
SM
2162 (unless minibuffer-p
2163 (message "Sole completion")))
3ee91e68
RS
2164 ((string-equal completion "") ; Means completion on "directory/".
2165 (comint-dynamic-list-filename-completions))
2166 (t ; Completion string returned.
2167 (let ((file (concat (file-name-as-directory directory) completion)))
59f36b08
SM
2168 (insert (comint-quote-filename
2169 (substring (directory-file-name completion)
2170 (length pathnondir))))
3ee91e68
RS
2171 (cond ((symbolp (file-name-completion completion directory))
2172 ;; We inserted a unique completion.
59f36b08 2173 (insert (if (file-directory-p file) dirsuffix filesuffix))
17193f89
SM
2174 (unless minibuffer-p
2175 (message "Completed")))
3ee91e68
RS
2176 ((and comint-completion-recexact comint-completion-addsuffix
2177 (string-equal pathnondir completion)
2178 (file-exists-p file))
2179 ;; It's not unique, but user wants shortest match.
59f36b08 2180 (insert (if (file-directory-p file) dirsuffix filesuffix))
17193f89
SM
2181 (unless minibuffer-p
2182 (message "Completed shortest")))
3ee91e68
RS
2183 ((or comint-completion-autolist
2184 (string-equal pathnondir completion))
2185 ;; It's not unique, list possible completions.
2186 (comint-dynamic-list-filename-completions))
2187 (t
17193f89
SM
2188 (unless minibuffer-p
2189 (message "Partially completed")))))))
1b421826 2190 success))
3ee91e68
RS
2191
2192
2193(defun comint-replace-by-expanded-filename ()
2194 "Dynamically expand and complete the filename at point.
2195Replace the filename with an expanded, canonicalised and completed replacement.
2196\"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2197with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2198removed, and the filename is made absolute instead of relative. For expansion
2199see `expand-file-name' and `substitute-in-file-name'. For completion see
2200`comint-dynamic-complete-filename'."
be9b65ac 2201 (interactive)
3ee91e68
RS
2202 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
2203 (comint-dynamic-complete-filename))
2204
2205
3ee91e68
RS
2206(defun comint-dynamic-simple-complete (stub candidates)
2207 "Dynamically complete STUB from CANDIDATES list.
2208This function inserts completion characters at point by completing STUB from
2209the strings in CANDIDATES. A completions listing may be shown in a help buffer
2210if completion is ambiguous.
2211
1b421826
RS
2212Returns nil if no completion was inserted.
2213Returns `sole' if completed with the only completion match.
2214Returns `shortest' if completed with the shortest of the completion matches.
2215Returns `partial' if completed as far as possible with the completion matches.
2216Returns `listed' if a completion listing was shown.
2217
3ee91e68 2218See also `comint-dynamic-complete-filename'."
107d7589 2219 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
59f36b08
SM
2220 (suffix (cond ((not comint-completion-addsuffix) "")
2221 ((not (consp comint-completion-addsuffix)) " ")
2222 (t (cdr comint-completion-addsuffix))))
3ee91e68
RS
2223 (candidates (mapcar (function (lambda (x) (list x))) candidates))
2224 (completions (all-completions stub candidates)))
be9b65ac 2225 (cond ((null completions)
3ee91e68 2226 (message "No completions of %s" stub)
1b421826 2227 nil)
3ee91e68
RS
2228 ((= 1 (length completions)) ; Gotcha!
2229 (let ((completion (car completions)))
2230 (if (string-equal completion stub)
2231 (message "Sole completion")
2232 (insert (substring completion (length stub)))
2233 (message "Completed"))
59f36b08 2234 (insert suffix)
1b421826 2235 'sole))
3ee91e68
RS
2236 (t ; There's no unique completion.
2237 (let ((completion (try-completion stub candidates)))
2238 ;; Insert the longest substring.
2239 (insert (substring completion (length stub)))
2240 (cond ((and comint-completion-recexact comint-completion-addsuffix
2241 (string-equal stub completion)
2242 (member completion completions))
2243 ;; It's not unique, but user wants shortest match.
59f36b08 2244 (insert suffix)
1b421826
RS
2245 (message "Completed shortest")
2246 'shortest)
3ee91e68
RS
2247 ((or comint-completion-autolist
2248 (string-equal stub completion))
2249 ;; It's not unique, list possible completions.
1b421826
RS
2250 (comint-dynamic-list-completions completions)
2251 'listed)
3ee91e68 2252 (t
1b421826
RS
2253 (message "Partially completed")
2254 'partial)))))))
3ee91e68
RS
2255
2256
2257(defun comint-dynamic-list-filename-completions ()
2258 "List in help buffer possible completions of the filename at point."
2259 (interactive)
107d7589
SM
2260 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
2261 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2262 ;; I think it was originally bound to solve file completion problems,
2263 ;; but subsequent changes may have made this unnecessary. sm.
2264 ;;(file-name-handler-alist nil)
1b421826 2265 (filename (or (comint-match-partial-filename) ""))
3ee91e68
RS
2266 (pathdir (file-name-directory filename))
2267 (pathnondir (file-name-nondirectory filename))
2268 (directory (if pathdir (comint-directory pathdir) default-directory))
2269 (completions (file-name-all-completions pathnondir directory)))
59f36b08
SM
2270 (if (not completions)
2271 (message "No completions of %s" filename)
2272 (comint-dynamic-list-completions
2273 (mapcar 'comint-quote-filename completions)))))
3ee91e68
RS
2274
2275
2276(defun comint-dynamic-list-completions (completions)
2277 "List in help buffer sorted COMPLETIONS.
2278Typing SPC flushes the help buffer."
2279 (let ((conf (current-window-configuration)))
dd3038f6 2280 (with-output-to-temp-buffer "*Completions*"
3ee91e68 2281 (display-completion-list (sort completions 'string-lessp)))
3ee91e68 2282 (message "Hit space to flush")
7d5d472e
RS
2283 (let (key first)
2284 (if (save-excursion
dd3038f6 2285 (set-buffer (get-buffer "*Completions*"))
7d5d472e
RS
2286 (setq key (read-key-sequence nil)
2287 first (aref key 0))
eb6c110a 2288 (and (consp first) (consp (event-start first))
7d5d472e 2289 (eq (window-buffer (posn-window (event-start first)))
dd3038f6 2290 (get-buffer "*Completions*"))
7d5d472e
RS
2291 (eq (key-binding key) 'mouse-choose-completion)))
2292 ;; If the user does mouse-choose-completion with the mouse,
2293 ;; execute the command, then delete the completion window.
2294 (progn
2295 (mouse-choose-completion first)
2296 (set-window-configuration conf))
2297 (if (eq first ?\ )
2298 (set-window-configuration conf)
2b5a5ed3 2299 (setq unread-command-events (listify-key-sequence key)))))))
be9b65ac 2300\f
361ecbf2
RS
2301(defun comint-get-next-from-history ()
2302 "After fetching a line from input history, this fetches the following line.
2303In other words, this recalls the input line after the line you recalled last.
2304You can use this to repeat a sequence of input lines."
2305 (interactive)
2306 (if comint-save-input-ring-index
2307 (progn
2308 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2309 (comint-next-input 1))
2310 (message "No previous history command")))
2311
2312(defun comint-accumulate ()
2313 "Accumulate a line to send as input along with more lines.
2314This inserts a newline so that you can enter more text
2315to be sent along with this line. Use \\[comint-send-input]
2316to send all the accumulated input, at once.
2317The entire accumulated text becomes one item in the input history
2318when you send it."
2319 (interactive)
2320 (insert "\n")
2321 (set-marker comint-accum-marker (point))
2322 (if comint-input-ring-index
2323 (setq comint-save-input-ring-index
2324 (- comint-input-ring-index 1))))
2325
2326(defun comint-goto-process-mark ()
2327 "Move point to the process mark.
2328The process mark separates output, and input already sent,
2329from input that has not yet been sent."
2330 (interactive)
2331 (let ((proc (or (get-buffer-process (current-buffer))
2332 (error "Current buffer has no process"))))
2333 (goto-char (process-mark proc))
2334 (message "Point is now at the process mark")))
2335
2336(defun comint-bol-or-process-mark ()
2337 "Move point beginning of line (after prompt) or to the process mark.
2338The first time you use this command, it moves to the beginning of the line
2339\(but after the prompt, if any). If you repeat it again immediately,
2340it moves point to the process mark.
2341
2342The process mark separates the process output, along with input already sent,
2343from input that has not yet been sent. Ordinarily, the process mark
2344is at the beginning of the current input line; but if you have
2345used \\[comint-accumulate] to send multiple lines at once,
2346the process mark is at the beginning of the accumulated input."
2347 (interactive)
c2705d61 2348 (if (not (eq last-command 'comint-bol-or-process-mark))
361ecbf2
RS
2349 (comint-bol nil)
2350 (comint-goto-process-mark)))
2351
2352(defun comint-set-process-mark ()
2353 "Set the process mark at point."
2354 (interactive)
2355 (let ((proc (or (get-buffer-process (current-buffer))
2356 (error "Current buffer has no process"))))
2357 (set-marker (process-mark proc) (point))
2358 (message "Process mark set")))
2359
2360\f
b578f267
EN
2361;; Converting process modes to use comint mode
2362;; ===========================================================================
2363;; The code in the Emacs 19 distribution has all been modified to use comint
2364;; where needed. However, there are `third-party' packages out there that
2365;; still use the old shell mode. Here's a guide to conversion.
2366;;
2367;; Renaming variables
2368;; Most of the work is renaming variables and functions. These are the common
2369;; ones:
2370;; Local variables:
2371;; last-input-start comint-last-input-start
2372;; last-input-end comint-last-input-end
2373;; shell-prompt-pattern comint-prompt-regexp
2374;; shell-set-directory-error-hook <no equivalent>
2375;; Miscellaneous:
2376;; shell-set-directory <unnecessary>
2377;; shell-mode-map comint-mode-map
2378;; Commands:
2379;; shell-send-input comint-send-input
2380;; shell-send-eof comint-delchar-or-maybe-eof
2381;; kill-shell-input comint-kill-input
2382;; interrupt-shell-subjob comint-interrupt-subjob
2383;; stop-shell-subjob comint-stop-subjob
2384;; quit-shell-subjob comint-quit-subjob
2385;; kill-shell-subjob comint-kill-subjob
2386;; kill-output-from-shell comint-kill-output
2387;; show-output-from-shell comint-show-output
2388;; copy-last-shell-input Use comint-previous-input/comint-next-input
2389;;
2390;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2391;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2392;; Comint mode does not provide functionality equivalent to
2393;; shell-set-directory-error-hook; it is gone.
2394;;
2395;; comint-last-input-start is provided for modes which want to munge
2396;; the buffer after input is sent, perhaps because the inferior
2397;; insists on echoing the input. The LAST-INPUT-START variable in
2398;; the old shell package was used to implement a history mechanism,
2399;; but you should think twice before using comint-last-input-start
2400;; for this; the input history ring often does the job better.
2401;;
2402;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2403;; *not* create the comint-mode local variables in your foo-mode function.
2404;; This is not modular. Instead, call comint-mode, and let *it* create the
2405;; necessary comint-specific local variables. Then create the
2406;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2407;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2408;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2409;; get-old-input) that need to be different from the defaults. Call
2410;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2411;; comint-mode will take care of it. The following example, from shell.el,
2412;; is typical:
2413;;
2414;; (defvar shell-mode-map '())
2415;; (cond ((not shell-mode-map)
2416;; (setq shell-mode-map (copy-keymap comint-mode-map))
2417;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2418;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2419;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2420;; (define-key shell-mode-map "\M-?"
2421;; 'comint-dynamic-list-filename-completions)))
2422;;
2423;; (defun shell-mode ()
2424;; (interactive)
2425;; (comint-mode)
2426;; (setq comint-prompt-regexp shell-prompt-pattern)
2427;; (setq major-mode 'shell-mode)
2428;; (setq mode-name "Shell")
2429;; (use-local-map shell-mode-map)
2430;; (make-local-variable 'shell-directory-stack)
2431;; (setq shell-directory-stack nil)
2432;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2433;; (run-hooks 'shell-mode-hook))
2434;;
2435;;
b578f267
EN
2436;; Completion for comint-mode users
2437;;
2438;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2439;; hook to add completion functions to. Functions on this list should return
2440;; non-nil if completion occurs (i.e., further completion should not occur).
2441;; You could use comint-dynamic-simple-complete to do the bulk of the
2442;; completion job.
49116ac0 2443\f
49116ac0 2444(provide 'comint)
c0274f38 2445
b578f267 2446;; comint.el ends here