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