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