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