| blob | aadf85f7261acbe93441d501821200b03e0883d5 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu> then
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; 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)
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.).
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.
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.
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.
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-complete-variable Complete variable name at point.
92 ;; comint-dynamic-list-filename-completions List completions in help buffer.
93 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
94 ;; replace with expanded/completed name.
95 ;; comint-replace-by-expanded-history Expand history at point;
96 ;; replace with expanded name.
97 ;; comint-magic-space Expand history and add (a) space(s).
98 ;; comint-kill-subjob No mercy.
99 ;; comint-show-maximum-output Show as much output as possible.
100 ;; comint-continue-subjob Send CONT signal to buffer's process
101 ;; group. Useful if you accidentally
102 ;; suspend your process (with C-c C-z).
103 ;; comint-get-next-from-history Fetch successive input history lines
104 ;; comint-accumulate Combine lines to send them together
105 ;; as input.
106 ;; comint-goto-process-mark Move point to where process-mark is.
107 ;; comint-set-process-mark Set process-mark to point.
109 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
111 ;;; Code:
114 \f
115 ;; Buffer Local Variables:
116 ;;============================================================================
117 ;; Comint mode buffer local variables:
118 ;; comint-prompt-regexp string comint-bol uses to match prompt
119 ;; comint-delimiter-argument-list list For delimiters and arguments
120 ;; comint-last-input-start marker Handy if inferior always echoes
121 ;; comint-last-input-end marker For comint-delete-output command
122 ;; comint-input-ring-size integer For the input history
123 ;; comint-input-ring ring mechanism
124 ;; comint-input-ring-index number ...
125 ;; comint-save-input-ring-index number ...
126 ;; comint-input-autoexpand symbol ...
127 ;; comint-input-ignoredups boolean ...
128 ;; comint-dynamic-complete-functions hook For the completion mechanism
129 ;; comint-completion-fignore list ...
130 ;; comint-file-name-chars string ...
131 ;; comint-file-name-quote-list list ...
132 ;; comint-get-old-input function Hooks for specific
133 ;; comint-input-filter-functions hook process-in-a-buffer
134 ;; comint-output-filter-functions hook function modes.
135 ;; comint-preoutput-filter-functions hook
136 ;; comint-input-filter function ...
137 ;; comint-input-sender function ...
138 ;; comint-eol-on-send boolean ...
139 ;; comint-process-echoes boolean ...
140 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
141 ;; comint-scroll-to-bottom-on-output symbol ...
142 ;; comint-scroll-show-maximum-output boolean ...
143 ;; comint-accum-marker maker For comint-accumulate
144 ;; comint-last-output-overlay overlay
145 ;;
146 ;; Comint mode non-buffer local variables:
147 ;; comint-completion-addsuffix boolean/cons For file name
148 ;; comint-completion-autolist boolean completion behavior
149 ;; comint-completion-recexact boolean ...
152 "General command interpreter in a window stuff."
156 "Completion facilities in comint"
160 "Source finding facilities in comint"
165 "Regexp to recognise prompts in the inferior process.
168 This variable is only used if the variable
169 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
171 Good choices:
182 "List of characters to recognise as separate arguments in input.
183 Strings comprising a character in this list will separate the arguments
184 surrounding them, and also be regarded as arguments in their own right (unlike
185 whitespace). See `comint-arguments'.
186 Defaults to the empty list.
193 "*If non-nil, expand input command history references on completion.
194 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
196 If the value is `input', then the expansion is seen on input.
197 If the value is `history', then the expansion is only when inserting
198 into the buffer's input ring. See also `comint-magic-space' and
199 `comint-dynamic-complete'.
201 This variable is buffer-local."
209 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
210 The face used is `comint-highlight-input'."
215 "Face to use to highlight input when `comint-highlight-input' is non-nil."
219 "*If non-nil, highlight program prompts.
220 The face used is `comint-highlight-prompt'."
227 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
231 "*If non-nil, don't add input matching the last on the input ring.
232 This mirrors the optional behavior of bash.
234 This variable is buffer-local."
239 "*If non-nil, name of the file to read/write input history.
240 See also `comint-read-input-ring' and `comint-write-input-ring'.
242 This variable is buffer-local, and is a good thing to set in mode hooks."
244 file)
248 "*Controls whether input to interpreter causes window to scroll.
249 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
250 If `this', scroll only the selected window.
252 The default is nil.
254 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
262 "*Controls whether interpreter output causes window to scroll.
263 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
264 If `this', scroll only the selected window.
265 If `others', scroll only those that are not the selected window.
267 The default is nil.
269 See variable `comint-scroll-show-maximum-output' and function
270 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
279 "*Controls how interpreter output causes window to scroll.
280 If non-nil, then show the maximum output when the window is scrolled.
282 See variable `comint-scroll-to-bottom-on-output' and function
283 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
288 "*The maximum size in lines for comint buffers.
289 Comint buffers are truncated from the top to be no greater than this number, if
290 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
304 "*If non-nil, assume that the subprocess echoes any input.
305 If so, delete one copy of the input so that only one copy eventually
306 appears in the buffer.
308 This variable is buffer-local."
312 ;; AIX puts the name of the person being su'd to in front of the prompt.
313 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
314 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
315 ;; ssh-add prints a prompt like `Enter passphrase: '.
316 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
321 "*Regexp matching prompts for passwords in the inferior process.
322 This is used by `comint-watch-for-password-prompt'."
326 ;; Here are the per-interpreter hooks.
328 "Function that returns old text in comint mode.
329 This function is called when return is typed while the point is in old
330 text. It returns the text to be submitted as process input. The
331 default is `comint-get-old-input-default', which either grabs the
332 current input field or grabs the current line and strips off leading
333 text matching `comint-prompt-regexp', depending on the value of
338 "List of functions called to perform completion.
339 Functions should return non-nil if completion was performed.
340 See also `comint-dynamic-complete'.
346 "Predicate for filtering additions to input history.
347 Takes one argument, the input. If non-nil, the input may be saved on the input
351 "Functions to call before input is sent to the process.
352 These functions get one argument, a string containing the text to send.
357 "Functions to call after output is inserted into the buffer.
358 One possible function is `comint-postoutput-scroll-to-bottom'.
359 These functions get one argument, a string containing the text as originally
360 inserted. Note that this might not be the same as the buffer contents between
361 `comint-last-output-start' and the buffer's `process-mark', if other filter
362 functions have already modified the buffer.
364 See also `comint-preoutput-filter-functions'.
369 "Function to actually send to PROCESS the STRING submitted by user.
370 Usually this is just `comint-simple-send', but if your mode needs to
371 massage the input string, put a different function here.
372 `comint-simple-send' just sends the string plus a newline.
376 "*Non-nil means go to the end of the line before sending input.
377 See `comint-send-input'."
381 ;; Note: If it is decided to purge comint-prompt-regexp from the source
382 ;; entirely, searching for uses of this variable will help to identify
383 ;; places that need attention.
385 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
386 If nil, then program output and user-input are given different `field'
387 properties, which emacs commands can use to distinguish them (in
388 particular, common movement commands such as begining-of-line respect
389 field boundaries in a natural way)."
394 "Called upon entry into `comint-mode'
395 This is run before the process is cranked up."
400 "Called each time a process is exec'd by `comint-exec'.
401 This is called after the process is cranked up. It is useful for things that
402 must be done each time a process is executed in a comint mode buffer (e.g.,
403 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
404 executed once when the buffer is created."
411 "Non-nil if communications via pty; false if by pipe. Buffer local.
423 "Last input ring index which you copied.
427 "Non-nil if you are accumulating input lines to send as input together.
446 "Major mode for interacting with an inferior interpreter.
447 Interpreter name is same as buffer name, sans the asterisks.
448 Return at end of buffer sends line as input.
449 Return not at end copies rest of line to end and sends it.
450 Setting variable `comint-eol-on-send' means jump to the end of the line
451 before submitting new input.
453 This mode is customised to create major modes such as Inferior Lisp
454 mode, Shell mode, etc. This can be done by setting the hooks
455 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
456 and `comint-get-old-input' to appropriate functions, and the variable
457 `comint-prompt-regexp' to the appropriate regular expression.
459 An input history is maintained of size `comint-input-ring-size', and
460 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
461 Input ring history expansion can be achieved with the commands
463 Input ring expansion is controlled by the variable `comint-input-autoexpand',
464 and addition is controlled by the variable `comint-input-ignoredups'.
466 Commands with no default key bindings include `send-invisible',
467 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
468 `comint-magic-space'.
470 Input to, and output from, the subprocess can cause the window to scroll to
471 the end of the buffer. See variables `comint-output-filter-functions',
472 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
473 and `comint-scroll-to-bottom-on-output'.
476 to continue it.
480 Entry to this mode runs the hooks on `comint-mode-hook'."
528 ;; This behavior is not useful in comint buffers, and is annoying
532 nil
533 ;; Keys:
563 ;; Mouse Buttons:
565 ;; Menu bars:
566 ;; completion:
577 ;; Input history:
618 ;; Signals
633 ;; Put them in the menu bar:
635 menu-bar-final-items))
636 )
639 "Return t if there is a living process associated w/buffer BUFFER.
640 Living means the status is `open', `run', or `stop'.
641 BUFFER can be either a buffer or the name of one."
645 ;;;###autoload
647 "Make a comint process NAME in BUFFER, running PROGRAM.
648 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
649 PROGRAM should be either a string denoting an executable program to create
650 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
651 connection to be opened via `open-network-stream'. If there is already a
652 running process in that buffer, it is not restarted. Optional third arg
653 STARTFILE is the name of a file to send the contents of to the process.
655 If PROGRAM is a string, any more args are arguments to PROGRAM."
659 ;; If no process, or nuked process, crank up a new one and put buffer in
660 ;; comint mode. Otherwise, leave buffer and existing process alone.
665 buffer)
667 ;;;###autoload
669 "Make a comint process NAME in a buffer, running PROGRAM.
670 The name of the buffer is made by surrounding NAME with `*'s.
671 PROGRAM should be either a string denoting an executable program to create
672 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
673 connection to be opened via `open-network-stream'. If there is already a
674 running process in that buffer, it is not restarted. Optional third arg
675 STARTFILE is the name of a file to send the contents of to the process.
677 If PROGRAM is a string, any more args are arguments to PROGRAM."
680 ;;;###autoload
682 "Run PROGRAM in a comint buffer and switch to it.
683 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
684 The file name is used to make a symbol name, such as `comint-sh-hook', and any
685 hooks on this symbol are run in the buffer.
686 See `make-comint' and `comint-exec'."
693 "Start up a process in buffer BUFFER for comint modes.
694 Blasts any old process running in the buffer. Doesn't set the buffer mode.
695 You can use this to cheaply run a series of processes in the same comint
696 buffer. The hook `comint-exec-hook' is run after each exec."
701 ;; Crank up a new process
709 ;; Jump to the end, and set the process mark.
712 ;; Feed it the startfile.
714 ;;This is guaranteed to wait long enough
715 ;;but has bad results if the comint does not prompt at all
716 ;; (while (= size (buffer-size))
717 ;; (sleep-for 1))
718 ;;I hope 1 second is enough!
726 buffer)))
728 ;; This auxiliary function cranks up the process for comint-exec in
729 ;; the appropriate environment.
734 ;; If using termcap, we specify `emacs' as the terminal type
735 ;; because that lets us specify a width.
736 ;; If using terminfo, we specify `dumb' because that is
737 ;; a defined terminal type. `emacs' is not a defined terminal type
738 ;; and there is no way for us to define it here.
739 ;; Some programs that use terminfo get very confused
740 ;; if TERM is not a valid terminal type.
747 process-environment))
750 default-directory
752 proc decoding encoding changed)
754 ;; If the command has slashes, make sure we
755 ;; first look relative to the current directory.
761 ;; If start-process decided to use some coding system for decoding
762 ;; data sent from the process and the coding system doesn't
763 ;; specify EOL conversion, we had better convert CRLF to LF.
766 changed t))
767 ;; Even if start-process left the coding system for encoding data
768 ;; sent from the process undecided, we had better use the same one
769 ;; as what we use for decoding. But, we should suppress EOL
770 ;; conversion.
773 changed t))
776 proc))
780 "In a comint buffer, set the current input to the clicked-on previous input."
783 ;; Ignore non-input overlays
787 ;; Do we have input in this area?
792 ;; Can't use kill-region as it sets this-command
797 ;; Fall back to the global definition.
803 \f
804 ;; Input history processing in a buffer
805 ;; ===========================================================================
806 ;; Useful input history functions, courtesy of the Ergo group.
808 ;; Eleven commands:
809 ;; comint-dynamic-list-input-ring List history in help buffer.
810 ;; comint-previous-input Previous input...
811 ;; comint-previous-matching-input ...matching a string.
812 ;; comint-previous-matching-input-from-input ... matching the current input.
813 ;; comint-next-input Next input...
814 ;; comint-next-matching-input ...matching a string.
815 ;; comint-next-matching-input-from-input ... matching the current input.
816 ;; comint-backward-matching-input Backwards input...
817 ;; comint-forward-matching-input ...matching a string.
818 ;; comint-replace-by-expanded-history Expand history at point;
819 ;; replace with expanded history.
820 ;; comint-magic-space Expand history and insert space.
821 ;;
822 ;; Three functions:
823 ;; comint-read-input-ring Read into comint-input-ring...
824 ;; comint-write-input-ring Write to comint-input-ring-file-name.
825 ;; comint-replace-by-expanded-history-before-point Workhorse function.
828 "Sets the buffer's `comint-input-ring' from a history file.
829 The name of the file is given by the variable `comint-input-ring-file-name'.
830 The history ring is of size `comint-input-ring-size', regardless of file size.
831 If `comint-input-ring-file-name' is nil this function does nothing.
833 If the optional argument SILENT is non-nil, we say nothing about a
834 failure to read the history file.
836 This function is useful for major mode commands and mode hooks.
838 The commands stored in the history file are separated by the
839 `comint-input-ring-separator', and entries that match
840 `comint-input-history-ignore' are ignored. The most recent command
841 comes last.
843 See also `comint-input-ignoredups' and `comint-write-input-ring'."
846 nil)
850 comint-input-ring-file-name)))
863 ;; Save restriction in case file is already visited...
864 ;; Watch for those date stamps in history files!
884 comint-input-ring-index nil)))))
887 "Writes the buffer's `comint-input-ring' to a history file.
888 The name of the file is given by the variable `comint-input-ring-file-name'.
889 The original contents of the file are lost if `comint-input-ring' is not empty.
890 If `comint-input-ring-file-name' is nil this function does nothing.
892 Useful within process sentinels.
894 See also `comint-read-input-ring'."
898 nil)
906 ;; Write it all out into a buffer first. Much faster, but messier,
907 ;; than writing it one line at a time.
919 "List in help buffer the buffer's input history."
928 ;; We have to build up a list ourselves from the ring vector.
932 ;; Change "completion" to "history reference"
933 ;; to make the display accurate.
949 ;; Return list of regexp and prefix arg using PROMPT.
957 regexp)
961 ;; First make sure there is a ring and that we are after the process mark
968 ;; arg of zero resets search from beginning, and uses arg of 1
972 arg)))
975 ;; Index to start a directional search, starting at comint-input-ring-index
977 ;; If a search is running, offset by 1 in direction of arg
980 ;; For a new search, start from beginning or end, as appropriate
986 "Return the string ARG places along the input ring.
987 Moves relative to `comint-input-ring-index'."
991 arg)))
994 "Cycle backwards through input history."
999 "Cycle forwards through input history."
1004 "Return the string matching REGEXP ARG places along the input ring.
1005 Moves relative to `comint-input-ring-index'."
1010 "Return the index matching REGEXP ARG places along the input ring.
1011 Moves relative to START, or `comint-input-ring-index'."
1020 ;; Do the whole search as many times as the argument says.
1022 ;; Step once.
1025 ;; If we haven't reached a match, step some more.
1029 ;; If we have gone all the way around in this search.
1032 ;; Now that we know which ring element to use, if we found it, return that.
1034 n)))
1037 "Search backwards through input history for match for REGEXP.
1038 \(Previous history elements are earlier commands.)
1039 With prefix argument N, search for Nth previous match.
1040 If N is negative, find the next or Nth next match."
1044 ;; Has a match been found?
1050 ;; Can't use kill-region as it sets this-command
1057 "Search forwards through input history for match for REGEXP.
1058 \(Later history elements are more recent commands.)
1059 With prefix argument N, search for Nth following match.
1060 If N is negative, find the previous or Nth previous match."
1065 "Search backwards through input history for match for current input.
1066 \(Previous history elements are earlier commands.)
1067 With prefix argument N, search for Nth previous match.
1068 If N is negative, search forwards for the -Nth following match."
1071 comint-next-matching-input-from-input)))
1072 ;; Starting a new search
1078 comint-input-ring-index nil))
1081 arg))
1084 "Search forwards through input history for match for current input.
1085 \(Following history elements are more recent commands.)
1086 With prefix argument N, search for Nth following match.
1087 If N is negative, search backwards for the -Nth previous match."
1093 "Expand input command history references before point.
1094 Expansion is dependent on the value of `comint-input-autoexpand'.
1096 This function depends on the buffer's idea of the input history, which may not
1097 match the command interpreter's idea, assuming it has one.
1099 Assumes history syntax is like typical Un*x shells'. However, since emacs
1100 cannot know the interpreter's idea of input line numbers, assuming it has one,
1101 it cannot expand absolute input line number references.
1103 If the optional argument SILENT is non-nil, never complain
1104 even if history reference seems erroneous.
1106 If the optional argument START is non-nil, that specifies the
1107 start of the text to scan for history references, rather
1108 than the logical beginning of line.
1110 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1112 Returns t if successful."
1116 ;; Use comint-prompt-regexp
1120 ;; Use input fields. User input that hasn't been entered
1121 ;; yet, at the end of the buffer, has a nil `field' property.
1124 ;; Looks like there might be history references in the command.
1131 "Expand directory stack reference before point.
1132 See `comint-replace-by-expanded-history'. Returns t if successful.
1134 If the optional argument START is non-nil, that specifies the
1135 start of the text to scan for history references, rather
1136 than the logical beginning of line."
1144 ;; This seems a bit complex. We look for references such as !!, !-num,
1145 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1146 ;; If that wasn't enough, the plings can be suffixed with argument
1147 ;; range specifiers.
1148 ;; Argument ranges are complex too, so we hive off the input line,
1149 ;; referenced with plings, with the range string to `comint-args'.
1153 ;; The history is quoted, or we're in quotes.
1156 ;; We cannot know the interpreter's idea of input line numbers.
1160 ;; Just a number of args from `number' lines backward.
1169 t t)
1175 ;; Just a number of args from the previous input line.
1179 t t)
1183 ;; Most recent input starting with or containing (possibly
1184 ;; protected) string, maybe just a number of args. Phew.
1202 t t)
1205 ;; Quick substitution on the previous input line.
1222 "Expand input history references before point and insert ARG spaces.
1223 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1227 \f
1229 "Return t if the number of quotes between BEG and END is odd.
1230 Quotes are single and double."
1236 "Return number of matches for REGEXP from BEG to END."
1243 count))
1246 ;; From STRING, return the args depending on the range specified in the text
1247 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1248 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1264 ;; Return a list of arguments from ARG. Break it up at the
1265 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1280 comint-delimiter-argument-list)))
1283 args)))
1286 "Return from STRING the NTH to MTH arguments.
1287 NTH and/or MTH can be nil, which means the last argument.
1288 Returned arguments are separated by single spaces.
1289 We assume whitespace separates arguments, except within quotes
1290 and except for a space or tab that immediately follows a backslash.
1291 Also, a run of one or more of a single character
1292 in `comint-delimiter-argument-list' is a separate argument.
1293 Argument 0 is the command name."
1294 ;; The first line handles ordinary characters and backslash-sequences
1295 ;; (except with w32 msdos-like shells, where backslashes are valid).
1296 ;; The second matches "-quoted strings.
1297 ;; The third matches '-quoted strings.
1298 ;; The fourth matches `-quoted strings.
1299 ;; This seems to fit the syntax of BASH 2.0.
1310 beg str value quotes)
1311 ;; Build a list of all the args until we have as many as we want.
1315 ;; It's contiguous, part of the same arg.
1318 ;; It's a new separate arg.
1320 ;; Put the previous arg, if there was one, onto ARGS.
1337 \f
1338 ;;
1339 ;; Input processing stuff
1340 ;;
1342 "Add CMD to the input history.
1343 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1349 cmd))))
1353 "Send input to process.
1354 After the process output mark, sends all text from the process mark to
1355 point as input to the process. Before the process output mark, calls value
1356 of variable `comint-get-old-input' to retrieve old input, copies it to the
1357 process mark, and sends it. If variable `comint-process-echoes' is nil,
1358 a terminal newline is also inserted into the buffer and sent to the process
1359 \(if it is non-nil, all text from the process mark to point is deleted,
1360 since it is assumed the remote process will re-echo it).
1362 Any history reference may be expanded depending on the value of the variable
1363 `comint-input-autoexpand'. The list of function names contained in the value
1364 of `comint-input-filter-functions' is called on the input before sending it.
1365 The input is entered into the input history ring, if the value of variable
1366 `comint-input-filter' returns non-nil when called on the input.
1368 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1369 end of line before sending the input.
1371 The values of `comint-get-old-input', `comint-input-filter-functions', and
1372 `comint-input-filter' are chosen according to the command interpreter running
1373 in the buffer. E.g.,
1375 If the interpreter is the csh,
1376 comint-get-old-input is the default: either return the current
1377 field, or take the current line and discard any
1378 initial string matching regexp `comint-prompt-regexp', depending
1379 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1382 comint-input-filter is the default: returns t if the input isn't all white
1383 space.
1385 If the comint is Lucid Common Lisp,
1386 comint-get-old-input snarfs the sexp ending at point.
1387 comint-input-filter-functions does nothing.
1388 comint-input-filter returns nil if the input matches input-filter-regexp,
1389 which matches (1) all whitespace (2) :a, :c, etc.
1391 Similarly for Soar, Scheme, etc."
1393 ;; Note that the input string does not include its terminal newline.
1403 copy)))
1405 ;; Just whatever's already there
1406 intxt
1407 ;; Expand and leave it visible in buffer
1411 input
1412 ;; This is messy 'cos ultimately the original
1413 ;; functions used do insertion, rather than return
1414 ;; strings. We have to expand, then insert back.
1420 copy))))
1434 ;; Make an overlay for the input field
1437 ;; Give old user input a field property of `input', to
1438 ;; distinguish it from both process output and unsent
1439 ;; input. The terminating newline is put into a special
1440 ;; `boundary' field to make cursor movement between input
1441 ;; and output fields smoother.
1448 ;; Make an overlay for the terminating newline
1457 ;; Update the markers before we send the input
1458 ;; in case we get output amidst sending the input.
1462 ;; clear the "accumulation" marker
1465 ;; This used to call comint-output-filter-functions,
1466 ;; but that scrolled the buffer in undesirable ways.
1470 "List of functions to call before inserting Comint output into the buffer.
1471 Each function gets one argument, a string containing the text received
1472 from the subprocess. It should return the string to insert, perhaps
1473 the same string that was received, or perhaps a modified or transformed
1474 string.
1476 The functions on the list are called sequentially, and each one is
1477 given the string returned by the previous one. The string returned by
1478 the last function is the text that is actually inserted in the
1479 redirection buffer.
1483 ;; When non-nil, this is the last overlay used for output.
1484 ;; It is kept around so that we can extend it instead of creating
1485 ;; multiple contiguous overlays for multiple contiguous output chunks.
1488 ;; When non-nil, this is an overlay over the last recognized prompt in
1489 ;; the buffer; it is used when highlighting the prompt.
1492 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1493 ;; Any further output will then create a new comint-last-prompt-overlay.
1499 ;; The purpose of using this filter for comint processes
1500 ;; is to keep comint-last-input-end from moving forward
1501 ;; when output is inserted.
1504 ;; First check for killed buffer or no input.
1507 ;; Run preoutput filters
1513 ;; Insert STRING
1515 ;; Avoid the overhead of save-excursion, since we just
1516 ;; fiddle with the point
1519 ;; The point should float after any insertion we do
1522 ;; We temporarly remove any buffer narrowing, in case the
1523 ;; process mark is outside of the restriction
1530 ;; insert-before-markers is a bad thing. XXX
1531 ;;
1532 ;; It is used here to force window-point markers (used to
1533 ;; store the value of point in non-selected windows) to
1534 ;; advance, but it also screws up any other markers that we
1535 ;; don't _want_ to advance, such as the start-marker of some
1536 ;; of the overlays we create.
1537 ;;
1538 ;; We work around the problem with the overlays by
1539 ;; explicitly adjusting them after we do the insertion, but
1540 ;; in the future this problem should be solved correctly, by
1541 ;; using `insert', and making the insertion-type of
1542 ;; window-point markers settable (via a buffer-local
1543 ;; variable). In comint buffers, this variable would be set
1544 ;; to `t', to cause point in non-select windows to advance.
1546 ;; Fixup markers and overlays that got screwed up because we
1547 ;; used `insert-before-markers'.
1549 ;; comint-last-output-start
1551 ;; comint-last-input-end
1556 ;; No overlays we create are set to advance upon insertion
1557 ;; (at the start/end), so we assume that any overlay which
1558 ;; is at the current point was incorrectly advanced by
1559 ;; insert-before-markers. First fixup overlays that might
1560 ;; start at point:
1565 old-point
1567 ;; Then do overlays that might end at point:
1572 old-point))))
1574 ;; Advance process-mark
1578 ;; We check to see if the last overlay used for output is
1579 ;; adjacent to the new input, and if so, just extend it.
1583 ;; Extend comint-last-output-overlay to include the
1584 ;; most recent output
1588 ;; Create a new overlay
1596 ;; Highlight the prompt, where we define `prompt' to mean
1597 ;; the most recent output that doesn't end with a newline.
1599 ;; Need to create or move the prompt overlay (in the case
1600 ;; where there is no prompt ((bolp) == t), we still do
1601 ;; this if there's already an existing overlay).
1604 ;; Just move an existing overlay
1607 ;; Need to create the overlay
1618 "Go to the end of buffer in all windows showing it.
1619 Movement occurs if point in the selected window is not after the process mark,
1620 and `this-command' is an insertion command. Insertion commands recognised
1621 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1622 Depends on the value of `comint-scroll-to-bottom-on-input'.
1624 This function should be a pre-command hook."
1627 hilit-yank)))
1643 nil t))))))
1646 "Go to the end of buffer in all windows showing it.
1647 Does not scroll if the current line is the last line in the buffer.
1648 Depends on the value of `comint-scroll-to-bottom-on-output' and
1649 `comint-scroll-show-maximum-output'.
1651 This function should be in the list `comint-output-filter-functions'."
1665 ;; Maybe user wants point to jump to end.
1668 ;; If point was at the end, keep it at end.
1672 ;; Optionally scroll so that the text
1673 ;; ends at the bottom of the window.
1680 nil t))
1684 "Truncate the buffer to `comint-buffer-maximum-size'.
1685 This function could be on `comint-output-filter-functions' or bound to a key."
1694 "Strip trailing `^M' characters from the current output group.
1695 This function could be on `comint-output-filter-functions' or bound to a key."
1708 "Put the end of the buffer at the bottom of the window."
1714 "Default for `comint-get-old-input'.
1715 Returns either the current field, or the current line with any initial
1716 text matching `comint-prompt-regexp' stripped off, depending on the
1717 value of `comint-use-prompt-regexp-instead-of-fields'."
1725 ;; Return the contents of the field at the current point.
1732 "Insert after prompt old input at point as new input to be edited.
1733 Calls `comint-get-old-input' to get old input."
1743 "Skip past the text matching regexp `comint-prompt-regexp'.
1744 If this takes us past the end of the current line, don't skip at all."
1751 "Return t if point is after the process output marker."
1756 "Default function for sending to PROC input STRING.
1757 This just sends STRING plus a newline. To override this,
1758 set the hook `comint-input-sender'."
1763 "Returns the buffer position of the beginning of the line, after any prompt.
1764 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1765 prompt skip is done by skipping text matching the regular expression
1766 `comint-prompt-regexp', a buffer local variable."
1768 ;; Use comint-prompt-regexp
1773 ;; Use input fields. Note that, unlike the behavior of
1774 ;; `line-beginning-position' inside a field, this function will
1775 ;; return the position of the end of a prompt, even if the point is
1776 ;; already inside the prompt. In order to do this, it assumes that
1777 ;; if there are two fields on a line, then the first one is the
1778 ;; prompt, and the second one is an input field, and is front-sticky
1779 ;; (as input fields should be).
1783 "Goes to the beginning of line, then skips past the prompt, if any.
1785 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1786 prompt skip is done by skipping text matching the regular expression
1787 `comint-prompt-regexp', a buffer local variable."
1790 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1794 ;; These three functions are for entering text you don't want echoed or
1795 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1796 ;; Just enter m-x send-invisible and type in your line, or add
1797 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1800 "Read a single line of text from user without echoing, and return it.
1801 Prompt with argument PROMPT, a string. Optional argument STARS causes
1802 input to be echoed with '*' characters on the prompt line. Input ends with
1803 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1804 `inhibit-quit' is set because e.g. this function was called from a process
1805 filter and C-g is pressed, this function returns nil rather than a string).
1807 Note that the keystrokes comprising the text can still be recovered
1809 Once the caller uses the password, it can erase the password
1810 by doing (fillarray STRING 0)."
1822 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1825 ;; This function may get called from a process filter, where
1826 ;; inhibit-quit is set. In later versions of emacs read-char
1827 ;; may clear quit-flag itself and return C-g. That would make
1828 ;; it impossible to quit this loop in a simple way, so
1829 ;; re-enable it here (for backward-compatibility the check for
1830 ;; quit-flag below would still be necessary, so this seems
1831 ;; like the simplest way to do things).
1833 done t))
1847 ;; Emulate a true quit, except that we have to return a value.
1853 ans)))
1856 "Read a string without echoing.
1857 Then send it to the process running in the current buffer.
1858 The string is sent using `comint-input-sender'.
1859 Security bug: your string can still be temporarily recovered with
1875 "Prompt in the minibuffer for password and send without echoing.
1876 This function uses `send-invisible' to read and send a password to the buffer's
1877 process if STRING contains a password prompt defined by
1878 `comint-password-prompt-regexp'.
1880 This function could be in the list `comint-output-filter-functions'."
1884 \f
1885 ;; Low-level process communication
1888 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1898 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1906 \f
1907 ;; Random input hackage
1910 "Delete all output from interpreter since last input.
1911 Does not delete the prompt."
1924 ;; Output message and put back prompt
1930 "Write output from interpreter since last input to FILENAME.
1931 Any prompt at the end of the output is not written.
1933 If the optional argument APPEND (the prefix argument when interactive)
1934 is non-nil, the output is appended to the file instead.
1936 If the optional argument MUSTBENEW is non-nil, check for an existing
1937 file with the same name. If MUSTBENEW is `excl', that means to get an
1938 error if the file already exists; never overwrite. If MUSTBENEW is
1939 neither nil nor `excl', that means ask for confirmation before
1940 overwriting, but do go ahead and overwrite the file if the user
1941 confirms. When interactive, MUSTBENEW is nil when appending, and t
1942 otherwise."
1946 "Append output to file: "
1948 current-prefix-arg
1954 append nil nil mustbenew)))
1956 ;; This function exists for the benefit of the menu; from the keyboard,
1957 ;; users can just use `comint-write-output' with a prefix arg.
1959 "Append output from interpreter since last input to FILENAME.
1960 Any prompt at the end of the output is not written."
1965 "Display start of this batch of interpreter output at top of window.
1966 Sets mark to the value of point when this command is run."
1981 "Interrupt the current subjob.
1982 This command also kills the pending input
1983 between the process-mark and point."
1989 "Send kill signal to the current subjob.
1990 This command also kills the pending input
1991 between the process-mark and point."
1997 "Send quit signal to the current subjob.
1998 This command also kills the pending input
1999 between the process-mark and point."
2005 "Stop the current subjob.
2006 This command also kills the pending input
2007 between the process-mark and point.
2009 WARNING: if there is no current subjob, you can end up suspending
2010 the top-level process running in the buffer. If you accidentally do
2012 is not a problem with most shells, since they ignore this signal.)"
2018 "Send CONT signal to process buffer's process group.
2019 Useful if you accidentally suspend the top-level process."
2024 "Kill all text from last stuff output by interpreter to point."
2031 "Delete ARG characters forward or send an EOF to subprocess.
2032 Sends an EOF only if point is at the end of the buffer and there is no input."
2040 "Send an EOF to the current buffer's process."
2047 "Search backward through buffer for input fields that match REGEXP.
2048 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2049 fields are identified by lines that match `comint-prompt-regexp'.
2051 With prefix argument N, search for Nth previous match.
2052 If N is negative, find the next or Nth next match."
2055 ;; Use comint-prompt-regexp
2065 ;; Use input fields
2079 "Search forward through buffer for input fields that match REGEXP.
2080 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2081 fields are identified by lines that match `comint-prompt-regexp'.
2083 With prefix argument N, search for Nth following match.
2084 If N is negative, find the previous or Nth previous match."
2090 "Move to end of Nth next prompt in the buffer.
2091 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2092 the beginning of the Nth next `input' field, otherwise, it means the Nth
2093 occurance of text matching `comint-prompt-regexp'."
2096 ;; Use comint-prompt-regexp
2101 ;; Use input fields
2110 ;; Ran off the end of the buffer.
2120 "Move to end of Nth previous prompt in the buffer.
2121 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2122 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2123 occurance of text matching `comint-prompt-regexp'."
2126 \f
2127 ;; Support for source-file processing commands.
2128 ;;============================================================================
2129 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2130 ;; commands that process files of source text (e.g. loading or compiling
2131 ;; files). So the corresponding process-in-a-buffer modes have commands
2132 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2133 ;; for defining these commands.
2134 ;;
2135 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2136 ;; and Soar, in that they don't know anything about file extensions.
2137 ;; So the compile/load interface gets the wrong default occasionally.
2138 ;; The load-file/compile-file default mechanism could be smarter -- it
2139 ;; doesn't know about the relationship between filename extensions and
2140 ;; whether the file is source or executable. If you compile foo.lisp
2141 ;; with compile-file, then the next load-file should use foo.bin for
2142 ;; the default, not foo.lisp. This is tricky to do right, particularly
2143 ;; because the extension for executable files varies so much (.o, .bin,
2144 ;; .lbin, .mo, .vo, .ao, ...).
2147 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2148 ;; commands.
2149 ;;
2150 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2151 ;; want to save the buffer before issuing any process requests to the command
2152 ;; interpreter.
2153 ;;
2154 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2155 ;; for the file to process.
2157 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2158 ;;============================================================================
2159 ;; This function computes the defaults for the load-file and compile-file
2160 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2161 ;;
2162 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2163 ;; source-file processing command. NIL if there hasn't been one yet.
2164 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2165 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2166 ;; Typically, (lisp-mode) or (scheme-mode).
2167 ;;
2168 ;; If the command is given while the cursor is inside a string, *and*
2169 ;; the string is an existing filename, *and* the filename is not a directory,
2170 ;; then the string is taken as default. This allows you to just position
2171 ;; your cursor over a string that's a filename and have it taken as default.
2172 ;;
2173 ;; If the command is given in a file buffer whose major mode is in
2174 ;; SOURCE-MODES, then the the filename is the default file, and the
2175 ;; file's directory is the default directory.
2176 ;;
2177 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2178 ;; then the default directory & file are what was used in the last source-file
2179 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2180 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2181 ;; is the cwd, with no default file. (\"no default file\" = nil)
2182 ;;
2183 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2184 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2185 ;; for Soar programs, etc.
2186 ;;
2187 ;; The function returns a pair: (default-directory . default-file).
2198 ;; (COMINT-CHECK-SOURCE fname)
2199 ;;============================================================================
2200 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2201 ;; process-in-a-buffer modes), this function can be called on the filename.
2202 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2203 ;; is queried to see if he wants to save the buffer before proceeding with
2204 ;; the load or compile.
2211 ;; save BUFF.
2218 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2219 ;;============================================================================
2220 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2221 ;; commands that process source files (like loading or compiling a file).
2222 ;; It prompts for the filename, provides a default, if there is one,
2223 ;; and returns the result filename.
2224 ;;
2225 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2226 ;;
2227 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2228 ;; from the last source processing command. SOURCE-MODES is a list of major
2229 ;; modes used to determine what file buffers contain source files. (These
2230 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2231 ;; then the filename reader will only accept a file that exists.
2232 ;;
2233 ;; A typical use:
2234 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2235 ;; '(lisp-mode) t))
2237 ;; This is pretty stupid about strings. It decides we're in a string
2238 ;; if there's a quote on both sides of point on the current line.
2240 "Return string around POINT that starts the current line, or nil."
2267 prompt deffile)
2268 prompt)
2269 defdir
2271 mustmatch-p)))
2274 ;; I am somewhat divided on this string-default feature. It seems
2275 ;; to violate the principle-of-least-astonishment, in that it makes
2276 ;; the default harder to predict, so you actually have to look and see
2277 ;; what the default really is before choosing it. This can trip you up.
2278 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2279 ;; on this.
2280 ;; -Olin
2282 \f
2283 ;; Simple process query facility.
2284 ;; ===========================================================================
2285 ;; This function is for commands that want to send a query to the process
2286 ;; and show the response to the user. For example, a command to get the
2287 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2288 ;; to an inferior Common Lisp process.
2289 ;;
2290 ;; This simple facility just sends strings to the inferior process and pops
2291 ;; up a window for the process buffer so you can see what the process
2292 ;; responds with. We don't do anything fancy like try to intercept what the
2293 ;; process responds with and put it in a pop-up window or on the message
2294 ;; line. We just display the buffer. Low tech. Simple. Works good.
2296 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2297 ;; a window for the inferior process so that its response can be seen.
2307 ;; Try to position the proc window so you can see the answer.
2308 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2309 ;; I don't know why. Wizards invited to improve it.
2318 \f
2319 ;; Filename/command/history completion in a buffer
2320 ;; ===========================================================================
2321 ;; Useful completion functions, courtesy of the Ergo group.
2323 ;; Six commands:
2324 ;; comint-dynamic-complete Complete or expand command, filename,
2325 ;; history at point.
2326 ;; comint-dynamic-complete-filename Complete filename at point.
2327 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2328 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2329 ;; replace with expanded/completed name.
2330 ;; comint-dynamic-simple-complete Complete stub given candidates.
2332 ;; These are not installed in the comint-mode keymap. But they are
2333 ;; available for people who want them. Shell-mode installs them:
2334 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2335 ;; (define-key shell-mode-map "\M-?"
2336 ;; 'comint-dynamic-list-filename-completions)))
2337 ;;
2338 ;; Commands like this are fine things to put in load hooks if you
2339 ;; want them present in specific modes.
2342 "*If non-nil, automatically list possibilities on partial completion.
2343 This mirrors the optional behavior of tcsh."
2348 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2349 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2350 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2351 This mirrors the optional behavior of tcsh."
2360 "*If non-nil, use shortest completion if characters cannot be added.
2361 This mirrors the optional behavior of tcsh.
2363 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2368 "*List of suffixes to be disregarded during file completion.
2369 This mirrors the optional behavior of bash and tcsh.
2371 Note that this applies to `comint-dynamic-complete-filename' only."
2376 "Prefix prepended to absolute file names taken from process input.
2377 This is used by comint's and shell's completion functions, and by shell's
2382 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2384 "String of characters valid in a file name.
2385 Note that all non-ASCII characters are considered valid in a file name
2386 regardless of what this variable says.
2397 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2400 directory)))
2404 "Return the word of WORD-CHARS at point, or nil if non is found.
2405 Word constituents are considered to be those in WORD-CHARS, which is like the
2407 plus all non-ASCII characters."
2411 ;;(memq (char-after (point)) shell-file-name-quote-list)
2415 ;; Don't go forward over a word-char (this can happen if we're at bob).
2418 ;; Set match-data to match the entire string.
2424 "Return FILENAME with environment variables substituted.
2425 Supports additional environment variable syntax of the command
2426 interpreter (e.g., the percent notation of cmd.exe on NT)."
2430 env-var-val)
2439 name))
2442 "Return the filename at point, or nil if non is found.
2443 Environment variables are substituted. See `comint-word'."
2450 "Return FILENAME with magic characters quoted.
2451 Magic characters are those in `comint-file-name-quote-list'."
2453 filename
2460 filename))))
2463 "Return FILENAME with quoted characters unquoted."
2465 filename
2471 filename)))
2475 "Dynamically perform completion at point.
2476 Calls the functions in `comint-dynamic-complete-functions' to perform
2477 completion until a function returns non-nil, at which point completion is
2478 assumed to have occurred."
2484 "Dynamically complete the filename at point.
2485 Completes if after a filename. See `comint-match-partial-filename' and
2486 `comint-dynamic-complete-as-filename'.
2487 This function is similar to `comint-replace-by-expanded-filename', except that
2488 it won't change parts of the filename already entered in the buffer; it just
2489 adds completion characters to the end of the filename. A completions listing
2490 may be shown in a help buffer if completion is ambiguous.
2492 Completion is dependent on the value of `comint-completion-addsuffix',
2493 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2494 completions listing is dependent on the value of `comint-completion-autolist'.
2496 Returns t if successful."
2504 "Dynamically complete at point as a filename.
2505 See `comint-dynamic-complete-filename'. Returns t if successful."
2508 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2509 ;; I think it was originally bound to solve file completion problems,
2510 ;; but subsequent changes may have made this unnecessary. sm.
2511 ;;(file-name-handler-alist nil)
2546 ;; We inserted a unique completion.
2553 ;; It's not unique, but user wants shortest match.
2559 ;; It's not unique, list possible completions.
2564 success))
2568 "Dynamically expand and complete the filename at point.
2569 Replace the filename with an expanded, canonicalised and completed replacement.
2572 removed, and the filename is made absolute instead of relative. For expansion
2573 see `expand-file-name' and `substitute-in-file-name'. For completion see
2574 `comint-dynamic-complete-filename'."
2581 "Dynamically complete STUB from CANDIDATES list.
2582 This function inserts completion characters at point by completing STUB from
2583 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2584 if completion is ambiguous.
2586 Returns nil if no completion was inserted.
2587 Returns `sole' if completed with the only completion match.
2588 Returns `shortest' if completed with the shortest of the completion matches.
2589 Returns `partial' if completed as far as possible with the completion matches.
2590 Returns `listed' if a completion listing was shown.
2592 See also `comint-dynamic-complete-filename'."
2601 nil)
2612 ;; Insert the longest substring.
2617 ;; It's not unique, but user wants shortest match.
2623 ;; It's not unique, list possible completions.
2632 "List in help buffer possible completions of the filename at point."
2635 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2636 ;; I think it was originally bound to solve file completion problems,
2637 ;; but subsequent changes may have made this unnecessary. sm.
2638 ;;(file-name-handler-alist nil)
2651 "List in help buffer sorted COMPLETIONS.
2652 Typing SPC flushes the help buffer."
2666 ;; If the user does mouse-choose-completion with the mouse,
2667 ;; execute the command, then delete the completion window.
2674 \f
2676 "After fetching a line from input history, this fetches the following line.
2677 In other words, this recalls the input line after the line you recalled last.
2678 You can use this to repeat a sequence of input lines."
2687 "Accumulate a line to send as input along with more lines.
2688 This inserts a newline so that you can enter more text
2690 to send all the accumulated input, at once.
2691 The entire accumulated text becomes one item in the input history
2692 when you send it."
2701 "Move point to the process mark.
2702 The process mark separates output, and input already sent,
2703 from input that has not yet been sent."
2712 "Move point to beginning of line (after prompt) or to the process mark.
2713 The first time you use this command, it moves to the beginning of the line
2714 \(but after the prompt, if any). If you repeat it again immediately,
2715 it moves point to the process mark.
2717 The process mark separates the process output, along with input already sent,
2718 from input that has not yet been sent. Ordinarily, the process mark
2719 is at the beginning of the current input line; but if you have
2721 the process mark is at the beginning of the accumulated input."
2728 "Set the process mark at point."
2735 \f
2736 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2738 ;; This little add-on for comint is intended to make it easy to get
2739 ;; output from currently active comint buffers into another buffer,
2740 ;; or buffers, and then go back to using the comint shell.
2741 ;;
2742 ;; My particular use is SQL interpreters; I want to be able to execute a
2743 ;; query using the process associated with a comint-buffer, and save that
2744 ;; somewhere else. Because the process might have state (for example, it
2745 ;; could be in an uncommitted transaction), just running starting a new
2746 ;; process and having it execute the query and then finish, would not
2747 ;; work. I'm sure there are other uses as well, although in many cases
2748 ;; starting a new process is the simpler, and thus preferable, approach.
2749 ;;
2750 ;; The basic implementation is as follows: comint-redirect changes the
2751 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2752 ;; its own filter. The filter puts the output into the designated buffer,
2753 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2754 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2755 ;; sees the stop regexp, it restores the old filter functions, and runs
2756 ;; comint-redirect-hook.
2757 ;;
2758 ;; Each comint buffer may only use one redirection at a time, but any number
2759 ;; of different comint buffers may be simultaneously redirected.
2760 ;;
2761 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2762 ;; correct prompt for your interpreter, or that you supply a regexp that says
2763 ;; when the redirection is finished. Otherwise, redirection will continue
2764 ;; indefinitely. The code now does a sanity check to ensure that it can find
2765 ;; a prompt in the comint buffer; however, it is still important to ensure that
2766 ;; this prompt is set correctly.
2767 ;;
2768 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2769 ;; perhaps it should prompt for a terminating string (with an
2770 ;; appropriate magic default by examining what we think is the prompt)?
2771 ;;
2773 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2774 ;; Variables
2775 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2778 "*If non-nil, print messages each time the redirection filter is invoked.
2779 Also print a message when redirection is completed."
2783 ;; Directly analagous to comint-preoutput-filter-functions
2785 "List of functions to call before inserting redirected process output.
2786 Each function gets one argument, a string containing the text received
2787 from the subprocess. It should return the string to insert, perhaps
2788 the same string that was received, or perhaps a modified or transformed
2789 string.
2791 The functions on the list are called sequentially, and each one is given
2792 the string returned by the previous one. The string returned by the
2797 ;; Internal variables
2803 "Regular expression that determines when to stop redirection in Comint.
2804 When the redirection filter function is given output that matches this regexp,
2808 "If non-nil, the text that ends a redirection is included in it.
2809 More precisely, the text that matches `comint-redirect-finished-regexp'
2810 and therefore terminates an output redirection is inserted in the
2823 "If non-nil, check that redirection is likely to complete successfully.
2824 More precisely, before starting a redirection, verify that the
2825 regular expression `comint-redirect-finished-regexp' that controls
2826 when to terminate it actually matches some text already in the process
2827 buffer. The idea is that this regular expression should match a prompt
2828 string, and that there ought to be at least one copy of your prompt string
2832 "The process filter that was in place when redirection is started.
2833 When redirection is completed, the process filter is restored to
2836 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2837 ;; Functions
2838 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2841 comint-buffer
2842 finished-regexp
2844 "Set up for output redirection.
2845 This function sets local variables that are used by `comint-redirect-filter'
2846 to perform redirection.
2848 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2849 in the output matches FINISHED-REGEXP.
2851 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2852 original comint buffer.
2854 This function is called by `comint-redirect-send-command-to-process',
2855 and does not normally need to be invoked by the end user or programmer."
2879 "End a Comint redirection. See `comint-redirect-send-command'."
2881 ;; Restore the process filter
2883 comint-redirect-original-filter-function)
2884 ;; Restore the mode line
2886 ;; Set the completed flag
2889 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2890 ;; that it really occurs.
2894 "Filter function which redirects output from PROCESS to a buffer or buffers.
2895 The variable `comint-redirect-output-buffer' says which buffer(s) to
2896 place output in.
2898 INPUT-STRING is the input from the comint process.
2900 This function runs as a process filter, and does not need to be invoked by the
2901 end user."
2905 ;; If we have to echo output, give it to the original filter function
2907 comint-redirect-original-filter-function
2909 process input-string)))))
2913 "Comint filter function which redirects comint output to a buffer or buffers.
2914 The variable `comint-redirect-output-buffer' says which buffer(s) to
2915 place output in.
2917 INPUT-STRING is the input from the comint process.
2919 This function does not need to be invoked by the end user."
2922 comint-redirect-output-buffer
2926 ;; If there are any filter functions, give them a chance to modify the string
2933 ;; Clobber `comint-redirect-finished-regexp'
2939 ;; Send output to all registered buffers
2943 ;; Set this buffer to the output buffer
2945 ;; Go to the end of the buffer
2947 ;; Insert the output
2949 output-buffer-list))
2951 ;; Message
2956 ;; If we see the prompt, tidy up
2957 ;; We'll look for the prompt in the original string, so nobody can
2958 ;; clobber it
2965 ;; Echo input?
2967 filtered-input-string
2970 ;;;###autoload
2972 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2973 With prefix arg, echo output in process buffer.
2975 If NO-DISPLAY is non-nil, do not show the output buffer."
2983 ;;;###autoload
2986 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2987 With prefix arg, echo output in process buffer.
2989 If NO-DISPLAY is non-nil, do not show the output buffer."
2994 process))
2996 ;; Change to the process buffer
2999 ;; Make sure there's a prompt in the current process buffer
3006 ;;;;;;;;;;;;;;;;;;;;;
3007 ;; Set up for redirection
3008 ;;;;;;;;;;;;;;;;;;;;;
3010 ;; Output Buffer
3011 output-buffer
3012 ;; Comint Buffer
3014 ;; Finished Regexp
3015 comint-prompt-regexp
3016 ;; Echo input
3017 echo)
3019 ;;;;;;;;;;;;;;;;;;;;;
3020 ;; Set the filter
3021 ;;;;;;;;;;;;;;;;;;;;;
3022 ;; Save the old filter
3027 ;;;;;;;;;;;;;;;;;;;;;
3028 ;; Send the command
3029 ;;;;;;;;;;;;;;;;;;;;;
3034 ;;;;;;;;;;;;;;;;;;;;;
3035 ;; Show the output
3036 ;;;;;;;;;;;;;;;;;;;;;
3042 output-buffer))))))
3044 ;;;###autoload
3046 "Send COMMAND to current process.
3047 Return a list of expressions in the output which match REGEXP.
3048 REGEXP-GROUP is the regular expression group in REGEXP to use."
3051 command regexp regexp-group))
3053 ;;;###autoload
3055 "Send COMMAND to PROCESS.
3056 Return a list of expressions in the output which match REGEXP.
3057 REGEXP-GROUP is the regular expression group in REGEXP to use."
3059 results)
3064 output-buffer process nil t)
3065 ;; Wait for the process to complete
3069 ;; Collect the output
3072 ;; Skip past the command, if it was echoed
3080 results)))
3081 results)))
3086 "^Empty input ring$"
3087 "^No history$"
3090 \f
3091 ;; Converting process modes to use comint mode
3092 ;; ===========================================================================
3093 ;; The code in the Emacs 19 distribution has all been modified to use comint
3094 ;; where needed. However, there are `third-party' packages out there that
3095 ;; still use the old shell mode. Here's a guide to conversion.
3096 ;;
3097 ;; Renaming variables
3098 ;; Most of the work is renaming variables and functions. These are the common
3099 ;; ones:
3100 ;; Local variables:
3101 ;; last-input-start comint-last-input-start
3102 ;; last-input-end comint-last-input-end
3103 ;; shell-prompt-pattern comint-prompt-regexp
3104 ;; shell-set-directory-error-hook <no equivalent>
3105 ;; Miscellaneous:
3106 ;; shell-set-directory <unnecessary>
3107 ;; shell-mode-map comint-mode-map
3108 ;; Commands:
3109 ;; shell-send-input comint-send-input
3110 ;; shell-send-eof comint-delchar-or-maybe-eof
3111 ;; kill-shell-input comint-kill-input
3112 ;; interrupt-shell-subjob comint-interrupt-subjob
3113 ;; stop-shell-subjob comint-stop-subjob
3114 ;; quit-shell-subjob comint-quit-subjob
3115 ;; kill-shell-subjob comint-kill-subjob
3116 ;; kill-output-from-shell comint-delete-output
3117 ;; show-output-from-shell comint-show-output
3118 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3119 ;;
3120 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3121 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3122 ;; Comint mode does not provide functionality equivalent to
3123 ;; shell-set-directory-error-hook; it is gone.
3124 ;;
3125 ;; comint-last-input-start is provided for modes which want to munge
3126 ;; the buffer after input is sent, perhaps because the inferior
3127 ;; insists on echoing the input. The LAST-INPUT-START variable in
3128 ;; the old shell package was used to implement a history mechanism,
3129 ;; but you should think twice before using comint-last-input-start
3130 ;; for this; the input history ring often does the job better.
3131 ;;
3132 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3133 ;; *not* create the comint-mode local variables in your foo-mode function.
3134 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3135 ;; necessary comint-specific local variables. Then create the
3136 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3137 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3138 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3139 ;; get-old-input) that need to be different from the defaults. Call
3140 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3141 ;; comint-mode will take care of it. The following example, from shell.el,
3142 ;; is typical:
3143 ;;
3144 ;; (defvar shell-mode-map '())
3145 ;; (cond ((not shell-mode-map)
3146 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3147 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3148 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3149 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3150 ;; (define-key shell-mode-map "\M-?"
3151 ;; 'comint-dynamic-list-filename-completions)))
3152 ;;
3153 ;; (defun shell-mode ()
3154 ;; (interactive)
3155 ;; (comint-mode)
3156 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3157 ;; (setq major-mode 'shell-mode)
3158 ;; (setq mode-name "Shell")
3159 ;; (use-local-map shell-mode-map)
3160 ;; (make-local-variable 'shell-directory-stack)
3161 ;; (setq shell-directory-stack nil)
3162 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3163 ;; (run-hooks 'shell-mode-hook))
3164 ;;
3165 ;;
3166 ;; Completion for comint-mode users
3167 ;;
3168 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3169 ;; hook to add completion functions to. Functions on this list should return
3170 ;; non-nil if completion occurs (i.e., further completion should not occur).
3171 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3172 ;; completion job.
3173 \f
3176 ;; comint.el ends here