| blob | 13b562bdf4ad5d8d6b90988003b2562c2aa08205 |
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'."
528 nil
529 ;; Keys:
558 ;; Mouse Buttons:
560 ;; Menu bars:
561 ;; completion:
572 ;; Input history:
609 ;; Signals
624 ;; Put them in the menu bar:
626 menu-bar-final-items))
627 )
630 "Return t if there is a living process associated w/buffer BUFFER.
631 Living means the status is `open', `run', or `stop'.
632 BUFFER can be either a buffer or the name of one."
636 ;;;###autoload
638 "Make a comint process NAME in a buffer, running PROGRAM.
639 The name of the buffer is made by surrounding NAME with `*'s.
640 PROGRAM should be either a string denoting an executable program to create
641 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
642 connection to be opened via `open-network-stream'. If there is already a
643 running process in that buffer, it is not restarted. Optional third arg
644 STARTFILE is the name of a file to send the contents of to the process.
646 If PROGRAM is a string, any more args are arguments to PROGRAM."
650 ;; If no process, or nuked process, crank up a new one and put buffer in
651 ;; comint mode. Otherwise, leave buffer and existing process alone.
656 buffer))
658 ;;;###autoload
660 "Run PROGRAM in a comint buffer and switch to it.
661 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
662 The file name is used to make a symbol name, such as `comint-sh-hook', and any
663 hooks on this symbol are run in the buffer.
664 See `make-comint' and `comint-exec'."
671 "Start up a process in buffer BUFFER for comint modes.
672 Blasts any old process running in the buffer. Doesn't set the buffer mode.
673 You can use this to cheaply run a series of processes in the same comint
674 buffer. The hook `comint-exec-hook' is run after each exec."
679 ;; Crank up a new process
687 ;; Jump to the end, and set the process mark.
690 ;; Feed it the startfile.
692 ;;This is guaranteed to wait long enough
693 ;;but has bad results if the comint does not prompt at all
694 ;; (while (= size (buffer-size))
695 ;; (sleep-for 1))
696 ;;I hope 1 second is enough!
704 buffer)))
706 ;; This auxiliary function cranks up the process for comint-exec in
707 ;; the appropriate environment.
712 ;; If using termcap, we specify `emacs' as the terminal type
713 ;; because that lets us specify a width.
714 ;; If using terminfo, we specify `dumb' because that is
715 ;; a defined terminal type. `emacs' is not a defined terminal type
716 ;; and there is no way for us to define it here.
717 ;; Some programs that use terminfo get very confused
718 ;; if TERM is not a valid terminal type.
725 process-environment))
728 default-directory
730 proc decoding encoding changed)
732 ;; If the command has slashes, make sure we
733 ;; first look relative to the current directory.
739 ;; If start-process decided to use some coding system for decoding
740 ;; data sent from the process and the coding system doesn't
741 ;; specify EOL conversion, we had better convert CRLF to LF.
744 changed t))
745 ;; Even if start-process left the coding system for encoding data
746 ;; sent from the process undecided, we had better use the same one
747 ;; as what we use for decoding. But, we should suppress EOL
748 ;; conversion.
751 changed t))
754 proc))
758 "In a comint buffer, set the current input to the clicked-on previous input."
761 ;; Ignore non-input overlays
765 ;; do we have input in this area?
770 ;; Can't use kill-region as it sets this-command
775 ;; fall back to the user's previous definition if we aren't
776 ;; on previous input region.
780 \f
781 ;; Input history processing in a buffer
782 ;; ===========================================================================
783 ;; Useful input history functions, courtesy of the Ergo group.
785 ;; Eleven commands:
786 ;; comint-dynamic-list-input-ring List history in help buffer.
787 ;; comint-previous-input Previous input...
788 ;; comint-previous-matching-input ...matching a string.
789 ;; comint-previous-matching-input-from-input ... matching the current input.
790 ;; comint-next-input Next input...
791 ;; comint-next-matching-input ...matching a string.
792 ;; comint-next-matching-input-from-input ... matching the current input.
793 ;; comint-backward-matching-input Backwards input...
794 ;; comint-forward-matching-input ...matching a string.
795 ;; comint-replace-by-expanded-history Expand history at point;
796 ;; replace with expanded history.
797 ;; comint-magic-space Expand history and insert space.
798 ;;
799 ;; Three functions:
800 ;; comint-read-input-ring Read into comint-input-ring...
801 ;; comint-write-input-ring Write to comint-input-ring-file-name.
802 ;; comint-replace-by-expanded-history-before-point Workhorse function.
805 "Sets the buffer's `comint-input-ring' from a history file.
806 The name of the file is given by the variable `comint-input-ring-file-name'.
807 The history ring is of size `comint-input-ring-size', regardless of file size.
808 If `comint-input-ring-file-name' is nil this function does nothing.
810 If the optional argument SILENT is non-nil, we say nothing about a
811 failure to read the history file.
813 This function is useful for major mode commands and mode hooks.
815 The commands stored in the history file are separated by the
816 `comint-input-ring-separator'. The most recent command comes last.
818 See also `comint-input-ignoredups' and `comint-write-input-ring'."
821 nil)
825 comint-input-ring-file-name)))
838 ;; Save restriction in case file is already visited...
839 ;; Watch for those date stamps in history files!
843 nil t))
859 comint-input-ring-index nil)))))
862 "Writes the buffer's `comint-input-ring' to a history file.
863 The name of the file is given by the variable `comint-input-ring-file-name'.
864 The original contents of the file are lost if `comint-input-ring' is not empty.
865 If `comint-input-ring-file-name' is nil this function does nothing.
867 Useful within process sentinels.
869 See also `comint-read-input-ring'."
873 nil)
881 ;; Write it all out into a buffer first. Much faster, but messier,
882 ;; than writing it one line at a time.
894 "List in help buffer the buffer's input history."
903 ;; We have to build up a list ourselves from the ring vector.
907 ;; Change "completion" to "history reference"
908 ;; to make the display accurate.
924 ;; Return list of regexp and prefix arg using PROMPT.
932 regexp)
936 ;; First make sure there is a ring and that we are after the process mark
943 ;; arg of zero resets search from beginning, and uses arg of 1
947 arg)))
950 ;; Index to start a directional search, starting at comint-input-ring-index
952 ;; If a search is running, offset by 1 in direction of arg
955 ;; For a new search, start from beginning or end, as appropriate
961 "Return the string ARG places along the input ring.
962 Moves relative to `comint-input-ring-index'."
966 arg)))
969 "Cycle backwards through input history."
974 "Cycle forwards through input history."
979 "Return the string matching REGEXP ARG places along the input ring.
980 Moves relative to `comint-input-ring-index'."
985 "Return the index matching REGEXP ARG places along the input ring.
986 Moves relative to START, or `comint-input-ring-index'."
995 ;; Do the whole search as many times as the argument says.
997 ;; Step once.
1000 ;; If we haven't reached a match, step some more.
1004 ;; If we have gone all the way around in this search.
1007 ;; Now that we know which ring element to use, if we found it, return that.
1009 n)))
1012 "Search backwards through input history for match for REGEXP.
1013 \(Previous history elements are earlier commands.)
1014 With prefix argument N, search for Nth previous match.
1015 If N is negative, find the next or Nth next match."
1019 ;; Has a match been found?
1025 ;; Can't use kill-region as it sets this-command
1032 "Search forwards through input history for match for REGEXP.
1033 \(Later history elements are more recent commands.)
1034 With prefix argument N, search for Nth following match.
1035 If N is negative, find the previous or Nth previous match."
1040 "Search backwards through input history for match for current input.
1041 \(Previous history elements are earlier commands.)
1042 With prefix argument N, search for Nth previous match.
1043 If N is negative, search forwards for the -Nth following match."
1046 comint-next-matching-input-from-input)))
1047 ;; Starting a new search
1053 comint-input-ring-index nil))
1056 arg))
1059 "Search forwards through input history for match for current input.
1060 \(Following history elements are more recent commands.)
1061 With prefix argument N, search for Nth following match.
1062 If N is negative, search backwards for the -Nth previous match."
1068 "Expand input command history references before point.
1069 Expansion is dependent on the value of `comint-input-autoexpand'.
1071 This function depends on the buffer's idea of the input history, which may not
1072 match the command interpreter's idea, assuming it has one.
1074 Assumes history syntax is like typical Un*x shells'. However, since emacs
1075 cannot know the interpreter's idea of input line numbers, assuming it has one,
1076 it cannot expand absolute input line number references.
1078 If the optional argument SILENT is non-nil, never complain
1079 even if history reference seems erroneous.
1081 If the optional argument START is non-nil, that specifies the
1082 start of the text to scan for history references, rather
1083 than the logical beginning of line.
1085 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1087 Returns t if successful."
1092 ;; Use comint-prompt-regexp
1095 ;; Use input fields. User input that hasn't been entered
1096 ;; yet, at the end of the buffer, has a nil `field' property.
1098 ;; Looks like there might be history references in the command.
1105 "Expand directory stack reference before point.
1106 See `comint-replace-by-expanded-history'. Returns t if successful.
1108 If the optional argument START is non-nil, that specifies the
1109 start of the text to scan for history references, rather
1110 than the logical beginning of line."
1117 ;; This seems a bit complex. We look for references such as !!, !-num,
1118 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1119 ;; If that wasn't enough, the plings can be suffixed with argument
1120 ;; range specifiers.
1121 ;; Argument ranges are complex too, so we hive off the input line,
1122 ;; referenced with plings, with the range string to `comint-args'.
1126 ;; The history is quoted, or we're in quotes.
1129 ;; We cannot know the interpreter's idea of input line numbers.
1133 ;; Just a number of args from `number' lines backward.
1142 t t)
1148 ;; Just a number of args from the previous input line.
1152 t t)
1156 ;; Most recent input starting with or containing (possibly
1157 ;; protected) string, maybe just a number of args. Phew.
1175 t t)
1178 ;; Quick substitution on the previous input line.
1195 "Expand input history references before point and insert ARG spaces.
1196 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1200 \f
1202 "Return t if the number of quotes between BEG and END is odd.
1203 Quotes are single and double."
1209 "Return number of matches for REGEXP from BEG to END."
1216 count))
1219 ;; From STRING, return the args depending on the range specified in the text
1220 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1221 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1237 ;; Return a list of arguments from ARG. Break it up at the
1238 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1253 comint-delimiter-argument-list)))
1256 args)))
1259 "Return from STRING the NTH to MTH arguments.
1260 NTH and/or MTH can be nil, which means the last argument.
1261 Returned arguments are separated by single spaces.
1262 We assume whitespace separates arguments, except within quotes
1263 and except for a space or tab that immediately follows a backslash.
1264 Also, a run of one or more of a single character
1265 in `comint-delimiter-argument-list' is a separate argument.
1266 Argument 0 is the command name."
1267 ;; The first line handles ordinary characters and backslash-sequences
1268 ;; (except with w32 msdos-like shells, where backslashes are valid).
1269 ;; The second matches "-quoted strings.
1270 ;; The third matches '-quoted strings.
1271 ;; The fourth matches `-quoted strings.
1272 ;; This seems to fit the syntax of BASH 2.0.
1283 beg str value quotes)
1284 ;; Build a list of all the args until we have as many as we want.
1288 ;; It's contiguous, part of the same arg.
1291 ;; It's a new separate arg.
1293 ;; Put the previous arg, if there was one, onto ARGS.
1310 \f
1311 ;;
1312 ;; Input processing stuff
1313 ;;
1316 "Send input to process.
1317 After the process output mark, sends all text from the process mark to
1318 point as input to the process. Before the process output mark, calls value
1319 of variable `comint-get-old-input' to retrieve old input, copies it to the
1320 process mark, and sends it. If variable `comint-process-echoes' is nil,
1321 a terminal newline is also inserted into the buffer and sent to the process
1322 \(if it is non-nil, all text from the process mark to point is deleted,
1323 since it is assumed the remote process will re-echo it).
1325 Any history reference may be expanded depending on the value of the variable
1326 `comint-input-autoexpand'. The list of function names contained in the value
1327 of `comint-input-filter-functions' is called on the input before sending it.
1328 The input is entered into the input history ring, if the value of variable
1329 `comint-input-filter' returns non-nil when called on the input.
1331 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1332 end of line before sending the input.
1334 The values of `comint-get-old-input', `comint-input-filter-functions', and
1335 `comint-input-filter' are chosen according to the command interpreter running
1336 in the buffer. E.g.,
1338 If the interpreter is the csh,
1339 comint-get-old-input is the default: either return the current
1340 field, or take the current line and discard any
1341 initial string matching regexp `comint-prompt-regexp', depending
1342 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1345 comint-input-filter is the default: returns t if the input isn't all white
1346 space.
1348 If the comint is Lucid Common Lisp,
1349 comint-get-old-input snarfs the sexp ending at point.
1350 comint-input-filter-functions does nothing.
1351 comint-input-filter returns nil if the input matches input-filter-regexp,
1352 which matches (1) all whitespace (2) :a, :c, etc.
1354 Similarly for Soar, Scheme, etc."
1356 ;; Note that the input string does not include its terminal newline.
1366 copy)))
1368 ;; Just whatever's already there
1369 intxt
1370 ;; Expand and leave it visible in buffer
1374 input
1375 ;; This is messy 'cos ultimately the original
1376 ;; functions used do insertion, rather than return
1377 ;; strings. We have to expand, then insert back.
1383 copy))))
1394 history))))
1403 ;; Make an overlay for the input field
1406 ;; Give old user input a field property of `input', to
1407 ;; distinguish it from both process output and unsent
1408 ;; input. The terminating newline is put into a special
1409 ;; `boundary' field to make cursor movement between input
1410 ;; and output fields smoother.
1418 ;; Make an overlay for the terminating newline
1428 ;; Update the markers before we send the input
1429 ;; in case we get output amidst sending the input.
1433 ;; clear the "accumulation" marker
1436 ;; This used to call comint-output-filter-functions,
1437 ;; but that scrolled the buffer in undesirable ways.
1441 "List of functions to call before inserting Comint output into the buffer.
1442 Each function gets one argument, a string containing the text received
1443 from the subprocess. It should return the string to insert, perhaps
1444 the same string that was received, or perhaps a modified or transformed
1445 string.
1447 The functions on the list are called sequentially, and each one is
1448 given the string returned by the previous one. The string returned by
1449 the last function is the text that is actually inserted in the
1450 redirection buffer.
1454 ;; When non-nil, this is the last overlay used for output.
1455 ;; It is kept around so that we can extend it instead of creating
1456 ;; multiple contiguous overlays for multiple contiguous output chunks.
1459 ;; When non-nil, this is an overlay over the last recognized prompt in
1460 ;; the buffer; it is used when highlighting the prompt.
1463 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1464 ;; Any further output will then create a new comint-last-prompt-overlay.
1470 ;; The purpose of using this filter for comint processes
1471 ;; is to keep comint-last-input-end from moving forward
1472 ;; when output is inserted.
1475 ;; First check for killed buffer or no input.
1478 ;; Run preoutput filters
1484 ;; Insert STRING
1486 ;; Avoid the overhead of save-excursion, since we just
1487 ;; fiddle with the point
1490 ;; The point should float after any insertion we do
1493 ;; We temporarly remove any buffer narrowing, in case the
1494 ;; process mark is outside of the restriction
1501 ;; insert-before-markers is a bad thing. XXX
1502 ;;
1503 ;; It is used here to force window-point markers (used to
1504 ;; store the value of point in non-selected windows) to
1505 ;; advance, but it also screws up any other markers that we
1506 ;; don't _want_ to advance, such as the start-marker of some
1507 ;; of the overlays we create.
1508 ;;
1509 ;; We work around the problem with the overlays by
1510 ;; explicitly adjusting them after we do the insertion, but
1511 ;; in the future this problem should be solved correctly, by
1512 ;; using `insert', and making the insertion-type of
1513 ;; window-point markers settable (via a buffer-local
1514 ;; variable). In comint buffers, this variable would be set
1515 ;; to `t', to cause point in non-select windows to advance.
1517 ;; Fixup markers and overlays that got screwed up because we
1518 ;; used `insert-before-markers'.
1520 ;; comint-last-output-start marker
1522 ;; No overlays we create are set to advance upon insertion
1523 ;; (at the start/end), so we assume that any overlay which
1524 ;; is at the current point was incorrectly advanced by
1525 ;; insert-before-markers. First fixup overlays that might
1526 ;; start at point:
1531 old-point
1533 ;; Then do overlays that might end at point:
1538 old-point))))
1540 ;; Advance process-mark
1544 ;; We check to see if the last overlay used for output is
1545 ;; adjacent to the new input, and if so, just extend it.
1549 ;; Extend comint-last-output-overlay to include the
1550 ;; most recent output
1554 ;; Create a new overlay
1564 ;; Highlight the prompt, where we define `prompt' to mean
1565 ;; the most recent output that doesn't end with a newline.
1567 ;; Need to create or move the prompt overlay (in the case
1568 ;; where there is no prompt ((bolp) == t), we still do
1569 ;; this if there's already an existing overlay).
1572 ;; Just move an existing overlay
1575 ;; Need to create the overlay
1582 ;;(force-mode-line-update)
1589 "Go to the end of buffer in all windows showing it.
1590 Movement occurs if point in the selected window is not after the process mark,
1591 and `this-command' is an insertion command. Insertion commands recognised
1592 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1593 Depends on the value of `comint-scroll-to-bottom-on-input'.
1595 This function should be a pre-command hook."
1598 hilit-yank)))
1614 nil t))))))
1617 "Go to the end of buffer in all windows showing it.
1618 Does not scroll if the current line is the last line in the buffer.
1619 Depends on the value of `comint-scroll-to-bottom-on-output' and
1620 `comint-scroll-show-maximum-output'.
1622 This function should be in the list `comint-output-filter-functions'."
1636 ;; Maybe user wants point to jump to end.
1639 ;; If point was at the end, keep it at end.
1643 ;; Optionally scroll so that the text
1644 ;; ends at the bottom of the window.
1651 nil t))
1655 "Truncate the buffer to `comint-buffer-maximum-size'.
1656 This function could be on `comint-output-filter-functions' or bound to a key."
1665 "Strip trailing `^M' characters from the current output group.
1666 This function could be on `comint-output-filter-functions' or bound to a key."
1679 "Put the end of the buffer at the bottom of the window."
1685 "Default for `comint-get-old-input'.
1686 Returns either the current field, or the current line with any initial
1687 text matching `comint-prompt-regexp' stripped off, depending on the
1688 value of `comint-use-prompt-regexp-instead-of-fields'."
1696 ;; Return the contents of the field at the current point.
1701 "Insert after prompt old input at point as new input to be edited.
1702 Calls `comint-get-old-input' to get old input."
1712 "Skip past the text matching regexp `comint-prompt-regexp'.
1713 If this takes us past the end of the current line, don't skip at all."
1720 "Return t if point is after the process output marker."
1725 "Default function for sending to PROC input STRING.
1726 This just sends STRING plus a newline. To override this,
1727 set the hook `comint-input-sender'."
1732 "Returns the buffer position of the beginning of the line, after any prompt.
1733 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1734 prompt skip is done by skipping text matching the regular expression
1735 `comint-prompt-regexp', a buffer local variable."
1737 ;; Use comint-prompt-regexp
1742 ;; Use input fields. Note that, unlike the behavior of
1743 ;; `line-beginning-position' inside a field, this function will
1744 ;; return the position of the end of a prompt, even if the point is
1745 ;; already inside the prompt. In order to do this, it assumes that
1746 ;; if there are two fields on a line, then the first one is the
1747 ;; prompt, and the second one is an input field, and is front-sticky
1748 ;; (as input fields should be).
1752 "Goes to the beginning of line, then skips past the prompt, if any.
1754 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1755 prompt skip is done by skipping text matching the regular expression
1756 `comint-prompt-regexp', a buffer local variable."
1759 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1763 ;; These three functions are for entering text you don't want echoed or
1764 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1765 ;; Just enter m-x send-invisible and type in your line, or add
1766 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1769 "Read a single line of text from user without echoing, and return it.
1770 Prompt with argument PROMPT, a string. Optional argument STARS causes
1771 input to be echoed with '*' characters on the prompt line. Input ends with
1772 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1773 `inhibit-quit' is set because e.g. this function was called from a process
1774 filter and C-g is pressed, this function returns nil rather than a string).
1776 Note that the keystrokes comprising the text can still be recovered
1778 Once the caller uses the password, it can erase the password
1779 by doing (fillarray STRING 0)."
1791 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1794 ;; This function may get called from a process filter, where
1795 ;; inhibit-quit is set. In later versions of emacs read-char
1796 ;; may clear quit-flag itself and return C-g. That would make
1797 ;; it impossible to quit this loop in a simple way, so
1798 ;; re-enable it here (for backward-compatibility the check for
1799 ;; quit-flag below would still be necessary, so this seems
1800 ;; like the simplest way to do things).
1802 done t))
1816 ;; Emulate a true quit, except that we have to return a value.
1822 ans)))
1825 "Read a string without echoing.
1826 Then send it to the process running in the current buffer.
1827 The string is sent using `comint-input-sender'.
1828 Security bug: your string can still be temporarily recovered with
1844 "Prompt in the minibuffer for password and send without echoing.
1845 This function uses `send-invisible' to read and send a password to the buffer's
1846 process if STRING contains a password prompt defined by
1847 `comint-password-prompt-regexp'.
1849 This function could be in the list `comint-output-filter-functions'."
1853 \f
1854 ;; Low-level process communication
1857 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1863 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1867 \f
1868 ;; Random input hackage
1871 "Kill all output from interpreter since last input.
1872 Does not delete the prompt."
1885 ;; Output message and put back prompt
1889 "Display start of this batch of interpreter output at top of window.
1890 Sets mark to the value of point when this command is run."
1905 "Interrupt the current subjob.
1906 This command also kills the pending input
1907 between the process-mark and point."
1913 "Send kill signal to the current subjob.
1914 This command also kills the pending input
1915 between the process-mark and point."
1921 "Send quit signal to the current subjob.
1922 This command also kills the pending input
1923 between the process-mark and point."
1929 "Stop the current subjob.
1930 This command also kills the pending input
1931 between the process-mark and point.
1933 WARNING: if there is no current subjob, you can end up suspending
1934 the top-level process running in the buffer. If you accidentally do
1936 is not a problem with most shells, since they ignore this signal.)"
1942 "Send CONT signal to process buffer's process group.
1943 Useful if you accidentally suspend the top-level process."
1948 "Kill all text from last stuff output by interpreter to point."
1955 "Delete ARG characters forward or send an EOF to subprocess.
1956 Sends an EOF only if point is at the end of the buffer and there is no input."
1964 "Send an EOF to the current buffer's process."
1971 "Search backward through buffer for input fields that match REGEXP.
1972 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
1973 fields are identified by lines that match `comint-prompt-regexp'.
1975 With prefix argument N, search for Nth previous match.
1976 If N is negative, find the next or Nth next match."
1979 ;; Use comint-prompt-regexp
1989 ;; Use input fields
2003 "Search forward through buffer for input fields that match REGEXP.
2004 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2005 fields are identified by lines that match `comint-prompt-regexp'.
2007 With prefix argument N, search for Nth following match.
2008 If N is negative, find the previous or Nth previous match."
2014 "Move to end of Nth next prompt in the buffer.
2015 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2016 the beginning of the Nth next `input' field, otherwise, it means the Nth
2017 occurance of text matching `comint-prompt-regexp'."
2020 ;; Use comint-prompt-regexp
2025 ;; Use input fields
2034 ;; Ran off the end of the buffer.
2044 "Move to end of Nth previous prompt in the buffer.
2045 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2046 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2047 occurance of text matching `comint-prompt-regexp'."
2050 \f
2051 ;; Support for source-file processing commands.
2052 ;;============================================================================
2053 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2054 ;; commands that process files of source text (e.g. loading or compiling
2055 ;; files). So the corresponding process-in-a-buffer modes have commands
2056 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2057 ;; for defining these commands.
2058 ;;
2059 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2060 ;; and Soar, in that they don't know anything about file extensions.
2061 ;; So the compile/load interface gets the wrong default occasionally.
2062 ;; The load-file/compile-file default mechanism could be smarter -- it
2063 ;; doesn't know about the relationship between filename extensions and
2064 ;; whether the file is source or executable. If you compile foo.lisp
2065 ;; with compile-file, then the next load-file should use foo.bin for
2066 ;; the default, not foo.lisp. This is tricky to do right, particularly
2067 ;; because the extension for executable files varies so much (.o, .bin,
2068 ;; .lbin, .mo, .vo, .ao, ...).
2071 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2072 ;; commands.
2073 ;;
2074 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2075 ;; want to save the buffer before issuing any process requests to the command
2076 ;; interpreter.
2077 ;;
2078 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2079 ;; for the file to process.
2081 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2082 ;;============================================================================
2083 ;; This function computes the defaults for the load-file and compile-file
2084 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2085 ;;
2086 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2087 ;; source-file processing command. NIL if there hasn't been one yet.
2088 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2089 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2090 ;; Typically, (lisp-mode) or (scheme-mode).
2091 ;;
2092 ;; If the command is given while the cursor is inside a string, *and*
2093 ;; the string is an existing filename, *and* the filename is not a directory,
2094 ;; then the string is taken as default. This allows you to just position
2095 ;; your cursor over a string that's a filename and have it taken as default.
2096 ;;
2097 ;; If the command is given in a file buffer whose major mode is in
2098 ;; SOURCE-MODES, then the the filename is the default file, and the
2099 ;; file's directory is the default directory.
2100 ;;
2101 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2102 ;; then the default directory & file are what was used in the last source-file
2103 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2104 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2105 ;; is the cwd, with no default file. (\"no default file\" = nil)
2106 ;;
2107 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2108 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2109 ;; for Soar programs, etc.
2110 ;;
2111 ;; The function returns a pair: (default-directory . default-file).
2122 ;; (COMINT-CHECK-SOURCE fname)
2123 ;;============================================================================
2124 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2125 ;; process-in-a-buffer modes), this function can be called on the filename.
2126 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2127 ;; is queried to see if he wants to save the buffer before proceeding with
2128 ;; the load or compile.
2135 ;; save BUFF.
2142 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2143 ;;============================================================================
2144 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2145 ;; commands that process source files (like loading or compiling a file).
2146 ;; It prompts for the filename, provides a default, if there is one,
2147 ;; and returns the result filename.
2148 ;;
2149 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2150 ;;
2151 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2152 ;; from the last source processing command. SOURCE-MODES is a list of major
2153 ;; modes used to determine what file buffers contain source files. (These
2154 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2155 ;; then the filename reader will only accept a file that exists.
2156 ;;
2157 ;; A typical use:
2158 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2159 ;; '(lisp-mode) t))
2161 ;; This is pretty stupid about strings. It decides we're in a string
2162 ;; if there's a quote on both sides of point on the current line.
2164 "Return string around POINT that starts the current line, or nil."
2191 prompt deffile)
2192 prompt)
2193 defdir
2195 mustmatch-p)))
2198 ;; I am somewhat divided on this string-default feature. It seems
2199 ;; to violate the principle-of-least-astonishment, in that it makes
2200 ;; the default harder to predict, so you actually have to look and see
2201 ;; what the default really is before choosing it. This can trip you up.
2202 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2203 ;; on this.
2204 ;; -Olin
2206 \f
2207 ;; Simple process query facility.
2208 ;; ===========================================================================
2209 ;; This function is for commands that want to send a query to the process
2210 ;; and show the response to the user. For example, a command to get the
2211 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2212 ;; to an inferior Common Lisp process.
2213 ;;
2214 ;; This simple facility just sends strings to the inferior process and pops
2215 ;; up a window for the process buffer so you can see what the process
2216 ;; responds with. We don't do anything fancy like try to intercept what the
2217 ;; process responds with and put it in a pop-up window or on the message
2218 ;; line. We just display the buffer. Low tech. Simple. Works good.
2220 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2221 ;; a window for the inferior process so that its response can be seen.
2231 ;; Try to position the proc window so you can see the answer.
2232 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2233 ;; I don't know why. Wizards invited to improve it.
2242 \f
2243 ;; Filename/command/history completion in a buffer
2244 ;; ===========================================================================
2245 ;; Useful completion functions, courtesy of the Ergo group.
2247 ;; Six commands:
2248 ;; comint-dynamic-complete Complete or expand command, filename,
2249 ;; history at point.
2250 ;; comint-dynamic-complete-filename Complete filename at point.
2251 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2252 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2253 ;; replace with expanded/completed name.
2254 ;; comint-dynamic-simple-complete Complete stub given candidates.
2256 ;; These are not installed in the comint-mode keymap. But they are
2257 ;; available for people who want them. Shell-mode installs them:
2258 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2259 ;; (define-key shell-mode-map "\M-?"
2260 ;; 'comint-dynamic-list-filename-completions)))
2261 ;;
2262 ;; Commands like this are fine things to put in load hooks if you
2263 ;; want them present in specific modes.
2266 "*If non-nil, automatically list possibilities on partial completion.
2267 This mirrors the optional behavior of tcsh."
2272 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2273 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2274 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2275 This mirrors the optional behavior of tcsh."
2280 "*If non-nil, use shortest completion if characters cannot be added.
2281 This mirrors the optional behavior of tcsh.
2283 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2288 "*List of suffixes to be disregarded during file completion.
2289 This mirrors the optional behavior of bash and tcsh.
2291 Note that this applies to `comint-dynamic-complete-filename' only."
2296 "Prefix prepended to absolute file names taken from process input.
2297 This is used by comint's and shell's completion functions, and by shell's
2302 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2304 "String of characters valid in a file name.
2305 Note that all non-ASCII characters are considered valid in a file name
2306 regardless of what this variable says.
2317 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2320 directory)))
2324 "Return the word of WORD-CHARS at point, or nil if non is found.
2325 Word constituents are considered to be those in WORD-CHARS, which is like the
2327 plus all non-ASCII characters."
2331 ;;(memq (char-after (point)) shell-file-name-quote-list)
2335 ;; Don't go forward over a word-char (this can happen if we're at bob).
2338 ;; Set match-data to match the entire string.
2344 "Return FILENAME with environment variables substituted.
2345 Supports additional environment variable syntax of the command
2346 interpreter (e.g., the percent notation of cmd.exe on NT)."
2350 env-var-val)
2359 name))
2362 "Return the filename at point, or nil if non is found.
2363 Environment variables are substituted. See `comint-word'."
2370 "Return FILENAME with magic characters quoted.
2371 Magic characters are those in `comint-file-name-quote-list'."
2373 filename
2380 filename))))
2383 "Return FILENAME with quoted characters unquoted."
2385 filename
2391 filename)))
2395 "Dynamically perform completion at point.
2396 Calls the functions in `comint-dynamic-complete-functions' to perform
2397 completion until a function returns non-nil, at which point completion is
2398 assumed to have occurred."
2404 "Dynamically complete the filename at point.
2405 Completes if after a filename. See `comint-match-partial-filename' and
2406 `comint-dynamic-complete-as-filename'.
2407 This function is similar to `comint-replace-by-expanded-filename', except that
2408 it won't change parts of the filename already entered in the buffer; it just
2409 adds completion characters to the end of the filename. A completions listing
2410 may be shown in a help buffer if completion is ambiguous.
2412 Completion is dependent on the value of `comint-completion-addsuffix',
2413 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2414 completions listing is dependent on the value of `comint-completion-autolist'.
2416 Returns t if successful."
2424 "Dynamically complete at point as a filename.
2425 See `comint-dynamic-complete-filename'. Returns t if successful."
2428 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2429 ;; I think it was originally bound to solve file completion problems,
2430 ;; but subsequent changes may have made this unnecessary. sm.
2431 ;;(file-name-handler-alist nil)
2466 ;; We inserted a unique completion.
2473 ;; It's not unique, but user wants shortest match.
2479 ;; It's not unique, list possible completions.
2484 success))
2488 "Dynamically expand and complete the filename at point.
2489 Replace the filename with an expanded, canonicalised and completed replacement.
2492 removed, and the filename is made absolute instead of relative. For expansion
2493 see `expand-file-name' and `substitute-in-file-name'. For completion see
2494 `comint-dynamic-complete-filename'."
2501 "Dynamically complete STUB from CANDIDATES list.
2502 This function inserts completion characters at point by completing STUB from
2503 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2504 if completion is ambiguous.
2506 Returns nil if no completion was inserted.
2507 Returns `sole' if completed with the only completion match.
2508 Returns `shortest' if completed with the shortest of the completion matches.
2509 Returns `partial' if completed as far as possible with the completion matches.
2510 Returns `listed' if a completion listing was shown.
2512 See also `comint-dynamic-complete-filename'."
2521 nil)
2532 ;; Insert the longest substring.
2537 ;; It's not unique, but user wants shortest match.
2543 ;; It's not unique, list possible completions.
2552 "List in help buffer possible completions of the filename at point."
2555 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2556 ;; I think it was originally bound to solve file completion problems,
2557 ;; but subsequent changes may have made this unnecessary. sm.
2558 ;;(file-name-handler-alist nil)
2571 "List in help buffer sorted COMPLETIONS.
2572 Typing SPC flushes the help buffer."
2586 ;; If the user does mouse-choose-completion with the mouse,
2587 ;; execute the command, then delete the completion window.
2594 \f
2596 "After fetching a line from input history, this fetches the following line.
2597 In other words, this recalls the input line after the line you recalled last.
2598 You can use this to repeat a sequence of input lines."
2607 "Accumulate a line to send as input along with more lines.
2608 This inserts a newline so that you can enter more text
2610 to send all the accumulated input, at once.
2611 The entire accumulated text becomes one item in the input history
2612 when you send it."
2621 "Move point to the process mark.
2622 The process mark separates output, and input already sent,
2623 from input that has not yet been sent."
2631 "Move point to beginning of line (after prompt) or to the process mark.
2632 The first time you use this command, it moves to the beginning of the line
2633 \(but after the prompt, if any). If you repeat it again immediately,
2634 it moves point to the process mark.
2636 The process mark separates the process output, along with input already sent,
2637 from input that has not yet been sent. Ordinarily, the process mark
2638 is at the beginning of the current input line; but if you have
2640 the process mark is at the beginning of the accumulated input."
2647 "Set the process mark at point."
2654 \f
2655 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2657 ;; This little add-on for comint is intended to make it easy to get
2658 ;; output from currently active comint buffers into another buffer,
2659 ;; or buffers, and then go back to using the comint shell.
2660 ;;
2661 ;; My particular use is SQL interpreters; I want to be able to execute a
2662 ;; query using the process associated with a comint-buffer, and save that
2663 ;; somewhere else. Because the process might have state (for example, it
2664 ;; could be in an uncommitted transaction), just running starting a new
2665 ;; process and having it execute the query and then finish, would not
2666 ;; work. I'm sure there are other uses as well, although in many cases
2667 ;; starting a new process is the simpler, and thus preferable, approach.
2668 ;;
2669 ;; The basic implementation is as follows: comint-redirect changes the
2670 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2671 ;; its own filter. The filter puts the output into the designated buffer,
2672 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2673 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2674 ;; sees the stop regexp, it restores the old filter functions, and runs
2675 ;; comint-redirect-hook.
2676 ;;
2677 ;; Each comint buffer may only use one redirection at a time, but any number
2678 ;; of different comint buffers may be simultaneously redirected.
2679 ;;
2680 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2681 ;; correct prompt for your interpreter, or that you supply a regexp that says
2682 ;; when the redirection is finished. Otherwise, redirection will continue
2683 ;; indefinitely. The code now does a sanity check to ensure that it can find
2684 ;; a prompt in the comint buffer; however, it is still important to ensure that
2685 ;; this prompt is set correctly.
2686 ;;
2687 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2688 ;; perhaps it should prompt for a terminating string (with an
2689 ;; appropriate magic default by examining what we think is the prompt)?
2690 ;;
2692 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2693 ;; Variables
2694 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2697 "*If non-nil, print messages each time the redirection filter is invoked.
2698 Also print a message when redirection is completed."
2702 ;; Directly analagous to comint-preoutput-filter-functions
2704 "List of functions to call before inserting redirected process output.
2705 Each function gets one argument, a string containing the text received
2706 from the subprocess. It should return the string to insert, perhaps
2707 the same string that was received, or perhaps a modified or transformed
2708 string.
2710 The functions on the list are called sequentially, and each one is given
2711 the string returned by the previous one. The string returned by the
2716 ;; Internal variables
2722 "Regular expression that determines when to stop redirection in Comint.
2723 When the redirection filter function is given output that matches this regexp,
2727 "If non-nil, the text that ends a redirection is included in it.
2728 More precisely, the text that matches `comint-redirect-finished-regexp'
2729 and therefore terminates an output redirection is inserted in the
2742 "If non-nil, check that redirection is likely to complete successfully.
2743 More precisely, before starting a redirection, verify that the
2744 regular expression `comint-redirect-finished-regexp' that controls
2745 when to terminate it actually matches some text already in the process
2746 buffer. The idea is that this regular expression should match a prompt
2747 string, and that there ought to be at least one copy of your prompt string
2751 "The process filter that was in place when redirection is started.
2752 When redirection is completed, the process filter is restored to
2755 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2756 ;; Functions
2757 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2760 comint-buffer
2761 finished-regexp
2763 "Set up for output redirection.
2764 This function sets local variables that are used by `comint-redirect-filter'
2765 to perform redirection.
2767 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2768 in the output matches FINISHED-REGEXP.
2770 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2771 original comint buffer.
2773 This function is called by `comint-redirect-send-command-to-process',
2774 and does not normally need to be invoked by the end user or programmer."
2798 "End a Comint redirection. See `comint-redirect-send-command'."
2800 ;; Restore the process filter
2802 comint-redirect-original-filter-function)
2803 ;; Restore the mode line
2805 ;; Set the completed flag
2808 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2809 ;; that it really occurs.
2813 "Filter function which redirects output from PROCESS to a buffer or buffers.
2814 The variable `comint-redirect-output-buffer' says which buffer(s) to
2815 place output in.
2817 INPUT-STRING is the input from the comint process.
2819 This function runs as a process filter, and does not need to be invoked by the
2820 end user."
2824 ;; If we have to echo output, give it to the original filter function
2826 comint-redirect-original-filter-function
2828 process input-string)))))
2832 "Comint filter function which redirects comint output to a buffer or buffers.
2833 The variable `comint-redirect-output-buffer' says which buffer(s) to
2834 place output in.
2836 INPUT-STRING is the input from the comint process.
2838 This function does not need to be invoked by the end user."
2841 comint-redirect-output-buffer
2845 ;; If there are any filter functions, give them a chance to modify the string
2852 ;; Clobber `comint-redirect-finished-regexp'
2858 ;; Send output to all registered buffers
2862 ;; Set this buffer to the output buffer
2864 ;; Go to the end of the buffer
2866 ;; Insert the output
2868 output-buffer-list))
2870 ;; Message
2875 ;; If we see the prompt, tidy up
2876 ;; We'll look for the prompt in the original string, so nobody can
2877 ;; clobber it
2884 ;; Echo input?
2886 filtered-input-string
2889 ;;;###autoload
2891 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2892 With prefix arg, echo output in process buffer.
2894 If NO-DISPLAY is non-nil, do not show the output buffer."
2902 ;;;###autoload
2905 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2906 With prefix arg, echo output in process buffer.
2908 If NO-DISPLAY is non-nil, do not show the output buffer."
2913 process))
2915 ;; Change to the process buffer
2918 ;; Make sure there's a prompt in the current process buffer
2925 ;;;;;;;;;;;;;;;;;;;;;
2926 ;; Set up for redirection
2927 ;;;;;;;;;;;;;;;;;;;;;
2929 ;; Output Buffer
2930 output-buffer
2931 ;; Comint Buffer
2933 ;; Finished Regexp
2934 comint-prompt-regexp
2935 ;; Echo input
2936 echo)
2938 ;;;;;;;;;;;;;;;;;;;;;
2939 ;; Set the filter
2940 ;;;;;;;;;;;;;;;;;;;;;
2941 ;; Save the old filter
2946 ;;;;;;;;;;;;;;;;;;;;;
2947 ;; Send the command
2948 ;;;;;;;;;;;;;;;;;;;;;
2953 ;;;;;;;;;;;;;;;;;;;;;
2954 ;; Show the output
2955 ;;;;;;;;;;;;;;;;;;;;;
2961 output-buffer))))))
2963 ;;;###autoload
2965 "Send COMMAND to current process.
2966 Return a list of expressions in the output which match REGEXP.
2967 REGEXP-GROUP is the regular expression group in REGEXP to use."
2970 command regexp regexp-group))
2972 ;;;###autoload
2974 "Send COMMAND to PROCESS.
2975 Return a list of expressions in the output which match REGEXP.
2976 REGEXP-GROUP is the regular expression group in REGEXP to use."
2978 results)
2983 output-buffer process nil t)
2984 ;; Wait for the process to complete
2988 ;; Collect the output
2991 ;; Skip past the command, if it was echoed
2999 results)))
3000 results)))
3005 "^Empty input ring$"
3006 "^No history$"
3009 \f
3010 ;; Converting process modes to use comint mode
3011 ;; ===========================================================================
3012 ;; The code in the Emacs 19 distribution has all been modified to use comint
3013 ;; where needed. However, there are `third-party' packages out there that
3014 ;; still use the old shell mode. Here's a guide to conversion.
3015 ;;
3016 ;; Renaming variables
3017 ;; Most of the work is renaming variables and functions. These are the common
3018 ;; ones:
3019 ;; Local variables:
3020 ;; last-input-start comint-last-input-start
3021 ;; last-input-end comint-last-input-end
3022 ;; shell-prompt-pattern comint-prompt-regexp
3023 ;; shell-set-directory-error-hook <no equivalent>
3024 ;; Miscellaneous:
3025 ;; shell-set-directory <unnecessary>
3026 ;; shell-mode-map comint-mode-map
3027 ;; Commands:
3028 ;; shell-send-input comint-send-input
3029 ;; shell-send-eof comint-delchar-or-maybe-eof
3030 ;; kill-shell-input comint-kill-input
3031 ;; interrupt-shell-subjob comint-interrupt-subjob
3032 ;; stop-shell-subjob comint-stop-subjob
3033 ;; quit-shell-subjob comint-quit-subjob
3034 ;; kill-shell-subjob comint-kill-subjob
3035 ;; kill-output-from-shell comint-kill-output
3036 ;; show-output-from-shell comint-show-output
3037 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3038 ;;
3039 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3040 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3041 ;; Comint mode does not provide functionality equivalent to
3042 ;; shell-set-directory-error-hook; it is gone.
3043 ;;
3044 ;; comint-last-input-start is provided for modes which want to munge
3045 ;; the buffer after input is sent, perhaps because the inferior
3046 ;; insists on echoing the input. The LAST-INPUT-START variable in
3047 ;; the old shell package was used to implement a history mechanism,
3048 ;; but you should think twice before using comint-last-input-start
3049 ;; for this; the input history ring often does the job better.
3050 ;;
3051 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3052 ;; *not* create the comint-mode local variables in your foo-mode function.
3053 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3054 ;; necessary comint-specific local variables. Then create the
3055 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3056 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3057 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3058 ;; get-old-input) that need to be different from the defaults. Call
3059 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3060 ;; comint-mode will take care of it. The following example, from shell.el,
3061 ;; is typical:
3062 ;;
3063 ;; (defvar shell-mode-map '())
3064 ;; (cond ((not shell-mode-map)
3065 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3066 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3067 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3068 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3069 ;; (define-key shell-mode-map "\M-?"
3070 ;; 'comint-dynamic-list-filename-completions)))
3071 ;;
3072 ;; (defun shell-mode ()
3073 ;; (interactive)
3074 ;; (comint-mode)
3075 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3076 ;; (setq major-mode 'shell-mode)
3077 ;; (setq mode-name "Shell")
3078 ;; (use-local-map shell-mode-map)
3079 ;; (make-local-variable 'shell-directory-stack)
3080 ;; (setq shell-directory-stack nil)
3081 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3082 ;; (run-hooks 'shell-mode-hook))
3083 ;;
3084 ;;
3085 ;; Completion for comint-mode users
3086 ;;
3087 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3088 ;; hook to add completion functions to. Functions on this list should return
3089 ;; non-nil if completion occurs (i.e., further completion should not occur).
3090 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3091 ;; completion job.
3092 \f
3095 ;; comint.el ends here