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