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