comint-password-prompt-regexp: New variable.
[emacs.git] / lisp / comint.el
blob469c8c12fcddd59102cdd6ae9792eaab6b774614
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993, 1994 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Adapted-by: Simon Marshall <s.marshall@dcs.hull.ac.uk>
7 ;; Keywords: processes
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;;; Commentary:
27 ;;; Please send me bug reports, bug fixes, and extensions, so that I can
28 ;;; merge them into the master source.
29 ;;; - Olin Shivers (shivers@cs.cmu.edu)
30 ;;; - Simon Marshall (s.marshall@dcs.hull.ac.uk)
32 ;;; This file defines a general command-interpreter-in-a-buffer package
33 ;;; (comint mode). The idea is that you can build specific process-in-a-buffer
34 ;;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
35 ;;; This way, all these specific packages share a common base functionality,
36 ;;; and a common set of bindings, which makes them easier to use (and
37 ;;; saves code, implementation time, etc., etc.).
39 ;;; Several packages are already defined using comint mode:
40 ;;; - shell.el defines a shell-in-a-buffer mode.
41 ;;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
42 ;;;
43 ;;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
44 ;;; - The file tea.el tunes scheme and inferior-scheme modes for T.
45 ;;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
46 ;;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
47 ;;; previewers, and printers from within emacs.
48 ;;; - background.el allows csh-like job control inside emacs.
49 ;;; It is pretty easy to make new derived modes for other processes.
51 ;;; For documentation on the functionality provided by comint mode, and
52 ;;; the hooks available for customising it, see the comments below.
53 ;;; For further information on the standard derived modes (shell,
54 ;;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
56 ;;; For hints on converting existing process modes (e.g., tex-mode,
57 ;;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
58 ;;; instead of shell-mode, see the notes at the end of this file.
61 ;;; Brief Command Documentation:
62 ;;;============================================================================
63 ;;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
64 ;;; mode)
65 ;;;
66 ;;; m-p comint-previous-input Cycle backwards in input history
67 ;;; m-n comint-next-input Cycle forwards
68 ;;; m-r comint-previous-matching-input Previous input matching a regexp
69 ;;; m-s comint-next-matching-input Next input that matches
70 ;;; m-c-l comint-show-output Show last batch of process output
71 ;;; return comint-send-input
72 ;;; c-a comint-bol Beginning of line; skip prompt
73 ;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
74 ;;; c-c c-u comint-kill-input ^u
75 ;;; c-c c-w backward-kill-word ^w
76 ;;; c-c c-c comint-interrupt-subjob ^c
77 ;;; c-c c-z comint-stop-subjob ^z
78 ;;; c-c c-\ comint-quit-subjob ^\
79 ;;; c-c c-o comint-kill-output Delete last batch of process output
80 ;;; c-c c-r comint-show-output Show last batch of process output
81 ;;; c-c c-h comint-dynamic-list-input-ring List input history
82 ;;;
83 ;;; Not bound by default in comint-mode (some are in shell mode)
84 ;;; comint-run Run a program under comint-mode
85 ;;; send-invisible Read a line w/o echo, and send to proc
86 ;;; comint-dynamic-complete-filename Complete filename at point.
87 ;;; comint-dynamic-complete-variable Complete variable name at point.
88 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
89 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
90 ;;; replace with expanded/completed name.
91 ;;; comint-replace-by-expanded-history Expand history at point;
92 ;;; replace with expanded name.
93 ;;; comint-magic-space Expand history and add (a) space(s).
94 ;;; comint-kill-subjob No mercy.
95 ;;; comint-show-maximum-output Show as much output as possible.
96 ;;; comint-continue-subjob Send CONT signal to buffer's process
97 ;;; group. Useful if you accidentally
98 ;;; suspend your process (with C-c C-z).
100 ;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
102 ;;; Code:
104 (require 'ring)
106 ;;; Buffer Local Variables:
107 ;;;============================================================================
108 ;;; Comint mode buffer local variables:
109 ;;; comint-prompt-regexp - string comint-bol uses to match prompt
110 ;;; comint-delimiter-argument-list - list For delimiters and arguments
111 ;;; comint-last-input-start - marker Handy if inferior always echoes
112 ;;; comint-last-input-end - marker For comint-kill-output command
113 ;;; comint-input-ring-size - integer For the input history
114 ;;; comint-input-ring - ring mechanism
115 ;;; comint-input-ring-index - number ...
116 ;;; comint-input-autoexpand - symbol ...
117 ;;; comint-input-ignoredups - boolean ...
118 ;;; comint-last-input-match - string ...
119 ;;; comint-dynamic-complete-functions - hook For the completion mechanism
120 ;;; comint-completion-fignore - list ...
121 ;;; comint-get-old-input - function Hooks for specific
122 ;;; comint-input-filter-functions - hook process-in-a-buffer
123 ;;; comint-output-filter-functions - hook function modes.
124 ;;; comint-input-filter - function ...
125 ;;; comint-input-send - function ...
126 ;;; comint-eol-on-send - boolean ...
127 ;;; comint-process-echoes - boolean ...
128 ;;; comint-scroll-to-bottom-on-input - symbol For scroll behavior
129 ;;; comint-scroll-to-bottom-on-output - symbol ...
130 ;;; comint-scroll-show-maximum-output - boolean...
132 ;;; Comint mode non-buffer local variables:
133 ;;; comint-completion-addsuffix - boolean For file name completion
134 ;;; comint-completion-autolist - boolean behavior
135 ;;; comint-completion-recexact - boolean ...
137 (defvar comint-prompt-regexp "^"
138 "Regexp to recognise prompts in the inferior process.
139 Defaults to \"^\", the null string at BOL.
141 Good choices:
142 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
143 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
144 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
145 kcl: \"^>+ *\"
146 shell: \"^[^#$%>\\n]*[#$%>] *\"
147 T: \"^>+ *\"
149 This is a good thing to set in mode hooks.")
151 (defvar comint-delimiter-argument-list ()
152 "List of characters to recognise as separate arguments in input.
153 Strings comprising a character in this list will separate the arguments
154 surrounding them, and also be regarded as arguments in their own right (unlike
155 whitespace). See `comint-arguments'.
156 Defaults to the empty list.
158 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
160 This is a good thing to set in mode hooks.")
162 (defvar comint-input-autoexpand nil
163 "*If non-nil, expand input command history references on completion.
164 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
166 If the value is `input', then the expansion is seen on input.
167 If the value is `history', then the expansion is only when inserting
168 into the buffer's input ring. See also `comint-magic-space' and
169 `comint-dynamic-complete'.
171 This variable is buffer-local.")
173 (defvar comint-input-ignoredups nil
174 "*If non-nil, don't add input matching the last on the input ring.
175 This mirrors the optional behavior of bash.
177 This variable is buffer-local.")
179 (defvar comint-input-ring-file-name nil
180 "*If non-nil, name of the file to read/write input history.
181 See also `comint-read-input-ring' and `comint-write-input-ring'.
183 This variable is buffer-local, and is a good thing to set in mode hooks.")
185 (defvar comint-scroll-to-bottom-on-input nil
186 "*Controls whether input to interpreter causes window to scroll.
187 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
188 If `this', scroll only the selected window.
190 The default is nil.
192 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local.")
194 (defvar comint-scroll-to-bottom-on-output nil
195 "*Controls whether interpreter output causes window to scroll.
196 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
197 If `this', scroll only the selected window.
198 If `others', scroll only those that are not the selected window.
200 The default is nil.
202 See variable `comint-scroll-show-maximum-output' and function
203 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local.")
205 (defvar comint-scroll-show-maximum-output nil
206 "*Controls how interpreter output causes window to scroll.
207 If non-nil, then show the maximum output when the window is scrolled.
209 See variable `comint-scroll-to-bottom-on-output' and function
210 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local.")
212 (defvar comint-input-ring-size 32
213 "Size of input history ring.")
215 (defvar comint-process-echoes nil
216 "*If non-nil, assume that the subprocess echoes any input.
217 If so, delete one copy of the input so that only one copy eventually
218 appears in the buffer.
220 This variable is buffer-local.")
222 (defvar comint-password-prompt-regexp "\\b[Pp]assword:\\s *\\'"
223 "*Regexp matching prompts for passwords in the inferior process.
224 This is used by comint-watch-for-password-prompt.")
226 ;;; Here are the per-interpreter hooks.
227 (defvar comint-get-old-input (function comint-get-old-input-default)
228 "Function that returns old text in comint mode.
229 This function is called when return is typed while the point is in old text.
230 It returns the text to be submitted as process input. The default is
231 `comint-get-old-input-default', which grabs the current line, and strips off
232 leading text matching `comint-prompt-regexp'.")
234 (defvar comint-dynamic-complete-functions
235 '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
236 "List of functions called to perform completion.
237 Functions should return non-nil if completion was performed.
238 See also `comint-dynamic-complete'.
240 This is a good thing to set in mode hooks.")
242 (defvar comint-input-filter
243 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
244 "Predicate for filtering additions to input history.
245 Takes one argument, the input. If non-nil, the input may be saved on the input
246 history list. Default is to save anything that isn't all whitespace.")
248 (defvar comint-input-filter-functions '()
249 "Functions to call before input is sent to the process.
250 These functions get one argument, a string containing the text to send.
252 This variable is buffer-local.")
254 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
255 "Functions to call after output is inserted into the buffer.
256 One possible function is `comint-postoutput-scroll-to-bottom'.
257 These functions get one argument, a string containing the text just inserted.
259 This variable is buffer-local.")
261 (defvar comint-input-sender (function comint-simple-send)
262 "Function to actually send to PROCESS the STRING submitted by user.
263 Usually this is just `comint-simple-send', but if your mode needs to
264 massage the input string, put a different function here.
265 `comint-simple-send' just sends the string plus a newline.
266 This is called from the user command `comint-send-input'.")
268 (defvar comint-eol-on-send t
269 "*Non-nil means go to the end of the line before sending input.
270 See `comint-send-input'.")
272 (defvar comint-mode-hook '()
273 "Called upon entry into comint-mode
274 This is run before the process is cranked up.")
276 (defvar comint-exec-hook '()
277 "Called each time a process is exec'd by `comint-exec'.
278 This is called after the process is cranked up. It is useful for things that
279 must be done each time a process is executed in a comint mode buffer (e.g.,
280 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
281 executed once when the buffer is created.")
283 (defvar comint-mode-map nil)
285 (defvar comint-ptyp t
286 "Non-nil if communications via pty; false if by pipe. Buffer local.
287 This is to work around a bug in Emacs process signalling.")
289 (defvar comint-input-ring nil)
290 (defvar comint-last-input-start)
291 (defvar comint-last-input-end)
292 (defvar comint-last-output-start)
293 (defvar comint-input-ring-index nil
294 "Index of last matched history element.")
295 (defvar comint-matching-input-from-input-string ""
296 "Input previously used to match input history.")
298 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
299 (put 'comint-input-ring 'permanent-local t)
300 (put 'comint-input-ring-index 'permanent-local t)
301 (put 'comint-input-autoexpand 'permanent-local t)
302 (put 'comint-input-filter-functions 'permanent-local t)
303 (put 'comint-output-filter-functions 'permanent-local t)
304 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
305 (put 'comint-scroll-to-bottom-on-output 'permanent-local t)
306 (put 'comint-scroll-show-maximum-output 'permanent-local t)
307 (put 'comint-ptyp 'permanent-local t)
309 (defun comint-mode ()
310 "Major mode for interacting with an inferior interpreter.
311 Interpreter name is same as buffer name, sans the asterisks.
312 Return at end of buffer sends line as input.
313 Return not at end copies rest of line to end and sends it.
314 Setting variable `comint-eol-on-send' means jump to the end of the line
315 before submitting new input.
317 This mode is customised to create major modes such as Inferior Lisp
318 mode, Shell mode, etc. This can be done by setting the hooks
319 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
320 and `comint-get-old-input' to appropriate functions, and the variable
321 `comint-prompt-regexp' to the appropriate regular expression.
323 An input history is maintained of size `comint-input-ring-size', and
324 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
325 Input ring history expansion can be achieved with the commands
326 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
327 Input ring expansion is controlled by the variable `comint-input-autoexpand',
328 and addition is controlled by the variable `comint-input-ignoredups'.
330 Commands with no default key bindings include `send-invisible',
331 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
332 `comint-magic-space'.
334 Input to, and output from, the subprocess can cause the window to scroll to
335 the end of the buffer. See variables `comint-output-filter-functions',
336 `comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
338 If you accidentally suspend your process, use \\[comint-continue-subjob]
339 to continue it.
341 \\{comint-mode-map}
343 Entry to this mode runs the hooks on `comint-mode-hook'."
344 (interactive)
345 ;; Do not remove this. All major modes must do this.
346 (kill-all-local-variables)
347 (setq major-mode 'comint-mode)
348 (setq mode-name "Comint")
349 (setq mode-line-process '(":%s"))
350 (use-local-map comint-mode-map)
351 (make-local-variable 'comint-last-input-start)
352 (setq comint-last-input-start (make-marker))
353 (set-marker comint-last-input-start (point-min))
354 (make-local-variable 'comint-last-input-end)
355 (setq comint-last-input-end (make-marker))
356 (set-marker comint-last-input-end (point-min))
357 (make-local-variable 'comint-last-output-start)
358 (setq comint-last-output-start (make-marker))
359 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
360 (make-local-variable 'comint-input-ring-size) ; ...to global val.
361 (make-local-variable 'comint-input-ring)
362 (make-local-variable 'comint-input-ring-file-name)
363 (or (and (boundp 'comint-input-ring) comint-input-ring)
364 (setq comint-input-ring (make-ring comint-input-ring-size)))
365 (make-local-variable 'comint-input-ring-index)
366 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
367 (setq comint-input-ring-index nil))
368 (make-local-variable 'comint-matching-input-from-input-string)
369 (make-local-variable 'comint-input-autoexpand)
370 (make-local-variable 'comint-input-ignoredups)
371 (make-local-variable 'comint-delimiter-argument-list)
372 (make-local-variable 'comint-dynamic-complete-functions)
373 (make-local-variable 'comint-completion-fignore)
374 (make-local-variable 'comint-get-old-input)
375 (make-local-variable 'comint-input-filter-functions)
376 (make-local-variable 'comint-input-filter)
377 (make-local-variable 'comint-input-sender)
378 (make-local-variable 'comint-eol-on-send)
379 (make-local-variable 'comint-scroll-to-bottom-on-input)
380 (make-local-variable 'comint-scroll-to-bottom-on-output)
381 (make-local-variable 'comint-scroll-show-maximum-output)
382 (make-local-variable 'pre-command-hook)
383 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom)
384 (make-local-variable 'comint-output-filter-functions)
385 (make-local-variable 'comint-ptyp)
386 (make-local-variable 'comint-exec-hook)
387 (make-local-variable 'comint-process-echoes)
388 (run-hooks 'comint-mode-hook))
390 (if comint-mode-map
392 ;; Keys:
393 (setq comint-mode-map (make-sparse-keymap))
394 (define-key comint-mode-map "\ep" 'comint-previous-input)
395 (define-key comint-mode-map "\en" 'comint-next-input)
396 (define-key comint-mode-map "\er" 'comint-previous-matching-input)
397 (define-key comint-mode-map "\es" 'comint-next-matching-input)
398 (define-key comint-mode-map [?\A-\M-r] 'comint-previous-matching-input-from-input)
399 (define-key comint-mode-map [?\A-\M-s] 'comint-next-matching-input-from-input)
400 (define-key comint-mode-map "\e\C-l" 'comint-show-output)
401 (define-key comint-mode-map "\C-m" 'comint-send-input)
402 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
403 (define-key comint-mode-map "\C-a" 'comint-bol)
404 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
405 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
406 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
407 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
408 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
409 (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
410 (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
411 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
412 (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
413 (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
414 (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
415 (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
416 (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
417 ;; Menu bars:
418 ;; completion:
419 (define-key comint-mode-map [menu-bar completion]
420 (cons "Complete" (make-sparse-keymap "Complete")))
421 (define-key comint-mode-map [menu-bar completion complete-expand]
422 '("Expand File Name" . comint-replace-by-expanded-filename))
423 (define-key comint-mode-map [menu-bar completion complete-listing]
424 '("File Completion Listing" . comint-dynamic-list-filename-completions))
425 (define-key comint-mode-map [menu-bar completion complete-file]
426 '("Complete File Name" . comint-dynamic-complete-filename))
427 (define-key comint-mode-map [menu-bar completion complete]
428 '("Complete Before Point" . comint-dynamic-complete))
429 ;; Input history:
430 (define-key comint-mode-map [menu-bar inout]
431 (cons "In/Out" (make-sparse-keymap "In/Out")))
432 (define-key comint-mode-map [menu-bar inout kill-output]
433 '("Kill Current Output Group" . comint-kill-output))
434 (define-key comint-mode-map [menu-bar inout next-prompt]
435 '("Forward Output Group" . comint-next-prompt))
436 (define-key comint-mode-map [menu-bar inout previous-prompt]
437 '("Backward Output Group" . comint-previous-prompt))
438 (define-key comint-mode-map [menu-bar inout show-maximum-output]
439 '("Show Maximum Output" . comint-show-maximum-output))
440 (define-key comint-mode-map [menu-bar inout show-output]
441 '("Show Current Output Group" . comint-show-output))
442 (define-key comint-mode-map [menu-bar inout kill-input]
443 '("Kill Current Input" . comint-kill-input))
444 (define-key comint-mode-map [menu-bar inout copy-input]
445 '("Copy Old Input" . comint-copy-old-input))
446 (define-key comint-mode-map [menu-bar inout forward-matching-history]
447 '("Forward Matching Input..." . comint-forward-matching-input))
448 (define-key comint-mode-map [menu-bar inout backward-matching-history]
449 '("Backward Matching Input..." . comint-backward-matching-input))
450 (define-key comint-mode-map [menu-bar inout next-matching-history]
451 '("Next Matching Input..." . comint-next-matching-input))
452 (define-key comint-mode-map [menu-bar inout previous-matching-history]
453 '("Previous Matching Input..." . comint-previous-matching-input))
454 (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
455 '("Next Matching Current Input" . comint-next-matching-input-from-input))
456 (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
457 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
458 (define-key comint-mode-map [menu-bar inout next-history]
459 '("Next Input" . comint-next-input))
460 (define-key comint-mode-map [menu-bar inout previous-history]
461 '("Previous Input" . comint-previous-input))
462 (define-key comint-mode-map [menu-bar inout list-history]
463 '("List Input History" . comint-dynamic-list-input-ring))
464 (define-key comint-mode-map [menu-bar inout expand-history]
465 '("Expand History Before Point" . comint-replace-by-expanded-history))
466 ;; Signals
467 (define-key comint-mode-map [menu-bar signals]
468 (cons "Signals" (make-sparse-keymap "Signals")))
469 (define-key comint-mode-map [menu-bar signals eof]
470 '("EOF" . comint-send-eof))
471 (define-key comint-mode-map [menu-bar signals kill]
472 '("KILL" . comint-kill-subjob))
473 (define-key comint-mode-map [menu-bar signals quit]
474 '("QUIT" . comint-quit-subjob))
475 (define-key comint-mode-map [menu-bar signals cont]
476 '("CONT" . comint-continue-subjob))
477 (define-key comint-mode-map [menu-bar signals stop]
478 '("STOP" . comint-stop-subjob))
479 (define-key comint-mode-map [menu-bar signals break]
480 '("BREAK" . comint-interrupt-subjob))
481 ;; Put them in the menu bar:
482 (setq menu-bar-final-items (append '(completion inout signals)
483 menu-bar-final-items))
486 (defun comint-check-proc (buffer)
487 "Return t if there is a living process associated w/buffer BUFFER.
488 Living means the status is `run' or `stop'.
489 BUFFER can be either a buffer or the name of one."
490 (let ((proc (get-buffer-process buffer)))
491 (and proc (memq (process-status proc) '(run stop)))))
493 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
494 ;;; for the second argument (program).
495 ;;;###autoload
496 (defun make-comint (name program &optional startfile &rest switches)
497 "Make a comint process NAME in a buffer, running PROGRAM.
498 The name of the buffer is made by surrounding NAME with `*'s.
499 If there is already a running process in that buffer, it is not restarted.
500 Optional third arg STARTFILE is the name of a file to send the contents of to
501 the process. Any more args are arguments to PROGRAM."
502 (let ((buffer (get-buffer-create (concat "*" name "*"))))
503 ;; If no process, or nuked process, crank up a new one and put buffer in
504 ;; comint mode. Otherwise, leave buffer and existing process alone.
505 (cond ((not (comint-check-proc buffer))
506 (save-excursion
507 (set-buffer buffer)
508 (comint-mode)) ; Install local vars, mode, keymap, ...
509 (comint-exec buffer name program startfile switches)))
510 buffer))
512 ;;;###autoload
513 (defun comint-run (program)
514 "Run PROGRAM in a comint buffer and switch to it.
515 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
516 The file name is used to make a symbol name, such as `comint-sh-hook', and any
517 hooks on this symbol are run in the buffer.
518 See `make-comint' and `comint-exec'."
519 (interactive "sRun program: ")
520 (let ((name (file-name-nondirectory program)))
521 (switch-to-buffer (make-comint name program))
522 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
524 (defun comint-exec (buffer name command startfile switches)
525 "Start up a process in buffer BUFFER for comint modes.
526 Blasts any old process running in the buffer. Doesn't set the buffer mode.
527 You can use this to cheaply run a series of processes in the same comint
528 buffer. The hook `comint-exec-hook' is run after each exec."
529 (save-excursion
530 (set-buffer buffer)
531 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
532 (if proc (delete-process proc)))
533 ;; Crank up a new process
534 (let ((proc (comint-exec-1 name buffer command switches)))
535 (set-process-filter proc 'comint-output-filter)
536 (make-local-variable 'comint-ptyp)
537 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
538 ;; Jump to the end, and set the process mark.
539 (goto-char (point-max))
540 (set-marker (process-mark proc) (point))
541 ;; Feed it the startfile.
542 (cond (startfile
543 ;;This is guaranteed to wait long enough
544 ;;but has bad results if the comint does not prompt at all
545 ;; (while (= size (buffer-size))
546 ;; (sleep-for 1))
547 ;;I hope 1 second is enough!
548 (sleep-for 1)
549 (goto-char (point-max))
550 (insert-file-contents startfile)
551 (setq startfile (buffer-substring (point) (point-max)))
552 (delete-region (point) (point-max))
553 (comint-send-string proc startfile)))
554 (run-hooks 'comint-exec-hook)
555 buffer)))
557 ;;; This auxiliary function cranks up the process for comint-exec in
558 ;;; the appropriate environment.
560 (defun comint-exec-1 (name buffer command switches)
561 (let ((process-environment
562 (nconc
563 ;; If using termcap, we specify `emacs' as the terminal type
564 ;; because that lets us specify a width.
565 ;; If using terminfo, we specify `unknown' because that is
566 ;; a defined terminal type. `emacs' is not a defined terminal type
567 ;; and there is no way for us to define it here.
568 ;; Some programs that use terminfo get very confused
569 ;; if TERM is not a valid terminal type.
570 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
571 (list "EMACS=t" "TERM=unknown"
572 (format "COLUMNS=%d" (frame-width)))
573 (list "EMACS=t" "TERM=emacs"
574 (format "TERMCAP=emacs:co#%d:tc=unknown" (frame-width))))
575 process-environment)))
576 (apply 'start-process name buffer command switches)))
578 ;;; Input history processing in a buffer
579 ;;; ===========================================================================
580 ;;; Useful input history functions, courtesy of the Ergo group.
582 ;;; Eleven commands:
583 ;;; comint-dynamic-list-input-ring List history in help buffer.
584 ;;; comint-previous-input Previous input...
585 ;;; comint-previous-matching-input ...matching a string.
586 ;;; comint-previous-matching-input-from-input ... matching the current input.
587 ;;; comint-next-input Next input...
588 ;;; comint-next-matching-input ...matching a string.
589 ;;; comint-next-matching-input-from-input ... matching the current input.
590 ;;; comint-backward-matching-input Backwards input...
591 ;;; comint-forward-matching-input ...matching a string.
592 ;;; comint-replace-by-expanded-history Expand history at point;
593 ;;; replace with expanded history.
594 ;;; comint-magic-space Expand history and insert space.
596 ;;; Three functions:
597 ;;; comint-read-input-ring Read into comint-input-ring...
598 ;;; comint-write-input-ring Write to comint-input-ring-file-name.
599 ;;; comint-replace-by-expanded-history-before-point Workhorse function.
601 (defun comint-read-input-ring (&optional silent)
602 "Sets the buffer's `comint-input-ring' from a history file.
603 The name of the file is given by the variable `comint-input-ring-file-name'.
604 The history ring is of size `comint-input-ring-size', regardless of file size.
605 If `comint-input-ring-file-name' is nil this function does nothing.
607 If the optional argument SILENT is non-nil, we say nothing about a
608 failure to read the history file.
610 This function is useful for major mode commands and mode hooks.
612 The structure of the history file should be one input command per line,
613 with the most recent command last.
614 See also `comint-input-ignoredups' and `comint-write-input-ring'."
615 (cond ((or (null comint-input-ring-file-name)
616 (equal comint-input-ring-file-name ""))
617 nil)
618 ((not (file-readable-p comint-input-ring-file-name))
619 (or silent
620 (message "Cannot read history file %s"
621 comint-input-ring-file-name)))
623 (let ((history-buf (get-buffer-create " *temp*"))
624 (file comint-input-ring-file-name)
625 (count 0)
626 (ring (make-ring comint-input-ring-size)))
627 (unwind-protect
628 (save-excursion
629 (set-buffer history-buf)
630 (widen)
631 (erase-buffer)
632 (insert-file-contents file)
633 ;; Save restriction in case file is already visited...
634 ;; Watch for those date stamps in history files!
635 (goto-char (point-max))
636 (while (and (< count comint-input-ring-size)
637 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
638 nil t))
639 (let ((history (buffer-substring (match-beginning 1)
640 (match-end 1))))
641 (if (or (null comint-input-ignoredups)
642 (ring-empty-p ring)
643 (not (string-equal (ring-ref ring 0) history)))
644 (ring-insert-at-beginning ring history)))
645 (setq count (1+ count))))
646 (kill-buffer history-buf))
647 (setq comint-input-ring ring
648 comint-input-ring-index nil)))))
650 (defun comint-write-input-ring ()
651 "Writes the buffer's `comint-input-ring' to a history file.
652 The name of the file is given by the variable `comint-input-ring-file-name'.
653 The original contents of the file are lost if `comint-input-ring' is not empty.
654 If `comint-input-ring-file-name' is nil this function does nothing.
656 Useful within process sentinels.
658 See also `comint-read-input-ring'."
659 (cond ((or (null comint-input-ring-file-name)
660 (equal comint-input-ring-file-name "")
661 (null comint-input-ring) (ring-empty-p comint-input-ring))
662 nil)
663 ((not (file-writable-p comint-input-ring-file-name))
664 (message "Cannot write history file %s" comint-input-ring-file-name))
666 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
667 (ring comint-input-ring)
668 (file comint-input-ring-file-name)
669 (index (ring-length ring)))
670 ;; Write it all out into a buffer first. Much faster, but messier,
671 ;; than writing it one line at a time.
672 (save-excursion
673 (set-buffer history-buf)
674 (erase-buffer)
675 (while (> index 0)
676 (setq index (1- index))
677 (insert (ring-ref ring index) ?\n))
678 (write-region (buffer-string) nil file nil 'no-message)
679 (kill-buffer nil))))))
682 (defun comint-dynamic-list-input-ring ()
683 "List in help buffer the buffer's input history."
684 (interactive)
685 (if (or (not (ring-p comint-input-ring))
686 (ring-empty-p comint-input-ring))
687 (message "No history")
688 (let ((history nil)
689 (history-buffer " *Input History*")
690 (index (1- (ring-length comint-input-ring)))
691 (conf (current-window-configuration)))
692 ;; We have to build up a list ourselves from the ring vector.
693 (while (>= index 0)
694 (setq history (cons (ring-ref comint-input-ring index) history)
695 index (1- index)))
696 ;; Change "completion" to "history reference"
697 ;; to make the display accurate.
698 (with-output-to-temp-buffer history-buffer
699 (display-completion-list history)
700 (set-buffer history-buffer)
701 (forward-line 3)
702 (while (search-backward "completion" nil 'move)
703 (replace-match "history reference")))
704 (sit-for 0)
705 (message "Hit space to flush")
706 (let ((ch (read-event)))
707 (if (eq ch ?\ )
708 (set-window-configuration conf)
709 (setq unread-command-events (list ch)))))))
712 (defun comint-regexp-arg (prompt)
713 ;; Return list of regexp and prefix arg using PROMPT.
714 (let* ((minibuffer-history-sexp-flag nil)
715 ;; Don't clobber this.
716 (last-command last-command)
717 (regexp (read-from-minibuffer prompt nil nil nil
718 'minibuffer-history-search-history)))
719 (list (if (string-equal regexp "")
720 (setcar minibuffer-history-search-history
721 (nth 1 minibuffer-history-search-history))
722 regexp)
723 (prefix-numeric-value current-prefix-arg))))
725 (defun comint-search-arg (arg)
726 ;; First make sure there is a ring and that we are after the process mark
727 (cond ((not (comint-after-pmark-p))
728 (error "Not at command line"))
729 ((or (null comint-input-ring)
730 (ring-empty-p comint-input-ring))
731 (error "Empty input ring"))
732 ((zerop arg)
733 ;; arg of zero resets search from beginning, and uses arg of 1
734 (setq comint-input-ring-index nil)
737 arg)))
739 (defun comint-search-start (arg)
740 ;; Index to start a directional search, starting at comint-input-ring-index
741 (if comint-input-ring-index
742 ;; If a search is running, offset by 1 in direction of arg
743 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
744 (ring-length comint-input-ring))
745 ;; For a new search, start from beginning or end, as appropriate
746 (if (>= arg 0)
747 0 ; First elt for forward search
748 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
750 (defun comint-previous-input-string (arg)
751 "Return the string ARG places along the input ring.
752 Moves relative to `comint-input-ring-index'."
753 (ring-ref comint-input-ring (if comint-input-ring-index
754 (mod (+ arg comint-input-ring-index)
755 (ring-length comint-input-ring))
756 arg)))
758 (defun comint-previous-input (arg)
759 "Cycle backwards through input history."
760 (interactive "*p")
761 (comint-previous-matching-input "." arg))
763 (defun comint-next-input (arg)
764 "Cycle forwards through input history."
765 (interactive "*p")
766 (comint-previous-input (- arg)))
768 (defun comint-previous-matching-input-string (regexp arg)
769 "Return the string matching REGEXP ARG places along the input ring.
770 Moves relative to `comint-input-ring-index'."
771 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
772 (if pos (ring-ref comint-input-ring pos))))
774 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
775 "Return the index matching REGEXP ARG places along the input ring.
776 Moves relative to START, or `comint-input-ring-index'."
777 (if (or (not (ring-p comint-input-ring))
778 (ring-empty-p comint-input-ring))
779 (error "No history"))
780 (let* ((len (ring-length comint-input-ring))
781 (motion (if (> arg 0) 1 -1))
782 (n (mod (- (or start (comint-search-start arg)) motion) len))
783 (tried-each-ring-item nil)
784 (prev nil))
785 ;; Do the whole search as many times as the argument says.
786 (while (and (/= arg 0) (not tried-each-ring-item))
787 ;; Step once.
788 (setq prev n
789 n (mod (+ n motion) len))
790 ;; If we haven't reached a match, step some more.
791 (while (and (< n len) (not tried-each-ring-item)
792 (not (string-match regexp (ring-ref comint-input-ring n))))
793 (setq n (mod (+ n motion) len)
794 ;; If we have gone all the way around in this search.
795 tried-each-ring-item (= n prev)))
796 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
797 ;; Now that we know which ring element to use, if we found it, return that.
798 (if (string-match regexp (ring-ref comint-input-ring n))
799 n)))
801 (defun comint-previous-matching-input (regexp arg)
802 "Search backwards through input history for match for REGEXP.
803 \(Previous history elements are earlier commands.)
804 With prefix argument N, search for Nth previous match.
805 If N is negative, find the next or Nth next match."
806 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
807 (setq arg (comint-search-arg arg))
808 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
809 ;; Has a match been found?
810 (if (null pos)
811 (error "Not found")
812 (setq comint-input-ring-index pos)
813 (message "History item: %d" (1+ pos))
814 (delete-region
815 ;; Can't use kill-region as it sets this-command
816 (process-mark (get-buffer-process (current-buffer))) (point))
817 (insert (ring-ref comint-input-ring pos)))))
819 (defun comint-next-matching-input (regexp arg)
820 "Search forwards through input history for match for REGEXP.
821 \(Later history elements are more recent commands.)
822 With prefix argument N, search for Nth following match.
823 If N is negative, find the previous or Nth previous match."
824 (interactive (comint-regexp-arg "Next input matching (regexp): "))
825 (comint-previous-matching-input regexp (- arg)))
827 (defun comint-previous-matching-input-from-input (arg)
828 "Search backwards through input history for match for current input.
829 \(Previous history elements are earlier commands.)
830 With prefix argument N, search for Nth previous match.
831 If N is negative, search forwards for the -Nth following match."
832 (interactive "p")
833 (if (not (memq last-command '(comint-previous-matching-input-from-input
834 comint-next-matching-input-from-input)))
835 ;; Starting a new search
836 (setq comint-matching-input-from-input-string
837 (buffer-substring
838 (process-mark (get-buffer-process (current-buffer)))
839 (point))
840 comint-input-ring-index nil))
841 (comint-previous-matching-input
842 (concat "^" (regexp-quote comint-matching-input-from-input-string))
843 arg))
845 (defun comint-next-matching-input-from-input (arg)
846 "Search forwards through input history for match for current input.
847 \(Following history elements are more recent commands.)
848 With prefix argument N, search for Nth following match.
849 If N is negative, search backwards for the -Nth previous match."
850 (interactive "p")
851 (comint-previous-matching-input-from-input (- arg)))
854 (defun comint-replace-by-expanded-history (&optional silent)
855 "Expand input command history references before point.
856 Expansion is dependent on the value of `comint-input-autoexpand'.
858 This function depends on the buffer's idea of the input history, which may not
859 match the command interpreter's idea, assuming it has one.
861 Assumes history syntax is like typical Un*x shells'. However, since emacs
862 cannot know the interpreter's idea of input line numbers, assuming it has one,
863 it cannot expand absolute input line number references.
865 If the optional argument SILENT is non-nil, never complain
866 even if history reference seems erroneous.
868 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
870 Returns t if successful."
871 (interactive)
872 (if (and comint-input-autoexpand
873 (string-match "[!^]" (funcall comint-get-old-input))
874 (save-excursion (beginning-of-line)
875 (looking-at comint-prompt-regexp)))
876 ;; Looks like there might be history references in the command.
877 (let ((previous-modified-tick (buffer-modified-tick)))
878 (message "Expanding history references...")
879 (comint-replace-by-expanded-history-before-point silent)
880 (/= previous-modified-tick (buffer-modified-tick)))))
883 (defun comint-replace-by-expanded-history-before-point (silent)
884 "Expand directory stack reference before point.
885 See `comint-replace-by-expanded-history'. Returns t if successful."
886 (save-excursion
887 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
888 (start (progn (comint-bol nil) (point))))
889 (while (progn
890 (skip-chars-forward "^!^"
891 (save-excursion
892 (end-of-line nil) (- (point) toend)))
893 (< (point)
894 (save-excursion
895 (end-of-line nil) (- (point) toend))))
896 ;; This seems a bit complex. We look for references such as !!, !-num,
897 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
898 ;; If that wasn't enough, the plings can be suffixed with argument
899 ;; range specifiers.
900 ;; Argument ranges are complex too, so we hive off the input line,
901 ;; referenced with plings, with the range string to `comint-args'.
902 (setq comint-input-ring-index nil)
903 (cond ((or (= (preceding-char) ?\\)
904 (comint-within-quotes start (point)))
905 ;; The history is quoted, or we're in quotes.
906 (goto-char (1+ (point))))
907 ((looking-at "![0-9]+\\($\\|[^-]\\)")
908 ;; We cannot know the interpreter's idea of input line numbers.
909 (goto-char (match-end 0))
910 (message "Absolute reference cannot be expanded"))
911 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
912 ;; Just a number of args from `number' lines backward.
913 (let ((number (1- (string-to-number
914 (buffer-substring (match-beginning 1)
915 (match-end 1))))))
916 (if (<= number (ring-length comint-input-ring))
917 (progn
918 (replace-match
919 (comint-args (comint-previous-input-string number)
920 (match-beginning 2) (match-end 2))
921 t t)
922 (setq comint-input-ring-index number)
923 (message "History item: %d" (1+ number)))
924 (goto-char (match-end 0))
925 (message "Relative reference exceeds input history size"))))
926 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
927 ;; Just a number of args from the previous input line.
928 (replace-match
929 (comint-args (comint-previous-input-string 0)
930 (match-beginning 1) (match-end 1))
931 t t)
932 (message "History item: previous"))
933 ((looking-at
934 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
935 ;; Most recent input starting with or containing (possibly
936 ;; protected) string, maybe just a number of args. Phew.
937 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
938 (mb2 (match-beginning 2)) (me2 (match-end 2))
939 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
940 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
941 (pos (save-match-data
942 (comint-previous-matching-input-string-position
943 (concat pref (regexp-quote exp)) 1))))
944 (if (null pos)
945 (progn
946 (goto-char (match-end 0))
947 (or silent
948 (progn (message "Not found")
949 (ding))))
950 (setq comint-input-ring-index pos)
951 (replace-match
952 (comint-args (ring-ref comint-input-ring pos)
953 (match-beginning 4) (match-end 4))
954 t t)
955 (message "History item: %d" (1+ pos)))))
956 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
957 ;; Quick substitution on the previous input line.
958 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
959 (new (buffer-substring (match-beginning 2) (match-end 2)))
960 (pos nil))
961 (replace-match (comint-previous-input-string 0) t t)
962 (setq pos (point))
963 (goto-char (match-beginning 0))
964 (if (not (search-forward old pos t))
965 (or silent
966 (error "Not found"))
967 (replace-match new t t)
968 (message "History item: substituted"))))
970 (goto-char (match-end 0))))))))
973 (defun comint-magic-space (arg)
974 "Expand input history references before point and insert ARG spaces.
975 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
976 (interactive "p")
977 (comint-replace-by-expanded-history)
978 (self-insert-command arg))
980 (defun comint-within-quotes (beg end)
981 "Return t if the number of quotes between BEG and END is odd.
982 Quotes are single and double."
983 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
984 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
985 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
987 (defun comint-how-many-region (regexp beg end)
988 "Return number of matches for REGEXP from BEG to END."
989 (let ((count 0))
990 (save-excursion
991 (save-match-data
992 (goto-char beg)
993 (while (re-search-forward regexp end t)
994 (setq count (1+ count)))))
995 count))
997 (defun comint-args (string begin end)
998 ;; From STRING, return the args depending on the range specified in the text
999 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1000 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1001 (save-match-data
1002 (if (null begin)
1003 (comint-arguments string 0 nil)
1004 (let* ((range (buffer-substring
1005 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1006 (nth (cond ((string-match "^[*^]" range) 1)
1007 ((string-match "^-" range) 0)
1008 ((string-equal range "$") nil)
1009 (t (string-to-number range))))
1010 (mth (cond ((string-match "[-*$]$" range) nil)
1011 ((string-match "-" range)
1012 (string-to-number (substring range (match-end 0))))
1013 (t nth))))
1014 (comint-arguments string nth mth)))))
1016 ;; Return a list of arguments from ARG. Break it up at the
1017 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1018 (defun comint-delim-arg (arg)
1019 (if (null comint-delimiter-argument-list)
1020 (list arg)
1021 (let ((args nil)
1022 (pos 0)
1023 (len (length arg)))
1024 (while (< pos len)
1025 (let ((char (aref arg pos))
1026 (start pos))
1027 (if (memq char comint-delimiter-argument-list)
1028 (while (and (< pos len) (eq (aref arg pos) char))
1029 (setq pos (1+ pos)))
1030 (while (and (< pos len)
1031 (not (memq (aref arg pos)
1032 comint-delimiter-argument-list)))
1033 (setq pos (1+ pos))))
1034 (setq args (cons (substring arg start pos) args))))
1035 args)))
1037 (defun comint-arguments (string nth mth)
1038 "Return from STRING the NTH to MTH arguments.
1039 NTH and/or MTH can be nil, which means the last argument.
1040 Returned arguments are separated by single spaces.
1041 We assume whitespace separates arguments, except within quotes.
1042 Also, a run of one or more of a single character
1043 in `comint-delimiter-argument-list' is a separate argument.
1044 Argument 0 is the command name."
1045 (let ((arg "\\(\\(\"[^\"]*\"\\|\'[^\']*\'\\|\`[^\`]*\`\\)\\|\\S \\)+")
1046 (args ()) (pos 0) (str nil))
1047 ;; We build a list of all the args. Unnecessary, but more efficient, when
1048 ;; ranges of args are required, than picking out one by one and recursing.
1049 (while (string-match arg string pos)
1050 (setq pos (match-end 0)
1051 str (substring string (match-beginning 0) pos)
1052 ;; (match-end 2) is non-nil if we found quotes.
1053 args (if (match-end 2) (cons str args)
1054 (nconc (comint-delim-arg str) args))))
1055 (let ((n (or nth (1- (length args))))
1056 (m (if mth (1- (- (length args) mth)) 0)))
1057 (mapconcat
1058 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1061 ;;; Input processing stuff
1064 (defun comint-send-input ()
1065 "Send input to process.
1066 After the process output mark, sends all text from the process mark to
1067 point as input to the process. Before the process output mark, calls value
1068 of variable `comint-get-old-input' to retrieve old input, copies it to the
1069 process mark, and sends it. If variable `comint-process-echoes' is nil,
1070 a terminal newline is also inserted into the buffer and sent to the process
1071 \(if it is non-nil, all text from the process mark to point is deleted,
1072 since it is assumed the remote process will re-echo it).
1074 Any history reference may be expanded depending on the value of the variable
1075 `comint-input-autoexpand'. The list of function names contained in the value
1076 of `comint-input-filter-functions' is called on the input before sending it.
1077 The input is entered into the input history ring, if the value of variable
1078 `comint-input-filter' returns non-nil when called on the input.
1080 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1081 end of line before sending the input.
1083 The values of `comint-get-old-input', `comint-input-filter-functions', and
1084 `comint-input-filter' are chosen according to the command interpreter running
1085 in the buffer. E.g.,
1087 If the interpreter is the csh,
1088 comint-get-old-input is the default: take the current line, discard any
1089 initial string matching regexp comint-prompt-regexp.
1090 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1091 \"popd\" commands. When it sees one, it cd's the buffer.
1092 comint-input-filter is the default: returns t if the input isn't all white
1093 space.
1095 If the comint is Lucid Common Lisp,
1096 comint-get-old-input snarfs the sexp ending at point.
1097 comint-input-filter-functions does nothing.
1098 comint-input-filter returns nil if the input matches input-filter-regexp,
1099 which matches (1) all whitespace (2) :a, :c, etc.
1101 Similarly for Soar, Scheme, etc."
1102 (interactive)
1103 ;; Note that the input string does not include its terminal newline.
1104 (let ((proc (get-buffer-process (current-buffer))))
1105 (if (not proc) (error "Current buffer has no process")
1106 (let* ((pmark (process-mark proc))
1107 (intxt (if (>= (point) (marker-position pmark))
1108 (progn (if comint-eol-on-send (end-of-line))
1109 (buffer-substring pmark (point)))
1110 (let ((copy (funcall comint-get-old-input)))
1111 (goto-char pmark)
1112 (insert copy)
1113 copy)))
1114 (input (if (not (eq comint-input-autoexpand 'input))
1115 ;; Just whatever's already there
1116 intxt
1117 ;; Expand and leave it visible in buffer
1118 (comint-replace-by-expanded-history t)
1119 (buffer-substring pmark (point))))
1120 (history (if (not (eq comint-input-autoexpand 'history))
1121 input
1122 ;; This is messy 'cos ultimately the original
1123 ;; functions used do insertion, rather than return
1124 ;; strings. We have to expand, then insert back.
1125 (comint-replace-by-expanded-history t)
1126 (let ((copy (buffer-substring pmark (point))))
1127 (delete-region pmark (point))
1128 (insert input)
1129 copy))))
1130 (if comint-process-echoes
1131 (delete-region pmark (point))
1132 (insert ?\n))
1133 (if (and (funcall comint-input-filter history)
1134 (or (null comint-input-ignoredups)
1135 (not (ring-p comint-input-ring))
1136 (ring-empty-p comint-input-ring)
1137 (not (string-equal (ring-ref comint-input-ring 0)
1138 history))))
1139 (ring-insert comint-input-ring history))
1140 (let ((functions comint-input-filter-functions))
1141 (while functions
1142 (funcall (car functions) (concat input "\n"))
1143 (setq functions (cdr functions))))
1144 (setq comint-input-ring-index nil)
1145 ;; Update the markers before we send the input
1146 ;; in case we get output amidst sending the input.
1147 (set-marker comint-last-input-start pmark)
1148 (set-marker comint-last-input-end (point))
1149 (set-marker (process-mark proc) (point))
1150 (funcall comint-input-sender proc input)
1151 (comint-output-filter proc "")))))
1153 ;; The purpose of using this filter for comint processes
1154 ;; is to keep comint-last-input-end from moving forward
1155 ;; when output is inserted.
1156 (defun comint-output-filter (process string)
1157 ;; First check for killed buffer
1158 (let ((oprocbuf (process-buffer process)))
1159 (if (and oprocbuf (buffer-name oprocbuf))
1160 (let ((obuf (current-buffer))
1161 (opoint nil) (obeg nil) (oend nil))
1162 (set-buffer oprocbuf)
1163 (setq opoint (point))
1164 (setq obeg (point-min))
1165 (setq oend (point-max))
1166 (let ((buffer-read-only nil)
1167 (nchars (length string))
1168 (ostart nil))
1169 (widen)
1170 (goto-char (process-mark process))
1171 (setq ostart (point))
1172 (if (<= (point) opoint)
1173 (setq opoint (+ opoint nchars)))
1174 ;; Insert after old_begv, but before old_zv.
1175 (if (< (point) obeg)
1176 (setq obeg (+ obeg nchars)))
1177 (if (<= (point) oend)
1178 (setq oend (+ oend nchars)))
1179 (insert-before-markers string)
1180 ;; Don't insert initial prompt outside the top of the window.
1181 (if (= (window-start (selected-window)) (point))
1182 (set-window-start (selected-window) (- (point) (length string))))
1183 (if (and comint-last-input-end
1184 (marker-buffer comint-last-input-end)
1185 (= (point) comint-last-input-end))
1186 (set-marker comint-last-input-end (- comint-last-input-end nchars)))
1187 (set-marker comint-last-output-start ostart)
1188 (set-marker (process-mark process) (point))
1189 (force-mode-line-update))
1191 (narrow-to-region obeg oend)
1192 (goto-char opoint)
1193 (let ((functions comint-output-filter-functions))
1194 (while functions
1195 (funcall (car functions) string)
1196 (setq functions (cdr functions))))
1197 (set-buffer obuf)))))
1199 (defun comint-preinput-scroll-to-bottom ()
1200 "Go to the end of buffer in all windows showing it.
1201 Movement occurs if point in the selected window is not after the process mark,
1202 and `this-command' is an insertion command. Insertion commands recognised
1203 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1204 Depends on the value of `comint-scroll-to-bottom-on-input'.
1206 This function should be a pre-command hook."
1207 (if (and comint-scroll-to-bottom-on-input
1208 (memq this-command '(self-insert-command comint-magic-space yank
1209 hilit-yank)))
1210 (let* ((selected (selected-window))
1211 (current (current-buffer))
1212 (process (get-buffer-process current))
1213 (scroll comint-scroll-to-bottom-on-input))
1214 (if (and process (< (point) (process-mark process)))
1215 (if (eq scroll 'this)
1216 (goto-char (point-max))
1217 (walk-windows
1218 (function (lambda (window)
1219 (if (and (eq (window-buffer window) current)
1220 (or (eq scroll t) (eq scroll 'all)))
1221 (progn
1222 (select-window window)
1223 (goto-char (point-max))
1224 (select-window selected)))))
1225 nil t))))))
1227 (defun comint-postoutput-scroll-to-bottom (string)
1228 "Go to the end of buffer in all windows showing it.
1229 Does not scroll if the current line is the last line in the buffer.
1230 Depends on the value of `comint-scroll-to-bottom-on-output' and
1231 `comint-scroll-show-maximum-output'.
1233 This function should be in the list `comint-output-filter-functions'."
1234 (let* ((selected (selected-window))
1235 (current (current-buffer))
1236 (process (get-buffer-process current))
1237 (scroll comint-scroll-to-bottom-on-output))
1238 (unwind-protect
1239 (if process
1240 (walk-windows
1241 (function (lambda (window)
1242 (if (eq (window-buffer window) current)
1243 (progn
1244 (select-window window)
1245 (if (and (< (point) (process-mark process))
1246 (or (eq scroll t) (eq scroll 'all)
1247 ;; Maybe user wants point to jump to the end.
1248 (and (eq scroll 'this) (eq selected window))
1249 (and (eq scroll 'others) (not (eq selected window)))
1250 ;; If point was at the end, keep it at the end.
1251 (>= (point)
1252 (- (process-mark process) (length string)))))
1253 (goto-char (process-mark process)))
1254 ;; Optionally scroll so that the text
1255 ;; ends at the bottom of the window.
1256 (if (and comint-scroll-show-maximum-output
1257 (>= (point) (process-mark process)))
1258 (save-excursion
1259 (goto-char (point-max))
1260 (recenter -1)))
1261 (select-window selected)))))
1262 nil t))
1263 (set-buffer current))))
1265 (defun comint-show-maximum-output ()
1266 "Put the end of the buffer at the bottom of the window."
1267 (interactive)
1268 (goto-char (point-max))
1269 (recenter -1))
1271 (defun comint-get-old-input-default ()
1272 "Default for `comint-get-old-input'.
1273 Take the current line, and discard any initial text matching
1274 `comint-prompt-regexp'."
1275 (save-excursion
1276 (beginning-of-line)
1277 (comint-skip-prompt)
1278 (let ((beg (point)))
1279 (end-of-line)
1280 (buffer-substring beg (point)))))
1282 (defun comint-copy-old-input ()
1283 "Insert after prompt old input at point as new input to be edited.
1284 Calls `comint-get-old-input' to get old input."
1285 (interactive)
1286 (let ((input (funcall comint-get-old-input))
1287 (process (get-buffer-process (current-buffer))))
1288 (if (not process)
1289 (error "Current buffer has no process")
1290 (goto-char (process-mark process))
1291 (insert input))))
1293 (defun comint-skip-prompt ()
1294 "Skip past the text matching regexp `comint-prompt-regexp'.
1295 If this takes us past the end of the current line, don't skip at all."
1296 (let ((eol (save-excursion (end-of-line) (point))))
1297 (if (and (looking-at comint-prompt-regexp)
1298 (<= (match-end 0) eol))
1299 (goto-char (match-end 0)))))
1301 (defun comint-after-pmark-p ()
1302 "Return t if point is after the process output marker."
1303 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1304 (<= (marker-position pmark) (point))))
1306 (defun comint-simple-send (proc string)
1307 "Default function for sending to PROC input STRING.
1308 This just sends STRING plus a newline. To override this,
1309 set the hook `comint-input-sender'."
1310 (comint-send-string proc string)
1311 (comint-send-string proc "\n"))
1313 (defun comint-bol (arg)
1314 "Goes to the beginning of line, then skips past the prompt, if any.
1315 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1317 The prompt skip is done by skipping text matching the regular expression
1318 `comint-prompt-regexp', a buffer local variable.
1320 If you don't like this command, bind C-a to `beginning-of-line'
1321 in your hook, `comint-mode-hook'."
1322 (interactive "P")
1323 (beginning-of-line)
1324 (if (null arg) (comint-skip-prompt)))
1326 ;;; These three functions are for entering text you don't want echoed or
1327 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
1328 ;;; Just enter m-x send-invisible and type in your line, or add
1329 ;;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1331 (defun comint-read-noecho (prompt &optional stars)
1332 "Read a single line of text from user without echoing, and return it.
1333 Prompt with argument PROMPT, a string. Optional argument STARS causes
1334 input to be echoed with '*' characters on the prompt line. Input ends with
1335 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1336 `inhibit-quit' is set because e.g. this function was called from a process
1337 filter and C-g is pressed, this function returns nil rather than a string).
1339 Note that the keystrokes comprising the text can still be recovered
1340 \(temporarily) with \\[view-lossage]. This may be a security bug for some
1341 applications."
1342 (let ((ans "")
1343 (c 0)
1344 (echo-keystrokes 0)
1345 (cursor-in-echo-area t)
1346 (done nil))
1347 (while (not done)
1348 (if stars
1349 (message "%s%s" prompt (make-string (length ans) ?*))
1350 (message prompt))
1351 (setq c (read-char))
1352 (cond ((= c ?\C-g)
1353 ;; This function may get called from a process filter, where
1354 ;; inhibit-quit is set. In later versions of emacs read-char
1355 ;; may clear quit-flag itself and return C-g. That would make
1356 ;; it impossible to quit this loop in a simple way, so
1357 ;; re-enable it here (for backward-compatibility the check for
1358 ;; quit-flag below would still be necessary, so this seems
1359 ;; like the simplest way to do things).
1360 (setq quit-flag t
1361 done t))
1362 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1363 (setq done t))
1364 ((= c ?\C-u)
1365 (setq ans ""))
1366 ((and (/= c ?\b) (/= c ?\177))
1367 (setq ans (concat ans (char-to-string c))))
1368 ((> (length ans) 0)
1369 (setq ans (substring ans 0 -1)))))
1370 (if quit-flag
1371 ;; Emulate a true quit, except that we have to return a value.
1372 (prog1
1373 (setq quit-flag nil)
1374 (message "Quit")
1375 (beep t))
1376 (message "")
1377 ans)))
1379 (defun send-invisible (str)
1380 "Read a string without echoing.
1381 Then send it to the process running in the current buffer. A new-line
1382 is additionally sent. String is not saved on comint input history list.
1383 Security bug: your string can still be temporarily recovered with
1384 \\[view-lossage]."
1385 (interactive "P") ; Defeat snooping via C-x esc
1386 (let ((proc (get-buffer-process (current-buffer))))
1387 (if (not proc)
1388 (error "Current buffer has no process")
1389 (comint-send-string
1390 proc (if (stringp str) str (comint-read-noecho "Non-echoed text: " t)))
1391 (comint-send-string proc "\n"))))
1393 (defun comint-watch-for-password-prompt (string)
1394 "Prompt in the minibuffer for password and send without echoing.
1395 This function uses `send-invisible' to read and send a password to the buffer's
1396 process if STRING contains a password prompt defined by
1397 `comint-password-prompt-regexp'.
1399 This function could be in the list `comint-output-filter-functions'."
1400 (if (string-match comint-password-prompt-regexp string)
1401 (send-invisible nil)))
1403 ;;; Low-level process communication
1405 (defvar comint-input-chunk-size 512
1406 "*Long inputs are sent to comint processes in chunks of this size.
1407 If your process is choking on big inputs, try lowering the value.")
1409 (defun comint-send-string (proc str)
1410 "Send PROCESS the contents of STRING as input.
1411 This is equivalent to `process-send-string', except that long input strings
1412 are broken up into chunks of size `comint-input-chunk-size'. Processes
1413 are given a chance to output between chunks. This can help prevent processes
1414 from hanging when you send them long inputs on some OS's."
1415 (let* ((len (length str))
1416 (i (min len comint-input-chunk-size)))
1417 (process-send-string proc (substring str 0 i))
1418 (while (< i len)
1419 (let ((next-i (+ i comint-input-chunk-size)))
1420 (accept-process-output)
1421 (sit-for 0)
1422 (process-send-string proc (substring str i (min len next-i)))
1423 (setq i next-i)))))
1425 (defun comint-send-region (proc start end)
1426 "Sends to PROC the region delimited by START and END.
1427 This is a replacement for `process-send-region' that tries to keep
1428 your process from hanging on long inputs. See `comint-send-string'."
1429 (comint-send-string proc (buffer-substring start end)))
1431 ;;; Random input hackage
1433 (defun comint-kill-output ()
1434 "Kill all output from interpreter since last input.
1435 Does not delete the prompt."
1436 (interactive)
1437 (let ((proc (get-buffer-process (current-buffer)))
1438 (replacement nil))
1439 (save-excursion
1440 (let ((pmark (progn (goto-char (process-mark proc))
1441 (beginning-of-line nil)
1442 (point-marker))))
1443 (delete-region comint-last-input-end pmark)
1444 (comint-skip-prompt)
1445 (setq replacement (concat "*** output flushed ***\n"
1446 (buffer-substring pmark (point))))
1447 (delete-region pmark (point))))
1448 ;; Output message and put back prompt
1449 (comint-output-filter proc replacement)))
1451 (defun comint-show-output ()
1452 "Display start of this batch of interpreter output at top of window.
1453 Sets mark to the value of point when this command is run."
1454 (interactive)
1455 (push-mark)
1456 (let ((pos (point)))
1457 (goto-char (or (marker-position comint-last-input-end) (point-max)))
1458 (beginning-of-line 0)
1459 (set-window-start (selected-window) (point))
1460 (comint-skip-prompt)))
1462 (defun comint-interrupt-subjob ()
1463 "Interrupt the current subjob."
1464 (interactive)
1465 (interrupt-process nil comint-ptyp))
1467 (defun comint-kill-subjob ()
1468 "Send kill signal to the current subjob."
1469 (interactive)
1470 (kill-process nil comint-ptyp))
1472 (defun comint-quit-subjob ()
1473 "Send quit signal to the current subjob."
1474 (interactive)
1475 (quit-process nil comint-ptyp))
1477 (defun comint-stop-subjob ()
1478 "Stop the current subjob.
1479 WARNING: if there is no current subjob, you can end up suspending
1480 the top-level process running in the buffer. If you accidentally do
1481 this, use \\[comint-continue-subjob] to resume the process. (This
1482 is not a problem with most shells, since they ignore this signal.)"
1483 (interactive)
1484 (stop-process nil comint-ptyp))
1486 (defun comint-continue-subjob ()
1487 "Send CONT signal to process buffer's process group.
1488 Useful if you accidentally suspend the top-level process."
1489 (interactive)
1490 (continue-process nil comint-ptyp))
1492 (defun comint-kill-input ()
1493 "Kill all text from last stuff output by interpreter to point."
1494 (interactive)
1495 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1496 (if (> (point) (marker-position pmark))
1497 (kill-region pmark (point)))))
1499 (defun comint-delchar-or-maybe-eof (arg)
1500 "Delete ARG characters forward, or (if at eob) send an EOF to subprocess."
1501 (interactive "p")
1502 (if (eobp)
1503 (process-send-eof)
1504 (delete-char arg)))
1506 (defun comint-send-eof ()
1507 "Send an EOF to the current buffer's process."
1508 (interactive)
1509 (process-send-eof))
1512 (defun comint-backward-matching-input (regexp arg)
1513 "Search backward through buffer for match for REGEXP.
1514 Matches are searched for on lines that match `comint-prompt-regexp'.
1515 With prefix argument N, search for Nth previous match.
1516 If N is negative, find the next or Nth next match."
1517 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
1518 (let* ((re (concat comint-prompt-regexp ".*" regexp))
1519 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
1520 (if (re-search-backward re nil t arg)
1521 (point)))))
1522 (if (null pos)
1523 (progn (message "Not found")
1524 (ding))
1525 (goto-char pos)
1526 (comint-bol nil))))
1528 (defun comint-forward-matching-input (regexp arg)
1529 "Search forward through buffer for match for REGEXP.
1530 Matches are searched for on lines that match `comint-prompt-regexp'.
1531 With prefix argument N, search for Nth following match.
1532 If N is negative, find the previous or Nth previous match."
1533 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
1534 (comint-backward-matching-input regexp (- arg)))
1537 (defun comint-next-prompt (n)
1538 "Move to end of Nth next prompt in the buffer.
1539 See `comint-prompt-regexp'."
1540 (interactive "p")
1541 (let ((paragraph-start comint-prompt-regexp))
1542 (end-of-line (if (> n 0) 1 0))
1543 (forward-paragraph n)
1544 (comint-skip-prompt)))
1546 (defun comint-previous-prompt (n)
1547 "Move to end of Nth previous prompt in the buffer.
1548 See `comint-prompt-regexp'."
1549 (interactive "p")
1550 (comint-next-prompt (- n)))
1552 ;;; Support for source-file processing commands.
1553 ;;;============================================================================
1554 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1555 ;;; commands that process files of source text (e.g. loading or compiling
1556 ;;; files). So the corresponding process-in-a-buffer modes have commands
1557 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
1558 ;;; for defining these commands.
1560 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1561 ;;; and Soar, in that they don't know anything about file extensions.
1562 ;;; So the compile/load interface gets the wrong default occasionally.
1563 ;;; The load-file/compile-file default mechanism could be smarter -- it
1564 ;;; doesn't know about the relationship between filename extensions and
1565 ;;; whether the file is source or executable. If you compile foo.lisp
1566 ;;; with compile-file, then the next load-file should use foo.bin for
1567 ;;; the default, not foo.lisp. This is tricky to do right, particularly
1568 ;;; because the extension for executable files varies so much (.o, .bin,
1569 ;;; .lbin, .mo, .vo, .ao, ...).
1572 ;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1573 ;;; commands.
1575 ;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1576 ;;; want to save the buffer before issuing any process requests to the command
1577 ;;; interpreter.
1579 ;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1580 ;;; for the file to process.
1582 ;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1583 ;;;============================================================================
1584 ;;; This function computes the defaults for the load-file and compile-file
1585 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
1586 ;;;
1587 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1588 ;;; source-file processing command. NIL if there hasn't been one yet.
1589 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
1590 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1591 ;;; Typically, (lisp-mode) or (scheme-mode).
1592 ;;;
1593 ;;; If the command is given while the cursor is inside a string, *and*
1594 ;;; the string is an existing filename, *and* the filename is not a directory,
1595 ;;; then the string is taken as default. This allows you to just position
1596 ;;; your cursor over a string that's a filename and have it taken as default.
1598 ;;; If the command is given in a file buffer whose major mode is in
1599 ;;; SOURCE-MODES, then the the filename is the default file, and the
1600 ;;; file's directory is the default directory.
1601 ;;;
1602 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1603 ;;; then the default directory & file are what was used in the last source-file
1604 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1605 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1606 ;;; is the cwd, with no default file. (\"no default file\" = nil)
1607 ;;;
1608 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1609 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1610 ;;; for Soar programs, etc.
1611 ;;;
1612 ;;; The function returns a pair: (default-directory . default-file).
1614 (defun comint-source-default (previous-dir/file source-modes)
1615 (cond ((and buffer-file-name (memq major-mode source-modes))
1616 (cons (file-name-directory buffer-file-name)
1617 (file-name-nondirectory buffer-file-name)))
1618 (previous-dir/file)
1620 (cons default-directory nil))))
1623 ;;; (COMINT-CHECK-SOURCE fname)
1624 ;;;============================================================================
1625 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1626 ;;; process-in-a-buffer modes), this function can be called on the filename.
1627 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
1628 ;;; is queried to see if he wants to save the buffer before proceeding with
1629 ;;; the load or compile.
1631 (defun comint-check-source (fname)
1632 (let ((buff (get-file-buffer fname)))
1633 (if (and buff
1634 (buffer-modified-p buff)
1635 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
1636 ;; save BUFF.
1637 (let ((old-buffer (current-buffer)))
1638 (set-buffer buff)
1639 (save-buffer)
1640 (set-buffer old-buffer)))))
1643 ;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1644 ;;;============================================================================
1645 ;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1646 ;;; commands that process source files (like loading or compiling a file).
1647 ;;; It prompts for the filename, provides a default, if there is one,
1648 ;;; and returns the result filename.
1649 ;;;
1650 ;;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1651 ;;;
1652 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1653 ;;; from the last source processing command. SOURCE-MODES is a list of major
1654 ;;; modes used to determine what file buffers contain source files. (These
1655 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1656 ;;; then the filename reader will only accept a file that exists.
1657 ;;;
1658 ;;; A typical use:
1659 ;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1660 ;;; '(lisp-mode) t))
1662 ;;; This is pretty stupid about strings. It decides we're in a string
1663 ;;; if there's a quote on both sides of point on the current line.
1664 (defun comint-extract-string ()
1665 "Return string around POINT that starts the current line, or nil."
1666 (save-excursion
1667 (let* ((point (point))
1668 (bol (progn (beginning-of-line) (point)))
1669 (eol (progn (end-of-line) (point)))
1670 (start (progn (goto-char point)
1671 (and (search-backward "\"" bol t)
1672 (1+ (point)))))
1673 (end (progn (goto-char point)
1674 (and (search-forward "\"" eol t)
1675 (1- (point))))))
1676 (and start end
1677 (buffer-substring start end)))))
1679 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
1680 (let* ((def (comint-source-default prev-dir/file source-modes))
1681 (stringfile (comint-extract-string))
1682 (sfile-p (and stringfile
1683 (condition-case ()
1684 (file-exists-p stringfile)
1685 (error nil))
1686 (not (file-directory-p stringfile))))
1687 (defdir (if sfile-p (file-name-directory stringfile)
1688 (car def)))
1689 (deffile (if sfile-p (file-name-nondirectory stringfile)
1690 (cdr def)))
1691 (ans (read-file-name (if deffile (format "%s(default %s) "
1692 prompt deffile)
1693 prompt)
1694 defdir
1695 (concat defdir deffile)
1696 mustmatch-p)))
1697 (list (expand-file-name (substitute-in-file-name ans)))))
1699 ;;; I am somewhat divided on this string-default feature. It seems
1700 ;;; to violate the principle-of-least-astonishment, in that it makes
1701 ;;; the default harder to predict, so you actually have to look and see
1702 ;;; what the default really is before choosing it. This can trip you up.
1703 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1704 ;;; on this.
1705 ;;; -Olin
1708 ;;; Simple process query facility.
1709 ;;; ===========================================================================
1710 ;;; This function is for commands that want to send a query to the process
1711 ;;; and show the response to the user. For example, a command to get the
1712 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1713 ;;; to an inferior Common Lisp process.
1714 ;;;
1715 ;;; This simple facility just sends strings to the inferior process and pops
1716 ;;; up a window for the process buffer so you can see what the process
1717 ;;; responds with. We don't do anything fancy like try to intercept what the
1718 ;;; process responds with and put it in a pop-up window or on the message
1719 ;;; line. We just display the buffer. Low tech. Simple. Works good.
1721 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1722 ;;; a window for the inferior process so that its response can be seen.
1723 (defun comint-proc-query (proc str)
1724 (let* ((proc-buf (process-buffer proc))
1725 (proc-mark (process-mark proc)))
1726 (display-buffer proc-buf)
1727 (set-buffer proc-buf) ; but it's not the selected *window*
1728 (let ((proc-win (get-buffer-window proc-buf))
1729 (proc-pt (marker-position proc-mark)))
1730 (comint-send-string proc str) ; send the query
1731 (accept-process-output proc) ; wait for some output
1732 ;; Try to position the proc window so you can see the answer.
1733 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1734 ;; I don't know why. Wizards invited to improve it.
1735 (if (not (pos-visible-in-window-p proc-pt proc-win))
1736 (let ((opoint (window-point proc-win)))
1737 (set-window-point proc-win proc-mark)
1738 (sit-for 0)
1739 (if (not (pos-visible-in-window-p opoint proc-win))
1740 (push-mark opoint)
1741 (set-window-point proc-win opoint)))))))
1744 ;;; Filename/command/history completion in a buffer
1745 ;;; ===========================================================================
1746 ;;; Useful completion functions, courtesy of the Ergo group.
1748 ;;; Six commands:
1749 ;;; comint-dynamic-complete Complete or expand command, filename,
1750 ;;; history at point.
1751 ;;; comint-dynamic-complete-filename Complete filename at point.
1752 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
1753 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
1754 ;;; replace with expanded/completed name.
1755 ;;; comint-dynamic-simple-complete Complete stub given candidates.
1757 ;;; These are not installed in the comint-mode keymap. But they are
1758 ;;; available for people who want them. Shell-mode installs them:
1759 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1760 ;;; (define-key shell-mode-map "\M-?"
1761 ;;; 'comint-dynamic-list-filename-completions)))
1763 ;;; Commands like this are fine things to put in load hooks if you
1764 ;;; want them present in specific modes.
1766 (defvar comint-completion-autolist nil
1767 "*If non-nil, automatically list possiblities on partial completion.
1768 This mirrors the optional behavior of tcsh.")
1770 (defvar comint-completion-addsuffix t
1771 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1772 This mirrors the optional behavior of tcsh.")
1774 (defvar comint-completion-recexact nil
1775 "*If non-nil, use shortest completion if characters cannot be added.
1776 This mirrors the optional behavior of tcsh.
1778 A non-nil value is useful if `comint-completion-autolist' is non-nil too.")
1780 (defvar comint-completion-fignore nil
1781 "*List of suffixes to be disregarded during file completion.
1782 This mirrors the optional behavior of bash and tcsh.
1784 Note that this applies to `comint-dynamic-complete-filename' only.")
1786 (defvar comint-file-name-prefix ""
1787 "Prefix prepended to absolute file names taken from process input.
1788 This is used by comint's and shell's completion functions, and by shell's
1789 directory tracking functions.")
1792 (defun comint-directory (directory)
1793 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1794 (expand-file-name (if (file-name-absolute-p directory)
1795 (concat comint-file-name-prefix directory)
1796 directory)))
1799 (defun comint-word (word-chars)
1800 "Return the word of WORD-CHARS at point, or nil if non is found.
1801 Word constituents are considered to be those in WORD-CHARS, which is like the
1802 inside of a \"[...]\" (see `skip-chars-forward')."
1803 (save-excursion
1804 (let ((limit (point))
1805 (word (concat "[" word-chars "]"))
1806 (non-word (concat "[^" word-chars "]")))
1807 (if (re-search-backward non-word nil 'move)
1808 (forward-char 1))
1809 ;; Anchor the search forwards.
1810 (if (or (eolp) (looking-at non-word))
1812 (re-search-forward (concat word "+") limit)
1813 (buffer-substring (match-beginning 0) (match-end 0))))))
1816 (defun comint-match-partial-filename ()
1817 "Return the filename at point, or nil if non is found.
1818 Environment variables are substituted. See `comint-word'."
1819 (let ((filename (comint-word "~/A-Za-z0-9+@:_.$#,={}-")))
1820 (and filename (substitute-in-file-name filename))))
1823 (defun comint-dynamic-complete ()
1824 "Dynamically perform completion at point.
1825 Calls the functions in `comint-dynamic-complete-functions' to perform
1826 completion until a function returns non-nil, at which point completion is
1827 assumed to have occurred."
1828 (interactive)
1829 (let ((functions comint-dynamic-complete-functions))
1830 (while (and functions (null (funcall (car functions))))
1831 (setq functions (cdr functions)))))
1834 (defun comint-dynamic-complete-filename ()
1835 "Dynamically complete the filename at point.
1836 Completes if after a filename. See `comint-match-partial-filename' and
1837 `comint-dynamic-complete-as-filename'.
1838 This function is similar to `comint-replace-by-expanded-filename', except that
1839 it won't change parts of the filename already entered in the buffer; it just
1840 adds completion characters to the end of the filename. A completions listing
1841 may be shown in a help buffer if completion is ambiguous.
1843 Completion is dependent on the value of `comint-completion-addsuffix',
1844 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
1845 completions listing is dependent on the value of `comint-completion-autolist'.
1847 Returns t if successful."
1848 (interactive)
1849 (if (comint-match-partial-filename)
1850 (prog2 (or (eq (selected-window) (minibuffer-window))
1851 (message "Completing file name..."))
1852 (comint-dynamic-complete-as-filename))))
1855 (defun comint-dynamic-complete-as-filename ()
1856 "Dynamically complete at point as a filename.
1857 See `comint-dynamic-complete-filename'. Returns t if successful."
1858 (let* ((completion-ignore-case nil)
1859 (completion-ignored-extensions comint-completion-fignore)
1860 (success t)
1861 (filename (or (comint-match-partial-filename) ""))
1862 (pathdir (file-name-directory filename))
1863 (pathnondir (file-name-nondirectory filename))
1864 (directory (if pathdir (comint-directory pathdir) default-directory))
1865 (completion (file-name-completion pathnondir directory))
1866 (mini-flag (eq (selected-window) (minibuffer-window))))
1867 (cond ((null completion)
1868 (message "No completions of %s" filename)
1869 (setq success nil))
1870 ((eq completion t) ; Means already completed "file".
1871 (if comint-completion-addsuffix (insert " "))
1872 (or mini-flag (message "Sole completion")))
1873 ((string-equal completion "") ; Means completion on "directory/".
1874 (comint-dynamic-list-filename-completions))
1875 (t ; Completion string returned.
1876 (let ((file (concat (file-name-as-directory directory) completion)))
1877 (insert (substring (directory-file-name completion)
1878 (length pathnondir)))
1879 (cond ((symbolp (file-name-completion completion directory))
1880 ;; We inserted a unique completion.
1881 (if comint-completion-addsuffix
1882 (insert (if (file-directory-p file) "/" " ")))
1883 (or mini-flag (message "Completed")))
1884 ((and comint-completion-recexact comint-completion-addsuffix
1885 (string-equal pathnondir completion)
1886 (file-exists-p file))
1887 ;; It's not unique, but user wants shortest match.
1888 (insert (if (file-directory-p file) "/" " "))
1889 (or mini-flag (message "Completed shortest")))
1890 ((or comint-completion-autolist
1891 (string-equal pathnondir completion))
1892 ;; It's not unique, list possible completions.
1893 (comint-dynamic-list-filename-completions))
1895 (or mini-flag (message "Partially completed")))))))
1896 success))
1899 (defun comint-replace-by-expanded-filename ()
1900 "Dynamically expand and complete the filename at point.
1901 Replace the filename with an expanded, canonicalised and completed replacement.
1902 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
1903 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
1904 removed, and the filename is made absolute instead of relative. For expansion
1905 see `expand-file-name' and `substitute-in-file-name'. For completion see
1906 `comint-dynamic-complete-filename'."
1907 (interactive)
1908 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
1909 (comint-dynamic-complete-filename))
1912 (defun comint-dynamic-simple-complete (stub candidates)
1913 "Dynamically complete STUB from CANDIDATES list.
1914 This function inserts completion characters at point by completing STUB from
1915 the strings in CANDIDATES. A completions listing may be shown in a help buffer
1916 if completion is ambiguous.
1918 Returns nil if no completion was inserted.
1919 Returns `sole' if completed with the only completion match.
1920 Returns `shortest' if completed with the shortest of the completion matches.
1921 Returns `partial' if completed as far as possible with the completion matches.
1922 Returns `listed' if a completion listing was shown.
1924 See also `comint-dynamic-complete-filename'."
1925 (let* ((completion-ignore-case nil)
1926 (candidates (mapcar (function (lambda (x) (list x))) candidates))
1927 (completions (all-completions stub candidates)))
1928 (cond ((null completions)
1929 (message "No completions of %s" stub)
1930 nil)
1931 ((= 1 (length completions)) ; Gotcha!
1932 (let ((completion (car completions)))
1933 (if (string-equal completion stub)
1934 (message "Sole completion")
1935 (insert (substring completion (length stub)))
1936 (message "Completed"))
1937 (if comint-completion-addsuffix (insert " "))
1938 'sole))
1939 (t ; There's no unique completion.
1940 (let ((completion (try-completion stub candidates)))
1941 ;; Insert the longest substring.
1942 (insert (substring completion (length stub)))
1943 (cond ((and comint-completion-recexact comint-completion-addsuffix
1944 (string-equal stub completion)
1945 (member completion completions))
1946 ;; It's not unique, but user wants shortest match.
1947 (insert " ")
1948 (message "Completed shortest")
1949 'shortest)
1950 ((or comint-completion-autolist
1951 (string-equal stub completion))
1952 ;; It's not unique, list possible completions.
1953 (comint-dynamic-list-completions completions)
1954 'listed)
1956 (message "Partially completed")
1957 'partial)))))))
1960 (defun comint-dynamic-list-filename-completions ()
1961 "List in help buffer possible completions of the filename at point."
1962 (interactive)
1963 (let* ((completion-ignore-case nil)
1964 (filename (or (comint-match-partial-filename) ""))
1965 (pathdir (file-name-directory filename))
1966 (pathnondir (file-name-nondirectory filename))
1967 (directory (if pathdir (comint-directory pathdir) default-directory))
1968 (completions (file-name-all-completions pathnondir directory)))
1969 (if completions
1970 (comint-dynamic-list-completions completions)
1971 (message "No completions of %s" filename))))
1974 (defun comint-dynamic-list-completions (completions)
1975 "List in help buffer sorted COMPLETIONS.
1976 Typing SPC flushes the help buffer."
1977 (let ((conf (current-window-configuration)))
1978 (with-output-to-temp-buffer "*Completions*"
1979 (display-completion-list (sort completions 'string-lessp)))
1980 (message "Hit space to flush")
1981 (let (key first)
1982 (if (save-excursion
1983 (set-buffer (get-buffer "*Completions*"))
1984 (setq key (read-key-sequence nil)
1985 first (aref key 0))
1986 (and (consp first)
1987 (eq (window-buffer (posn-window (event-start first)))
1988 (get-buffer "*Completions*"))
1989 (eq (key-binding key) 'mouse-choose-completion)))
1990 ;; If the user does mouse-choose-completion with the mouse,
1991 ;; execute the command, then delete the completion window.
1992 (progn
1993 (mouse-choose-completion first)
1994 (set-window-configuration conf))
1995 (if (eq first ?\ )
1996 (set-window-configuration conf)
1997 (setq unread-command-events (append key nil)))))))
1999 ;;; Converting process modes to use comint mode
2000 ;;; ===========================================================================
2001 ;;; The code in the Emacs 19 distribution has all been modified to use comint
2002 ;;; where needed. However, there are `third-party' packages out there that
2003 ;;; still use the old shell mode. Here's a guide to conversion.
2005 ;;; Renaming variables
2006 ;;; Most of the work is renaming variables and functions. These are the common
2007 ;;; ones:
2008 ;;; Local variables:
2009 ;;; last-input-start comint-last-input-start
2010 ;;; last-input-end comint-last-input-end
2011 ;;; shell-prompt-pattern comint-prompt-regexp
2012 ;;; shell-set-directory-error-hook <no equivalent>
2013 ;;; Miscellaneous:
2014 ;;; shell-set-directory <unnecessary>
2015 ;;; shell-mode-map comint-mode-map
2016 ;;; Commands:
2017 ;;; shell-send-input comint-send-input
2018 ;;; shell-send-eof comint-delchar-or-maybe-eof
2019 ;;; kill-shell-input comint-kill-input
2020 ;;; interrupt-shell-subjob comint-interrupt-subjob
2021 ;;; stop-shell-subjob comint-stop-subjob
2022 ;;; quit-shell-subjob comint-quit-subjob
2023 ;;; kill-shell-subjob comint-kill-subjob
2024 ;;; kill-output-from-shell comint-kill-output
2025 ;;; show-output-from-shell comint-show-output
2026 ;;; copy-last-shell-input Use comint-previous-input/comint-next-input
2028 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2029 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2030 ;;; Comint mode does not provide functionality equivalent to
2031 ;;; shell-set-directory-error-hook; it is gone.
2033 ;;; comint-last-input-start is provided for modes which want to munge
2034 ;;; the buffer after input is sent, perhaps because the inferior
2035 ;;; insists on echoing the input. The LAST-INPUT-START variable in
2036 ;;; the old shell package was used to implement a history mechanism,
2037 ;;; but you should think twice before using comint-last-input-start
2038 ;;; for this; the input history ring often does the job better.
2039 ;;;
2040 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2041 ;;; *not* create the comint-mode local variables in your foo-mode function.
2042 ;;; This is not modular. Instead, call comint-mode, and let *it* create the
2043 ;;; necessary comint-specific local variables. Then create the
2044 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2045 ;;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2046 ;;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2047 ;;; get-old-input) that need to be different from the defaults. Call
2048 ;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2049 ;;; comint-mode will take care of it. The following example, from shell.el,
2050 ;;; is typical:
2051 ;;;
2052 ;;; (defvar shell-mode-map '())
2053 ;;; (cond ((not shell-mode-map)
2054 ;;; (setq shell-mode-map (copy-keymap comint-mode-map))
2055 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2056 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2057 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2058 ;;; (define-key shell-mode-map "\M-?"
2059 ;;; 'comint-dynamic-list-filename-completions)))
2061 ;;; (defun shell-mode ()
2062 ;;; (interactive)
2063 ;;; (comint-mode)
2064 ;;; (setq comint-prompt-regexp shell-prompt-pattern)
2065 ;;; (setq major-mode 'shell-mode)
2066 ;;; (setq mode-name "Shell")
2067 ;;; (use-local-map shell-mode-map)
2068 ;;; (make-local-variable 'shell-directory-stack)
2069 ;;; (setq shell-directory-stack nil)
2070 ;;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2071 ;;; (run-hooks 'shell-mode-hook))
2074 ;;; Note that make-comint is different from make-shell in that it
2075 ;;; doesn't have a default program argument. If you give make-shell
2076 ;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
2077 ;;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument
2078 ;;; of NIL, it barfs. Adjust your code accordingly...
2080 ;;; Completion for comint-mode users
2081 ;;;
2082 ;;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2083 ;;; hook to add completion functions to. Functions on this list should return
2084 ;;; non-nil if completion occurs (i.e., further completion should not occur).
2085 ;;; You could use comint-dynamic-simple-complete to do the bulk of the
2086 ;;; completion job.
2088 (provide 'comint)
2090 ;;; comint.el ends here