| blob | 4fc8f67402e03220443d3a97e388ae30a58b305f |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000
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-kill-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-kill-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 See also `comint-highlight-face'."
215 "Face to use to highlight input when `comint-highlight-input' is non-nil."
219 "*If non-nil, highlight program prompts.
220 See also `comint-highlight-face'."
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'."
301 "*If non-nil, assume that the subprocess echoes any input.
302 If so, delete one copy of the input so that only one copy eventually
303 appears in the buffer.
305 This variable is buffer-local."
309 ;; AIX puts the name of the person being su'd to in front of the prompt.
310 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
311 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
312 ;; ssh-add prints a prompt like `Enter passphrase: '.
313 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
318 "*Regexp matching prompts for passwords in the inferior process.
319 This is used by `comint-watch-for-password-prompt'."
323 ;; Here are the per-interpreter hooks.
325 "Function that returns old text in comint mode.
326 This function is called when return is typed while the point is in old
327 text. It returns the text to be submitted as process input. The
328 default is `comint-get-old-input-default', which either grabs the
329 current input field or grabs the current line and strips off leading
330 text matching `comint-prompt-regexp', depending on the value of
335 "List of functions called to perform completion.
336 Functions should return non-nil if completion was performed.
337 See also `comint-dynamic-complete'.
343 "Predicate for filtering additions to input history.
344 Takes one argument, the input. If non-nil, the input may be saved on the input
348 "Functions to call before input is sent to the process.
349 These functions get one argument, a string containing the text to send.
354 "Functions to call after output is inserted into the buffer.
355 One possible function is `comint-postoutput-scroll-to-bottom'.
356 These functions get one argument, a string containing the text as originally
357 inserted. Note that this might not be the same as the buffer contents between
358 `comint-last-output-start' and the buffer's `process-mark', if other filter
359 functions have already modified the buffer.
361 See also `comint-preoutput-filter-functions'.
366 "Function to actually send to PROCESS the STRING submitted by user.
367 Usually this is just `comint-simple-send', but if your mode needs to
368 massage the input string, put a different function here.
369 `comint-simple-send' just sends the string plus a newline.
373 "*Non-nil means go to the end of the line before sending input.
374 See `comint-send-input'."
378 ;; Note: If it is decided to purge comint-prompt-regexp from the source
379 ;; entirely, searching for uses of this variable will help to identify
380 ;; places that need attention.
382 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
383 If nil, then program output and user-input are given different `field'
384 properties, which emacs commands can use to distinguish them (in
385 particular, common movement commands such as begining-of-line respect
386 field boundaries in a natural way)."
391 "Called upon entry into comint-mode
392 This is run before the process is cranked up."
397 "Called each time a process is exec'd by `comint-exec'.
398 This is called after the process is cranked up. It is useful for things that
399 must be done each time a process is executed in a comint mode buffer (e.g.,
400 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
401 executed once when the buffer is created."
408 "Non-nil if communications via pty; false if by pipe. Buffer local.
420 "Last input ring index which you copied.
424 "Non-nil if you are accumulating input lines to send as input together.
443 "Major mode for interacting with an inferior interpreter.
444 Interpreter name is same as buffer name, sans the asterisks.
445 Return at end of buffer sends line as input.
446 Return not at end copies rest of line to end and sends it.
447 Setting variable `comint-eol-on-send' means jump to the end of the line
448 before submitting new input.
450 This mode is customised to create major modes such as Inferior Lisp
451 mode, Shell mode, etc. This can be done by setting the hooks
452 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
453 and `comint-get-old-input' to appropriate functions, and the variable
454 `comint-prompt-regexp' to the appropriate regular expression.
456 An input history is maintained of size `comint-input-ring-size', and
457 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
458 Input ring history expansion can be achieved with the commands
460 Input ring expansion is controlled by the variable `comint-input-autoexpand',
461 and addition is controlled by the variable `comint-input-ignoredups'.
463 Commands with no default key bindings include `send-invisible',
464 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
465 `comint-magic-space'.
467 Input to, and output from, the subprocess can cause the window to scroll to
468 the end of the buffer. See variables `comint-output-filter-functions',
469 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
470 and `comint-scroll-to-bottom-on-output'.
473 to continue it.
477 Entry to this mode runs the hooks on `comint-mode-hook'."
479 ;; Do not remove this. All major modes must do this.
535 nil
536 ;; Keys:
565 ;; Mouse Buttons:
566 ;; Note, if you change this, you will have to change
567 ;; comint-insert-clicked-input as well
569 ;; Menu bars:
570 ;; completion:
581 ;; 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 a buffer, running PROGRAM.
648 The name of the buffer is made by surrounding NAME with `*'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.
666 buffer))
668 ;;;###autoload
670 "Run PROGRAM in a comint buffer and switch to it.
671 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
672 The file name is used to make a symbol name, such as `comint-sh-hook', and any
673 hooks on this symbol are run in the buffer.
674 See `make-comint' and `comint-exec'."
681 "Start up a process in buffer BUFFER for comint modes.
682 Blasts any old process running in the buffer. Doesn't set the buffer mode.
683 You can use this to cheaply run a series of processes in the same comint
684 buffer. The hook `comint-exec-hook' is run after each exec."
689 ;; Crank up a new process
697 ;; Jump to the end, and set the process mark.
700 ;; Feed it the startfile.
702 ;;This is guaranteed to wait long enough
703 ;;but has bad results if the comint does not prompt at all
704 ;; (while (= size (buffer-size))
705 ;; (sleep-for 1))
706 ;;I hope 1 second is enough!
714 buffer)))
716 ;; This auxiliary function cranks up the process for comint-exec in
717 ;; the appropriate environment.
722 ;; If using termcap, we specify `emacs' as the terminal type
723 ;; because that lets us specify a width.
724 ;; If using terminfo, we specify `dumb' because that is
725 ;; a defined terminal type. `emacs' is not a defined terminal type
726 ;; and there is no way for us to define it here.
727 ;; Some programs that use terminfo get very confused
728 ;; if TERM is not a valid terminal type.
735 process-environment))
738 default-directory
740 proc decoding encoding changed)
742 ;; If the command has slashes, make sure we
743 ;; first look relative to the current directory.
749 ;; If start-process decided to use some coding system for decoding
750 ;; data sent from the process and the coding system doesn't
751 ;; specify EOL conversion, we had better convert CRLF to LF.
754 changed t))
755 ;; Even if start-process left the coding system for encoding data
756 ;; sent from the process undecided, we had better use the same one
757 ;; as what we use for decoding. But, we should suppress EOL
758 ;; conversion.
761 changed t))
764 proc))
768 "In a comint buffer, set the current input to the clicked-on previous input."
770 ;; This won't play nicely with other overlays...
772 ;; do we have input in this area?
779 ;; Can't use kill-region as it sets this-command
784 ;; fall back to the user's previous definition if we aren't
785 ;; on previous input region (note, if you change [mouse-2]
786 ;; to something else, you should also change the default
787 ;; keybinding above)
792 \f
793 ;; Input history processing in a buffer
794 ;; ===========================================================================
795 ;; Useful input history functions, courtesy of the Ergo group.
797 ;; Eleven commands:
798 ;; comint-dynamic-list-input-ring List history in help buffer.
799 ;; comint-previous-input Previous input...
800 ;; comint-previous-matching-input ...matching a string.
801 ;; comint-previous-matching-input-from-input ... matching the current input.
802 ;; comint-next-input Next input...
803 ;; comint-next-matching-input ...matching a string.
804 ;; comint-next-matching-input-from-input ... matching the current input.
805 ;; comint-backward-matching-input Backwards input...
806 ;; comint-forward-matching-input ...matching a string.
807 ;; comint-replace-by-expanded-history Expand history at point;
808 ;; replace with expanded history.
809 ;; comint-magic-space Expand history and insert space.
810 ;;
811 ;; Three functions:
812 ;; comint-read-input-ring Read into comint-input-ring...
813 ;; comint-write-input-ring Write to comint-input-ring-file-name.
814 ;; comint-replace-by-expanded-history-before-point Workhorse function.
817 "Sets the buffer's `comint-input-ring' from a history file.
818 The name of the file is given by the variable `comint-input-ring-file-name'.
819 The history ring is of size `comint-input-ring-size', regardless of file size.
820 If `comint-input-ring-file-name' is nil this function does nothing.
822 If the optional argument SILENT is non-nil, we say nothing about a
823 failure to read the history file.
825 This function is useful for major mode commands and mode hooks.
827 The commands stored in the history file are separated by the
828 `comint-input-ring-separator'. The most recent command comes last.
830 See also `comint-input-ignoredups' and `comint-write-input-ring'."
833 nil)
837 comint-input-ring-file-name)))
850 ;; Save restriction in case file is already visited...
851 ;; Watch for those date stamps in history files!
855 nil t))
871 comint-input-ring-index nil)))))
874 "Writes the buffer's `comint-input-ring' to a history file.
875 The name of the file is given by the variable `comint-input-ring-file-name'.
876 The original contents of the file are lost if `comint-input-ring' is not empty.
877 If `comint-input-ring-file-name' is nil this function does nothing.
879 Useful within process sentinels.
881 See also `comint-read-input-ring'."
885 nil)
893 ;; Write it all out into a buffer first. Much faster, but messier,
894 ;; than writing it one line at a time.
906 "List in help buffer the buffer's input history."
915 ;; We have to build up a list ourselves from the ring vector.
919 ;; Change "completion" to "history reference"
920 ;; to make the display accurate.
936 ;; Return list of regexp and prefix arg using PROMPT.
944 regexp)
948 ;; First make sure there is a ring and that we are after the process mark
955 ;; arg of zero resets search from beginning, and uses arg of 1
959 arg)))
962 ;; Index to start a directional search, starting at comint-input-ring-index
964 ;; If a search is running, offset by 1 in direction of arg
967 ;; For a new search, start from beginning or end, as appropriate
973 "Return the string ARG places along the input ring.
974 Moves relative to `comint-input-ring-index'."
978 arg)))
981 "Cycle backwards through input history."
986 "Cycle forwards through input history."
991 "Return the string matching REGEXP ARG places along the input ring.
992 Moves relative to `comint-input-ring-index'."
997 "Return the index matching REGEXP ARG places along the input ring.
998 Moves relative to START, or `comint-input-ring-index'."
1007 ;; Do the whole search as many times as the argument says.
1009 ;; Step once.
1012 ;; If we haven't reached a match, step some more.
1016 ;; If we have gone all the way around in this search.
1019 ;; Now that we know which ring element to use, if we found it, return that.
1021 n)))
1024 "Search backwards through input history for match for REGEXP.
1025 \(Previous history elements are earlier commands.)
1026 With prefix argument N, search for Nth previous match.
1027 If N is negative, find the next or Nth next match."
1031 ;; Has a match been found?
1037 ;; Can't use kill-region as it sets this-command
1044 "Search forwards through input history for match for REGEXP.
1045 \(Later history elements are more recent commands.)
1046 With prefix argument N, search for Nth following match.
1047 If N is negative, find the previous or Nth previous match."
1052 "Search backwards through input history for match for current input.
1053 \(Previous history elements are earlier commands.)
1054 With prefix argument N, search for Nth previous match.
1055 If N is negative, search forwards for the -Nth following match."
1058 comint-next-matching-input-from-input)))
1059 ;; Starting a new search
1065 comint-input-ring-index nil))
1068 arg))
1071 "Search forwards through input history for match for current input.
1072 \(Following history elements are more recent commands.)
1073 With prefix argument N, search for Nth following match.
1074 If N is negative, search backwards for the -Nth previous match."
1080 "Expand input command history references before point.
1081 Expansion is dependent on the value of `comint-input-autoexpand'.
1083 This function depends on the buffer's idea of the input history, which may not
1084 match the command interpreter's idea, assuming it has one.
1086 Assumes history syntax is like typical Un*x shells'. However, since emacs
1087 cannot know the interpreter's idea of input line numbers, assuming it has one,
1088 it cannot expand absolute input line number references.
1090 If the optional argument SILENT is non-nil, never complain
1091 even if history reference seems erroneous.
1093 If the optional argument START is non-nil, that specifies the
1094 start of the text to scan for history references, rather
1095 than the logical beginning of line.
1097 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1099 Returns t if successful."
1104 ;; Use comint-prompt-regexp
1107 ;; Use input fields. User input that hasn't been entered
1108 ;; yet, at the end of the buffer, has a nil `field' property.
1110 ;; Looks like there might be history references in the command.
1117 "Expand directory stack reference before point.
1118 See `comint-replace-by-expanded-history'. Returns t if successful.
1120 If the optional argument START is non-nil, that specifies the
1121 start of the text to scan for history references, rather
1122 than the logical beginning of line."
1129 ;; This seems a bit complex. We look for references such as !!, !-num,
1130 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1131 ;; If that wasn't enough, the plings can be suffixed with argument
1132 ;; range specifiers.
1133 ;; Argument ranges are complex too, so we hive off the input line,
1134 ;; referenced with plings, with the range string to `comint-args'.
1138 ;; The history is quoted, or we're in quotes.
1141 ;; We cannot know the interpreter's idea of input line numbers.
1145 ;; Just a number of args from `number' lines backward.
1154 t t)
1160 ;; Just a number of args from the previous input line.
1164 t t)
1168 ;; Most recent input starting with or containing (possibly
1169 ;; protected) string, maybe just a number of args. Phew.
1187 t t)
1190 ;; Quick substitution on the previous input line.
1207 "Expand input history references before point and insert ARG spaces.
1208 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1212 \f
1214 "Return t if the number of quotes between BEG and END is odd.
1215 Quotes are single and double."
1221 "Return number of matches for REGEXP from BEG to END."
1228 count))
1231 ;; From STRING, return the args depending on the range specified in the text
1232 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1233 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1249 ;; Return a list of arguments from ARG. Break it up at the
1250 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1265 comint-delimiter-argument-list)))
1268 args)))
1271 "Return from STRING the NTH to MTH arguments.
1272 NTH and/or MTH can be nil, which means the last argument.
1273 Returned arguments are separated by single spaces.
1274 We assume whitespace separates arguments, except within quotes
1275 and except for a space or tab that immediately follows a backslash.
1276 Also, a run of one or more of a single character
1277 in `comint-delimiter-argument-list' is a separate argument.
1278 Argument 0 is the command name."
1279 ;; The first line handles ordinary characters and backslash-sequences
1280 ;; (except with w32 msdos-like shells, where backslashes are valid).
1281 ;; The second matches "-quoted strings.
1282 ;; The third matches '-quoted strings.
1283 ;; The fourth matches `-quoted strings.
1284 ;; This seems to fit the syntax of BASH 2.0.
1295 beg str value quotes)
1296 ;; Build a list of all the args until we have as many as we want.
1300 ;; It's contiguous, part of the same arg.
1303 ;; It's a new separate arg.
1305 ;; Put the previous arg, if there was one, onto ARGS.
1322 \f
1323 ;;
1324 ;; Input processing stuff
1325 ;;
1328 "Send input to process.
1329 After the process output mark, sends all text from the process mark to
1330 point as input to the process. Before the process output mark, calls value
1331 of variable `comint-get-old-input' to retrieve old input, copies it to the
1332 process mark, and sends it. If variable `comint-process-echoes' is nil,
1333 a terminal newline is also inserted into the buffer and sent to the process
1334 \(if it is non-nil, all text from the process mark to point is deleted,
1335 since it is assumed the remote process will re-echo it).
1337 Any history reference may be expanded depending on the value of the variable
1338 `comint-input-autoexpand'. The list of function names contained in the value
1339 of `comint-input-filter-functions' is called on the input before sending it.
1340 The input is entered into the input history ring, if the value of variable
1341 `comint-input-filter' returns non-nil when called on the input.
1343 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1344 end of line before sending the input.
1346 The values of `comint-get-old-input', `comint-input-filter-functions', and
1347 `comint-input-filter' are chosen according to the command interpreter running
1348 in the buffer. E.g.,
1350 If the interpreter is the csh,
1351 comint-get-old-input is the default: either return the current
1352 field, or take the current line and discard any
1353 initial string matching regexp `comint-prompt-regexp', depending
1354 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1357 comint-input-filter is the default: returns t if the input isn't all white
1358 space.
1360 If the comint is Lucid Common Lisp,
1361 comint-get-old-input snarfs the sexp ending at point.
1362 comint-input-filter-functions does nothing.
1363 comint-input-filter returns nil if the input matches input-filter-regexp,
1364 which matches (1) all whitespace (2) :a, :c, etc.
1366 Similarly for Soar, Scheme, etc."
1368 ;; Note that the input string does not include its terminal newline.
1378 copy)))
1380 ;; Just whatever's already there
1381 intxt
1382 ;; Expand and leave it visible in buffer
1386 input
1387 ;; This is messy 'cos ultimately the original
1388 ;; functions used do insertion, rather than return
1389 ;; strings. We have to expand, then insert back.
1395 copy))))
1406 history))))
1415 ;; Make an overlay for the input field
1418 ;; Give old user input a field property of `input', to
1419 ;; distinguish it from both process output and unsent
1420 ;; input. The terminating newline is put into a special
1421 ;; `boundary' field to make cursor movement between input
1422 ;; and output fields smoother.
1430 ;; Make an overlay for the terminating newline
1440 ;; Update the markers before we send the input
1441 ;; in case we get output amidst sending the input.
1445 ;; clear the "accumulation" marker
1448 ;; This used to call comint-output-filter-functions,
1449 ;; but that scrolled the buffer in undesirable ways.
1453 "List of functions to call before inserting Comint output into the buffer.
1454 Each function gets one argument, a string containing the text received
1455 from the subprocess. It should return the string to insert, perhaps
1456 the same string that was received, or perhaps a modified or transformed
1457 string.
1459 The functions on the list are called sequentially, and each one is
1460 given the string returned by the previous one. The string returned by
1461 the last function is the text that is actually inserted in the
1462 redirection buffer.
1466 ;; When non-nil, this is the last overlay used for output.
1467 ;; It is kept around so that we can extend it instead of creating
1468 ;; multiple contiguous overlays for multiple contiguous output chunks.
1471 ;; When non-nil, this is an overlay over the last recognized prompt in
1472 ;; the buffer; it is used when highlighting the prompt.
1475 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1476 ;; Any further output will then create a new comint-last-prompt-overlay.
1482 ;; The purpose of using this filter for comint processes
1483 ;; is to keep comint-last-input-end from moving forward
1484 ;; when output is inserted.
1487 ;; First check for killed buffer or no input.
1490 ;; Run preoutput filters
1496 ;; Insert STRING
1498 ;; Avoid the overhead of save-excursion, since we just
1499 ;; fiddle with the point
1502 ;; The point should float after any insertion we do
1505 ;; We temporarly remove any buffer narrowing, in case the
1506 ;; process mark is outside of the restriction
1513 ;; insert-before-markers is a bad thing. XXX
1514 ;;
1515 ;; It is used here to force window-point markers (used to
1516 ;; store the value of point in non-selected windows) to
1517 ;; advance, but it also screws up any other markers that we
1518 ;; don't _want_ to advance, such as the start-marker of some
1519 ;; of the overlays we create.
1520 ;;
1521 ;; We work around the problem with the overlays by
1522 ;; explicitly adjusting them after we do the insertion, but
1523 ;; in the future this problem should be solved correctly, by
1524 ;; using `insert', and making the insertion-type of
1525 ;; window-point markers settable (via a buffer-local
1526 ;; variable). In comint buffers, this variable would be set
1527 ;; to `t', to cause point in non-select windows to advance.
1529 ;; Fixup markers and overlays that got screwed up because we
1530 ;; used `insert-before-markers'.
1532 ;; comint-last-output-start marker
1534 ;; No overlays we create are set to advance upon insertion
1535 ;; (at the start/end), so we assume that any overlay which
1536 ;; is at the current point was incorrectly advanced by
1537 ;; insert-before-markers. First fixup overlays that might
1538 ;; start at point:
1543 old-point
1545 ;; Then do overlays that might end at point:
1550 old-point))))
1552 ;; Advance process-mark
1556 ;; We check to see if the last overlay used for output is
1557 ;; adjacent to the new input, and if so, just extend it.
1561 ;; Extend comint-last-output-overlay to include the
1562 ;; most recent output
1566 ;; Create a new overlay
1576 ;; Highlight the prompt, where we define `prompt' to mean
1577 ;; the most recent output that doesn't end with a newline.
1579 ;; Need to create or move the prompt overlay (in the case
1580 ;; where there is no prompt ((bolp) == t), we still do
1581 ;; this if there's already an existing overlay).
1584 ;; Just move an existing overlay
1587 ;; Need to create the overlay
1594 ;;(force-mode-line-update)
1601 "Go to the end of buffer in all windows showing it.
1602 Movement occurs if point in the selected window is not after the process mark,
1603 and `this-command' is an insertion command. Insertion commands recognised
1604 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1605 Depends on the value of `comint-scroll-to-bottom-on-input'.
1607 This function should be a pre-command hook."
1610 hilit-yank)))
1626 nil t))))))
1629 "Go to the end of buffer in all windows showing it.
1630 Does not scroll if the current line is the last line in the buffer.
1631 Depends on the value of `comint-scroll-to-bottom-on-output' and
1632 `comint-scroll-show-maximum-output'.
1634 This function should be in the list `comint-output-filter-functions'."
1648 ;; Maybe user wants point to jump to end.
1651 ;; If point was at the end, keep it at end.
1655 ;; Optionally scroll so that the text
1656 ;; ends at the bottom of the window.
1663 nil t))
1667 "Truncate the buffer to `comint-buffer-maximum-size'.
1668 This function could be on `comint-output-filter-functions' or bound to a key."
1677 "Strip trailing `^M' characters from the current output group.
1678 This function could be on `comint-output-filter-functions' or bound to a key."
1691 "Put the end of the buffer at the bottom of the window."
1697 "Default for `comint-get-old-input'.
1698 Returns either the current field, or the current line with any initial
1699 text matching `comint-prompt-regexp' stripped off, depending on the
1700 value of `comint-use-prompt-regexp-instead-of-fields'."
1708 ;; Return the contents of the field at the current point.
1713 "Insert after prompt old input at point as new input to be edited.
1714 Calls `comint-get-old-input' to get old input."
1724 "Skip past the text matching regexp `comint-prompt-regexp'.
1725 If this takes us past the end of the current line, don't skip at all."
1732 "Return t if point is after the process output marker."
1737 "Default function for sending to PROC input STRING.
1738 This just sends STRING plus a newline. To override this,
1739 set the hook `comint-input-sender'."
1744 "Returns the buffer position of the beginning of the line, after any prompt.
1745 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1746 prompt skip is done by skipping text matching the regular expression
1747 `comint-prompt-regexp', a buffer local variable."
1749 ;; Use comint-prompt-regexp
1754 ;; Use input fields. Note that, unlike the behavior of
1755 ;; `line-beginning-position' inside a field, this function will
1756 ;; return the position of the end of a prompt, even if the point is
1757 ;; already inside the prompt. In order to do this, it assumes that
1758 ;; if there are two fields on a line, then the first one is the
1759 ;; prompt, and the second one is an input field, and is front-sticky
1760 ;; (as input fields should be).
1764 "Goes to the beginning of line, then skips past the prompt, if any.
1766 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1767 prompt skip is done by skipping text matching the regular expression
1768 `comint-prompt-regexp', a buffer local variable."
1771 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1775 ;; These three functions are for entering text you don't want echoed or
1776 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1777 ;; Just enter m-x send-invisible and type in your line, or add
1778 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1781 "Read a single line of text from user without echoing, and return it.
1782 Prompt with argument PROMPT, a string. Optional argument STARS causes
1783 input to be echoed with '*' characters on the prompt line. Input ends with
1784 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1785 `inhibit-quit' is set because e.g. this function was called from a process
1786 filter and C-g is pressed, this function returns nil rather than a string).
1788 Note that the keystrokes comprising the text can still be recovered
1790 Once the caller uses the password, it can erase the password
1791 by doing (fillarray STRING 0)."
1803 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1806 ;; This function may get called from a process filter, where
1807 ;; inhibit-quit is set. In later versions of emacs read-char
1808 ;; may clear quit-flag itself and return C-g. That would make
1809 ;; it impossible to quit this loop in a simple way, so
1810 ;; re-enable it here (for backward-compatibility the check for
1811 ;; quit-flag below would still be necessary, so this seems
1812 ;; like the simplest way to do things).
1814 done t))
1828 ;; Emulate a true quit, except that we have to return a value.
1834 ans)))
1837 "Read a string without echoing.
1838 Then send it to the process running in the current buffer.
1839 The string is sent using `comint-input-sender'.
1840 Security bug: your string can still be temporarily recovered with
1856 "Prompt in the minibuffer for password and send without echoing.
1857 This function uses `send-invisible' to read and send a password to the buffer's
1858 process if STRING contains a password prompt defined by
1859 `comint-password-prompt-regexp'.
1861 This function could be in the list `comint-output-filter-functions'."
1864 \f
1865 ;; Low-level process communication
1868 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1874 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1878 \f
1879 ;; Random input hackage
1882 "Kill all output from interpreter since last input.
1883 Does not delete the prompt."
1896 ;; Output message and put back prompt
1900 "Display start of this batch of interpreter output at top of window.
1901 Sets mark to the value of point when this command is run."
1916 "Interrupt the current subjob.
1917 This command also kills the pending input
1918 between the process-mark and point."
1924 "Send kill signal to the current subjob.
1925 This command also kills the pending input
1926 between the process-mark and point."
1932 "Send quit signal to the current subjob.
1933 This command also kills the pending input
1934 between the process-mark and point."
1940 "Stop the current subjob.
1941 This command also kills the pending input
1942 between the process-mark and point.
1944 WARNING: if there is no current subjob, you can end up suspending
1945 the top-level process running in the buffer. If you accidentally do
1947 is not a problem with most shells, since they ignore this signal.)"
1953 "Send CONT signal to process buffer's process group.
1954 Useful if you accidentally suspend the top-level process."
1959 "Kill all text from last stuff output by interpreter to point."
1966 "Delete ARG characters forward or send an EOF to subprocess.
1967 Sends an EOF only if point is at the end of the buffer and there is no input."
1975 "Send an EOF to the current buffer's process."
1982 "Search backward through buffer for input fields that match REGEXP.
1983 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
1984 fields are identified by lines that match `comint-prompt-regexp'.
1986 With prefix argument N, search for Nth previous match.
1987 If N is negative, find the next or Nth next match."
1990 ;; Use comint-prompt-regexp
2000 ;; Use input fields
2014 "Search forward through buffer for input fields that match REGEXP.
2015 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2016 fields are identified by lines that match `comint-prompt-regexp'.
2018 With prefix argument N, search for Nth following match.
2019 If N is negative, find the previous or Nth previous match."
2025 "Move to end of Nth next prompt in the buffer.
2026 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2027 the beginning of the Nth next `input' field, otherwise, it means the Nth
2028 occurance of text matching `comint-prompt-regexp'."
2031 ;; Use comint-prompt-regexp
2036 ;; Use input fields
2045 ;; Ran off the end of the buffer.
2055 "Move to end of Nth previous prompt in the buffer.
2056 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2057 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2058 occurance of text matching `comint-prompt-regexp'."
2061 \f
2062 ;; Support for source-file processing commands.
2063 ;;============================================================================
2064 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2065 ;; commands that process files of source text (e.g. loading or compiling
2066 ;; files). So the corresponding process-in-a-buffer modes have commands
2067 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2068 ;; for defining these commands.
2069 ;;
2070 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2071 ;; and Soar, in that they don't know anything about file extensions.
2072 ;; So the compile/load interface gets the wrong default occasionally.
2073 ;; The load-file/compile-file default mechanism could be smarter -- it
2074 ;; doesn't know about the relationship between filename extensions and
2075 ;; whether the file is source or executable. If you compile foo.lisp
2076 ;; with compile-file, then the next load-file should use foo.bin for
2077 ;; the default, not foo.lisp. This is tricky to do right, particularly
2078 ;; because the extension for executable files varies so much (.o, .bin,
2079 ;; .lbin, .mo, .vo, .ao, ...).
2082 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2083 ;; commands.
2084 ;;
2085 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2086 ;; want to save the buffer before issuing any process requests to the command
2087 ;; interpreter.
2088 ;;
2089 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2090 ;; for the file to process.
2092 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2093 ;;============================================================================
2094 ;; This function computes the defaults for the load-file and compile-file
2095 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2096 ;;
2097 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2098 ;; source-file processing command. NIL if there hasn't been one yet.
2099 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2100 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2101 ;; Typically, (lisp-mode) or (scheme-mode).
2102 ;;
2103 ;; If the command is given while the cursor is inside a string, *and*
2104 ;; the string is an existing filename, *and* the filename is not a directory,
2105 ;; then the string is taken as default. This allows you to just position
2106 ;; your cursor over a string that's a filename and have it taken as default.
2107 ;;
2108 ;; If the command is given in a file buffer whose major mode is in
2109 ;; SOURCE-MODES, then the the filename is the default file, and the
2110 ;; file's directory is the default directory.
2111 ;;
2112 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2113 ;; then the default directory & file are what was used in the last source-file
2114 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2115 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2116 ;; is the cwd, with no default file. (\"no default file\" = nil)
2117 ;;
2118 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2119 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2120 ;; for Soar programs, etc.
2121 ;;
2122 ;; The function returns a pair: (default-directory . default-file).
2133 ;; (COMINT-CHECK-SOURCE fname)
2134 ;;============================================================================
2135 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2136 ;; process-in-a-buffer modes), this function can be called on the filename.
2137 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2138 ;; is queried to see if he wants to save the buffer before proceeding with
2139 ;; the load or compile.
2146 ;; save BUFF.
2153 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2154 ;;============================================================================
2155 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2156 ;; commands that process source files (like loading or compiling a file).
2157 ;; It prompts for the filename, provides a default, if there is one,
2158 ;; and returns the result filename.
2159 ;;
2160 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2161 ;;
2162 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2163 ;; from the last source processing command. SOURCE-MODES is a list of major
2164 ;; modes used to determine what file buffers contain source files. (These
2165 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2166 ;; then the filename reader will only accept a file that exists.
2167 ;;
2168 ;; A typical use:
2169 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2170 ;; '(lisp-mode) t))
2172 ;; This is pretty stupid about strings. It decides we're in a string
2173 ;; if there's a quote on both sides of point on the current line.
2175 "Return string around POINT that starts the current line, or nil."
2202 prompt deffile)
2203 prompt)
2204 defdir
2206 mustmatch-p)))
2209 ;; I am somewhat divided on this string-default feature. It seems
2210 ;; to violate the principle-of-least-astonishment, in that it makes
2211 ;; the default harder to predict, so you actually have to look and see
2212 ;; what the default really is before choosing it. This can trip you up.
2213 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2214 ;; on this.
2215 ;; -Olin
2217 \f
2218 ;; Simple process query facility.
2219 ;; ===========================================================================
2220 ;; This function is for commands that want to send a query to the process
2221 ;; and show the response to the user. For example, a command to get the
2222 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2223 ;; to an inferior Common Lisp process.
2224 ;;
2225 ;; This simple facility just sends strings to the inferior process and pops
2226 ;; up a window for the process buffer so you can see what the process
2227 ;; responds with. We don't do anything fancy like try to intercept what the
2228 ;; process responds with and put it in a pop-up window or on the message
2229 ;; line. We just display the buffer. Low tech. Simple. Works good.
2231 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2232 ;; a window for the inferior process so that its response can be seen.
2242 ;; Try to position the proc window so you can see the answer.
2243 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2244 ;; I don't know why. Wizards invited to improve it.
2253 \f
2254 ;; Filename/command/history completion in a buffer
2255 ;; ===========================================================================
2256 ;; Useful completion functions, courtesy of the Ergo group.
2258 ;; Six commands:
2259 ;; comint-dynamic-complete Complete or expand command, filename,
2260 ;; history at point.
2261 ;; comint-dynamic-complete-filename Complete filename at point.
2262 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2263 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2264 ;; replace with expanded/completed name.
2265 ;; comint-dynamic-simple-complete Complete stub given candidates.
2267 ;; These are not installed in the comint-mode keymap. But they are
2268 ;; available for people who want them. Shell-mode installs them:
2269 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2270 ;; (define-key shell-mode-map "\M-?"
2271 ;; 'comint-dynamic-list-filename-completions)))
2272 ;;
2273 ;; Commands like this are fine things to put in load hooks if you
2274 ;; want them present in specific modes.
2277 "*If non-nil, automatically list possibilities on partial completion.
2278 This mirrors the optional behavior of tcsh."
2283 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2284 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2285 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2286 This mirrors the optional behavior of tcsh."
2291 "*If non-nil, use shortest completion if characters cannot be added.
2292 This mirrors the optional behavior of tcsh.
2294 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2299 "*List of suffixes to be disregarded during file completion.
2300 This mirrors the optional behavior of bash and tcsh.
2302 Note that this applies to `comint-dynamic-complete-filename' only."
2307 "Prefix prepended to absolute file names taken from process input.
2308 This is used by comint's and shell's completion functions, and by shell's
2313 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2315 "String of characters valid in a file name.
2316 Note that all non-ASCII characters are considered valid in a file name
2317 regardless of what this variable says.
2328 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2331 directory)))
2335 "Return the word of WORD-CHARS at point, or nil if non is found.
2336 Word constituents are considered to be those in WORD-CHARS, which is like the
2338 plus all non-ASCII characters."
2342 ;;(memq (char-after (point)) shell-file-name-quote-list)
2346 ;; Don't go forward over a word-char (this can happen if we're at bob).
2349 ;; Set match-data to match the entire string.
2355 "Return FILENAME with environment variables substituted.
2356 Supports additional environment variable syntax of the command
2357 interpreter (e.g., the percent notation of cmd.exe on NT)."
2361 env-var-val)
2370 name))
2373 "Return the filename at point, or nil if non is found.
2374 Environment variables are substituted. See `comint-word'."
2381 "Return FILENAME with magic characters quoted.
2382 Magic characters are those in `comint-file-name-quote-list'."
2384 filename
2391 filename))))
2394 "Return FILENAME with quoted characters unquoted."
2396 filename
2402 filename)))
2406 "Dynamically perform completion at point.
2407 Calls the functions in `comint-dynamic-complete-functions' to perform
2408 completion until a function returns non-nil, at which point completion is
2409 assumed to have occurred."
2415 "Dynamically complete the filename at point.
2416 Completes if after a filename. See `comint-match-partial-filename' and
2417 `comint-dynamic-complete-as-filename'.
2418 This function is similar to `comint-replace-by-expanded-filename', except that
2419 it won't change parts of the filename already entered in the buffer; it just
2420 adds completion characters to the end of the filename. A completions listing
2421 may be shown in a help buffer if completion is ambiguous.
2423 Completion is dependent on the value of `comint-completion-addsuffix',
2424 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2425 completions listing is dependent on the value of `comint-completion-autolist'.
2427 Returns t if successful."
2435 "Dynamically complete at point as a filename.
2436 See `comint-dynamic-complete-filename'. Returns t if successful."
2439 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2440 ;; I think it was originally bound to solve file completion problems,
2441 ;; but subsequent changes may have made this unnecessary. sm.
2442 ;;(file-name-handler-alist nil)
2477 ;; We inserted a unique completion.
2484 ;; It's not unique, but user wants shortest match.
2490 ;; It's not unique, list possible completions.
2495 success))
2499 "Dynamically expand and complete the filename at point.
2500 Replace the filename with an expanded, canonicalised and completed replacement.
2503 removed, and the filename is made absolute instead of relative. For expansion
2504 see `expand-file-name' and `substitute-in-file-name'. For completion see
2505 `comint-dynamic-complete-filename'."
2512 "Dynamically complete STUB from CANDIDATES list.
2513 This function inserts completion characters at point by completing STUB from
2514 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2515 if completion is ambiguous.
2517 Returns nil if no completion was inserted.
2518 Returns `sole' if completed with the only completion match.
2519 Returns `shortest' if completed with the shortest of the completion matches.
2520 Returns `partial' if completed as far as possible with the completion matches.
2521 Returns `listed' if a completion listing was shown.
2523 See also `comint-dynamic-complete-filename'."
2532 nil)
2543 ;; Insert the longest substring.
2548 ;; It's not unique, but user wants shortest match.
2554 ;; It's not unique, list possible completions.
2563 "List in help buffer possible completions of the filename at point."
2566 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2567 ;; I think it was originally bound to solve file completion problems,
2568 ;; but subsequent changes may have made this unnecessary. sm.
2569 ;;(file-name-handler-alist nil)
2582 "List in help buffer sorted COMPLETIONS.
2583 Typing SPC flushes the help buffer."
2597 ;; If the user does mouse-choose-completion with the mouse,
2598 ;; execute the command, then delete the completion window.
2605 \f
2607 "After fetching a line from input history, this fetches the following line.
2608 In other words, this recalls the input line after the line you recalled last.
2609 You can use this to repeat a sequence of input lines."
2618 "Accumulate a line to send as input along with more lines.
2619 This inserts a newline so that you can enter more text
2621 to send all the accumulated input, at once.
2622 The entire accumulated text becomes one item in the input history
2623 when you send it."
2632 "Move point to the process mark.
2633 The process mark separates output, and input already sent,
2634 from input that has not yet been sent."
2642 "Move point to beginning of line (after prompt) or to the process mark.
2643 The first time you use this command, it moves to the beginning of the line
2644 \(but after the prompt, if any). If you repeat it again immediately,
2645 it moves point to the process mark.
2647 The process mark separates the process output, along with input already sent,
2648 from input that has not yet been sent. Ordinarily, the process mark
2649 is at the beginning of the current input line; but if you have
2651 the process mark is at the beginning of the accumulated input."
2658 "Set the process mark at point."
2665 \f
2666 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2668 ;; This little add-on for comint is intended to make it easy to get
2669 ;; output from currently active comint buffers into another buffer,
2670 ;; or buffers, and then go back to using the comint shell.
2671 ;;
2672 ;; My particular use is SQL interpreters; I want to be able to execute a
2673 ;; query using the process associated with a comint-buffer, and save that
2674 ;; somewhere else. Because the process might have state (for example, it
2675 ;; could be in an uncommitted transaction), just running starting a new
2676 ;; process and having it execute the query and then finish, would not
2677 ;; work. I'm sure there are other uses as well, although in many cases
2678 ;; starting a new process is the simpler, and thus preferable, approach.
2679 ;;
2680 ;; The basic implementation is as follows: comint-redirect changes the
2681 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2682 ;; its own filter. The filter puts the output into the designated buffer,
2683 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2684 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2685 ;; sees the stop regexp, it restores the old filter functions, and runs
2686 ;; comint-redirect-hook.
2687 ;;
2688 ;; Each comint buffer may only use one redirection at a time, but any number
2689 ;; of different comint buffers may be simultaneously redirected.
2690 ;;
2691 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2692 ;; correct prompt for your interpreter, or that you supply a regexp that says
2693 ;; when the redirection is finished. Otherwise, redirection will continue
2694 ;; indefinitely. The code now does a sanity check to ensure that it can find
2695 ;; a prompt in the comint buffer; however, it is still important to ensure that
2696 ;; this prompt is set correctly.
2697 ;;
2698 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2699 ;; perhaps it should prompt for a terminating string (with an
2700 ;; appropriate magic default by examining what we think is the prompt)?
2701 ;;
2703 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2704 ;; Variables
2705 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2708 "*If non-nil, print messages each time the redirection filter is invoked.
2709 Also print a message when redirection is completed."
2713 ;; Directly analagous to comint-preoutput-filter-functions
2715 "List of functions to call before inserting redirected process output.
2716 Each function gets one argument, a string containing the text received
2717 from the subprocess. It should return the string to insert, perhaps
2718 the same string that was received, or perhaps a modified or transformed
2719 string.
2721 The functions on the list are called sequentially, and each one is given
2722 the string returned by the previous one. The string returned by the
2727 ;; Internal variables
2733 "Regular expression that determines when to stop redirection in Comint.
2734 When the redirection filter function is given output that matches this regexp,
2738 "If non-nil, the text that ends a redirection is included in it.
2739 More precisely, the text that matches `comint-redirect-finished-regexp'
2740 and therefore terminates an output redirection is inserted in the
2753 "If non-nil, check that redirection is likely to complete successfully.
2754 More precisely, before starting a redirection, verify that the
2755 regular expression `comint-redirect-finished-regexp' that controls
2756 when to terminate it actually matches some text already in the process
2757 buffer. The idea is that this regular expression should match a prompt
2758 string, and that there ought to be at least one copy of your prompt string
2762 "The process filter that was in place when redirection is started.
2763 When redirection is completed, the process filter is restored to
2766 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2767 ;; Functions
2768 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2771 comint-buffer
2772 finished-regexp
2774 "Set up for output redirection.
2775 This function sets local variables that are used by `comint-redirect-filter'
2776 to perform redirection.
2778 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2779 in the output matches FINISHED-REGEXP.
2781 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2782 original comint buffer.
2784 This function is called by `comint-redirect-send-command-to-process',
2785 and does not normally need to be invoked by the end user or programmer."
2809 "End a Comint redirection. See `comint-redirect-send-command'."
2811 ;; Restore the process filter
2813 comint-redirect-original-filter-function)
2814 ;; Restore the mode line
2816 ;; Set the completed flag
2819 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2820 ;; that it really occurs.
2824 "Filter function which redirects output from PROCESS to a buffer or buffers.
2825 The variable `comint-redirect-output-buffer' says which buffer(s) to
2826 place output in.
2828 INPUT-STRING is the input from the comint process.
2830 This function runs as a process filter, and does not need to be invoked by the
2831 end user."
2835 ;; If we have to echo output, give it to the original filter function
2837 comint-redirect-original-filter-function
2839 process input-string)))))
2843 "Comint filter function which redirects comint output to a buffer or buffers.
2844 The variable `comint-redirect-output-buffer' says which buffer(s) to
2845 place output in.
2847 INPUT-STRING is the input from the comint process.
2849 This function does not need to be invoked by the end user."
2852 comint-redirect-output-buffer
2856 ;; If there are any filter functions, give them a chance to modify the string
2863 ;; Clobber `comint-redirect-finished-regexp'
2869 ;; Send output to all registered buffers
2873 ;; Set this buffer to the output buffer
2875 ;; Go to the end of the buffer
2877 ;; Insert the output
2879 output-buffer-list))
2881 ;; Message
2886 ;; If we see the prompt, tidy up
2887 ;; We'll look for the prompt in the original string, so nobody can
2888 ;; clobber it
2895 ;; Echo input?
2897 filtered-input-string
2900 ;;;###autoload
2902 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2903 With prefix arg, echo output in process buffer.
2905 If NO-DISPLAY is non-nil, do not show the output buffer."
2913 ;;;###autoload
2916 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2917 With prefix arg, echo output in process buffer.
2919 If NO-DISPLAY is non-nil, do not show the output buffer."
2924 process))
2926 ;; Change to the process buffer
2929 ;; Make sure there's a prompt in the current process buffer
2936 ;;;;;;;;;;;;;;;;;;;;;
2937 ;; Set up for redirection
2938 ;;;;;;;;;;;;;;;;;;;;;
2940 ;; Output Buffer
2941 output-buffer
2942 ;; Comint Buffer
2944 ;; Finished Regexp
2945 comint-prompt-regexp
2946 ;; Echo input
2947 echo)
2949 ;;;;;;;;;;;;;;;;;;;;;
2950 ;; Set the filter
2951 ;;;;;;;;;;;;;;;;;;;;;
2952 ;; Save the old filter
2957 ;;;;;;;;;;;;;;;;;;;;;
2958 ;; Send the command
2959 ;;;;;;;;;;;;;;;;;;;;;
2964 ;;;;;;;;;;;;;;;;;;;;;
2965 ;; Show the output
2966 ;;;;;;;;;;;;;;;;;;;;;
2972 output-buffer))))))
2974 ;;;###autoload
2976 "Send COMMAND to current process.
2977 Return a list of expressions in the output which match REGEXP.
2978 REGEXP-GROUP is the regular expression group in REGEXP to use."
2981 command regexp regexp-group))
2983 ;;;###autoload
2985 "Send COMMAND to PROCESS.
2986 Return a list of expressions in the output which match REGEXP.
2987 REGEXP-GROUP is the regular expression group in REGEXP to use."
2989 results)
2994 output-buffer process nil t)
2995 ;; Wait for the process to complete
2999 ;; Collect the output
3002 ;; Skip past the command, if it was echoed
3010 results)))
3011 results)))
3016 "^Empty input ring$"
3017 "^No history$"
3020 \f
3021 ;; Converting process modes to use comint mode
3022 ;; ===========================================================================
3023 ;; The code in the Emacs 19 distribution has all been modified to use comint
3024 ;; where needed. However, there are `third-party' packages out there that
3025 ;; still use the old shell mode. Here's a guide to conversion.
3026 ;;
3027 ;; Renaming variables
3028 ;; Most of the work is renaming variables and functions. These are the common
3029 ;; ones:
3030 ;; Local variables:
3031 ;; last-input-start comint-last-input-start
3032 ;; last-input-end comint-last-input-end
3033 ;; shell-prompt-pattern comint-prompt-regexp
3034 ;; shell-set-directory-error-hook <no equivalent>
3035 ;; Miscellaneous:
3036 ;; shell-set-directory <unnecessary>
3037 ;; shell-mode-map comint-mode-map
3038 ;; Commands:
3039 ;; shell-send-input comint-send-input
3040 ;; shell-send-eof comint-delchar-or-maybe-eof
3041 ;; kill-shell-input comint-kill-input
3042 ;; interrupt-shell-subjob comint-interrupt-subjob
3043 ;; stop-shell-subjob comint-stop-subjob
3044 ;; quit-shell-subjob comint-quit-subjob
3045 ;; kill-shell-subjob comint-kill-subjob
3046 ;; kill-output-from-shell comint-kill-output
3047 ;; show-output-from-shell comint-show-output
3048 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3049 ;;
3050 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3051 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3052 ;; Comint mode does not provide functionality equivalent to
3053 ;; shell-set-directory-error-hook; it is gone.
3054 ;;
3055 ;; comint-last-input-start is provided for modes which want to munge
3056 ;; the buffer after input is sent, perhaps because the inferior
3057 ;; insists on echoing the input. The LAST-INPUT-START variable in
3058 ;; the old shell package was used to implement a history mechanism,
3059 ;; but you should think twice before using comint-last-input-start
3060 ;; for this; the input history ring often does the job better.
3061 ;;
3062 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3063 ;; *not* create the comint-mode local variables in your foo-mode function.
3064 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3065 ;; necessary comint-specific local variables. Then create the
3066 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3067 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3068 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3069 ;; get-old-input) that need to be different from the defaults. Call
3070 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3071 ;; comint-mode will take care of it. The following example, from shell.el,
3072 ;; is typical:
3073 ;;
3074 ;; (defvar shell-mode-map '())
3075 ;; (cond ((not shell-mode-map)
3076 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3077 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3078 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3079 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3080 ;; (define-key shell-mode-map "\M-?"
3081 ;; 'comint-dynamic-list-filename-completions)))
3082 ;;
3083 ;; (defun shell-mode ()
3084 ;; (interactive)
3085 ;; (comint-mode)
3086 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3087 ;; (setq major-mode 'shell-mode)
3088 ;; (setq mode-name "Shell")
3089 ;; (use-local-map shell-mode-map)
3090 ;; (make-local-variable 'shell-directory-stack)
3091 ;; (setq shell-directory-stack nil)
3092 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3093 ;; (run-hooks 'shell-mode-hook))
3094 ;;
3095 ;;
3096 ;; Completion for comint-mode users
3097 ;;
3098 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3099 ;; hook to add completion functions to. Functions on this list should return
3100 ;; non-nil if completion occurs (i.e., further completion should not occur).
3101 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3102 ;; completion job.
3103 \f
3106 ;; comint.el ends here