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