1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Adapted-by: Simon Marshall <s.marshall@dcs.hull.ac.uk>
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)
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.
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.
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
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-r comint-previous-input-matching Search backwards in input history
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
83 ;;; Not bound by default in comint-mode (some are in shell 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-complete-variable Complete variable name at point.
87 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
88 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
89 ;;; replace with expanded/completed name.
90 ;;; comint-replace-by-expanded-history Expand history at point;
91 ;;; replace with expanded name.
92 ;;; comint-magic-space Expand history and add (a) space(s).
93 ;;; comint-kill-subjob No mercy.
94 ;;; comint-show-maximum-output Show as much output as possible.
95 ;;; comint-continue-subjob Send CONT signal to buffer's process
96 ;;; group. Useful if you accidentally
97 ;;; suspend your process (with C-c C-z).
99 ;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
105 ;;; Buffer Local Variables:
106 ;;;============================================================================
107 ;;; Comint mode buffer local variables:
108 ;;; comint-prompt-regexp - string comint-bol uses to match prompt
109 ;;; comint-delimiter-argument-list - list For delimiters and arguments
110 ;;; comint-last-input-start - marker Handy if inferior always echoes
111 ;;; comint-last-input-end - marker For comint-kill-output command
112 ;;; comint-input-ring-size - integer For the input history
113 ;;; comint-input-ring - ring mechanism
114 ;;; comint-input-ring-index - number ...
115 ;;; comint-input-autoexpand - symbol ...
116 ;;; comint-input-ignoredups - boolean ...
117 ;;; comint-last-input-match - string ...
118 ;;; comint-get-old-input - function Hooks for specific
119 ;;; comint-get-current-command - function process-in-a-buffer
120 ;;; comint-dynamic-complete-command-command - function modes.
121 ;;; comint-after-partial-filename-command -
122 ;;; comint-input-sentinel - function ...
123 ;;; comint-input-filter - function ...
124 ;;; comint-input-send - function ...
125 ;;; comint-eol-on-send - boolean ...
126 ;;; comint-process-echoes - boolean ...
127 ;;; comint-scroll-to-bottom-on-input - symbol For scroll behavior
128 ;;; comint-scroll-to-bottom-on-output - symbol ...
129 ;;; comint-scroll-show-maximum-output - boolean ...
131 ;;; Comint mode non-buffer local variables:
132 ;;; comint-completion-addsuffix - boolean For file name completion
133 ;;; comint-completion-autolist - boolean behavior
134 ;;; comint-completion-recexact - boolean ...
136 (defvar comint-prompt-regexp "^"
137 "Regexp to recognise prompts in the inferior process.
138 Defaults to \"^\", the null string at BOL.
141 Canonical Lisp: \"^[^> ]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
142 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
143 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
145 shell: \"^[^#$%>]*[#$%>] *\"
148 This is a good thing to set in mode hooks.")
150 (defvar comint-delimiter-argument-list ()
151 "List of characters to recognise as separate arguments in input.
152 Strings comprising a character in this list will separate the arguments
153 surrounding them, and also be regarded as arguments in their own right (unlike
154 whitespace). See `comint-arguments'.
155 Defaults to (), the empty list.
158 shell: \(\"|\" \"&\" \"<\" \">\" \"\(\" \")\" \";\")
160 This is a good thing to set in mode hooks.")
162 (defvar comint-input-autoexpand 'history
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.
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.
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 ;;; Here are the per-interpreter hooks.
223 (defvar comint-get-old-input (function comint-get-old-input-default)
224 "Function that returns old text in comint mode.
225 This function is called when return is typed while the point is in old text.
226 It returns the text to be submitted as process input. The default is
227 `comint-get-old-input-default', which grabs the current line, and strips off
228 leading text matching `comint-prompt-regexp'.")
230 (defvar comint-after-partial-filename-command 'comint-after-partial-filename
231 "Function that returns non-nil if point is after a file name.
232 By default this is `comint-after-partial-filename'.
234 This is a good thing to set in mode hooks.")
236 (defvar comint-dynamic-complete-filename-command
237 'comint-dynamic-complete-filename
238 "Function that dynamically completes the file name at point.
239 By default this is `comint-dynamic-complete-filename', though an alternative is
240 `comint-replace-by-expanded-filename'.
242 This is a good thing to set in mode hooks.")
244 (defvar comint-dynamic-complete-command-command
245 'comint-dynamic-complete-filename
246 "Function that dynamically completes the command at point.
247 By default this is `comint-dynamic-complete-filename'.
249 This is a good thing to set in mode hooks.")
251 (defvar comint-get-current-command 'comint-get-old-input-default
252 "Function that returns the current command including arguments.
253 By default this is `comint-get-old-input-default', meaning the whole line.
255 This is a good thing to set in mode hooks.")
257 (defvar comint-input-sentinel (function ignore)
258 "Called on each input submitted to comint mode process by `comint-send-input'.
259 Thus it can, for instance, track cd/pushd/popd commands issued to a shell.")
261 (defvar comint-input-filter
262 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
263 "Predicate for filtering additions to input history.
264 Takes one argument, the input. If non-nil, the input may be saved on the input
265 history list. Default is to save anything that isn't all whitespace.")
267 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
268 "Functions to call after output is inserted into the buffer.
269 One possible function is `comint-postoutput-scroll-to-bottom'.
270 These functions get one argument, a string containing the text just inserted.
272 This variable is buffer-local.")
274 (defvar comint-input-sender (function comint-simple-send)
275 "Function to actually send to PROCESS the STRING submitted by user.
276 Usually this is just `comint-simple-send', but if your mode needs to
277 massage the input string, put a different function here.
278 `comint-simple-send' just sends the string plus a newline.
279 This is called from the user command `comint-send-input'.")
281 (defvar comint-eol-on-send t
282 "*Non-nil means go to the end of the line before sending input.
283 See `comint-send-input'.")
285 (defvar comint-mode-hook '()
286 "Called upon entry into comint-mode
287 This is run before the process is cranked up.")
289 (defvar comint-exec-hook '()
290 "Called each time a process is exec'd by `comint-exec'.
291 This is called after the process is cranked up. It is useful for things that
292 must be done each time a process is executed in a comint mode buffer (e.g.,
293 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
294 executed once when the buffer is created.")
296 (defvar comint-mode-map nil)
298 (defvar comint-ptyp t
299 "Non-nil if communications via pty; false if by pipe. Buffer local.
300 This is to work around a bug in Emacs process signalling.")
302 (defvar comint-input-ring nil)
303 (defvar comint-last-input-start)
304 (defvar comint-last-input-end)
305 (defvar comint-input-ring-index nil
306 "Index of last matched history element.")
307 (defvar comint-matching-input-from-input-string ""
308 "Input previously used to match input history.")
309 (put 'comint-input-ring 'permanent-local t)
310 (put 'comint-input-ring-index 'permanent-local t)
311 (put 'comint-input-autoexpand 'permanent-local t)
312 (put 'comint-output-filter-functions 'permanent-local t)
313 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
314 (put 'comint-scroll-to-bottom-on-output 'permanent-local t)
315 (put 'comint-scroll-show-maximum-output 'permanent-local t)
316 (put 'comint-ptyp 'permanent-local t)
318 (defun comint-mode ()
319 "Major mode for interacting with an inferior interpreter.
320 Interpreter name is same as buffer name, sans the asterisks.
321 Return at end of buffer sends line as input.
322 Return not at end copies rest of line to end and sends it.
323 Setting variable `comint-eol-on-send' means jump to the end of the line
324 before submitting new input.
326 This mode is customised to create major modes such as Inferior Lisp
327 mode, Shell mode, etc. This can be done by setting the hooks
328 `comint-input-sentinel', `comint-input-filter', `comint-input-sender'
329 and `comint-get-old-input' to appropriate functions, and the variable
330 `comint-prompt-regexp' to the appropriate regular expression.
332 An input history is maintained of size `comint-input-ring-size', and
333 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
334 Input ring history expansion can be achieved with the commands
335 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
336 Input ring expansion is controlled by the variable `comint-input-autoexpand',
337 and addition is controlled by the variable `comint-input-ignoredups'.
339 Commands with no default key bindings include `send-invisible',
340 `comint-dynamic-complete', `comint-list-dynamic-completions', and
341 `comint-magic-space'.
343 Input to, and output from, the subprocess can cause the window to scroll to
344 the end of the buffer. See variables `comint-output-filter-functions',
345 `comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
347 If you accidentally suspend your process, use \\[comint-continue-subjob]
352 Entry to this mode runs the hooks on `comint-mode-hook'."
354 ;; Do not remove this. All major modes must do this.
355 (kill-all-local-variables)
356 (setq major-mode 'comint-mode)
357 (setq mode-name "Comint")
358 (setq mode-line-process '(": %s"))
359 (use-local-map comint-mode-map)
360 (make-local-variable 'comint-last-input-start)
361 (setq comint-last-input-start (make-marker))
362 (make-local-variable 'comint-last-input-end)
363 (setq comint-last-input-end (make-marker))
364 (make-local-variable 'comint-last-output-start)
365 (setq comint-last-output-start (make-marker))
366 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
367 (make-local-variable 'comint-input-ring-size) ; ...to global val.
368 (make-local-variable 'comint-input-ring)
369 (make-local-variable 'comint-input-ring-file-name)
370 (or (and (boundp 'comint-input-ring) comint-input-ring)
371 (setq comint-input-ring (make-ring comint-input-ring-size)))
372 (make-local-variable 'comint-input-ring-index)
373 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
374 (setq comint-input-ring-index nil))
375 (make-local-variable 'comint-matching-input-from-input-string)
376 (make-local-variable 'comint-input-autoexpand)
377 (make-local-variable 'comint-input-ignoredups)
378 (make-local-variable 'comint-delimiter-argument-list)
379 (make-local-variable 'comint-after-partial-filename-command)
380 (make-local-variable 'comint-dynamic-complete-filename-command)
381 (make-local-variable 'comint-dynamic-complete-command-command)
382 (make-local-variable 'comint-get-current-command)
383 (make-local-variable 'comint-get-old-input)
384 (make-local-variable 'comint-input-sentinel)
385 (make-local-variable 'comint-input-filter)
386 (make-local-variable 'comint-input-sender)
387 (make-local-variable 'comint-eol-on-send)
388 (make-local-variable 'comint-scroll-to-bottom-on-input)
389 (make-local-variable 'comint-scroll-to-bottom-on-output)
390 (make-local-variable 'comint-scroll-show-maximum-output)
391 (make-local-variable 'pre-command-hook)
392 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom)
393 (make-local-variable 'comint-output-filter-functions)
394 (make-local-variable 'comint-ptyp)
395 (make-local-variable 'comint-exec-hook)
396 (make-local-variable 'comint-process-echoes)
397 (run-hooks 'comint-mode-hook))
402 (setq comint-mode-map (make-sparse-keymap))
403 (define-key comint-mode-map "\ep" 'comint-previous-input)
404 (define-key comint-mode-map "\en" 'comint-next-input)
405 (define-key comint-mode-map "\er" 'comint-previous-matching-input)
406 (define-key comint-mode-map "\es" 'comint-next-matching-input)
407 (define-key comint-mode-map [?\A-\M-r] 'comint-previous-matching-input-from-input)
408 (define-key comint-mode-map [?\A-\M-s] 'comint-next-matching-input-from-input)
409 (define-key comint-mode-map "\C-m" 'comint-send-input)
410 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
411 (define-key comint-mode-map "\C-a" 'comint-bol)
412 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
413 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
414 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
415 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
416 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
417 ;; " ; Stops emacs-19.19's hilit getting confused.
418 (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
419 (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output)
420 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
421 (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
422 (define-key comint-mode-map "\C-c\C-h" 'comint-dynamic-list-input-ring)
423 (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
424 (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
425 (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
428 (define-key comint-mode-map [menu-bar completion]
429 (cons "Complete" (make-sparse-keymap "Complete")))
430 (define-key comint-mode-map [menu-bar completion complete-expand]
431 '("Expand File Name" . comint-replace-by-expanded-filename))
432 (define-key comint-mode-map [menu-bar completion complete-listing]
433 '("File Completion Listing" . comint-dynamic-list-filename-completions))
434 (define-key comint-mode-map [menu-bar completion complete-variable]
435 '("Complete Variable Name" . comint-dynamic-complete-variable))
436 (define-key comint-mode-map [menu-bar completion complete-command]
437 '("Complete Command Name" . (lambda () (interactive)
439 comint-dynamic-complete-command-command))))
440 (define-key comint-mode-map [menu-bar completion complete-file]
441 '("Complete File Name" . comint-dynamic-complete-filename))
442 (define-key comint-mode-map [menu-bar completion complete]
443 '("Complete Before Point" . comint-dynamic-complete))
445 (define-key comint-mode-map [menu-bar input]
446 (cons "In/Out" (make-sparse-keymap "In/Out")))
447 (define-key comint-mode-map [menu-bar input kill-output]
448 '("Kill Current Output Group" . comint-kill-output))
449 (define-key comint-mode-map [menu-bar input next-prompt]
450 '("Forward Output Group" . comint-next-prompt))
451 (define-key comint-mode-map [menu-bar input previous-prompt]
452 '("Backward Output Group" . comint-previous-prompt))
453 (define-key comint-mode-map [menu-bar input show-maximum-output]
454 '("Show Maximum Output" . comint-show-maximum-output))
455 (define-key comint-mode-map [menu-bar input show-output]
456 '("Show Current Output Group" . comint-show-output))
457 (define-key comint-mode-map [menu-bar input kill-input]
458 '("Kill Current Input" . comint-kill-input))
459 (define-key comint-mode-map [menu-bar input copy-input]
460 '("Copy Old Input" . comint-copy-old-input))
461 (define-key comint-mode-map [menu-bar input forward-matching-history]
462 '("Forward Matching Input..." . comint-forward-matching-input))
463 (define-key comint-mode-map [menu-bar input backward-matching-history]
464 '("Backward Matching Input..." . comint-backward-matching-input))
465 (define-key comint-mode-map [menu-bar input next-matching-history]
466 '("Next Matching Input..." . comint-next-matching-input))
467 (define-key comint-mode-map [menu-bar input previous-matching-history]
468 '("Previous Matching Input..." . comint-previous-matching-input))
469 (define-key comint-mode-map [menu-bar input next-matching-history-from-input]
470 '("Next Matching Current Input" . comint-next-matching-input-from-input))
471 (define-key comint-mode-map [menu-bar input previous-matching-history-from-input]
472 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
473 (define-key comint-mode-map [menu-bar input next-history]
474 '("Next Input" . comint-next-input))
475 (define-key comint-mode-map [menu-bar input previous-history]
476 '("Previous Input" . comint-previous-input))
477 (define-key comint-mode-map [menu-bar input list-history]
478 '("List Input History" . comint-dynamic-list-input-ring))
479 (define-key comint-mode-map [menu-bar input expand-history]
480 '("Expand History Before Point" . comint-replace-by-expanded-history))
482 (define-key comint-mode-map [menu-bar signals]
483 (cons "Signals" (make-sparse-keymap "Signals")))
484 (define-key comint-mode-map [menu-bar signals eof]
485 '("EOF" . comint-send-eof))
486 (define-key comint-mode-map [menu-bar signals kill]
487 '("KILL" . comint-kill-subjob))
488 (define-key comint-mode-map [menu-bar signals quit]
489 '("QUIT" . comint-quit-subjob))
490 (define-key comint-mode-map [menu-bar signals cont]
491 '("CONT" . comint-continue-subjob))
492 (define-key comint-mode-map [menu-bar signals stop]
493 '("STOP" . comint-stop-subjob))
494 (define-key comint-mode-map [menu-bar signals break]
495 '("BREAK" . comint-interrupt-subjob))
496 ;; Put them in the menu bar:
497 (setq menu-bar-final-items (append '(completion input output signals)
498 menu-bar-final-items))
502 ;;; This function is used to make a full copy of the comint mode map,
503 ;;; so that client modes won't interfere with each other. This function
504 ;;; isn't necessary in emacs 18.5x, but we keep it around for 18.4x versions.
505 (defun full-copy-sparse-keymap (km)
506 "Recursively copy the sparse keymap KM."
508 (cons (full-copy-sparse-keymap (car km))
509 (full-copy-sparse-keymap (cdr km))))
512 (defun comint-check-proc (buffer)
513 "Return t if there is a living process associated w/buffer BUFFER.
514 Living means the status is `run' or `stop'.
515 BUFFER can be either a buffer or the name of one."
516 (let ((proc (get-buffer-process buffer)))
517 (and proc (memq (process-status proc) '(run stop)))))
519 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
520 ;;; for the second argument (program).
522 (defun make-comint (name program &optional startfile &rest switches)
523 "Make a comint process NAME in a buffer, running PROGRAM.
524 The name of the buffer is made by surrounding NAME with `*'s.
525 If there is already a running process in that buffer, it is not restarted.
526 Optional third arg STARTFILE is the name of a file to send the contents of to
527 the process. Any more args are arguments to PROGRAM."
528 (let ((buffer (get-buffer-create (concat "*" name "*"))))
529 ;; If no process, or nuked process, crank up a new one and put buffer in
530 ;; comint mode. Otherwise, leave buffer and existing process alone.
531 (cond ((not (comint-check-proc buffer))
534 (comint-mode)) ; Install local vars, mode, keymap, ...
535 (comint-exec buffer name program startfile switches)))
538 (defun comint-exec (buffer name command startfile switches)
539 "Start up a process in buffer BUFFER for comint modes.
540 Blasts any old process running in the buffer. Doesn't set the buffer mode.
541 You can use this to cheaply run a series of processes in the same comint
542 buffer. The hook `comint-exec-hook' is run after each exec."
545 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
546 (if proc (delete-process proc)))
547 ;; Crank up a new process
548 (let ((proc (comint-exec-1 name buffer command switches)))
549 (set-process-filter proc 'comint-output-filter)
550 (make-local-variable 'comint-ptyp)
551 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
552 ;; Jump to the end, and set the process mark.
553 (goto-char (point-max))
554 (set-marker (process-mark proc) (point))
555 ;; Feed it the startfile.
557 ;;This is guaranteed to wait long enough
558 ;;but has bad results if the comint does not prompt at all
559 ;; (while (= size (buffer-size))
561 ;;I hope 1 second is enough!
563 (goto-char (point-max))
564 (insert-file-contents startfile)
565 (setq startfile (buffer-substring (point) (point-max)))
566 (delete-region (point) (point-max))
567 (comint-send-string proc startfile)))
568 (run-hooks 'comint-exec-hook)
571 ;;; This auxiliary function cranks up the process for comint-exec in
572 ;;; the appropriate environment.
574 (defun comint-exec-1 (name buffer command switches)
575 (let ((process-environment process-environment))
576 (setenv "TERMCAP" (format "emacs:co#%d:tc=unknown" (frame-width)))
577 (setenv "TERM" "emacs")
579 (apply 'start-process name buffer command switches)))
581 ;;; Input history processing in a buffer
582 ;;; ===========================================================================
583 ;;; Useful input history functions, courtesy of the Ergo group.
586 ;;; comint-dynamic-list-input-ring List history in help buffer.
587 ;;; comint-previous-input Previous input...
588 ;;; comint-previous-matching-input ...matching a string.
589 ;;; comint-previous-matching-input-from-input ... matching the current input.
590 ;;; comint-next-input Next input...
591 ;;; comint-next-matching-input ...matching a string.
592 ;;; comint-next-matching-input-from-input ... matching the current input.
593 ;;; comint-backward-matching-input Backwards input...
594 ;;; comint-forward-matching-input ...matching a string.
595 ;;; comint-replace-by-expanded-history Expand history at point;
596 ;;; replace with expanded history.
597 ;;; comint-magic-space Expand history and insert space.
600 ;;; comint-read-input-ring Read into comint-input-ring...
601 ;;; comint-write-input-ring Write to comint-input-ring-file-name.
603 (defun comint-read-input-ring ()
604 "Sets the buffer's `comint-input-ring' from a history file.
605 The name of the file is given by the variable `comint-input-ring-file-name'.
606 The history ring is of size `comint-input-ring-size', regardless of file size.
607 If `comint-input-ring-file-name' is nil this function does nothing.
609 Useful within mode or mode hooks.
611 The structure of the history file should be one input command per line, and
612 most recent command last.
613 See also `comint-input-ignoredups' and `comint-write-input-ring'."
614 (cond ((or (null comint-input-ring-file-name)
615 (equal comint-input-ring-file-name ""))
617 ((not (file-readable-p comint-input-ring-file-name))
618 (message "Cannot read history file %s" comint-input-ring-file-name))
620 (let ((history-buf (get-file-buffer comint-input-ring-file-name))
621 (ring (make-ring comint-input-ring-size)))
623 (set-buffer (or history-buf
624 (find-file-noselect comint-input-ring-file-name)))
625 ;; Save restriction in case file is already visited...
626 ;; Watch for those date stamps in history files!
630 (goto-char (point-min))
631 (while (re-search-forward "^\\s *\\([^#].*\\)\\s *$" nil t)
632 (let ((history (buffer-substring (match-beginning 1)
634 (if (or (null comint-input-ignoredups)
636 (not (string-equal (ring-ref ring 0) history)))
637 (ring-insert ring history)))))
638 ;; Kill buffer unless already visited.
639 (if (null history-buf)
641 (setq comint-input-ring ring
642 comint-input-ring-index nil)))))
644 (defun comint-write-input-ring ()
645 "Writes the buffer's `comint-input-ring' to a history file.
646 The name of the file is given by the variable `comint-input-ring-file-name'.
647 The original contents of the file are lost if `comint-input-ring' is not empty.
648 If `comint-input-ring-file-name' is nil this function does nothing.
650 Useful within process sentinels.
652 See also `comint-read-input-ring'."
653 (cond ((or (null comint-input-ring-file-name)
654 (equal comint-input-ring-file-name "")
655 (null comint-input-ring) (ring-empty-p comint-input-ring))
657 ((not (file-writable-p comint-input-ring-file-name))
658 (message "Cannot write history file %s" comint-input-ring-file-name))
660 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
661 (ring comint-input-ring)
662 (file comint-input-ring-file-name)
663 (index (ring-length ring)))
664 ;; Write it all out into a buffer first. Much faster, but messier,
665 ;; than writing it one line at a time.
667 (set-buffer history-buf)
670 (setq index (1- index))
671 (insert (ring-ref ring index) ?\n))
672 (write-region (buffer-string) nil file nil 'no-message)
673 (kill-buffer nil))))))
676 (defun comint-dynamic-list-input-ring ()
677 "List in help buffer the buffer's input history."
679 (if (or (not (ring-p comint-input-ring))
680 (ring-empty-p comint-input-ring))
681 (message "No history")
683 (history-buffer " *Input History*")
684 (index (1- (ring-length comint-input-ring)))
685 (conf (current-window-configuration)))
686 ;; We have to build up a list ourselves from the ring vector.
688 (setq history (cons (ring-ref comint-input-ring index) history)
690 ;; Change "completion" to "history reference"
691 ;; to make the display accurate.
692 (with-output-to-temp-buffer history-buffer
693 (display-completion-list history)
694 (set-buffer history-buffer)
696 (while (search-backward "completion" nil 'move)
697 (replace-match "history reference")))
699 (message "Hit space to flush")
700 (let ((ch (read-event)))
702 (set-window-configuration conf)
703 (setq unread-command-events (list ch)))))))
706 (defun comint-regexp-arg (prompt)
707 ;; Return list of regexp and prefix arg using PROMPT.
708 (let* ((minibuffer-history-sexp-flag nil)
709 ;; Don't clobber this.
710 (last-command last-command)
711 (regexp (read-from-minibuffer prompt nil nil nil
712 'minibuffer-history-search-history)))
713 (list (if (string-equal regexp "")
714 (setcar minibuffer-history-search-history
715 (nth 1 minibuffer-history-search-history))
717 (prefix-numeric-value current-prefix-arg))))
719 (defun comint-search-arg (arg)
720 ;; First make sure there is a ring and that we are after the process mark
721 (cond ((not (comint-after-pmark-p))
722 (error "Not at command line"))
723 ((or (null comint-input-ring)
724 (ring-empty-p comint-input-ring))
725 (error "Empty input ring"))
727 ;; arg of zero resets search from beginning, and uses arg of 1
728 (setq comint-input-ring-index nil)
733 (defun comint-search-start (arg)
734 ;; Index to start a directional search, starting at comint-input-ring-index
735 (if comint-input-ring-index
736 ;; If a search is running, offset by 1 in direction of arg
737 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
738 (ring-length comint-input-ring))
739 ;; For a new search, start from beginning or end, as appropriate
741 0 ; First elt for forward search
742 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
744 (defun comint-previous-input-string (arg)
745 "Return the string ARG places along the input ring.
746 Moves relative to `comint-input-ring-index'."
747 (ring-ref comint-input-ring (if comint-input-ring-index
748 (mod (+ arg comint-input-ring-index)
749 (ring-length comint-input-ring))
752 (defun comint-previous-input (arg)
753 "Cycle backwards through input history."
755 (comint-previous-matching-input "." arg))
757 (defun comint-next-input (arg)
758 "Cycle forwards through input history."
760 (comint-previous-input (- arg)))
762 (defun comint-previous-matching-input-string (regexp arg)
763 "Return the string matching REGEXP ARG places along the input ring.
764 Moves relative to `comint-input-ring-index'."
765 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
766 (if pos (ring-ref comint-input-ring pos))))
768 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
769 "Return the index matching REGEXP ARG places along the input ring.
770 Moves relative to START, or `comint-input-ring-index'."
771 (if (or (not (ring-p comint-input-ring))
772 (ring-empty-p comint-input-ring))
773 (error "No history"))
774 (let* ((len (ring-length comint-input-ring))
775 (motion (if (> arg 0) 1 -1))
776 (n (mod (- (or start (comint-search-start arg)) motion) len))
777 (tried-each-ring-item nil)
779 ;; Do the whole search as many times as the argument says.
780 (while (and (/= arg 0) (not tried-each-ring-item))
783 n (mod (+ n motion) len))
784 ;; If we haven't reached a match, step some more.
785 (while (and (< n len) (not tried-each-ring-item)
786 (not (string-match regexp (ring-ref comint-input-ring n))))
787 (setq n (mod (+ n motion) len)
788 ;; If we have gone all the way around in this search.
789 tried-each-ring-item (= n prev)))
790 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
791 ;; Now that we know which ring element to use, if we found it, return that.
792 (if (string-match regexp (ring-ref comint-input-ring n))
795 (defun comint-previous-matching-input (regexp arg)
796 "Search backwards through input history for match for REGEXP.
797 \(Previous history elements are earlier commands.)
798 With prefix argument N, search for Nth previous match.
799 If N is negative, find the next or Nth next match."
800 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
801 (setq arg (comint-search-arg arg))
802 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
803 ;; Has a match been found?
806 (setq comint-input-ring-index pos)
807 (message "History item: %d" (1+ pos))
809 ;; Can't use kill-region as it sets this-command
810 (process-mark (get-buffer-process (current-buffer))) (point))
811 (insert (ring-ref comint-input-ring pos)))))
813 (defun comint-next-matching-input (regexp arg)
814 "Search forwards through input history for match for REGEXP.
815 \(Later history elements are more recent commands.)
816 With prefix argument N, search for Nth following match.
817 If N is negative, find the previous or Nth previous match."
818 (interactive (comint-regexp-arg "Next input matching (regexp): "))
819 (comint-previous-matching-input regexp (- arg)))
821 (defun comint-previous-matching-input-from-input (arg)
822 "Search backwards through input history for match for current input.
823 \(Previous history elements are earlier commands.)
824 With prefix argument N, search for Nth previous match.
825 If N is negative, find the next or Nth next match."
827 (if (not (memq last-command '(comint-previous-matching-input-from-input
828 comint-next-matching-input-from-input)))
829 ;; Starting a new search
830 (setq comint-matching-input-from-input-string
832 (process-mark (get-buffer-process (current-buffer)))
834 comint-input-ring-index nil))
835 (comint-previous-matching-input
836 (concat "^" (regexp-quote comint-matching-input-from-input-string))
839 (defun comint-next-matching-input-from-input (arg)
840 "Search forwards through input history for match for current input.
841 \(Previous history elements are earlier commands.)
842 With prefix argument N, search for Nth previous match.
843 If N is negative, find the next or Nth next match."
845 (comint-previous-matching-input-from-input (- arg)))
848 (defun comint-replace-by-expanded-history ()
849 "Expand input command history references before point.
850 This function depends on the buffer's idea of the input history, which may not
851 match the command interpreter's idea, assuming it has one.
853 Assumes history syntax is like typical Un*x shells'. However, since emacs
854 cannot know the interpreter's idea of input line numbers, assuming it has one,
855 it cannot expand absolute input line number references.
857 See also `comint-magic-space'."
860 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
861 (start (progn (comint-bol nil) (point))))
862 (while (re-search-forward
863 "[!^]" (save-excursion (end-of-line nil) (- (point) toend)) t)
864 ;; This seems a bit complex. We look for references such as !!, !-num,
865 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
866 ;; If that wasn't enough, the plings can be suffixed with argument
868 ;; Argument ranges are complex too, so we hive off the input line,
869 ;; referenced with plings, with the range string to `comint-args'.
870 (setq comint-input-ring-index nil)
871 (goto-char (match-beginning 0))
872 (cond ((or (= (preceding-char) ?\\)
873 (comint-within-quotes start (point)))
874 ;; The history is quoted, or we're in quotes.
875 (goto-char (match-end 0)))
876 ((looking-at "![0-9]+\\($\\|[^-]\\)")
877 ;; We cannot know the interpreter's idea of input line numbers.
878 (goto-char (match-end 0))
879 (message "Absolute reference cannot be expanded"))
880 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
881 ;; Just a number of args from `number' lines backward.
882 (let ((number (1- (string-to-number
883 (buffer-substring (match-beginning 1)
885 (if (<= number (ring-length comint-input-ring))
888 (comint-args (comint-previous-input-string number)
889 (match-beginning 2) (match-end 2)) t t)
890 (setq comint-input-ring-index number)
891 (message "History item: %d" (1+ number)))
892 (goto-char (match-end 0))
893 (message "Relative reference exceeds input history size"))))
894 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
895 ;; Just a number of args from the previous input line.
897 (comint-args (comint-previous-input-string 0)
898 (match-beginning 1) (match-end 1)) t t))
900 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
901 ;; Most recent input starting with or containing (possibly
902 ;; protected) string, maybe just a number of args. Phew.
903 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
904 (mb2 (match-beginning 2)) (me2 (match-end 2))
905 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
906 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
907 (pos (save-match-data
908 (comint-previous-matching-input-string-position
909 (concat pref (regexp-quote exp)) 1))))
911 (progn (message "Not found")
912 (goto-char (match-end 0))
914 (setq comint-input-ring-index pos)
915 (message "History item: %d" (1+ pos))
917 (comint-args (ring-ref comint-input-ring pos)
918 (match-beginning 4) (match-end 4))
920 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
921 ;; Quick substitution on the previous input line.
922 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
923 (new (buffer-substring (match-beginning 2) (match-end 2)))
925 (replace-match (comint-previous-input-string 0) t t)
927 (goto-char (match-beginning 0))
928 (if (search-forward old pos t)
929 (replace-match new t t)
930 (message "Not found")
933 (goto-char (match-end 0))))))))
936 (defun comint-magic-space (arg)
937 "Expand input history references before point and insert ARG spaces.
938 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
940 (comint-replace-by-expanded-history)
941 (self-insert-command arg))
943 (defun comint-within-quotes (beg end)
944 "Return t if the number of quotes between BEG and END is odd.
945 Quotes are single and double."
946 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
947 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
948 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
950 (defun comint-how-many-region (regexp beg end)
951 "Return number of matches for REGEXP from BEG to END."
956 (while (re-search-forward regexp end t)
957 (setq count (1+ count)))))
960 (defun comint-args (string begin end)
961 ;; From STRING, return the args depending on the range specified in the text
962 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
963 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
966 (comint-arguments string 0 nil)
967 (let* ((range (buffer-substring
968 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
969 (nth (cond ((string-match "^[*^]" range) 1)
970 ((string-match "^-" range) 0)
971 ((string-equal range "$") nil)
972 (t (string-to-number range))))
973 (mth (cond ((string-match "[-*$]$" range) nil)
974 ((string-match "-" range)
975 (string-to-number (substring range (match-end 0))))
977 (comint-arguments string nth mth)))))
979 (defun comint-delim-arg (arg)
980 ;; Return a list of arguments from ARG. If there's a quote in there, just
981 ;; a list of the arg, otherwise try and break up using characters in
982 ;; comint-delimiter-argument-list. Returned list is backwards.
983 (if (or (null comint-delimiter-argument-list)
984 (string-match "[\"\'\`]" arg))
986 (let ((not-delim (concat
987 (format "\\([^%s]" (mapconcat
988 (function (lambda (d) (regexp-quote d)))
989 comint-delimiter-argument-list ""))
991 (mapconcat (function (lambda (d)
992 (concat "\\\\" (regexp-quote d))))
993 comint-delimiter-argument-list "\\|")
995 (delim-str (mapconcat (function (lambda (d)
996 (concat (regexp-quote d) "+")))
997 comint-delimiter-argument-list "\\|"))
999 (while (or (eq pos (string-match not-delim arg pos))
1000 (eq pos (string-match delim-str arg pos)))
1001 (setq pos (match-end 0)
1002 args (cons (substring arg (match-beginning 0) pos) args)))
1005 (defun comint-arguments (string nth mth)
1006 "Return from STRING the NTH to MTH arguments.
1007 NTH and/or MTH can be nil, which means the last argument.
1008 Returned arguments are separated by single spaces. Arguments are assumed to be
1009 delimited by whitespace. Strings comprising characters in the variable
1010 `comint-delimiter-argument-list' are treated as delimiters and arguments.
1011 Argument 0 is the command name."
1012 (let ((arg "\\(\\S \\|\\(\"[^\"]*\"\\|\'[^\']*\'\\|\`[^\`]*\`\\)\\)+")
1013 (args ()) (pos 0) (str nil))
1014 ;; We build a list of all the args. Unnecessary, but more efficient, when
1015 ;; ranges of args are required, than picking out one by one and recursing.
1016 (while (string-match arg string pos)
1017 (setq pos (match-end 0)
1018 str (substring string (match-beginning 0) pos)
1019 args (nconc (comint-delim-arg str) args)))
1020 (let ((n (or nth (1- (length args))))
1021 (m (if mth (1- (- (length args) mth)) 0)))
1023 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1026 ;;; Input processing stuff
1029 (defun comint-send-input ()
1030 "Send input to process.
1031 After the process output mark, sends all text from the process mark to
1032 point as input to the process. Before the process output mark, calls value
1033 of variable `comint-get-old-input' to retrieve old input, copies it to the
1034 process mark, and sends it. If variable `comint-process-echoes' is nil,
1035 a terminal newline is also inserted into the buffer and sent to the process
1036 \(if it is non-nil, all text from the process mark to point is deleted,
1037 since it is assumed the remote process will re-echo it).
1039 Any history reference may be expanded depending on the value of the variable
1040 `comint-input-autoexpand'. The value of variable `comint-input-sentinel' is
1041 called on the input before sending it. The input is entered into the input
1042 history ring, if the value of variable `comint-input-filter' returns non-nil
1043 when called on the input.
1045 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1046 end of line before sending the input.
1048 `comint-get-old-input', `comint-input-sentinel', and `comint-input-filter'
1049 are chosen according to the command interpreter running in the buffer. E.g.,
1050 If the interpreter is the csh,
1051 comint-get-old-input is the default: take the current line, discard any
1052 initial string matching regexp comint-prompt-regexp.
1053 comint-input-sentinel monitors input for \"cd\", \"pushd\", and \"popd\"
1054 commands. When it sees one, it cd's the buffer.
1055 comint-input-filter is the default: returns t if the input isn't all white
1058 If the comint is Lucid Common Lisp,
1059 comint-get-old-input snarfs the sexp ending at point.
1060 comint-input-sentinel does nothing.
1061 comint-input-filter returns nil if the input matches input-filter-regexp,
1062 which matches (1) all whitespace (2) :a, :c, etc.
1064 Similarly for Soar, Scheme, etc."
1066 ;; Note that the input string does not include its terminal newline.
1067 (let ((proc (get-buffer-process (current-buffer))))
1068 (if (not proc) (error "Current buffer has no process")
1069 (let* ((pmark (process-mark proc))
1070 (intxt (if (>= (point) (marker-position pmark))
1071 (progn (if comint-eol-on-send (end-of-line))
1072 (buffer-substring pmark (point)))
1073 (let ((copy (funcall comint-get-old-input)))
1077 (input (if (not (eq comint-input-autoexpand 'input))
1078 ;; Just whatever's already there
1080 ;; Expand and leave it visible in buffer
1081 (comint-replace-by-expanded-history)
1082 (buffer-substring pmark (point))))
1083 (history (if (not (eq comint-input-autoexpand 'history))
1084 (comint-arguments input 0 nil)
1085 ;; This is messy 'cos ultimately the original
1086 ;; functions used do insertion, rather than return
1087 ;; strings. We have to expand, then insert back.
1088 (comint-replace-by-expanded-history)
1089 (buffer-substring pmark (point)))))
1090 (if comint-process-echoes
1091 (delete-region pmark (point))
1093 (if (and (funcall comint-input-filter history)
1094 (or (null comint-input-ignoredups)
1095 (not (ring-p comint-input-ring))
1096 (ring-empty-p comint-input-ring)
1097 (not (string-equal (ring-ref comint-input-ring 0)
1099 (ring-insert comint-input-ring history))
1100 (funcall comint-input-sentinel input)
1101 (funcall comint-input-sender proc input)
1102 (setq comint-input-ring-index nil)
1103 (set-marker comint-last-input-start pmark)
1104 (set-marker comint-last-input-end (point))
1105 (set-marker (process-mark proc) (point))
1106 ;; A kludge to prevent the delay between insert and process output
1107 ;; affecting the display. A case for a comint-send-input-hook?
1108 (if (eq (process-filter proc) 'comint-output-filter)
1109 (let ((functions comint-output-filter-functions))
1111 (funcall (car functions) (concat input "\n"))
1112 (setq functions (cdr functions)))))))))
1114 ;; The purpose of using this filter for comint processes
1115 ;; is to keep comint-last-input-end from moving forward
1116 ;; when output is inserted.
1117 (defun comint-output-filter (process string)
1118 ;; First check for killed buffer
1119 (let ((oprocbuf (process-buffer process)))
1120 (if (and oprocbuf (buffer-name oprocbuf))
1121 (let ((obuf (current-buffer))
1122 (opoint nil) (obeg nil) (oend nil))
1123 (set-buffer oprocbuf)
1124 (setq opoint (point))
1125 (setq obeg (point-min))
1126 (setq oend (point-max))
1127 (let ((buffer-read-only nil)
1128 (nchars (length string))
1131 (goto-char (process-mark process))
1132 (setq ostart (point))
1133 (if (<= (point) opoint)
1134 (setq opoint (+ opoint nchars)))
1135 ;; Insert after old_begv, but before old_zv.
1136 (if (< (point) obeg)
1137 (setq obeg (+ obeg nchars)))
1138 (if (<= (point) oend)
1139 (setq oend (+ oend nchars)))
1140 (insert-before-markers string)
1141 ;; Don't insert initial prompt outside the top of the window.
1142 (if (= (window-start (selected-window)) (point))
1143 (set-window-start (selected-window) (- (point) (length string))))
1144 (if (and comint-last-input-end
1145 (marker-buffer comint-last-input-end)
1146 (= (point) comint-last-input-end))
1147 (set-marker comint-last-input-end (- comint-last-input-end nchars)))
1148 (set-marker comint-last-output-start ostart)
1149 (set-marker (process-mark process) (point))
1150 (force-mode-line-update))
1152 (narrow-to-region obeg oend)
1154 (let ((functions comint-output-filter-functions))
1156 (funcall (car functions) string)
1157 (setq functions (cdr functions))))
1158 (set-buffer obuf)))))
1160 (defun comint-preinput-scroll-to-bottom ()
1161 "Go to the end of buffer in all windows showing it.
1162 Movement occurs if point in the selected window is not after the process mark,
1163 and `this-command' is an insertion command. Insertion commands recognised
1164 are `self-insert-command', `comint-magic-space', `yank', `mouse-yank-at-click',
1166 Depends on the value of `comint-scroll-to-bottom-on-input'.
1168 This function should be a pre-command hook."
1169 (if (and comint-scroll-to-bottom-on-input
1170 (memq this-command '(self-insert-command comint-magic-space yank
1171 mouse-yank-at-click hilit-yank)))
1172 (let* ((selected (selected-window))
1173 (current (current-buffer))
1174 (process (get-buffer-process current))
1175 (scroll comint-scroll-to-bottom-on-input))
1176 (if (and process (< (point) (process-mark process))
1177 scroll (not (window-minibuffer-p selected)))
1178 (if (eq scroll 'this)
1179 (goto-char (point-max))
1181 (function (lambda (window)
1182 (if (and (eq (window-buffer window) current)
1183 (or (eq scroll t) (eq scroll 'all)
1184 (and (eq scroll 'this) (eq selected window))))
1186 (select-window window)
1187 (goto-char (point-max))
1188 (select-window selected)))))
1189 'not-minibuf t))))))
1191 (defun comint-postoutput-scroll-to-bottom (string)
1192 "Go to the end of buffer in all windows showing it.
1193 Does not scroll if the current line is the last line in the buffer.
1194 Depends on the value of `comint-scroll-to-bottom-on-output' and
1195 `comint-scroll-show-maximum-output'.
1197 This function should be in the list `comint-output-filter-functions'."
1198 (let* ((selected (selected-window))
1199 (current (current-buffer))
1200 (process (get-buffer-process current))
1201 (scroll comint-scroll-to-bottom-on-output))
1204 (function (lambda (window)
1205 (if (eq (window-buffer window) current)
1207 (select-window window)
1208 (if (and (< (point) (process-mark process))
1209 (or (eq scroll t) (eq scroll 'all)
1210 ;; Maybe user wants point to jump to the end.
1211 (and (eq scroll 'this) (eq selected window))
1212 (and (eq scroll 'others) (not (eq selected window)))
1213 ;; If point was at the end, keep it at the end.
1215 (- (process-mark process) (length string)))))
1216 (goto-char (process-mark process)))
1217 ;; Optionally scroll so that the text
1218 ;; ends at the bottom of the window.
1219 (if (and comint-scroll-show-maximum-output
1220 (>= (point) (process-mark process)))
1222 (goto-char (point-max))
1224 (select-window selected)))))
1227 (defun comint-show-maximum-output ()
1228 "Put the end of the buffer at the bottom of the window."
1230 (goto-char (point-max))
1233 (defun comint-get-old-input-default ()
1234 "Default for `comint-get-old-input'.
1235 Take the current line, and discard any initial text matching
1236 `comint-prompt-regexp'."
1239 (comint-skip-prompt)
1240 (let ((beg (point)))
1242 (buffer-substring beg (point)))))
1244 (defun comint-copy-old-input ()
1245 "Insert after prompt old input at point as new input to be edited.
1246 Calls `comint-get-old-input' to get old input."
1248 (let ((input (funcall comint-get-old-input))
1249 (process (get-buffer-process (current-buffer))))
1251 (error "Current buffer has no process")
1252 (goto-char (process-mark process))
1255 (defun comint-skip-prompt ()
1256 "Skip past the text matching regexp `comint-prompt-regexp'.
1257 If this takes us past the end of the current line, don't skip at all."
1258 (let ((eol (save-excursion (end-of-line) (point))))
1259 (if (and (looking-at comint-prompt-regexp)
1260 (<= (match-end 0) eol))
1261 (goto-char (match-end 0)))))
1263 (defun comint-after-pmark-p ()
1264 "Return t if point is after the process output marker."
1265 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1266 (<= (marker-position pmark) (point))))
1268 (defun comint-simple-send (proc string)
1269 "Default function for sending to PROC input STRING.
1270 This just sends STRING plus a newline. To override this,
1271 set the hook `comint-input-sender'."
1272 (comint-send-string proc string)
1273 (comint-send-string proc "\n"))
1275 (defun comint-bol (arg)
1276 "Goes to the beginning of line, then skips past the prompt, if any.
1277 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1279 The prompt skip is done by skipping text matching the regular expression
1280 `comint-prompt-regexp', a buffer local variable.
1282 If you don't like this command, bind C-a to `beginning-of-line'
1283 in your hook, `comint-mode-hook'."
1286 (if (null arg) (comint-skip-prompt)))
1288 ;;; These two functions are for entering text you don't want echoed or
1289 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
1290 ;;; Just enter m-x send-invisible and type in your line.
1292 (defun comint-read-noecho (prompt &optional stars)
1293 "Read a single line of text from user without echoing, and return it.
1294 Prompt with argument PROMPT, a string. Optional argument STARS causes
1295 input to be echoed with '*' characters on the prompt line. Input ends with
1296 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1297 `inhibit-quit' is set because e.g. this function was called from a process
1298 filter and C-g is pressed, this function returns nil rather than a string).
1300 Note that the keystrokes comprising the text can still be recovered
1301 \(temporarily) with \\[view-lossage]. This may be a security bug for some
1306 (cursor-in-echo-area t)
1310 (message "%s%s" prompt (make-string (length ans) ?*))
1312 (setq c (read-char))
1314 ;; This function may get called from a process filter, where
1315 ;; inhibit-quit is set. In later versions of emacs read-char
1316 ;; may clear quit-flag itself and return C-g. That would make
1317 ;; it impossible to quit this loop in a simple way, so
1318 ;; re-enable it here (for backward-compatibility the check for
1319 ;; quit-flag below would still be necessary, so this is seems
1320 ;; like the simplest way to do things).
1323 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1327 ((and (/= c ?\b) (/= c ?\177))
1328 (setq ans (concat ans (char-to-string c))))
1330 (setq ans (substring ans 0 -1)))))
1332 ;; Emulate a true quit, except that we have to return a value.
1334 (setq quit-flag nil)
1340 (defun send-invisible (str)
1341 "Read a string without echoing.
1342 Then send it to the process running in the current buffer. A new-line
1343 is additionally sent. String is not saved on comint input history list.
1344 Security bug: your string can still be temporarily recovered with
1346 (interactive "P") ; Defeat snooping via C-x esc
1347 (let ((proc (get-buffer-process (current-buffer))))
1348 (if (not proc) (error "Current buffer has no process")
1349 (comint-send-string proc
1350 (if (stringp str) str
1351 (comint-read-noecho "Non-echoed text: " t)))
1352 (comint-send-string proc "\n"))))
1355 ;;; Low-level process communication
1357 (defvar comint-input-chunk-size 512
1358 "*Long inputs are sent to comint processes in chunks of this size.
1359 If your process is choking on big inputs, try lowering the value.")
1361 (defun comint-send-string (proc str)
1362 "Send PROCESS the contents of STRING as input.
1363 This is equivalent to `process-send-string', except that long input strings
1364 are broken up into chunks of size `comint-input-chunk-size'. Processes
1365 are given a chance to output between chunks. This can help prevent processes
1366 from hanging when you send them long inputs on some OS's."
1367 (let* ((len (length str))
1368 (i (min len comint-input-chunk-size)))
1369 (process-send-string proc (substring str 0 i))
1371 (let ((next-i (+ i comint-input-chunk-size)))
1372 (accept-process-output)
1374 (process-send-string proc (substring str i (min len next-i)))
1377 (defun comint-send-region (proc start end)
1378 "Sends to PROC the region delimited by START and END.
1379 This is a replacement for `process-send-region' that tries to keep
1380 your process from hanging on long inputs. See `comint-send-string'."
1381 (comint-send-string proc (buffer-substring start end)))
1383 ;;; Random input hackage
1385 (defun comint-kill-output ()
1386 "Kill all output from interpreter since last input.
1387 Does not delete the prompt."
1389 (let ((pmark (progn (goto-char
1390 (process-mark (get-buffer-process (current-buffer))))
1391 (beginning-of-line nil)
1393 (kill-region comint-last-input-end pmark)
1394 (insert "*** output flushed ***\n")
1395 (comint-skip-prompt)
1396 (set-marker pmark (point))))
1398 (defun comint-show-output ()
1399 "Display start of this batch of interpreter output at top of window.
1400 Also put cursor there if the current position is not visible."
1402 (let ((pos (point)))
1403 (goto-char comint-last-input-end)
1404 (beginning-of-line 0)
1405 (set-window-start (selected-window) (point))
1406 (if (pos-visible-in-window-p pos)
1408 (comint-skip-prompt))))
1410 (defun comint-interrupt-subjob ()
1411 "Interrupt the current subjob."
1413 (interrupt-process nil comint-ptyp))
1415 (defun comint-kill-subjob ()
1416 "Send kill signal to the current subjob."
1418 (kill-process nil comint-ptyp))
1420 (defun comint-quit-subjob ()
1421 "Send quit signal to the current subjob."
1423 (quit-process nil comint-ptyp))
1425 (defun comint-stop-subjob ()
1426 "Stop the current subjob.
1427 WARNING: if there is no current subjob, you can end up suspending
1428 the top-level process running in the buffer. If you accidentally do
1429 this, use \\[comint-continue-subjob] to resume the process. (This
1430 is not a problem with most shells, since they ignore this signal.)"
1432 (stop-process nil comint-ptyp))
1434 (defun comint-continue-subjob ()
1435 "Send CONT signal to process buffer's process group.
1436 Useful if you accidentally suspend the top-level process."
1438 (continue-process nil comint-ptyp))
1440 (defun comint-kill-input ()
1441 "Kill all text from last stuff output by interpreter to point."
1443 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1444 (if (> (point) (marker-position pmark))
1445 (kill-region pmark (point)))))
1447 (defun comint-delchar-or-maybe-eof (arg)
1448 "Delete ARG characters forward, or (if at eob) send an EOF to subprocess."
1454 (defun comint-send-eof ()
1455 "Send an EOF to the current buffer's process."
1460 (defun comint-backward-matching-input (regexp arg)
1461 "Search backward through buffer for match for REGEXP.
1462 Matches are searched for on lines that match `comint-prompt-regexp'.
1463 With prefix argument N, search for Nth previous match.
1464 If N is negative, find the next or Nth next match."
1465 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
1466 (let* ((re (concat comint-prompt-regexp ".*" regexp))
1467 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
1468 (if (re-search-backward re nil t arg)
1471 (progn (message "Not found")
1476 (defun comint-forward-matching-input (regexp arg)
1477 "Search forward through buffer for match for REGEXP.
1478 Matches are searched for on lines that match `comint-prompt-regexp'.
1479 With prefix argument N, search for Nth following match.
1480 If N is negative, find the previous or Nth previous match."
1481 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
1482 (comint-backward-matching-input regexp (- arg)))
1485 (defun comint-next-prompt (n)
1486 "Move to end of Nth next prompt in the buffer.
1487 See `comint-prompt-regexp'."
1489 (let ((paragraph-start comint-prompt-regexp))
1490 (end-of-line (if (> n 0) 1 0))
1491 (forward-paragraph n)
1492 (comint-skip-prompt)))
1494 (defun comint-previous-prompt (n)
1495 "Move to end of Nth previous prompt in the buffer.
1496 See `comint-prompt-regexp'."
1498 (comint-next-prompt (- n)))
1500 ;;; Support for source-file processing commands.
1501 ;;;============================================================================
1502 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1503 ;;; commands that process files of source text (e.g. loading or compiling
1504 ;;; files). So the corresponding process-in-a-buffer modes have commands
1505 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
1506 ;;; for defining these commands.
1508 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1509 ;;; and Soar, in that they don't know anything about file extensions.
1510 ;;; So the compile/load interface gets the wrong default occasionally.
1511 ;;; The load-file/compile-file default mechanism could be smarter -- it
1512 ;;; doesn't know about the relationship between filename extensions and
1513 ;;; whether the file is source or executable. If you compile foo.lisp
1514 ;;; with compile-file, then the next load-file should use foo.bin for
1515 ;;; the default, not foo.lisp. This is tricky to do right, particularly
1516 ;;; because the extension for executable files varies so much (.o, .bin,
1517 ;;; .lbin, .mo, .vo, .ao, ...).
1520 ;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1523 ;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1524 ;;; want to save the buffer before issuing any process requests to the command
1527 ;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1528 ;;; for the file to process.
1530 ;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1531 ;;;============================================================================
1532 ;;; This function computes the defaults for the load-file and compile-file
1533 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
1535 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1536 ;;; source-file processing command. NIL if there hasn't been one yet.
1537 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
1538 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1539 ;;; Typically, (lisp-mode) or (scheme-mode).
1541 ;;; If the command is given while the cursor is inside a string, *and*
1542 ;;; the string is an existing filename, *and* the filename is not a directory,
1543 ;;; then the string is taken as default. This allows you to just position
1544 ;;; your cursor over a string that's a filename and have it taken as default.
1546 ;;; If the command is given in a file buffer whose major mode is in
1547 ;;; SOURCE-MODES, then the the filename is the default file, and the
1548 ;;; file's directory is the default directory.
1550 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1551 ;;; then the default directory & file are what was used in the last source-file
1552 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1553 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1554 ;;; is the cwd, with no default file. (\"no default file\" = nil)
1556 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1557 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1558 ;;; for Soar programs, etc.
1560 ;;; The function returns a pair: (default-directory . default-file).
1562 (defun comint-source-default (previous-dir/file source-modes)
1563 (cond ((and buffer-file-name (memq major-mode source-modes))
1564 (cons (file-name-directory buffer-file-name)
1565 (file-name-nondirectory buffer-file-name)))
1568 (cons default-directory nil))))
1571 ;;; (COMINT-CHECK-SOURCE fname)
1572 ;;;============================================================================
1573 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1574 ;;; process-in-a-buffer modes), this function can be called on the filename.
1575 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
1576 ;;; is queried to see if he wants to save the buffer before proceeding with
1577 ;;; the load or compile.
1579 (defun comint-check-source (fname)
1580 (let ((buff (get-file-buffer fname)))
1582 (buffer-modified-p buff)
1583 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
1585 (let ((old-buffer (current-buffer)))
1588 (set-buffer old-buffer)))))
1591 ;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1592 ;;;============================================================================
1593 ;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1594 ;;; commands that process source files (like loading or compiling a file).
1595 ;;; It prompts for the filename, provides a default, if there is one,
1596 ;;; and returns the result filename.
1598 ;;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1600 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1601 ;;; from the last source processing command. SOURCE-MODES is a list of major
1602 ;;; modes used to determine what file buffers contain source files. (These
1603 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1604 ;;; then the filename reader will only accept a file that exists.
1607 ;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1608 ;;; '(lisp-mode) t))
1610 ;;; This is pretty stupid about strings. It decides we're in a string
1611 ;;; if there's a quote on both sides of point on the current line.
1612 (defun comint-extract-string ()
1613 "Return string around POINT that starts the current line, or nil."
1615 (let* ((point (point))
1616 (bol (progn (beginning-of-line) (point)))
1617 (eol (progn (end-of-line) (point)))
1618 (start (progn (goto-char point)
1619 (and (search-backward "\"" bol t)
1621 (end (progn (goto-char point)
1622 (and (search-forward "\"" eol t)
1625 (buffer-substring start end)))))
1627 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
1628 (let* ((def (comint-source-default prev-dir/file source-modes))
1629 (stringfile (comint-extract-string))
1630 (sfile-p (and stringfile
1632 (file-exists-p stringfile)
1634 (not (file-directory-p stringfile))))
1635 (defdir (if sfile-p (file-name-directory stringfile)
1637 (deffile (if sfile-p (file-name-nondirectory stringfile)
1639 (ans (read-file-name (if deffile (format "%s(default %s) "
1643 (concat defdir deffile)
1645 (list (expand-file-name (substitute-in-file-name ans)))))
1647 ;;; I am somewhat divided on this string-default feature. It seems
1648 ;;; to violate the principle-of-least-astonishment, in that it makes
1649 ;;; the default harder to predict, so you actually have to look and see
1650 ;;; what the default really is before choosing it. This can trip you up.
1651 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1656 ;;; Simple process query facility.
1657 ;;; ===========================================================================
1658 ;;; This function is for commands that want to send a query to the process
1659 ;;; and show the response to the user. For example, a command to get the
1660 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1661 ;;; to an inferior Common Lisp process.
1663 ;;; This simple facility just sends strings to the inferior process and pops
1664 ;;; up a window for the process buffer so you can see what the process
1665 ;;; responds with. We don't do anything fancy like try to intercept what the
1666 ;;; process responds with and put it in a pop-up window or on the message
1667 ;;; line. We just display the buffer. Low tech. Simple. Works good.
1669 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1670 ;;; a window for the inferior process so that its response can be seen.
1671 (defun comint-proc-query (proc str)
1672 (let* ((proc-buf (process-buffer proc))
1673 (proc-mark (process-mark proc)))
1674 (display-buffer proc-buf)
1675 (set-buffer proc-buf) ; but it's not the selected *window*
1676 (let ((proc-win (get-buffer-window proc-buf))
1677 (proc-pt (marker-position proc-mark)))
1678 (comint-send-string proc str) ; send the query
1679 (accept-process-output proc) ; wait for some output
1680 ;; Try to position the proc window so you can see the answer.
1681 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1682 ;; I don't know why. Wizards invited to improve it.
1683 (if (not (pos-visible-in-window-p proc-pt proc-win))
1684 (let ((opoint (window-point proc-win)))
1685 (set-window-point proc-win proc-mark)
1687 (if (not (pos-visible-in-window-p opoint proc-win))
1689 (set-window-point proc-win opoint)))))))
1692 ;;; Filename/command/history completion in a buffer
1693 ;;; ===========================================================================
1694 ;;; Useful completion functions, courtesy of the Ergo group.
1697 ;;; comint-dynamic-complete Complete or expand command, filename,
1698 ;;; history at point.
1699 ;;; comint-dynamic-complete-filename Complete filename at point.
1700 ;;; comint-dynamic-complete-variable Complete variable at point.
1701 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
1702 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
1703 ;;; replace with expanded/completed name.
1704 ;;; comint-dynamic-simple-complete Complete stub given candidates.
1706 ;;; Four hooks (defined above):
1707 ;;; comint-dynamic-complete-filename-command Complete file name at point.
1708 ;;; comint-dynamic-complete-command-command Complete command at point.
1709 ;;; comint-get-current-command Return command at point.
1710 ;;; comint-after-partial-filename-command Return non-nil if after file.
1712 ;;; These are not installed in the comint-mode keymap. But they are
1713 ;;; available for people who want them. Shell-mode installs them:
1714 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1715 ;;; (define-key shell-mode-map "\M-?"
1716 ;;; 'comint-dynamic-list-filename-completions)))
1718 ;;; Commands like this are fine things to put in load hooks if you
1719 ;;; want them present in specific modes.
1721 (defvar comint-completion-autolist nil
1722 "*If non-nil, automatically list possiblities on partial completion.
1723 This mirrors the optional behavior of tcsh.")
1725 (defvar comint-completion-addsuffix t
1726 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1727 This mirrors the optional behavior of tcsh.")
1729 (defvar comint-completion-recexact nil
1730 "*If non-nil, use shortest completion if characters cannot be added.
1731 This mirrors the optional behavior of tcsh.
1733 A non-nil value is useful if `comint-completion-autolist' is non-nil too.")
1735 (defvar comint-file-name-prefix ""
1736 "Prefix prepended to absolute file names taken from process input.
1737 This is used by comint's and shell's completion functions, and by shell's
1738 directory tracking functions.")
1741 (defun comint-directory (directory)
1742 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1743 (expand-file-name (if (file-name-absolute-p directory)
1744 (concat comint-file-name-prefix directory)
1748 (defun comint-match-partial-filename ()
1749 "Return the filename at point, or signal an error.
1750 Environment variables are substituted."
1752 (if (re-search-backward "[^~/A-Za-z0-9+@:_.$#,={}-]" nil 'move)
1754 ;; Anchor the search forwards.
1755 (if (not (looking-at "[~/A-Za-z0-9+@:_.$#,={}-]")) (error ""))
1756 (re-search-forward "[~/A-Za-z0-9+@:_.$#,={}-]+")
1757 (substitute-in-file-name
1758 (buffer-substring (match-beginning 0) (match-end 0)))))
1761 (defun comint-match-partial-variable ()
1762 "Return the variable at point, or signal an error."
1764 (if (re-search-backward "[^A-Za-z0-9_${}]" nil 'move)
1766 ;; Anchor the search forwards.
1767 (if (not (looking-at "\\$")) (error ""))
1768 (re-search-forward "\\${?[A-Za-z0-9_]+}?")
1769 (buffer-substring (match-beginning 0) (match-end 0))))
1772 (defun comint-after-partial-filename ()
1773 "Returns t if point is after a file name.
1774 File names are assumed to contain `/'s or not be the first item in the input.
1776 See also `comint-bol'."
1777 (let ((filename (comint-match-partial-filename)))
1778 (or (save-match-data (string-match "/" filename))
1779 (not (eq (match-beginning 0)
1780 (save-excursion (comint-bol nil) (point)))))))
1783 (defun comint-dynamic-complete ()
1784 "Dynamically complete/expand the command/filename/history at point.
1785 If the text contains (a non-absolute line reference) `!' or `^' and
1786 `comint-input-autoexpand' is non-nil, then an attempt is made to complete the
1787 history. The value of the variable `comint-after-partial-filename-command' is
1788 used to match file names. Otherwise, an attempt is made to complete the
1791 See also the variables `comint-after-partial-filename-command',
1792 `comint-dynamic-complete-filename-command', and
1793 `comint-dynamic-complete-command-command', and functions
1794 `comint-replace-by-expanded-history' and `comint-magic-space'."
1796 (let ((previous-modified-tick (buffer-modified-tick)))
1797 (if (and comint-input-autoexpand
1798 (string-match "[!^]" (funcall comint-get-current-command)))
1799 ;; Looks like there might be history references in the command.
1800 (comint-replace-by-expanded-history))
1801 (if (= previous-modified-tick (buffer-modified-tick))
1802 ;; No references were expanded, so maybe they were none after all.
1803 (cond ((funcall comint-after-partial-filename-command)
1804 ;; It's a file name.
1805 (funcall comint-dynamic-complete-filename-command))
1807 ;; Assume it's a command.
1808 (funcall comint-dynamic-complete-command-command))))))
1811 (defun comint-dynamic-complete-filename ()
1812 "Dynamically complete the filename at point.
1813 This function is similar to `comint-replace-by-expanded-filename', except that
1814 it won't change parts of the filename already entered in the buffer; it just
1815 adds completion characters to the end of the filename. A completions listing
1816 may be shown in a help buffer if completion is ambiguous.
1818 Completion is dependent on the value of `comint-completion-addsuffix' and
1819 `comint-completion-recexact', and the timing of completions listing is
1820 dependent on the value of `comint-completion-autolist'."
1822 (let* ((completion-ignore-case nil)
1823 (filename (comint-match-partial-filename))
1824 (pathdir (file-name-directory filename))
1825 (pathnondir (file-name-nondirectory filename))
1826 (directory (if pathdir (comint-directory pathdir) default-directory))
1827 (completion (file-name-completion pathnondir directory)))
1828 (cond ((null completion)
1829 (message "No completions of %s" filename)
1831 ((eq completion t) ; Means already completed "file".
1832 (if comint-completion-addsuffix (insert " "))
1833 (message "Sole completion"))
1834 ((string-equal completion "") ; Means completion on "directory/".
1835 (comint-dynamic-list-filename-completions))
1836 (t ; Completion string returned.
1837 (let ((file (concat (file-name-as-directory directory) completion)))
1838 (goto-char (match-end 0))
1839 (insert (substring (directory-file-name completion)
1840 (length pathnondir)))
1841 (cond ((symbolp (file-name-completion completion directory))
1842 ;; We inserted a unique completion.
1843 (if comint-completion-addsuffix
1844 (insert (if (file-directory-p file) "/" " ")))
1845 (message "Completed"))
1846 ((and comint-completion-recexact comint-completion-addsuffix
1847 (string-equal pathnondir completion)
1848 (file-exists-p file))
1849 ;; It's not unique, but user wants shortest match.
1850 (insert (if (file-directory-p file) "/" " "))
1851 (message "Completed shortest"))
1852 ((or comint-completion-autolist
1853 (string-equal pathnondir completion))
1854 ;; It's not unique, list possible completions.
1855 (comint-dynamic-list-filename-completions))
1857 (message "Partially completed"))))))))
1860 (defun comint-replace-by-expanded-filename ()
1861 "Dynamically expand and complete the filename at point.
1862 Replace the filename with an expanded, canonicalised and completed replacement.
1863 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
1864 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
1865 removed, and the filename is made absolute instead of relative. For expansion
1866 see `expand-file-name' and `substitute-in-file-name'. For completion see
1867 `comint-dynamic-complete-filename'."
1869 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
1870 (comint-dynamic-complete-filename))
1873 (defun comint-dynamic-complete-variable ()
1874 "Dynamically complete the environment variable at point.
1875 This function is similar to `comint-dynamic-complete-filename', except that it
1876 searches `process-environment' for completion candidates. Note that this may
1877 not be the same as the interpreter's idea of variable names. The main
1878 problem with this type of completion is that `process-environment' is the
1879 environment which Emacs started with. Emacs does not track changes to the
1880 environment made by the interpreter. Perhaps it would be more accurate if this
1881 function was called `comint-dynamic-complete-process-environment-variable'.
1883 See also `comint-dynamic-complete-filename'."
1885 (let* ((completion-ignore-case nil)
1886 (variable (comint-match-partial-variable))
1887 (varname (substring variable (string-match "[^$({]" variable)))
1888 (protection (cond ((string-match "{" variable) "}")
1889 ((string-match "(" variable) ")")
1891 (variables (mapcar (function (lambda (x)
1892 (list (substring x 0 (string-match "=" x)))))
1893 process-environment))
1895 (function (lambda (var)
1897 (comint-directory (substitute-in-file-name (concat "$" var)))))))
1898 (completions (all-completions varname variables)))
1899 ;; Complete variable as if its value were a filename (which it might be).
1900 (cond ((null completions)
1901 (message "No completions of %s" varname)
1903 ((= 1 (length completions)) ; Gotcha!
1904 (let ((completion (car completions)))
1905 (if (string-equal completion varname)
1906 (message "Sole completion")
1907 (insert (substring (directory-file-name completion)
1909 (message "Completed"))
1911 (if comint-completion-addsuffix
1912 (insert (if (funcall var-directory-p completion) "/" " ")))))
1913 (t ; There's no unique completion.
1914 (let ((completion (try-completion varname variables)))
1915 ;; Insert the longest substring.
1916 (insert (substring (directory-file-name completion)
1918 (cond ((and comint-completion-recexact comint-completion-addsuffix
1919 (string-equal varname completion)
1920 (member completion completions))
1921 ;; It's not unique, but user wants shortest match.
1923 (if (funcall var-directory-p completion) "/" " "))
1924 (message "Completed shortest"))
1925 ((or comint-completion-autolist
1926 (string-equal varname completion))
1927 ;; It's not unique, list possible completions.
1928 (comint-dynamic-list-completions completions))
1930 (message "Partially completed"))))))))
1933 (defun comint-dynamic-simple-complete (stub candidates)
1934 "Dynamically complete STUB from CANDIDATES list.
1935 This function inserts completion characters at point by completing STUB from
1936 the strings in CANDIDATES. A completions listing may be shown in a help buffer
1937 if completion is ambiguous.
1939 See also `comint-dynamic-complete-filename'."
1940 (let* ((completion-ignore-case nil)
1941 (candidates (mapcar (function (lambda (x) (list x))) candidates))
1942 (completions (all-completions stub candidates)))
1943 (cond ((null completions)
1944 (message "No completions of %s" stub)
1946 ((= 1 (length completions)) ; Gotcha!
1947 (let ((completion (car completions)))
1948 (if (string-equal completion stub)
1949 (message "Sole completion")
1950 (insert (substring completion (length stub)))
1951 (message "Completed"))
1952 (if comint-completion-addsuffix (insert " "))))
1953 (t ; There's no unique completion.
1954 (let ((completion (try-completion stub candidates)))
1955 ;; Insert the longest substring.
1956 (insert (substring completion (length stub)))
1957 (cond ((and comint-completion-recexact comint-completion-addsuffix
1958 (string-equal stub completion)
1959 (member completion completions))
1960 ;; It's not unique, but user wants shortest match.
1962 (message "Completed shortest"))
1963 ((or comint-completion-autolist
1964 (string-equal stub completion))
1965 ;; It's not unique, list possible completions.
1966 (comint-dynamic-list-completions completions))
1968 (message "Partially completed"))))))))
1971 (defun comint-dynamic-list-filename-completions ()
1972 "List in help buffer possible completions of the filename at point."
1974 (let* ((completion-ignore-case nil)
1975 (filename (comint-match-partial-filename))
1976 (pathdir (file-name-directory filename))
1977 (pathnondir (file-name-nondirectory filename))
1978 (directory (if pathdir (comint-directory pathdir) default-directory))
1979 (completions (file-name-all-completions pathnondir directory)))
1981 (comint-dynamic-list-completions completions)
1982 (message "No completions of %s" filename)
1986 (defun comint-dynamic-list-completions (completions)
1987 "List in help buffer sorted COMPLETIONS.
1988 Typing SPC flushes the help buffer."
1989 (let ((conf (current-window-configuration)))
1990 (with-output-to-temp-buffer " *Completions*"
1991 (display-completion-list (sort completions 'string-lessp)))
1993 (message "Hit space to flush")
1994 (let ((ch (read-event)))
1996 (set-window-configuration conf)
1997 (setq unread-command-events (list ch))))))
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
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>
2014 ;;; shell-set-directory <unnecessary>
2015 ;;; shell-mode-map comint-mode-map
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-sentinel.
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.
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, comint-input-filter, comint-input-sentinel,
2047 ;;; comint-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,
2052 ;;; (defvar shell-mode-map '())
2053 ;;; (cond ((not shell-mode-map)
2054 ;;; (setq shell-mode-map (full-copy-sparse-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 ()
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 ;;; (setq comint-input-sentinel '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
2082 ;;; For modes that use comint-mode, comint-after-partial-filename-command
2083 ;;; should be set to a function that returns t if the stub before point is to
2084 ;;; be treated as a filename. By default, if the stub contains a `/', or does
2085 ;;; not follow the prompt, comint-dynamic-complete-filename-command is called.
2086 ;;; Otherwise, comint-dynamic-complete-command-command is called. This should
2087 ;;; also be set to a function that completes whatever the mode calls commands.
2088 ;;; You could use comint-dynamic-simple-complete to do the bulk of the
2091 ;;; Do the user's customisation...
2093 ;;; Isn't this what eval-after-load is for?
2094 ;;;(defvar comint-load-hook nil
2095 ;;; "This hook is run when comint is loaded in.
2096 ;;;This is a good place to put keybindings.")
2098 ;;;(run-hooks 'comint-load-hook)
2102 ;;; comint.el ends here