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