| blob | 57e785dce472fdc88d0bcc2d86c8024a1b1b7832 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988,90,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
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 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
40 ;;
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
58 \f
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
62 ;; mode)
63 ;;
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-previous-matching-input Previous input matching a regexp
67 ;; M-s comint-next-matching-input Next input that matches
68 ;; M-C-l comint-show-output Show last batch of process output
69 ;; RET comint-send-input
70 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
71 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
72 ;; second time, move to process-mark.
73 ;; C-c C-u comint-kill-input ^u
74 ;; C-c C-w backward-kill-word ^w
75 ;; C-c C-c comint-interrupt-subjob ^c
76 ;; C-c C-z comint-stop-subjob ^z
77 ;; C-c C-\ comint-quit-subjob ^\
78 ;; C-c C-o comint-delete-output Delete last batch of process output
79 ;; C-c C-r comint-show-output Show last batch of process output
80 ;; C-c C-l comint-dynamic-list-input-ring List input history
81 ;;
82 ;; Not bound by default in comint-mode (some are in shell mode)
83 ;; comint-run Run a program under comint-mode
84 ;; send-invisible Read a line w/o echo, and send to proc
85 ;; comint-dynamic-complete-filename Complete filename at point.
86 ;; comint-dynamic-list-filename-completions List completions in help buffer.
87 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
88 ;; replace with expanded/completed name.
89 ;; comint-replace-by-expanded-history Expand history at point;
90 ;; replace with expanded name.
91 ;; comint-magic-space Expand history and add (a) space(s).
92 ;; comint-kill-subjob No mercy.
93 ;; comint-show-maximum-output Show as much output as possible.
94 ;; comint-continue-subjob Send CONT signal to buffer's process
95 ;; group. Useful if you accidentally
96 ;; suspend your process (with C-c C-z).
97 ;; comint-get-next-from-history Fetch successive input history lines
98 ;; comint-accumulate Combine lines to send them together
99 ;; as input.
100 ;; comint-goto-process-mark Move point to where process-mark is.
101 ;; comint-set-process-mark Set process-mark to point.
103 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
105 ;;; Code:
108 \f
109 ;; Buffer Local Variables:
110 ;;============================================================================
111 ;; Comint mode buffer local variables:
112 ;; comint-prompt-regexp string comint-bol uses to match prompt
113 ;; comint-delimiter-argument-list list For delimiters and arguments
114 ;; comint-last-input-start marker Handy if inferior always echoes
115 ;; comint-last-input-end marker For comint-delete-output command
116 ;; comint-input-ring-size integer For the input history
117 ;; comint-input-ring ring mechanism
118 ;; comint-input-ring-index number ...
119 ;; comint-save-input-ring-index number ...
120 ;; comint-input-autoexpand symbol ...
121 ;; comint-input-ignoredups boolean ...
122 ;; comint-dynamic-complete-functions hook For the completion mechanism
123 ;; comint-completion-fignore list ...
124 ;; comint-file-name-chars string ...
125 ;; comint-file-name-quote-list list ...
126 ;; comint-get-old-input function Hooks for specific
127 ;; comint-input-filter-functions hook process-in-a-buffer
128 ;; comint-output-filter-functions hook function modes.
129 ;; comint-preoutput-filter-functions hook
130 ;; comint-input-filter function ...
131 ;; comint-input-sender function ...
132 ;; comint-eol-on-send boolean ...
133 ;; comint-process-echoes boolean ...
134 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
135 ;; comint-scroll-to-bottom-on-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
138 ;;
139 ;; Comint mode non-buffer local variables:
140 ;; comint-completion-addsuffix boolean/cons For file name
141 ;; comint-completion-autolist boolean completion behavior
142 ;; comint-completion-recexact boolean ...
145 "General command interpreter in a window stuff."
149 "Completion facilities in comint"
153 "Source finding facilities in comint"
158 "Regexp to recognise prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
164 Good choices:
175 "List of characters to recognise as separate arguments in input.
176 Strings comprising a character in this list will separate the arguments
177 surrounding them, and also be regarded as arguments in their own right (unlike
178 whitespace). See `comint-arguments'.
179 Defaults to the empty list.
186 "*If non-nil, expand input command history references on completion.
187 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
189 If the value is `input', then the expansion is seen on input.
190 If the value is `history', then the expansion is only when inserting
191 into the buffer's input ring. See also `comint-magic-space' and
192 `comint-dynamic-complete'.
194 This variable is buffer-local."
202 "Face to use to highlight user input."
208 "Face to use to highlight prompts."
212 "*If non-nil, don't add input matching the last on the input ring.
213 This mirrors the optional behavior of bash.
215 This variable is buffer-local."
220 "*If non-nil, name of the file to read/write input history.
221 See also `comint-read-input-ring' and `comint-write-input-ring'.
223 This variable is buffer-local, and is a good thing to set in mode hooks."
225 file)
229 "*Controls whether input to interpreter causes window to scroll.
230 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
231 If `this', scroll only the selected window.
233 The default is nil.
235 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
243 "*Controls whether interpreter output moves point to the end of the output.
244 If nil, then output never moves point to the output.
245 (If the output occurs at point, it is inserted before point.)
246 If t or `all', move point in all windows showing the buffer.
247 If `this', move point only the selected window.
248 If `others', move point only in other windows, not in the selected window.
250 The default is nil.
252 See the variable `comint-scroll-show-maximum-output' and the function
253 `comint-postoutput-scroll-to-bottom'.
254 This variable is buffer-local in all Comint buffers."
265 "*Controls how to scroll due to interpreter output.
266 This variable applies when point is at the end of the buffer
267 \(either because it was originally there, or because
268 `comint-move-point-for-output' said to move it there)
269 and output from the subprocess is inserted.
271 Non-nil means scroll so that the window is full of text
272 and point is on the last line. A value of nil
273 means don't do anything special--scroll normally.
275 See also the variable `comint-move-point-for-output' and the function
276 `comint-postoutput-scroll-to-bottom'.
277 This variable is buffer-local in all Comint buffers."
282 "*The maximum size in lines for Comint buffers.
283 Comint buffers are truncated from the top to be no greater than this number, if
284 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
298 "*If non-nil, assume that the subprocess echoes any input.
299 If so, delete one copy of the input so that only one copy eventually
300 appears in the buffer.
302 This variable is buffer-local."
306 ;; AIX puts the name of the person being su'd to in front of the prompt.
307 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
308 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
309 ;; ssh-add prints a prompt like `Enter passphrase: '.
310 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
317 "*Regexp matching prompts for passwords in the inferior process.
318 This is used by `comint-watch-for-password-prompt'."
322 ;; Here are the per-interpreter hooks.
324 "Function that returns old text in Comint mode.
325 This function is called when return is typed while the point is in old
326 text. It returns the text to be submitted as process input. The
327 default is `comint-get-old-input-default', which either grabs the
328 current input field or grabs the current line and strips off leading
329 text matching `comint-prompt-regexp', depending on the value of
334 "List of functions called to perform completion.
335 Functions should return non-nil if completion was performed.
336 See also `comint-dynamic-complete'.
342 "Predicate for filtering additions to input history.
343 Takes one argument, the input. If non-nil, the input may be saved on the input
347 "Functions to call before input is sent to the process.
348 These functions get one argument, a string containing the text to send.
350 You can use `add-hook' to add functions to this list
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'.
363 You can use `add-hook' to add functions to this list
370 "Function to actually send to PROCESS the STRING submitted by user.
371 Usually this is just `comint-simple-send', but if your mode needs to
372 massage the input string, put a different function here.
373 `comint-simple-send' just sends the string plus a newline.
374 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
378 "*Non-nil means go to the end of the line before sending input.
379 See `comint-send-input'."
383 ;; Note: If it is decided to purge comint-prompt-regexp from the source
384 ;; entirely, searching for uses of this variable will help to identify
385 ;; places that need attention.
387 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
388 If nil, then program output and user-input are given different `field'
389 properties, which emacs commands can use to distinguish them (in
390 particular, common movement commands such as begining-of-line respect
391 field boundaries in a natural way)."
396 "Hook run upon entry to `comint-mode'.
397 This is run before the process is cranked up."
402 "Hook run each time a process is exec'd by `comint-exec'.
403 This is called after the process is cranked up. It is useful for things that
404 must be done each time a process is executed in a Comint mode buffer (e.g.,
405 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
406 executed once when the buffer is created."
412 ;; Fixme: Is this still relevant?
414 "Non-nil if communications via pty; false if by pipe. Buffer local.
426 "Last input ring index which you copied.
430 "Non-nil if you are accumulating input lines to send as input together.
449 "Major mode for interacting with an inferior interpreter.
450 Interpreter name is same as buffer name, sans the asterisks.
451 Return at end of buffer sends line as input.
452 Return not at end copies rest of line to end and sends it.
453 Setting variable `comint-eol-on-send' means jump to the end of the line
454 before submitting new input.
456 This mode is customised to create major modes such as Inferior Lisp
457 mode, Shell mode, etc. This can be done by setting the hooks
458 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
459 and `comint-get-old-input' to appropriate functions, and the variable
460 `comint-prompt-regexp' to the appropriate regular expression.
462 An input history is maintained of size `comint-input-ring-size', and
463 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
464 Input ring history expansion can be achieved with the commands
466 Input ring expansion is controlled by the variable `comint-input-autoexpand',
467 and addition is controlled by the variable `comint-input-ignoredups'.
469 Commands with no default key bindings include `send-invisible',
470 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
471 `comint-magic-space'.
473 Input to, and output from, the subprocess can cause the window to scroll to
474 the end of the buffer. See variables `comint-output-filter-functions',
475 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
476 and `comint-move-point-for-output'.
479 to continue it.
483 Entry to this mode runs the hooks on `comint-mode-hook'."
513 ;; This makes it really work to keep point at the bottom.
523 ;; This behavior is not useful in comint buffers, and is annoying
527 nil
528 ;; Keys:
559 ;; Mouse Buttons:
561 ;; Menu bars:
562 ;; completion:
573 ;; Input history:
614 ;; Signals
629 ;; Put them in the menu bar:
631 menu-bar-final-items))
632 )
635 "Return t if there is a living process associated w/buffer BUFFER.
636 Living means the status is `open', `run', or `stop'.
637 BUFFER can be either a buffer or the name of one."
641 ;;;###autoload
643 "Make a Comint process NAME in BUFFER, running PROGRAM.
644 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
645 PROGRAM should be either a string denoting an executable program to create
646 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
647 connection to be opened via `open-network-stream'. If there is already a
648 running process in that buffer, it is not restarted. Optional third arg
649 STARTFILE is the name of a file to send the contents of to the process.
651 If PROGRAM is a string, any more args are arguments to PROGRAM."
655 ;; If no process, or nuked process, crank up a new one and put buffer in
656 ;; comint mode. Otherwise, leave buffer and existing process alone.
662 buffer)
664 ;;;###autoload
666 "Make a Comint process NAME in a buffer, running PROGRAM.
667 The name of the buffer is made by surrounding NAME with `*'s.
668 PROGRAM should be either a string denoting an executable program to create
669 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
670 connection to be opened via `open-network-stream'. If there is already a
671 running process in that buffer, it is not restarted. Optional third arg
672 STARTFILE is the name of a file to send the contents of the process to.
674 If PROGRAM is a string, any more args are arguments to PROGRAM."
677 ;;;###autoload
679 "Run PROGRAM in a Comint buffer and switch to it.
680 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
681 The file name is used to make a symbol name, such as `comint-sh-hook', and any
682 hooks on this symbol are run in the buffer.
683 See `make-comint' and `comint-exec'."
690 "Start up a process named NAME in buffer BUFFER for Comint modes.
691 Runs the given COMMAND with SWITCHES with output to STARTFILE.
692 Blasts any old process running in the buffer. Doesn't set the buffer mode.
693 You can use this to cheaply run a series of processes in the same Comint
694 buffer. The hook `comint-exec-hook' is run after each exec."
698 ;; Crank up a new process
706 ;; Jump to the end, and set the process mark.
709 ;; Feed it the startfile.
711 ;;This is guaranteed to wait long enough
712 ;;but has bad results if the comint does not prompt at all
713 ;; (while (= size (buffer-size))
714 ;; (sleep-for 1))
715 ;;I hope 1 second is enough!
723 buffer)))
725 ;; This auxiliary function cranks up the process for comint-exec in
726 ;; the appropriate environment.
731 ;; If using termcap, we specify `emacs' as the terminal type
732 ;; because that lets us specify a width.
733 ;; If using terminfo, we specify `dumb' because that is
734 ;; a defined terminal type. `emacs' is not a defined terminal type
735 ;; and there is no way for us to define it here.
736 ;; Some programs that use terminfo get very confused
737 ;; if TERM is not a valid terminal type.
738 ;; ;; There is similar code in compile.el.
745 process-environment))
748 default-directory
750 proc decoding encoding changed)
752 ;; If the command has slashes, make sure we
753 ;; first look relative to the current directory.
759 ;; If start-process decided to use some coding system for decoding
760 ;; data sent from the process and the coding system doesn't
761 ;; specify EOL conversion, we had better convert CRLF to LF.
764 changed t))
765 ;; Even if start-process left the coding system for encoding data
766 ;; sent from the process undecided, we had better use the same one
767 ;; as what we use for decoding. But, we should suppress EOL
768 ;; conversion.
771 changed t))
774 proc))
778 "In a Comint buffer, set the current input to the clicked-on previous input."
782 ;; No input at POS, fall back to the global definition.
787 ;; There's previous input at POS, insert it at the end of the buffer.
789 ;; First delete any old unsent input at the end
794 ;; Insert the clicked-upon input
800 \f
801 ;; Input history processing in a buffer
802 ;; ===========================================================================
803 ;; Useful input history functions, courtesy of the Ergo group.
805 ;; Eleven commands:
806 ;; comint-dynamic-list-input-ring List history in help buffer.
807 ;; comint-previous-input Previous input...
808 ;; comint-previous-matching-input ...matching a string.
809 ;; comint-previous-matching-input-from-input ... matching the current input.
810 ;; comint-next-input Next input...
811 ;; comint-next-matching-input ...matching a string.
812 ;; comint-next-matching-input-from-input ... matching the current input.
813 ;; comint-backward-matching-input Backwards input...
814 ;; comint-forward-matching-input ...matching a string.
815 ;; comint-replace-by-expanded-history Expand history at point;
816 ;; replace with expanded history.
817 ;; comint-magic-space Expand history and insert space.
818 ;;
819 ;; Three functions:
820 ;; comint-read-input-ring Read into comint-input-ring...
821 ;; comint-write-input-ring Write to comint-input-ring-file-name.
822 ;; comint-replace-by-expanded-history-before-point Workhorse function.
825 "Set the buffer's `comint-input-ring' from a history file.
826 The name of the file is given by the variable `comint-input-ring-file-name'.
827 The history ring is of size `comint-input-ring-size', regardless of file size.
828 If `comint-input-ring-file-name' is nil this function does nothing.
830 If the optional argument SILENT is non-nil, we say nothing about a
831 failure to read the history file.
833 This function is useful for major mode commands and mode hooks.
835 The commands stored in the history file are separated by the
836 `comint-input-ring-separator', and entries that match
837 `comint-input-history-ignore' are ignored. The most recent command
838 comes last.
840 See also `comint-input-ignoredups' and `comint-write-input-ring'."
843 nil)
847 comint-input-ring-file-name)))
860 ;; Save restriction in case file is already visited...
861 ;; Watch for those date stamps in history files!
881 comint-input-ring-index nil)))))
884 "Writes the buffer's `comint-input-ring' to a history file.
885 The name of the file is given by the variable `comint-input-ring-file-name'.
886 The original contents of the file are lost if `comint-input-ring' is not empty.
887 If `comint-input-ring-file-name' is nil this function does nothing.
889 Useful within process sentinels.
891 See also `comint-read-input-ring'."
895 nil)
903 ;; Write it all out into a buffer first. Much faster, but messier,
904 ;; than writing it one line at a time.
918 "Choose the input history entry that point is in or next to."
935 "List in help buffer the buffer's input history."
944 ;; We have to build up a list ourselves from the ring vector.
948 ;; Change "completion" to "history reference"
949 ;; to make the display accurate.
970 "Return list of regexp and prefix arg using PROMPT."
978 regexp)
982 ;; First make sure there is a ring and that we are after the process mark
989 ;; arg of zero resets search from beginning, and uses arg of 1
993 arg)))
996 "Index to start a directional search, starting at `comint-input-ring-index'."
998 ;; If a search is running, offset by 1 in direction of arg
1001 ;; For a new search, start from beginning or end, as appropriate
1007 "Return the string ARG places along the input ring.
1008 Moves relative to `comint-input-ring-index'."
1012 arg)))
1015 "Cycle backwards through input history."
1020 "Cycle forwards through input history."
1025 "Return the string matching REGEXP ARG places along the input ring.
1026 Moves relative to `comint-input-ring-index'."
1031 "Return the index matching REGEXP ARG places along the input ring.
1032 Moves relative to START, or `comint-input-ring-index'."
1041 ;; Do the whole search as many times as the argument says.
1043 ;; Step once.
1046 ;; If we haven't reached a match, step some more.
1050 ;; If we have gone all the way around in this search.
1053 ;; Now that we know which ring element to use, if we found it, return that.
1055 n)))
1058 "Search backwards through input history for match for REGEXP.
1059 \(Previous history elements are earlier commands.)
1060 With prefix argument N, search for Nth previous match.
1061 If N is negative, find the next or Nth next match."
1065 ;; Has a match been found?
1071 ;; Can't use kill-region as it sets this-command
1078 "Search forwards through input history for match for REGEXP.
1079 \(Later history elements are more recent commands.)
1080 With prefix argument N, search for Nth following match.
1081 If N is negative, find the previous or Nth previous match."
1086 "Search backwards through input history for match for current input.
1087 \(Previous history elements are earlier commands.)
1088 With prefix argument N, search for Nth previous match.
1089 If N is negative, search forwards for the -Nth following match."
1092 comint-next-matching-input-from-input)))
1093 ;; Starting a new search
1099 comint-input-ring-index nil))
1102 arg))
1105 "Search forwards through input history for match for current input.
1106 \(Following history elements are more recent commands.)
1107 With prefix argument N, search for Nth following match.
1108 If N is negative, search backwards for the -Nth previous match."
1114 "Expand input command history references before point.
1115 Expansion is dependent on the value of `comint-input-autoexpand'.
1117 This function depends on the buffer's idea of the input history, which may not
1118 match the command interpreter's idea, assuming it has one.
1120 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1121 cannot know the interpreter's idea of input line numbers, assuming it has one,
1122 it cannot expand absolute input line number references.
1124 If the optional argument SILENT is non-nil, never complain
1125 even if history reference seems erroneous.
1127 If the optional argument START is non-nil, that specifies the
1128 start of the text to scan for history references, rather
1129 than the logical beginning of line.
1131 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1133 Returns t if successful."
1137 ;; Use comint-prompt-regexp
1141 ;; Use input fields. User input that hasn't been entered
1142 ;; yet, at the end of the buffer, has a nil `field' property.
1145 ;; Looks like there might be history references in the command.
1152 "Expand directory stack reference before point.
1153 See `comint-replace-by-expanded-history'. Returns t if successful.
1155 If the optional argument START is non-nil, that specifies the
1156 start of the text to scan for history references, rather
1157 than the logical beginning of line."
1165 ;; This seems a bit complex. We look for references such as !!, !-num,
1166 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1167 ;; If that wasn't enough, the plings can be suffixed with argument
1168 ;; range specifiers.
1169 ;; Argument ranges are complex too, so we hive off the input line,
1170 ;; referenced with plings, with the range string to `comint-args'.
1174 ;; The history is quoted, or we're in quotes.
1177 ;; We cannot know the interpreter's idea of input line numbers.
1181 ;; Just a number of args from `number' lines backward.
1190 t t)
1196 ;; Just a number of args from the previous input line.
1200 t t)
1204 ;; Most recent input starting with or containing (possibly
1205 ;; protected) string, maybe just a number of args. Phew.
1223 t t)
1226 ;; Quick substitution on the previous input line.
1243 "Expand input history references before point and insert ARG spaces.
1244 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1248 \f
1250 "Return t if the number of quotes between BEG and END is odd.
1251 Quotes are single and double."
1257 "Return number of matches for REGEXP from BEG to END."
1264 count))
1267 ;; From STRING, return the args depending on the range specified in the text
1268 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1269 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1286 "Return a list of arguments from ARG.
1287 Break it up at the delimiters in `comint-delimiter-argument-list'.
1288 Returned list is backwards."
1302 comint-delimiter-argument-list)))
1305 args)))
1308 "Return from STRING the NTH to MTH arguments.
1309 NTH and/or MTH can be nil, which means the last argument.
1310 Returned arguments are separated by single spaces.
1311 We assume whitespace separates arguments, except within quotes
1312 and except for a space or tab that immediately follows a backslash.
1313 Also, a run of one or more of a single character
1314 in `comint-delimiter-argument-list' is a separate argument.
1315 Argument 0 is the command name."
1316 ;; The first line handles ordinary characters and backslash-sequences
1317 ;; (except with w32 msdos-like shells, where backslashes are valid).
1318 ;; The second matches "-quoted strings.
1319 ;; The third matches '-quoted strings.
1320 ;; The fourth matches `-quoted strings.
1321 ;; This seems to fit the syntax of BASH 2.0.
1332 beg str quotes)
1333 ;; Build a list of all the args until we have as many as we want.
1337 ;; It's contiguous, part of the same arg.
1340 ;; It's a new separate arg.
1342 ;; Put the previous arg, if there was one, onto ARGS.
1359 \f
1360 ;;
1361 ;; Input processing stuff
1362 ;;
1364 "Add CMD to the input history.
1365 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1371 cmd))))
1375 "Send input to process.
1376 After the process output mark, sends all text from the process mark to
1377 point as input to the process. Before the process output mark, calls
1378 value of variable `comint-get-old-input' to retrieve old input, copies
1379 it to the process mark, and sends it. A terminal newline is also
1380 inserted into the buffer and sent to the process unless NO-NEWLINE is
1381 non-nil.
1383 Any history reference may be expanded depending on the value of the variable
1384 `comint-input-autoexpand'. The list of function names contained in the value
1385 of `comint-input-filter-functions' is called on the input before sending it.
1386 The input is entered into the input history ring, if the value of variable
1387 `comint-input-filter' returns non-nil when called on the input.
1389 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1390 end of line before sending the input.
1392 After the input has been sent, if `comint-process-echoes' is non-nil,
1393 then `comint-send-input' waits to see if the process outputs a string
1394 matching the input, and if so, deletes that part of the output.
1396 The values of `comint-get-old-input', `comint-input-filter-functions', and
1397 `comint-input-filter' are chosen according to the command interpreter running
1398 in the buffer. E.g.,
1400 If the interpreter is the csh,
1401 `comint-get-old-input' is the default:
1402 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1403 either return the current input field, if point is on an input
1404 field, or the current line, if point is on an output field.
1405 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1406 return the current line with any initial string matching the
1407 regexp `comint-prompt-regexp' removed.
1410 comint-input-filter is the default: returns t if the input isn't all white
1411 space.
1413 If the Comint is Lucid Common Lisp,
1414 comint-get-old-input snarfs the sexp ending at point.
1415 comint-input-filter-functions does nothing.
1416 comint-input-filter returns nil if the input matches input-filter-regexp,
1417 which matches (1) all whitespace (2) :a, :c, etc.
1419 Similarly for Soar, Scheme, etc."
1421 ;; Note that the input string does not include its terminal newline.
1431 copy)))
1433 ;; Just whatever's already there
1434 intxt
1435 ;; Expand and leave it visible in buffer
1439 input
1440 ;; This is messy 'cos ultimately the original
1441 ;; functions used do insertion, rather than return
1442 ;; strings. We have to expand, then insert back.
1448 copy))))
1462 ;; Set text-properties for the input field
1464 beg end
1466 font-lock-face comint-highlight-input
1467 mouse-face highlight
1470 ;; Give old user input a field property of `input', to
1471 ;; distinguish it from both process output and unsent
1472 ;; input. The terminating newline is put into a special
1473 ;; `boundary' field to make cursor movement between input
1474 ;; and output fields smoother.
1477 ;; Cover the terminating newline
1480 field boundary
1481 inhibit-line-move-field-capture t))))
1487 ;; Update the markers before we send the input
1488 ;; in case we get output amidst sending the input.
1492 ;; clear the "accumulation" marker
1497 ;; Optionally delete echoed input (after checking it).
1500 comint-last-input-start)))
1501 ;; Wait for all input to be echoed:
1507 nil comint-last-input-start
1509 ;; Above difference is equivalent to
1510 ;; (+ comint-last-input-start
1511 ;; (- (point-max) comint-last-input-end))
1518 nil comint-last-input-start comint-last-input-end
1519 nil comint-last-input-end
1524 ;; This used to call comint-output-filter-functions,
1525 ;; but that scrolled the buffer in undesirable ways.
1529 "List of functions to call before inserting Comint output into the buffer.
1530 Each function gets one argument, a string containing the text received
1531 from the subprocess. It should return the string to insert, perhaps
1532 the same string that was received, or perhaps a modified or transformed
1533 string.
1535 The functions on the list are called sequentially, and each one is
1536 given the string returned by the previous one. The string returned by
1537 the last function is the text that is actually inserted in the
1538 redirection buffer.
1540 You can use `add-hook' to add functions to this list
1544 "If nil, Comint will interpret `carriage control' characters in output.
1547 ;; When non-nil, this is an overlay over the last recognized prompt in
1548 ;; the buffer; it is used when highlighting the prompt.
1552 "`snapshot' any current `comint-last-prompt-overlay'.
1553 freeze its attributes in place, even when more input comes a long
1554 and moves the prompt overlay."
1562 "Interpret carriage control characters in the region from START to END.
1563 Translate carriage return/linefeed sequences to linefeeds.
1564 Make single carriage returns delete to the beginning of the line.
1565 Make backspaces delete the previous character."
1567 ;; First do a quick check to see if there are any applicable
1568 ;; characters, so we can avoid calling save-match-data and
1569 ;; save-restriction if not.
1577 ;; CR LF -> LF
1578 ;; Note that this won't work properly when the CR and LF
1579 ;; are in different output chunks, but this is probably an
1580 ;; exceedingly rare case (because they are generally
1581 ;; written as a unit), and to delay interpretation of a
1582 ;; trailing CR in a chunk would result in odd interactive
1583 ;; behavior (and this case is probably far more common).
1586 ;; bare CR -> delete preceding line
1590 ;; BS -> delete preceding character
1595 ;; The purpose of using this filter for comint processes
1596 ;; is to keep comint-last-input-end from moving forward
1597 ;; when output is inserted.
1600 ;; First check for killed buffer or no input.
1603 ;; Run preoutput filters
1614 ;; Insert STRING
1616 ;; Avoid the overhead of save-excursion, since we just
1617 ;; fiddle with the point
1620 ;; The point should float after any insertion we do
1623 ;; We temporarly remove any buffer narrowing, in case the
1624 ;; process mark is outside of the restriction
1631 ;; insert-before-markers is a bad thing. XXX
1632 ;;
1633 ;; It is used here to force window-point markers (used to
1634 ;; store the value of point in non-selected windows) to
1635 ;; advance, but it also screws up any other markers that we
1636 ;; don't _want_ to advance, such as the start-marker of some
1637 ;; of the overlays we create.
1638 ;;
1639 ;; We work around the problem with the overlays by
1640 ;; explicitly adjusting them after we do the insertion, but
1641 ;; in the future this problem should be solved correctly, by
1642 ;; using `insert', and making the insertion-type of
1643 ;; window-point markers settable (via a buffer-local
1644 ;; variable). In comint buffers, this variable would be set
1645 ;; to `t', to cause point in non-select windows to advance.
1647 ;; Fixup markers and overlays that got screwed up because we
1648 ;; used `insert-before-markers'.
1650 ;; comint-last-output-start
1652 ;; comint-last-input-end
1657 ;; No overlays we create are set to advance upon insertion
1658 ;; (at the start/end), so we assume that any overlay which
1659 ;; is at the current point was incorrectly advanced by
1660 ;; insert-before-markers. First fixup overlays that might
1661 ;; start at point:
1666 old-point
1668 ;; Then do overlays that might end at point:
1673 old-point))))
1675 ;; Advance process-mark
1679 ;; Interpret any carriage motion characters (newline, backspace)
1690 field output
1691 inhibit-line-move-field-capture t))))
1693 ;; Highlight the prompt, where we define `prompt' to mean
1694 ;; the most recent output that doesn't end with a newline.
1696 ;; Need to create or move the prompt overlay (in the case
1697 ;; where there is no prompt ((bolp) == t), we still do
1698 ;; this if there's already an existing overlay).
1701 ;; Just move an existing overlay
1704 ;; Need to create the overlay
1713 "Go to the end of buffer in all windows showing it.
1714 Movement occurs if point in the selected window is not after the process mark,
1715 and `this-command' is an insertion command. Insertion commands recognised
1716 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1717 Depends on the value of `comint-scroll-to-bottom-on-input'.
1719 This function should be a pre-command hook."
1722 hilit-yank)))
1738 nil t))))))
1741 "Go to the end of buffer in some or all windows showing it.
1742 Does not scroll if the current line is the last line in the buffer.
1743 Depends on the value of `comint-move-point-for-output' and
1744 `comint-scroll-show-maximum-output'.
1746 This function should be in the list `comint-output-filter-functions'."
1760 ;; Maybe user wants point to jump to end.
1763 ;; If point was at the end, keep it at end.
1767 ;; Optionally scroll so that the text
1768 ;; ends at the bottom of the window.
1775 nil t))
1779 "Truncate the buffer to `comint-buffer-maximum-size'.
1780 This function could be on `comint-output-filter-functions' or bound to a key."
1790 "Strip trailing `^M' characters from the current output group.
1791 This function could be on `comint-output-filter-functions' or bound to a key."
1804 "Put the end of the buffer at the bottom of the window."
1810 "Default for `comint-get-old-input'.
1811 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1812 return the current input field, if point is on an input field, or the
1813 current line, if point is on an output field.
1814 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1815 the current line with any initial string matching the regexp
1816 `comint-prompt-regexp' removed."
1824 "Insert after prompt old input at point as new input to be edited.
1825 Calls `comint-get-old-input' to get old input."
1835 "Skip past the text matching regexp `comint-prompt-regexp'.
1836 If this takes us past the end of the current line, don't skip at all."
1842 "Return t if point is after the process output marker."
1847 "Default function for sending to PROC input STRING.
1848 This just sends STRING plus a newline. To override this,
1849 set the hook `comint-input-sender'."
1857 "Return the buffer position of the beginning of the line, after any prompt.
1858 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1859 prompt skip is done by skipping text matching the regular expression
1860 `comint-prompt-regexp', a buffer local variable."
1862 ;; Use comint-prompt-regexp
1867 ;; Use input fields. Note that, unlike the behavior of
1868 ;; `line-beginning-position' inside a field, this function will
1869 ;; return the position of the end of a prompt, even if the point is
1870 ;; already inside the prompt. In order to do this, it assumes that
1871 ;; if there are two fields on a line, then the first one is the
1872 ;; prompt, and the second one is an input field, and is front-sticky
1873 ;; (as input fields should be).
1877 "Go to the beginning of line, then skip past the prompt, if any.
1879 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1880 prompt skip is done by skipping text matching the regular expression
1881 `comint-prompt-regexp', a buffer local variable."
1884 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1888 ;; These three functions are for entering text you don't want echoed or
1889 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1890 ;; Just enter m-x send-invisible and type in your line, or add
1891 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1894 "Read a single line of text from user without echoing, and return it.
1895 Prompt with argument PROMPT, a string. Optional argument STARS causes
1896 input to be echoed with '*' characters on the prompt line. Input ends with
1897 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1898 `inhibit-quit' is set because e.g. this function was called from a process
1899 filter and C-g is pressed, this function returns nil rather than a string).
1901 Note that the keystrokes comprising the text can still be recovered
1903 however, `clear-this-command-keys').
1904 Once the caller uses the password, it can erase the password
1905 by doing (clear-string STRING)."
1917 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1920 ;; This function may get called from a process filter, where
1921 ;; inhibit-quit is set. In later versions of emacs read-char
1922 ;; may clear quit-flag itself and return C-g. That would make
1923 ;; it impossible to quit this loop in a simple way, so
1924 ;; re-enable it here (for backward-compatibility the check for
1925 ;; quit-flag below would still be necessary, so this seems
1926 ;; like the simplest way to do things).
1928 done t))
1942 ;; Emulate a true quit, except that we have to return a value.
1948 ans)))
1951 "Read a string without echoing.
1952 Then send it to the process running in the current buffer.
1953 The string is sent using `comint-input-sender'.
1954 Security bug: your string can still be temporarily recovered with
1968 "Prompt in the minibuffer for password and send without echoing.
1969 This function uses `send-invisible' to read and send a password to the buffer's
1970 process if STRING contains a password prompt defined by
1971 `comint-password-prompt-regexp'.
1973 This function could be in the list `comint-output-filter-functions'."
1978 \f
1979 ;; Low-level process communication
1982 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
1992 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2001 \f
2002 ;; Random input hackage
2005 "Delete all output from interpreter since last input.
2006 Does not delete the prompt."
2019 ;; Output message and put back prompt
2025 "Write output from interpreter since last input to FILENAME.
2026 Any prompt at the end of the output is not written.
2028 If the optional argument APPEND (the prefix argument when interactive)
2029 is non-nil, the output is appended to the file instead.
2031 If the optional argument MUSTBENEW is non-nil, check for an existing
2032 file with the same name. If MUSTBENEW is `excl', that means to get an
2033 error if the file already exists; never overwrite. If MUSTBENEW is
2034 neither nil nor `excl', that means ask for confirmation before
2035 overwriting, but do go ahead and overwrite the file if the user
2036 confirms. When interactive, MUSTBENEW is nil when appending, and t
2037 otherwise."
2041 "Append output to file: "
2043 current-prefix-arg
2049 append nil nil mustbenew)))
2051 ;; This function exists for the benefit of the menu; from the keyboard,
2052 ;; users can just use `comint-write-output' with a prefix arg.
2054 "Append output from interpreter since last input to FILENAME.
2055 Any prompt at the end of the output is not written."
2060 "Display start of this batch of interpreter output at top of window.
2061 Sets mark to the value of point when this command is run."
2076 "Interrupt the current subjob.
2077 This command also kills the pending input
2078 between the process mark and point."
2082 ;; (process-send-string nil "\n")
2083 )
2086 "Send kill signal to the current subjob.
2087 This command also kills the pending input
2088 between the process mark and point."
2094 "Send quit signal to the current subjob.
2095 This command also kills the pending input
2096 between the process mark and point."
2102 "Stop the current subjob.
2103 This command also kills the pending input
2104 between the process mark and point.
2106 WARNING: if there is no current subjob, you can end up suspending
2107 the top-level process running in the buffer. If you accidentally do
2109 is not a problem with most shells, since they ignore this signal.)"
2115 "Send CONT signal to process buffer's process group.
2116 Useful if you accidentally suspend the top-level process."
2121 "Skip all pending input, from last stuff output by interpreter to point.
2122 This means mark it as if it had been sent as input, without sending it."
2134 "Kill all text from last stuff output by interpreter to point."
2141 "Delete ARG characters forward or send an EOF to subprocess.
2142 Sends an EOF only if point is at the end of the buffer and there is no input."
2150 "Send an EOF to the current buffer's process."
2157 "Search backward through buffer for input fields that match REGEXP.
2158 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2159 fields are identified by lines that match `comint-prompt-regexp'.
2161 With prefix argument N, search for Nth previous match.
2162 If N is negative, find the next or Nth next match."
2165 ;; Use comint-prompt-regexp
2175 ;; Use input fields
2189 "Search forward through buffer for input fields that match REGEXP.
2190 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2191 fields are identified by lines that match `comint-prompt-regexp'.
2193 With prefix argument N, search for Nth following match.
2194 If N is negative, find the previous or Nth previous match."
2200 "Move to end of Nth next prompt in the buffer.
2201 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2202 the beginning of the Nth next `input' field, otherwise, it means the Nth
2203 occurrence of text matching `comint-prompt-regexp'."
2206 ;; Use comint-prompt-regexp
2211 ;; Use input fields
2214 prev-pos)
2222 ;; Ran off the end of the buffer.
2224 ;; There's always an input field at the end of the
2225 ;; buffer, but it has a `field' property of nil.
2227 ;; stop iterating
2237 "Move to end of Nth previous prompt in the buffer.
2238 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2239 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2240 occurrence of text matching `comint-prompt-regexp'."
2244 ;; State used by `comint-insert-previous-argument' when cycling.
2250 ;; Needs fixing:
2251 ;; make comint-arguments understand negative indices as bash does
2253 "Insert the INDEXth argument from the previous Comint command-line at point.
2254 Spaces are added at beginning and/or end of the inserted string if
2255 necessary to ensure that it's separated from adjacent arguments.
2256 Interactively, if no prefix argument is given, the last argument is inserted.
2257 Repeated interactive invocations will cycle through the same argument
2258 from progressively earlier commands (using the value of INDEX specified
2259 with the first command).
2260 This command is like `M-.' in bash."
2265 ;; Delete last input inserted by this command.
2269 ;; This is a non-repeat invocation, so initialize state.
2273 ;; First usage; initialize to a marker
2276 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2280 ;; Remember the beginning of what we insert, so we can delete it if
2281 ;; the command is repeated.
2283 ;; Insert the argument.
2286 ;; strip terminating '&'
2289 ;; Make next invocation return arg from previous input
2291 ;; Add a terminating space if necessary.
2295 \f
2296 ;; Support for source-file processing commands.
2297 ;;============================================================================
2298 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2299 ;; commands that process files of source text (e.g. loading or compiling
2300 ;; files). So the corresponding process-in-a-buffer modes have commands
2301 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2302 ;; for defining these commands.
2303 ;;
2304 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2305 ;; and Soar, in that they don't know anything about file extensions.
2306 ;; So the compile/load interface gets the wrong default occasionally.
2307 ;; The load-file/compile-file default mechanism could be smarter -- it
2308 ;; doesn't know about the relationship between filename extensions and
2309 ;; whether the file is source or executable. If you compile foo.lisp
2310 ;; with compile-file, then the next load-file should use foo.bin for
2311 ;; the default, not foo.lisp. This is tricky to do right, particularly
2312 ;; because the extension for executable files varies so much (.o, .bin,
2313 ;; .lbin, .mo, .vo, .ao, ...).
2316 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2317 ;; commands.
2318 ;;
2319 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2320 ;; want to save the buffer before issuing any process requests to the command
2321 ;; interpreter.
2322 ;;
2323 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2324 ;; for the file to process.
2327 "Compute the defaults for `load-file' and `compile-file' commands.
2329 PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2330 source-file processing command. nil if there hasn't been one yet.
2331 SOURCE-MODES is a list used to determine what buffers contain source
2332 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2333 Typically, (lisp-mode) or (scheme-mode).
2335 If the command is given while the cursor is inside a string, *and*
2336 the string is an existing filename, *and* the filename is not a directory,
2337 then the string is taken as default. This allows you to just position
2338 your cursor over a string that's a filename and have it taken as default.
2340 If the command is given in a file buffer whose major mode is in
2341 SOURCE-MODES, then the filename is the default file, and the
2342 file's directory is the default directory.
2344 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2345 then the default directory & file are what was used in the last source-file
2346 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2347 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2350 SOURCE-REGEXP is typically going to be something like (tea-mode)
2351 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2352 for Soar programs, etc.
2354 The function returns a pair: (default-directory . default-file)."
2364 "Check whether to save buffers visiting file FNAME.
2365 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2366 process-in-a-buffer modes), this function can be called on the filename.
2367 If the file is loaded into a buffer, and the buffer is modified, the user
2368 is queried to see if he wants to save the buffer before proceeding with
2369 the load or compile."
2374 ;; save BUFF.
2381 "Return string around POINT, or nil."
2392 "Prompt for filenames in commands that process source files,
2393 e.g. loading or compiling a file.
2394 Provides a default, if there is one, and returns the result filename.
2396 See `comint-source-default' for more on determining defaults.
2398 PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2399 from the last source processing command. SOURCE-MODES is a list of major
2400 modes used to determine what file buffers contain source files. (These
2401 two arguments are used for determining defaults). If MUSTMATCH-P is true,
2402 then the filename reader will only accept a file that exists.
2404 A typical use:
2406 '(lisp-mode) t))"
2419 prompt deffile)
2420 prompt)
2421 defdir
2423 mustmatch-p)))
2426 ;; I am somewhat divided on this string-default feature. It seems
2427 ;; to violate the principle-of-least-astonishment, in that it makes
2428 ;; the default harder to predict, so you actually have to look and see
2429 ;; what the default really is before choosing it. This can trip you up.
2430 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2431 ;; on this.
2432 ;; -Olin
2434 \f
2435 ;; Simple process query facility.
2436 ;; ===========================================================================
2437 ;; This function is for commands that want to send a query to the process
2438 ;; and show the response to the user. For example, a command to get the
2439 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2440 ;; to an inferior Common Lisp process.
2441 ;;
2442 ;; This simple facility just sends strings to the inferior process and pops
2443 ;; up a window for the process buffer so you can see what the process
2444 ;; responds with. We don't do anything fancy like try to intercept what the
2445 ;; process responds with and put it in a pop-up window or on the message
2446 ;; line. We just display the buffer. Low tech. Simple. Works good.
2449 "Send to the inferior process PROC the string STR.
2450 Pop-up but do not select a window for the inferior process so that
2451 its response can be seen."
2460 ;; Try to position the proc window so you can see the answer.
2461 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2462 ;; I don't know why. Wizards invited to improve it.
2471 \f
2472 ;; Filename/command/history completion in a buffer
2473 ;; ===========================================================================
2474 ;; Useful completion functions, courtesy of the Ergo group.
2476 ;; Six commands:
2477 ;; comint-dynamic-complete Complete or expand command, filename,
2478 ;; history at point.
2479 ;; comint-dynamic-complete-filename Complete filename at point.
2480 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2481 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2482 ;; replace with expanded/completed name.
2483 ;; comint-dynamic-simple-complete Complete stub given candidates.
2485 ;; These are not installed in the comint-mode keymap. But they are
2486 ;; available for people who want them. Shell-mode installs them:
2487 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2488 ;; (define-key shell-mode-map "\M-?"
2489 ;; 'comint-dynamic-list-filename-completions)))
2490 ;;
2491 ;; Commands like this are fine things to put in load hooks if you
2492 ;; want them present in specific modes.
2495 "*If non-nil, automatically list possibilities on partial completion.
2496 This mirrors the optional behavior of tcsh."
2501 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2502 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2503 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2504 This mirrors the optional behavior of tcsh."
2513 "*If non-nil, use shortest completion if characters cannot be added.
2514 This mirrors the optional behavior of tcsh.
2516 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2521 "*List of suffixes to be disregarded during file completion.
2522 This mirrors the optional behavior of bash and tcsh.
2524 Note that this applies to `comint-dynamic-complete-filename' only."
2529 "Prefix prepended to absolute file names taken from process input.
2530 This is used by Comint's and shell's completion functions, and by shell's
2535 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2537 "String of characters valid in a file name.
2538 Note that all non-ASCII characters are considered valid in a file name
2539 regardless of what this variable says.
2550 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2553 directory)))
2557 "Return the word of WORD-CHARS at point, or nil if none is found.
2558 Word constituents are considered to be those in WORD-CHARS, which is like the
2560 plus all non-ASCII characters."
2563 giveup)
2567 ;; Fixme: This isn't consistent with Bash, at least -- not
2568 ;; all non-ASCII chars should be word constituents.
2577 ;; Set match-data to match the entire string.
2583 "Return FILENAME with environment variables substituted.
2584 Supports additional environment variable syntax of the command
2585 interpreter (e.g., the percent notation of cmd.exe on NT)."
2589 env-var-val)
2598 name))
2601 "Return the filename at point, or nil if non is found.
2602 Environment variables are substituted. See `comint-word'."
2609 "Return FILENAME with magic characters quoted.
2610 Magic characters are those in `comint-file-name-quote-list'."
2612 filename
2621 filename))))
2624 "Return FILENAME with quoted characters unquoted."
2626 filename
2632 filename)))
2636 "Dynamically perform completion at point.
2637 Calls the functions in `comint-dynamic-complete-functions' to perform
2638 completion until a function returns non-nil, at which point completion is
2639 assumed to have occurred."
2645 "Dynamically complete the filename at point.
2646 Completes if after a filename. See `comint-match-partial-filename' and
2647 `comint-dynamic-complete-as-filename'.
2648 This function is similar to `comint-replace-by-expanded-filename', except that
2649 it won't change parts of the filename already entered in the buffer; it just
2650 adds completion characters to the end of the filename. A completions listing
2651 may be shown in a help buffer if completion is ambiguous.
2653 Completion is dependent on the value of `comint-completion-addsuffix',
2654 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2655 completions listing is dependent on the value of `comint-completion-autolist'.
2657 Returns t if successful."
2665 "Dynamically complete at point as a filename.
2666 See `comint-dynamic-complete-filename'. Returns t if successful."
2669 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2670 ;; I think it was originally bound to solve file completion problems,
2671 ;; but subsequent changes may have made this unnecessary. sm.
2672 ;;(file-name-handler-alist nil)
2707 ;; We inserted a unique completion.
2714 ;; It's not unique, but user wants shortest match.
2720 ;; It's not unique, list possible completions.
2725 success))
2729 "Dynamically expand and complete the filename at point.
2730 Replace the filename with an expanded, canonicalised and completed replacement.
2733 removed, and the filename is made absolute instead of relative. For expansion
2734 see `expand-file-name' and `substitute-in-file-name'. For completion see
2735 `comint-dynamic-complete-filename'."
2744 "Dynamically complete STUB from CANDIDATES list.
2745 This function inserts completion characters at point by completing STUB from
2746 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2747 if completion is ambiguous.
2749 Returns nil if no completion was inserted.
2750 Returns `sole' if completed with the only completion match.
2751 Returns `shortest' if completed with the shortest of the completion matches.
2752 Returns `partial' if completed as far as possible with the completion matches.
2753 Returns `listed' if a completion listing was shown.
2755 See also `comint-dynamic-complete-filename'."
2763 nil)
2774 ;; Insert the longest substring.
2779 ;; It's not unique, but user wants shortest match.
2785 ;; It's not unique, list possible completions.
2794 "List in help buffer possible completions of the filename at point."
2797 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2798 ;; I think it was originally bound to solve file completion problems,
2799 ;; but subsequent changes may have made this unnecessary. sm.
2800 ;;(file-name-handler-alist nil)
2812 ;; This is bound locally in a *Completions* buffer to the list of
2813 ;; completions displayed, and is used to detect the case where the same
2814 ;; command is repeatedly used without the set of completions changing.
2820 "List in help buffer sorted COMPLETIONS.
2821 Typing SPC flushes the help buffer."
2827 ;; The above tests are not sufficient to detect the case where we
2828 ;; should scroll, because the top-level interactive command may
2829 ;; not have displayed a completions window the last time it was
2830 ;; invoked, and there may be such a window left over from a
2831 ;; previous completion command with a different set of
2832 ;; completions. To detect that case, we also test that the set
2833 ;; of displayed completions is in fact the same as the previously
2834 ;; displayed set.
2838 ;; If this command was repeated, and
2839 ;; there's a fresh completion window with a live buffer,
2840 ;; and this command is repeated, scroll that window.
2848 ;; Display a completion list for the first time.
2855 ;; Read the next key, to process SPC.
2861 completions)
2868 ;; If the user does mouse-choose-completion with the mouse,
2869 ;; execute the command, then delete the completion window.
2878 \f
2880 "After fetching a line from input history, this fetches the following line.
2881 In other words, this recalls the input line after the line you recalled last.
2882 You can use this to repeat a sequence of input lines."
2891 "Accumulate a line to send as input along with more lines.
2892 This inserts a newline so that you can enter more text
2894 to send all the accumulated input, at once.
2895 The entire accumulated text becomes one item in the input history
2896 when you send it."
2905 "Move point to the process mark.
2906 The process mark separates output, and input already sent,
2907 from input that has not yet been sent."
2916 "Move point to beginning of line (after prompt) or to the process mark.
2917 The first time you use this command, it moves to the beginning of the line
2918 \(but after the prompt, if any). If you repeat it again immediately,
2919 it moves point to the process mark.
2921 The process mark separates the process output, along with input already sent,
2922 from input that has not yet been sent. Ordinarily, the process mark
2923 is at the beginning of the current input line; but if you have
2925 the process mark is at the beginning of the accumulated input."
2932 "Set the process mark at point."
2939 \f
2940 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2942 ;; This little add-on for comint is intended to make it easy to get
2943 ;; output from currently active comint buffers into another buffer,
2944 ;; or buffers, and then go back to using the comint shell.
2945 ;;
2946 ;; My particular use is SQL interpreters; I want to be able to execute a
2947 ;; query using the process associated with a comint-buffer, and save that
2948 ;; somewhere else. Because the process might have state (for example, it
2949 ;; could be in an uncommitted transaction), just running starting a new
2950 ;; process and having it execute the query and then finish, would not
2951 ;; work. I'm sure there are other uses as well, although in many cases
2952 ;; starting a new process is the simpler, and thus preferable, approach.
2953 ;;
2954 ;; The basic implementation is as follows: comint-redirect changes the
2955 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
2956 ;; its own filter. The filter puts the output into the designated buffer,
2957 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2958 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
2959 ;; sees the stop regexp, it restores the old filter functions, and runs
2960 ;; `comint-redirect-hook'.
2961 ;;
2962 ;; Each comint buffer may only use one redirection at a time, but any number
2963 ;; of different comint buffers may be simultaneously redirected.
2964 ;;
2965 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2966 ;; correct prompt for your interpreter, or that you supply a regexp that says
2967 ;; when the redirection is finished. Otherwise, redirection will continue
2968 ;; indefinitely. The code now does a sanity check to ensure that it can find
2969 ;; a prompt in the comint buffer; however, it is still important to ensure that
2970 ;; this prompt is set correctly.
2971 ;;
2972 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
2973 ;; perhaps it should prompt for a terminating string (with an
2974 ;; appropriate magic default by examining what we think is the prompt)?
2975 ;;
2976 ;; Fixme: look for appropriate fields, rather than regexp, if
2977 ;; `comint-use-prompt-regexp-instead-of-fields' is true.
2979 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2980 ;; Variables
2981 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2984 "*If non-nil, print messages each time the redirection filter is invoked.
2985 Also print a message when redirection is completed."
2989 ;; Directly analagous to comint-preoutput-filter-functions
2991 "List of functions to call before inserting redirected process output.
2992 Each function gets one argument, a string containing the text received
2993 from the subprocess. It should return the string to insert, perhaps
2994 the same string that was received, or perhaps a modified or transformed
2995 string.
2997 The functions on the list are called sequentially, and each one is given
2998 the string returned by the previous one. The string returned by the
2999 last function is the text that is actually inserted in the redirection buffer.
3001 You can use `add-hook' to add functions to this list
3004 ;; Internal variables
3010 "Regular expression that determines when to stop redirection in Comint.
3011 When the redirection filter function is given output that matches this regexp,
3015 "If non-nil, the text that ends a redirection is included in it.
3016 More precisely, the text that matches `comint-redirect-finished-regexp'
3017 and therefore terminates an output redirection is inserted in the
3030 "If non-nil, check that redirection is likely to complete successfully.
3031 More precisely, before starting a redirection, verify that the
3032 regular expression `comint-redirect-finished-regexp' that controls
3033 when to terminate it actually matches some text already in the process
3034 buffer. The idea is that this regular expression should match a prompt
3035 string, and that there ought to be at least one copy of your prompt string
3039 "The process filter that was in place when redirection is started.
3040 When redirection is completed, the process filter is restored to
3044 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3045 The readonly status is toggled around insertion.
3046 This is useful, for instance, for insertion into Help mode buffers.
3049 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3050 ;; Functions
3051 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3054 comint-buffer
3055 finished-regexp
3057 "Set up for output redirection.
3058 This function sets local variables that are used by `comint-redirect-filter'
3059 to perform redirection.
3061 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3062 in the output matches FINISHED-REGEXP.
3064 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3065 original Comint buffer.
3067 This function is called by `comint-redirect-send-command-to-process',
3068 and does not normally need to be invoked by the end user or programmer."
3092 "End a Comint redirection. See `comint-redirect-send-command'."
3094 ;; Restore the process filter
3096 comint-redirect-original-filter-function)
3097 ;; Restore the mode line
3099 ;; Set the completed flag
3102 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3103 ;; that it really occurs.
3107 "Filter function which redirects output from PROCESS to a buffer or buffers.
3108 The variable `comint-redirect-output-buffer' says which buffer(s) to
3109 place output in.
3111 INPUT-STRING is the input from the Comint process.
3113 This function runs as a process filter, and does not need to be invoked by the
3114 end user."
3118 ;; If we have to echo output, give it to the original filter function
3120 comint-redirect-original-filter-function
3122 process input-string)))))
3126 "Comint filter function which redirects Comint output to a buffer or buffers.
3127 The variable `comint-redirect-output-buffer' says which buffer(s) to
3128 place output in.
3130 INPUT-STRING is the input from the Comint process.
3132 This function does not need to be invoked by the end user."
3135 comint-redirect-output-buffer
3139 ;; If there are any filter functions, give them a chance to modify the string
3143 ;; If a local value says "use the default value too",
3144 ;; do that.
3154 ;; Clobber `comint-redirect-finished-regexp'
3160 ;; Send output to all registered buffers
3163 ;; Set this buffer to the output buffer
3165 ;; Go to the end of the buffer
3167 ;; Insert the output
3171 ;; Message
3176 ;; If we see the prompt, tidy up
3177 ;; We'll look for the prompt in the original string, so nobody can
3178 ;; clobber it
3185 ;; Echo input?
3187 filtered-input-string
3190 ;;;###autoload
3192 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3193 With prefix arg ECHO, echo output in process buffer.
3195 If NO-DISPLAY is non-nil, do not show the output buffer."
3203 ;;;###autoload
3206 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3207 With prefix arg, echo output in process buffer.
3209 If NO-DISPLAY is non-nil, do not show the output buffer."
3214 process))
3216 ;; Change to the process buffer
3219 ;; Make sure there's a prompt in the current process buffer
3226 ;;;;;;;;;;;;;;;;;;;;;
3227 ;; Set up for redirection
3228 ;;;;;;;;;;;;;;;;;;;;;
3230 ;; Output Buffer
3231 output-buffer
3232 ;; Comint Buffer
3234 ;; Finished Regexp
3235 comint-prompt-regexp
3236 ;; Echo input
3237 echo)
3239 ;;;;;;;;;;;;;;;;;;;;;
3240 ;; Set the filter
3241 ;;;;;;;;;;;;;;;;;;;;;
3242 ;; Save the old filter
3247 ;;;;;;;;;;;;;;;;;;;;;
3248 ;; Send the command
3249 ;;;;;;;;;;;;;;;;;;;;;
3254 ;;;;;;;;;;;;;;;;;;;;;
3255 ;; Show the output
3256 ;;;;;;;;;;;;;;;;;;;;;
3262 output-buffer)))))))
3264 ;;;###autoload
3266 "Send COMMAND to current process.
3267 Return a list of expressions in the output which match REGEXP.
3268 REGEXP-GROUP is the regular expression group in REGEXP to use."
3271 command regexp regexp-group))
3273 ;;;###autoload
3275 "Send COMMAND to PROCESS.
3276 Return a list of expressions in the output which match REGEXP.
3277 REGEXP-GROUP is the regular expression group in REGEXP to use."
3279 results)
3284 output-buffer process nil t)
3285 ;; Wait for the process to complete
3289 ;; Collect the output
3292 ;; Skip past the command, if it was echoed
3300 results)))
3301 results)))
3306 "^Empty input ring$"
3307 "^No history$"
3311 \f
3312 ;; Converting process modes to use comint mode
3313 ;; ===========================================================================
3314 ;; The code in the Emacs 19 distribution has all been modified to use comint
3315 ;; where needed. However, there are `third-party' packages out there that
3316 ;; still use the old shell mode. Here's a guide to conversion.
3317 ;;
3318 ;; Renaming variables
3319 ;; Most of the work is renaming variables and functions. These are the common
3320 ;; ones:
3321 ;; Local variables:
3322 ;; last-input-start comint-last-input-start
3323 ;; last-input-end comint-last-input-end
3324 ;; shell-prompt-pattern comint-prompt-regexp
3325 ;; shell-set-directory-error-hook <no equivalent>
3326 ;; Miscellaneous:
3327 ;; shell-set-directory <unnecessary>
3328 ;; shell-mode-map comint-mode-map
3329 ;; Commands:
3330 ;; shell-send-input comint-send-input
3331 ;; shell-send-eof comint-delchar-or-maybe-eof
3332 ;; kill-shell-input comint-kill-input
3333 ;; interrupt-shell-subjob comint-interrupt-subjob
3334 ;; stop-shell-subjob comint-stop-subjob
3335 ;; quit-shell-subjob comint-quit-subjob
3336 ;; kill-shell-subjob comint-kill-subjob
3337 ;; kill-output-from-shell comint-delete-output
3338 ;; show-output-from-shell comint-show-output
3339 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3340 ;;
3341 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3342 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3343 ;; Comint mode does not provide functionality equivalent to
3344 ;; shell-set-directory-error-hook; it is gone.
3345 ;;
3346 ;; comint-last-input-start is provided for modes which want to munge
3347 ;; the buffer after input is sent, perhaps because the inferior
3348 ;; insists on echoing the input. The LAST-INPUT-START variable in
3349 ;; the old shell package was used to implement a history mechanism,
3350 ;; but you should think twice before using comint-last-input-start
3351 ;; for this; the input history ring often does the job better.
3352 ;;
3353 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3354 ;; *not* create the comint-mode local variables in your foo-mode function.
3355 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3356 ;; necessary comint-specific local variables. Then create the
3357 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3358 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3359 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3360 ;; get-old-input) that need to be different from the defaults. Call
3361 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3362 ;; comint-mode will take care of it. The following example, from shell.el,
3363 ;; is typical:
3364 ;;
3365 ;; (defvar shell-mode-map '())
3366 ;; (cond ((not shell-mode-map)
3367 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3368 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3369 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3370 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3371 ;; (define-key shell-mode-map "\M-?"
3372 ;; 'comint-dynamic-list-filename-completions)))
3373 ;;
3374 ;; (defun shell-mode ()
3375 ;; (interactive)
3376 ;; (comint-mode)
3377 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3378 ;; (setq major-mode 'shell-mode)
3379 ;; (setq mode-name "Shell")
3380 ;; (use-local-map shell-mode-map)
3381 ;; (make-local-variable 'shell-directory-stack)
3382 ;; (setq shell-directory-stack nil)
3383 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3384 ;; (run-hooks 'shell-mode-hook))
3385 ;;
3386 ;;
3387 ;; Completion for comint-mode users
3388 ;;
3389 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3390 ;; hook to add completion functions to. Functions on this list should return
3391 ;; non-nil if completion occurs (i.e., further completion should not occur).
3392 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3393 ;; completion job.
3394 \f
3398 ;;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3399 ;;; comint.el ends here