| blob | 381938b568c82c903588e342462170265803d7ac |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu> then
6 ;; Simon Marshall <simon@gnu.ai.mit.edu>
7 ;; Maintainer: FSF
8 ;; Keywords: processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; Please send me bug reports, bug fixes, and extensions, so that I can
30 ;; merge them into the master source.
31 ;; - Olin Shivers (shivers@cs.cmu.edu)
32 ;; - Simon Marshall (simon@gnu.ai.mit.edu)
34 ;; This file defines a general command-interpreter-in-a-buffer package
35 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
36 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
37 ;; This way, all these specific packages share a common base functionality,
38 ;; and a common set of bindings, which makes them easier to use (and
39 ;; saves code, implementation time, etc., etc.).
41 ;; Several packages are already defined using comint mode:
42 ;; - shell.el defines a shell-in-a-buffer mode.
43 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
44 ;;
45 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
46 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
47 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
48 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
49 ;; previewers, and printers from within emacs.
50 ;; - background.el allows csh-like job control inside emacs.
51 ;; It is pretty easy to make new derived modes for other processes.
53 ;; For documentation on the functionality provided by comint mode, and
54 ;; the hooks available for customising it, see the comments below.
55 ;; For further information on the standard derived modes (shell,
56 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
58 ;; For hints on converting existing process modes (e.g., tex-mode,
59 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
60 ;; instead of shell-mode, see the notes at the end of this file.
62 \f
63 ;; Brief Command Documentation:
64 ;;============================================================================
65 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
66 ;; mode)
67 ;;
68 ;; m-p comint-previous-input Cycle backwards in input history
69 ;; m-n comint-next-input Cycle forwards
70 ;; m-r comint-previous-matching-input Previous input matching a regexp
71 ;; m-s comint-next-matching-input Next input that matches
72 ;; m-c-l comint-show-output Show last batch of process output
73 ;; return comint-send-input
74 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
75 ;; c-c c-a comint-bol Beginning of line; skip prompt
76 ;; c-c c-u comint-kill-input ^u
77 ;; c-c c-w backward-kill-word ^w
78 ;; c-c c-c comint-interrupt-subjob ^c
79 ;; c-c c-z comint-stop-subjob ^z
80 ;; c-c c-\ comint-quit-subjob ^\
81 ;; c-c c-o comint-kill-output Delete last batch of process output
82 ;; c-c c-r comint-show-output Show last batch of process output
83 ;; c-c c-l comint-dynamic-list-input-ring List input history
84 ;;
85 ;; Not bound by default in comint-mode (some are in shell mode)
86 ;; comint-run Run a program under comint-mode
87 ;; send-invisible Read a line w/o echo, and send to proc
88 ;; comint-dynamic-complete-filename Complete filename at point.
89 ;; comint-dynamic-complete-variable Complete variable name at point.
90 ;; comint-dynamic-list-filename-completions List completions in help buffer.
91 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
92 ;; replace with expanded/completed name.
93 ;; comint-replace-by-expanded-history Expand history at point;
94 ;; replace with expanded name.
95 ;; comint-magic-space Expand history and add (a) space(s).
96 ;; comint-kill-subjob No mercy.
97 ;; comint-show-maximum-output Show as much output as possible.
98 ;; comint-continue-subjob Send CONT signal to buffer's process
99 ;; group. Useful if you accidentally
100 ;; suspend your process (with C-c C-z).
102 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
104 ;;; Code:
107 \f
108 ;; Buffer Local Variables:
109 ;;============================================================================
110 ;; Comint mode buffer local variables:
111 ;; comint-prompt-regexp string comint-bol uses to match prompt
112 ;; comint-delimiter-argument-list list For delimiters and arguments
113 ;; comint-last-input-start marker Handy if inferior always echoes
114 ;; comint-last-input-end marker For comint-kill-output command
115 ;; comint-input-ring-size integer For the input history
116 ;; comint-input-ring ring mechanism
117 ;; comint-input-ring-index number ...
118 ;; comint-input-autoexpand symbol ...
119 ;; comint-input-ignoredups boolean ...
120 ;; comint-last-input-match string ...
121 ;; comint-dynamic-complete-functions hook For the completion mechanism
122 ;; comint-completion-fignore list ...
123 ;; comint-file-name-chars string ...
124 ;; comint-file-name-quote-list list ...
125 ;; comint-get-old-input function Hooks for specific
126 ;; comint-input-filter-functions hook process-in-a-buffer
127 ;; comint-output-filter-functions hook function modes.
128 ;; comint-preoutput-filter-functions hook
129 ;; comint-input-filter function ...
130 ;; comint-input-sender function ...
131 ;; comint-eol-on-send boolean ...
132 ;; comint-process-echoes boolean ...
133 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
134 ;; comint-scroll-to-bottom-on-output symbol ...
135 ;; comint-scroll-show-maximum-output boolean ...
136 ;;
137 ;; Comint mode non-buffer local variables:
138 ;; comint-completion-addsuffix boolean/cons For file name
139 ;; comint-completion-autolist boolean completion behavior
140 ;; comint-completion-recexact boolean ...
143 "General command interpreter in a window stuff."
147 "Completion facilities in comint"
151 "Source finding facilities in comint"
157 "Regexp to recognise prompts in the inferior process.
160 Good choices:
171 "List of characters to recognise as separate arguments in input.
172 Strings comprising a character in this list will separate the arguments
173 surrounding them, and also be regarded as arguments in their own right (unlike
174 whitespace). See `comint-arguments'.
175 Defaults to the empty list.
182 "*If non-nil, expand input command history references on completion.
183 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
185 If the value is `input', then the expansion is seen on input.
186 If the value is `history', then the expansion is only when inserting
187 into the buffer's input ring. See also `comint-magic-space' and
188 `comint-dynamic-complete'.
190 This variable is buffer-local."
198 "*If non-nil, don't add input matching the last on the input ring.
199 This mirrors the optional behavior of bash.
201 This variable is buffer-local."
206 "*If non-nil, name of the file to read/write input history.
207 See also `comint-read-input-ring' and `comint-write-input-ring'.
209 This variable is buffer-local, and is a good thing to set in mode hooks."
214 "*Controls whether input to interpreter causes window to scroll.
215 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
216 If `this', scroll only the selected window.
218 The default is nil.
220 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
228 "*Controls whether interpreter output causes window to scroll.
229 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
230 If `this', scroll only the selected window.
231 If `others', scroll only those that are not the selected window.
233 The default is nil.
235 See variable `comint-scroll-show-maximum-output' and function
236 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
245 "*Controls how interpreter output causes window to scroll.
246 If non-nil, then show the maximum output when the window is scrolled.
248 See variable `comint-scroll-to-bottom-on-output' and function
249 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
254 "*The maximum size in lines for comint buffers.
255 Comint buffers are truncated from the top to be no greater than this number, if
256 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
264 "*If non-nil, assume that the subprocess echoes any input.
265 If so, delete one copy of the input so that only one copy eventually
266 appears in the buffer.
268 This variable is buffer-local."
272 ;; AIX puts the name of the person being su'd to in from of the prompt.
275 "*Regexp matching prompts for passwords in the inferior process.
276 This is used by `comint-watch-for-password-prompt'."
280 ;; Here are the per-interpreter hooks.
282 "Function that returns old text in comint mode.
283 This function is called when return is typed while the point is in old text.
284 It returns the text to be submitted as process input. The default is
285 `comint-get-old-input-default', which grabs the current line, and strips off
290 "List of functions called to perform completion.
291 Functions should return non-nil if completion was performed.
292 See also `comint-dynamic-complete'.
298 "Predicate for filtering additions to input history.
299 Takes one argument, the input. If non-nil, the input may be saved on the input
303 "Functions to call before input is sent to the process.
304 These functions get one argument, a string containing the text to send.
309 "Functions to call after output is inserted into the buffer.
310 One possible function is `comint-postoutput-scroll-to-bottom'.
311 These functions get one argument, a string containing the text as originally
312 inserted. Note that this might not be the same as the buffer contents between
313 `comint-last-output-start' and the buffer's `process-mark', if other filter
314 functions have already modified the buffer.
316 See also `comint-preoutput-filter-functions'.
321 "Function to actually send to PROCESS the STRING submitted by user.
322 Usually this is just `comint-simple-send', but if your mode needs to
323 massage the input string, put a different function here.
324 `comint-simple-send' just sends the string plus a newline.
328 "*Non-nil means go to the end of the line before sending input.
329 See `comint-send-input'."
334 "Called upon entry into comint-mode
335 This is run before the process is cranked up."
340 "Called each time a process is exec'd by `comint-exec'.
341 This is called after the process is cranked up. It is useful for things that
342 must be done each time a process is executed in a comint mode buffer (e.g.,
343 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
344 executed once when the buffer is created."
351 "Non-nil if communications via pty; false if by pipe. Buffer local.
378 "Major mode for interacting with an inferior interpreter.
379 Interpreter name is same as buffer name, sans the asterisks.
380 Return at end of buffer sends line as input.
381 Return not at end copies rest of line to end and sends it.
382 Setting variable `comint-eol-on-send' means jump to the end of the line
383 before submitting new input.
385 This mode is customised to create major modes such as Inferior Lisp
386 mode, Shell mode, etc. This can be done by setting the hooks
387 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
388 and `comint-get-old-input' to appropriate functions, and the variable
389 `comint-prompt-regexp' to the appropriate regular expression.
391 An input history is maintained of size `comint-input-ring-size', and
392 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
393 Input ring history expansion can be achieved with the commands
395 Input ring expansion is controlled by the variable `comint-input-autoexpand',
396 and addition is controlled by the variable `comint-input-ignoredups'.
398 Commands with no default key bindings include `send-invisible',
399 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
400 `comint-magic-space'.
402 Input to, and output from, the subprocess can cause the window to scroll to
403 the end of the buffer. See variables `comint-output-filter-functions',
404 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
405 and `comint-scroll-to-bottom-on-output'.
408 to continue it.
412 Entry to this mode runs the hooks on `comint-mode-hook'."
414 ;; Do not remove this. All major modes must do this.
462 nil
463 ;; Keys:
490 ;; Menu bars:
491 ;; completion:
502 ;; Input history:
539 ;; Signals
554 ;; Put them in the menu bar:
556 menu-bar-final-items))
557 )
560 "Return t if there is a living process associated w/buffer BUFFER.
561 Living means the status is `open', `run', or `stop'.
562 BUFFER can be either a buffer or the name of one."
566 ;;;###autoload
568 "Make a comint process NAME in a buffer, running PROGRAM.
569 The name of the buffer is made by surrounding NAME with `*'s.
570 PROGRAM should be either a string denoting an executable program to create
571 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
572 connection to be opened via `open-network-stream'. If there is already a
573 running process in that buffer, it is not restarted. Optional third arg
574 STARTFILE is the name of a file to send the contents of to the process.
576 If PROGRAM is a string, any more args are arguments to PROGRAM."
580 ;; If no process, or nuked process, crank up a new one and put buffer in
581 ;; comint mode. Otherwise, leave buffer and existing process alone.
587 buffer))
589 ;;;###autoload
591 "Run PROGRAM in a comint buffer and switch to it.
592 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
593 The file name is used to make a symbol name, such as `comint-sh-hook', and any
594 hooks on this symbol are run in the buffer.
595 See `make-comint' and `comint-exec'."
602 "Start up a process in buffer BUFFER for comint modes.
603 Blasts any old process running in the buffer. Doesn't set the buffer mode.
604 You can use this to cheaply run a series of processes in the same comint
605 buffer. The hook `comint-exec-hook' is run after each exec."
610 ;; Crank up a new process
618 ;; Jump to the end, and set the process mark.
621 ;; Feed it the startfile.
623 ;;This is guaranteed to wait long enough
624 ;;but has bad results if the comint does not prompt at all
625 ;; (while (= size (buffer-size))
626 ;; (sleep-for 1))
627 ;;I hope 1 second is enough!
635 buffer)))
637 ;; This auxiliary function cranks up the process for comint-exec in
638 ;; the appropriate environment.
643 ;; If using termcap, we specify `emacs' as the terminal type
644 ;; because that lets us specify a width.
645 ;; If using terminfo, we specify `dumb' because that is
646 ;; a defined terminal type. `emacs' is not a defined terminal type
647 ;; and there is no way for us to define it here.
648 ;; Some programs that use terminfo get very confused
649 ;; if TERM is not a valid terminal type.
656 process-environment))
659 default-directory
662 \f
663 ;; Input history processing in a buffer
664 ;; ===========================================================================
665 ;; Useful input history functions, courtesy of the Ergo group.
667 ;; Eleven commands:
668 ;; comint-dynamic-list-input-ring List history in help buffer.
669 ;; comint-previous-input Previous input...
670 ;; comint-previous-matching-input ...matching a string.
671 ;; comint-previous-matching-input-from-input ... matching the current input.
672 ;; comint-next-input Next input...
673 ;; comint-next-matching-input ...matching a string.
674 ;; comint-next-matching-input-from-input ... matching the current input.
675 ;; comint-backward-matching-input Backwards input...
676 ;; comint-forward-matching-input ...matching a string.
677 ;; comint-replace-by-expanded-history Expand history at point;
678 ;; replace with expanded history.
679 ;; comint-magic-space Expand history and insert space.
680 ;;
681 ;; Three functions:
682 ;; comint-read-input-ring Read into comint-input-ring...
683 ;; comint-write-input-ring Write to comint-input-ring-file-name.
684 ;; comint-replace-by-expanded-history-before-point Workhorse function.
687 "Sets the buffer's `comint-input-ring' from a history file.
688 The name of the file is given by the variable `comint-input-ring-file-name'.
689 The history ring is of size `comint-input-ring-size', regardless of file size.
690 If `comint-input-ring-file-name' is nil this function does nothing.
692 If the optional argument SILENT is non-nil, we say nothing about a
693 failure to read the history file.
695 This function is useful for major mode commands and mode hooks.
697 The structure of the history file should be one input command per line,
698 with the most recent command last.
699 See also `comint-input-ignoredups' and `comint-write-input-ring'."
702 nil)
706 comint-input-ring-file-name)))
718 ;; Save restriction in case file is already visited...
719 ;; Watch for those date stamps in history files!
723 nil t))
733 comint-input-ring-index nil)))))
736 "Writes the buffer's `comint-input-ring' to a history file.
737 The name of the file is given by the variable `comint-input-ring-file-name'.
738 The original contents of the file are lost if `comint-input-ring' is not empty.
739 If `comint-input-ring-file-name' is nil this function does nothing.
741 Useful within process sentinels.
743 See also `comint-read-input-ring'."
747 nil)
755 ;; Write it all out into a buffer first. Much faster, but messier,
756 ;; than writing it one line at a time.
768 "List in help buffer the buffer's input history."
777 ;; We have to build up a list ourselves from the ring vector.
781 ;; Change "completion" to "history reference"
782 ;; to make the display accurate.
798 ;; Return list of regexp and prefix arg using PROMPT.
800 ;; Don't clobber this.
807 regexp)
811 ;; First make sure there is a ring and that we are after the process mark
818 ;; arg of zero resets search from beginning, and uses arg of 1
822 arg)))
825 ;; Index to start a directional search, starting at comint-input-ring-index
827 ;; If a search is running, offset by 1 in direction of arg
830 ;; For a new search, start from beginning or end, as appropriate
836 "Return the string ARG places along the input ring.
837 Moves relative to `comint-input-ring-index'."
841 arg)))
844 "Cycle backwards through input history."
849 "Cycle forwards through input history."
854 "Return the string matching REGEXP ARG places along the input ring.
855 Moves relative to `comint-input-ring-index'."
860 "Return the index matching REGEXP ARG places along the input ring.
861 Moves relative to START, or `comint-input-ring-index'."
870 ;; Do the whole search as many times as the argument says.
872 ;; Step once.
875 ;; If we haven't reached a match, step some more.
879 ;; If we have gone all the way around in this search.
882 ;; Now that we know which ring element to use, if we found it, return that.
884 n)))
887 "Search backwards through input history for match for REGEXP.
888 \(Previous history elements are earlier commands.)
889 With prefix argument N, search for Nth previous match.
890 If N is negative, find the next or Nth next match."
894 ;; Has a match been found?
900 ;; Can't use kill-region as it sets this-command
905 "Search forwards through input history for match for REGEXP.
906 \(Later history elements are more recent commands.)
907 With prefix argument N, search for Nth following match.
908 If N is negative, find the previous or Nth previous match."
913 "Search backwards through input history for match for current input.
914 \(Previous history elements are earlier commands.)
915 With prefix argument N, search for Nth previous match.
916 If N is negative, search forwards for the -Nth following match."
919 comint-next-matching-input-from-input)))
920 ;; Starting a new search
925 comint-input-ring-index nil))
928 arg))
931 "Search forwards through input history for match for current input.
932 \(Following history elements are more recent commands.)
933 With prefix argument N, search for Nth following match.
934 If N is negative, search backwards for the -Nth previous match."
940 "Expand input command history references before point.
941 Expansion is dependent on the value of `comint-input-autoexpand'.
943 This function depends on the buffer's idea of the input history, which may not
944 match the command interpreter's idea, assuming it has one.
946 Assumes history syntax is like typical Un*x shells'. However, since emacs
947 cannot know the interpreter's idea of input line numbers, assuming it has one,
948 it cannot expand absolute input line number references.
950 If the optional argument SILENT is non-nil, never complain
951 even if history reference seems erroneous.
953 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
955 Returns t if successful."
961 ;; Looks like there might be history references in the command.
969 "Expand directory stack reference before point.
970 See `comint-replace-by-expanded-history'. Returns t if successful."
981 ;; This seems a bit complex. We look for references such as !!, !-num,
982 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
983 ;; If that wasn't enough, the plings can be suffixed with argument
984 ;; range specifiers.
985 ;; Argument ranges are complex too, so we hive off the input line,
986 ;; referenced with plings, with the range string to `comint-args'.
990 ;; The history is quoted, or we're in quotes.
993 ;; We cannot know the interpreter's idea of input line numbers.
997 ;; Just a number of args from `number' lines backward.
1006 t t)
1012 ;; Just a number of args from the previous input line.
1016 t t)
1020 ;; Most recent input starting with or containing (possibly
1021 ;; protected) string, maybe just a number of args. Phew.
1039 t t)
1042 ;; Quick substitution on the previous input line.
1059 "Expand input history references before point and insert ARG spaces.
1060 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1064 \f
1066 "Return t if the number of quotes between BEG and END is odd.
1067 Quotes are single and double."
1073 "Return number of matches for REGEXP from BEG to END."
1080 count))
1083 ;; From STRING, return the args depending on the range specified in the text
1084 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1085 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1101 ;; Return a list of arguments from ARG. Break it up at the
1102 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1117 comint-delimiter-argument-list)))
1120 args)))
1123 "Return from STRING the NTH to MTH arguments.
1124 NTH and/or MTH can be nil, which means the last argument.
1125 Returned arguments are separated by single spaces.
1126 We assume whitespace separates arguments, except within quotes.
1127 Also, a run of one or more of a single character
1128 in `comint-delimiter-argument-list' is a separate argument.
1129 Argument 0 is the command name."
1133 beg str value quotes)
1134 ;; Build a list of all the args until we have as many as we want.
1138 ;; It's contiguous, part of the same arg.
1141 ;; It's a new separate arg.
1143 ;; Put the previous arg, if there was one, onto ARGS.
1160 \f
1161 ;;
1162 ;; Input processing stuff
1163 ;;
1166 "Send input to process.
1167 After the process output mark, sends all text from the process mark to
1168 point as input to the process. Before the process output mark, calls value
1169 of variable `comint-get-old-input' to retrieve old input, copies it to the
1170 process mark, and sends it. If variable `comint-process-echoes' is nil,
1171 a terminal newline is also inserted into the buffer and sent to the process
1172 \(if it is non-nil, all text from the process mark to point is deleted,
1173 since it is assumed the remote process will re-echo it).
1175 Any history reference may be expanded depending on the value of the variable
1176 `comint-input-autoexpand'. The list of function names contained in the value
1177 of `comint-input-filter-functions' is called on the input before sending it.
1178 The input is entered into the input history ring, if the value of variable
1179 `comint-input-filter' returns non-nil when called on the input.
1181 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1182 end of line before sending the input.
1184 The values of `comint-get-old-input', `comint-input-filter-functions', and
1185 `comint-input-filter' are chosen according to the command interpreter running
1186 in the buffer. E.g.,
1188 If the interpreter is the csh,
1189 comint-get-old-input is the default: take the current line, discard any
1190 initial string matching regexp comint-prompt-regexp.
1193 comint-input-filter is the default: returns t if the input isn't all white
1194 space.
1196 If the comint is Lucid Common Lisp,
1197 comint-get-old-input snarfs the sexp ending at point.
1198 comint-input-filter-functions does nothing.
1199 comint-input-filter returns nil if the input matches input-filter-regexp,
1200 which matches (1) all whitespace (2) :a, :c, etc.
1202 Similarly for Soar, Scheme, etc."
1204 ;; Note that the input string does not include its terminal newline.
1214 copy)))
1216 ;; Just whatever's already there
1217 intxt
1218 ;; Expand and leave it visible in buffer
1222 input
1223 ;; This is messy 'cos ultimately the original
1224 ;; functions used do insertion, rather than return
1225 ;; strings. We have to expand, then insert back.
1231 copy))))
1240 history))))
1245 ;; Update the markers before we send the input
1246 ;; in case we get output amidst sending the input.
1251 ;; This used to call comint-output-filter-functions,
1252 ;; but that scrolled the buffer in undesirable ways.
1256 "Functions to call after output is inserted into the buffer.
1257 These functions get one argument, a string containing the text to be
1258 inserted. They return the string as it should be inserted.
1262 ;; The purpose of using this filter for comint processes
1263 ;; is to keep comint-last-input-end from moving forward
1264 ;; when output is inserted.
1266 ;; First check for killed buffer
1287 ;; Insert after old_begv, but before old_zv.
1293 ;; Don't insert initial prompt outside the top of the window.
1310 "Go to the end of buffer in all windows showing it.
1311 Movement occurs if point in the selected window is not after the process mark,
1312 and `this-command' is an insertion command. Insertion commands recognised
1313 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1314 Depends on the value of `comint-scroll-to-bottom-on-input'.
1316 This function should be a pre-command hook."
1319 hilit-yank)))
1335 nil t))))))
1338 "Go to the end of buffer in all windows showing it.
1339 Does not scroll if the current line is the last line in the buffer.
1340 Depends on the value of `comint-scroll-to-bottom-on-output' and
1341 `comint-scroll-show-maximum-output'.
1343 This function should be in the list `comint-output-filter-functions'."
1357 ;; Maybe user wants point to jump to end.
1360 ;; If point was at the end, keep it at end.
1363 ;; Optionally scroll so that the text
1364 ;; ends at the bottom of the window.
1371 nil t))
1375 "Truncate the buffer to `comint-buffer-maximum-size'.
1376 This function could be on `comint-output-filter-functions' or bound to a key."
1385 "Strip trailing `^M' characters from the current output group.
1386 This function could be on `comint-output-filter-functions' or bound to a key."
1397 "Put the end of the buffer at the bottom of the window."
1403 "Default for `comint-get-old-input'.
1404 Take the current line, and discard any initial text matching
1405 `comint-prompt-regexp'."
1414 "Insert after prompt old input at point as new input to be edited.
1415 Calls `comint-get-old-input' to get old input."
1425 "Skip past the text matching regexp `comint-prompt-regexp'.
1426 If this takes us past the end of the current line, don't skip at all."
1433 "Return t if point is after the process output marker."
1438 "Default function for sending to PROC input STRING.
1439 This just sends STRING plus a newline. To override this,
1440 set the hook `comint-input-sender'."
1445 "Goes to the beginning of line, then skips past the prompt, if any.
1448 The prompt skip is done by skipping text matching the regular expression
1449 `comint-prompt-regexp', a buffer local variable."
1454 ;; These three functions are for entering text you don't want echoed or
1455 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1456 ;; Just enter m-x send-invisible and type in your line, or add
1457 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1460 "Read a single line of text from user without echoing, and return it.
1461 Prompt with argument PROMPT, a string. Optional argument STARS causes
1462 input to be echoed with '*' characters on the prompt line. Input ends with
1463 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1464 `inhibit-quit' is set because e.g. this function was called from a process
1465 filter and C-g is pressed, this function returns nil rather than a string).
1467 Note that the keystrokes comprising the text can still be recovered
1469 Once the caller uses the password, it can erase the password
1470 by doing (fillarray STRING 0)."
1482 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1485 ;; This function may get called from a process filter, where
1486 ;; inhibit-quit is set. In later versions of emacs read-char
1487 ;; may clear quit-flag itself and return C-g. That would make
1488 ;; it impossible to quit this loop in a simple way, so
1489 ;; re-enable it here (for backward-compatibility the check for
1490 ;; quit-flag below would still be necessary, so this seems
1491 ;; like the simplest way to do things).
1493 done t))
1507 ;; Emulate a true quit, except that we have to return a value.
1513 ans)))
1516 "Read a string without echoing.
1517 Then send it to the process running in the current buffer.
1518 The string is sent using `comint-input-sender'.
1519 Security bug: your string can still be temporarily recovered with
1534 "Prompt in the minibuffer for password and send without echoing.
1535 This function uses `send-invisible' to read and send a password to the buffer's
1536 process if STRING contains a password prompt defined by
1537 `comint-password-prompt-regexp'.
1539 This function could be in the list `comint-output-filter-functions'."
1542 \f
1543 ;; Low-level process communication
1547 \f
1548 ;; Random input hackage
1551 "Kill all output from interpreter since last input.
1552 Does not delete the prompt."
1565 ;; Output message and put back prompt
1569 "Display start of this batch of interpreter output at top of window.
1570 Sets mark to the value of point when this command is run."
1580 "Interrupt the current subjob."
1585 "Send kill signal to the current subjob."
1590 "Send quit signal to the current subjob."
1595 "Stop the current subjob.
1596 WARNING: if there is no current subjob, you can end up suspending
1597 the top-level process running in the buffer. If you accidentally do
1599 is not a problem with most shells, since they ignore this signal.)"
1604 "Send CONT signal to process buffer's process group.
1605 Useful if you accidentally suspend the top-level process."
1610 "Kill all text from last stuff output by interpreter to point."
1617 "Delete ARG characters forward or send an EOF to subprocess.
1618 Sends an EOF only if point is at the end of the buffer and there is no input."
1626 "Send an EOF to the current buffer's process."
1632 "Search backward through buffer for match for REGEXP.
1633 Matches are searched for on lines that match `comint-prompt-regexp'.
1634 With prefix argument N, search for Nth previous match.
1635 If N is negative, find the next or Nth next match."
1648 "Search forward through buffer for match for REGEXP.
1649 Matches are searched for on lines that match `comint-prompt-regexp'.
1650 With prefix argument N, search for Nth following match.
1651 If N is negative, find the previous or Nth previous match."
1657 "Move to end of Nth next prompt in the buffer.
1658 See `comint-prompt-regexp'."
1666 "Move to end of Nth previous prompt in the buffer.
1667 See `comint-prompt-regexp'."
1670 \f
1671 ;; Support for source-file processing commands.
1672 ;;============================================================================
1673 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1674 ;; commands that process files of source text (e.g. loading or compiling
1675 ;; files). So the corresponding process-in-a-buffer modes have commands
1676 ;; for doing this (e.g., lisp-load-file). The functions below are useful
1677 ;; for defining these commands.
1678 ;;
1679 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1680 ;; and Soar, in that they don't know anything about file extensions.
1681 ;; So the compile/load interface gets the wrong default occasionally.
1682 ;; The load-file/compile-file default mechanism could be smarter -- it
1683 ;; doesn't know about the relationship between filename extensions and
1684 ;; whether the file is source or executable. If you compile foo.lisp
1685 ;; with compile-file, then the next load-file should use foo.bin for
1686 ;; the default, not foo.lisp. This is tricky to do right, particularly
1687 ;; because the extension for executable files varies so much (.o, .bin,
1688 ;; .lbin, .mo, .vo, .ao, ...).
1691 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1692 ;; commands.
1693 ;;
1694 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1695 ;; want to save the buffer before issuing any process requests to the command
1696 ;; interpreter.
1697 ;;
1698 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1699 ;; for the file to process.
1701 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1702 ;;============================================================================
1703 ;; This function computes the defaults for the load-file and compile-file
1704 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
1705 ;;
1706 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1707 ;; source-file processing command. NIL if there hasn't been one yet.
1708 ;; - SOURCE-MODES is a list used to determine what buffers contain source
1709 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1710 ;; Typically, (lisp-mode) or (scheme-mode).
1711 ;;
1712 ;; If the command is given while the cursor is inside a string, *and*
1713 ;; the string is an existing filename, *and* the filename is not a directory,
1714 ;; then the string is taken as default. This allows you to just position
1715 ;; your cursor over a string that's a filename and have it taken as default.
1716 ;;
1717 ;; If the command is given in a file buffer whose major mode is in
1718 ;; SOURCE-MODES, then the the filename is the default file, and the
1719 ;; file's directory is the default directory.
1720 ;;
1721 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1722 ;; then the default directory & file are what was used in the last source-file
1723 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1724 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1725 ;; is the cwd, with no default file. (\"no default file\" = nil)
1726 ;;
1727 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1728 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1729 ;; for Soar programs, etc.
1730 ;;
1731 ;; The function returns a pair: (default-directory . default-file).
1742 ;; (COMINT-CHECK-SOURCE fname)
1743 ;;============================================================================
1744 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1745 ;; process-in-a-buffer modes), this function can be called on the filename.
1746 ;; If the file is loaded into a buffer, and the buffer is modified, the user
1747 ;; is queried to see if he wants to save the buffer before proceeding with
1748 ;; the load or compile.
1755 ;; save BUFF.
1762 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1763 ;;============================================================================
1764 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1765 ;; commands that process source files (like loading or compiling a file).
1766 ;; It prompts for the filename, provides a default, if there is one,
1767 ;; and returns the result filename.
1768 ;;
1769 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1770 ;;
1771 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1772 ;; from the last source processing command. SOURCE-MODES is a list of major
1773 ;; modes used to determine what file buffers contain source files. (These
1774 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1775 ;; then the filename reader will only accept a file that exists.
1776 ;;
1777 ;; A typical use:
1778 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1779 ;; '(lisp-mode) t))
1781 ;; This is pretty stupid about strings. It decides we're in a string
1782 ;; if there's a quote on both sides of point on the current line.
1784 "Return string around POINT that starts the current line, or nil."
1811 prompt deffile)
1812 prompt)
1813 defdir
1815 mustmatch-p)))
1818 ;; I am somewhat divided on this string-default feature. It seems
1819 ;; to violate the principle-of-least-astonishment, in that it makes
1820 ;; the default harder to predict, so you actually have to look and see
1821 ;; what the default really is before choosing it. This can trip you up.
1822 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
1823 ;; on this.
1824 ;; -Olin
1826 \f
1827 ;; Simple process query facility.
1828 ;; ===========================================================================
1829 ;; This function is for commands that want to send a query to the process
1830 ;; and show the response to the user. For example, a command to get the
1831 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1832 ;; to an inferior Common Lisp process.
1833 ;;
1834 ;; This simple facility just sends strings to the inferior process and pops
1835 ;; up a window for the process buffer so you can see what the process
1836 ;; responds with. We don't do anything fancy like try to intercept what the
1837 ;; process responds with and put it in a pop-up window or on the message
1838 ;; line. We just display the buffer. Low tech. Simple. Works good.
1840 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
1841 ;; a window for the inferior process so that its response can be seen.
1851 ;; Try to position the proc window so you can see the answer.
1852 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1853 ;; I don't know why. Wizards invited to improve it.
1862 \f
1863 ;; Filename/command/history completion in a buffer
1864 ;; ===========================================================================
1865 ;; Useful completion functions, courtesy of the Ergo group.
1867 ;; Six commands:
1868 ;; comint-dynamic-complete Complete or expand command, filename,
1869 ;; history at point.
1870 ;; comint-dynamic-complete-filename Complete filename at point.
1871 ;; comint-dynamic-list-filename-completions List completions in help buffer.
1872 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
1873 ;; replace with expanded/completed name.
1874 ;; comint-dynamic-simple-complete Complete stub given candidates.
1876 ;; These are not installed in the comint-mode keymap. But they are
1877 ;; available for people who want them. Shell-mode installs them:
1878 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1879 ;; (define-key shell-mode-map "\M-?"
1880 ;; 'comint-dynamic-list-filename-completions)))
1881 ;;
1882 ;; Commands like this are fine things to put in load hooks if you
1883 ;; want them present in specific modes.
1886 "*If non-nil, automatically list possibilities on partial completion.
1887 This mirrors the optional behavior of tcsh."
1892 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1893 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
1894 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
1895 This mirrors the optional behavior of tcsh."
1900 "*If non-nil, use shortest completion if characters cannot be added.
1901 This mirrors the optional behavior of tcsh.
1903 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
1908 "*List of suffixes to be disregarded during file completion.
1909 This mirrors the optional behavior of bash and tcsh.
1911 Note that this applies to `comint-dynamic-complete-filename' only."
1916 "Prefix prepended to absolute file names taken from process input.
1917 This is used by comint's and shell's completion functions, and by shell's
1928 "String of characters valid in a file name.
1929 Note that all non-ASCII characters are considered valid in a file name
1930 regardless of what this variable says.
1941 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1944 directory)))
1948 "Return the word of WORD-CHARS at point, or nil if non is found.
1949 Word constituents are considered to be those in WORD-CHARS, which is like the
1951 plus all non-ASCII characters."
1955 ;;(memq (char-after (point)) shell-file-name-quote-list)
1959 ;; Don't go forward over a word-char (this can happen if we're at bob).
1962 ;; Set match-data to match the entire string.
1968 "Return FILENAME with environment variables substituted.
1969 Supports additional environment variable syntax of the command
1970 interpreter (e.g., the percent notation of cmd.exe on NT)."
1974 env-var-val)
1983 name))
1986 "Return the filename at point, or nil if non is found.
1987 Environment variables are substituted. See `comint-word'."
1994 "Return FILENAME with magic characters quoted.
1995 Magic characters are those in `comint-file-name-quote-list'."
1997 filename
2004 filename))))
2007 "Return FILENAME with quoted characters unquoted."
2009 filename
2015 filename)))
2019 "Dynamically perform completion at point.
2020 Calls the functions in `comint-dynamic-complete-functions' to perform
2021 completion until a function returns non-nil, at which point completion is
2022 assumed to have occurred."
2028 "Dynamically complete the filename at point.
2029 Completes if after a filename. See `comint-match-partial-filename' and
2030 `comint-dynamic-complete-as-filename'.
2031 This function is similar to `comint-replace-by-expanded-filename', except that
2032 it won't change parts of the filename already entered in the buffer; it just
2033 adds completion characters to the end of the filename. A completions listing
2034 may be shown in a help buffer if completion is ambiguous.
2036 Completion is dependent on the value of `comint-completion-addsuffix',
2037 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2038 completions listing is dependent on the value of `comint-completion-autolist'.
2040 Returns t if successful."
2044 ?\\
2045 ?/)))
2051 "Dynamically complete at point as a filename.
2052 See `comint-dynamic-complete-filename'. Returns t if successful."
2055 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2056 ;; I think it was originally bound to solve file completion problems,
2057 ;; but subsequent changes may have made this unnecessary. sm.
2058 ;;(file-name-handler-alist nil)
2086 ;; We inserted a unique completion.
2092 ;; It's not unique, but user wants shortest match.
2097 ;; It's not unique, list possible completions.
2101 success))
2105 "Dynamically expand and complete the filename at point.
2106 Replace the filename with an expanded, canonicalised and completed replacement.
2109 removed, and the filename is made absolute instead of relative. For expansion
2110 see `expand-file-name' and `substitute-in-file-name'. For completion see
2111 `comint-dynamic-complete-filename'."
2118 "Dynamically complete STUB from CANDIDATES list.
2119 This function inserts completion characters at point by completing STUB from
2120 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2121 if completion is ambiguous.
2123 Returns nil if no completion was inserted.
2124 Returns `sole' if completed with the only completion match.
2125 Returns `shortest' if completed with the shortest of the completion matches.
2126 Returns `partial' if completed as far as possible with the completion matches.
2127 Returns `listed' if a completion listing was shown.
2129 See also `comint-dynamic-complete-filename'."
2138 nil)
2149 ;; Insert the longest substring.
2154 ;; It's not unique, but user wants shortest match.
2160 ;; It's not unique, list possible completions.
2169 "List in help buffer possible completions of the filename at point."
2172 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2173 ;; I think it was originally bound to solve file completion problems,
2174 ;; but subsequent changes may have made this unnecessary. sm.
2175 ;;(file-name-handler-alist nil)
2188 "List in help buffer sorted COMPLETIONS.
2189 Typing SPC flushes the help buffer."
2203 ;; If the user does mouse-choose-completion with the mouse,
2204 ;; execute the command, then delete the completion window.
2211 \f
2212 ;; Converting process modes to use comint mode
2213 ;; ===========================================================================
2214 ;; The code in the Emacs 19 distribution has all been modified to use comint
2215 ;; where needed. However, there are `third-party' packages out there that
2216 ;; still use the old shell mode. Here's a guide to conversion.
2217 ;;
2218 ;; Renaming variables
2219 ;; Most of the work is renaming variables and functions. These are the common
2220 ;; ones:
2221 ;; Local variables:
2222 ;; last-input-start comint-last-input-start
2223 ;; last-input-end comint-last-input-end
2224 ;; shell-prompt-pattern comint-prompt-regexp
2225 ;; shell-set-directory-error-hook <no equivalent>
2226 ;; Miscellaneous:
2227 ;; shell-set-directory <unnecessary>
2228 ;; shell-mode-map comint-mode-map
2229 ;; Commands:
2230 ;; shell-send-input comint-send-input
2231 ;; shell-send-eof comint-delchar-or-maybe-eof
2232 ;; kill-shell-input comint-kill-input
2233 ;; interrupt-shell-subjob comint-interrupt-subjob
2234 ;; stop-shell-subjob comint-stop-subjob
2235 ;; quit-shell-subjob comint-quit-subjob
2236 ;; kill-shell-subjob comint-kill-subjob
2237 ;; kill-output-from-shell comint-kill-output
2238 ;; show-output-from-shell comint-show-output
2239 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
2240 ;;
2241 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2242 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2243 ;; Comint mode does not provide functionality equivalent to
2244 ;; shell-set-directory-error-hook; it is gone.
2245 ;;
2246 ;; comint-last-input-start is provided for modes which want to munge
2247 ;; the buffer after input is sent, perhaps because the inferior
2248 ;; insists on echoing the input. The LAST-INPUT-START variable in
2249 ;; the old shell package was used to implement a history mechanism,
2250 ;; but you should think twice before using comint-last-input-start
2251 ;; for this; the input history ring often does the job better.
2252 ;;
2253 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2254 ;; *not* create the comint-mode local variables in your foo-mode function.
2255 ;; This is not modular. Instead, call comint-mode, and let *it* create the
2256 ;; necessary comint-specific local variables. Then create the
2257 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2258 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2259 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2260 ;; get-old-input) that need to be different from the defaults. Call
2261 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2262 ;; comint-mode will take care of it. The following example, from shell.el,
2263 ;; is typical:
2264 ;;
2265 ;; (defvar shell-mode-map '())
2266 ;; (cond ((not shell-mode-map)
2267 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
2268 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2269 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2270 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2271 ;; (define-key shell-mode-map "\M-?"
2272 ;; 'comint-dynamic-list-filename-completions)))
2273 ;;
2274 ;; (defun shell-mode ()
2275 ;; (interactive)
2276 ;; (comint-mode)
2277 ;; (setq comint-prompt-regexp shell-prompt-pattern)
2278 ;; (setq major-mode 'shell-mode)
2279 ;; (setq mode-name "Shell")
2280 ;; (use-local-map shell-mode-map)
2281 ;; (make-local-variable 'shell-directory-stack)
2282 ;; (setq shell-directory-stack nil)
2283 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2284 ;; (run-hooks 'shell-mode-hook))
2285 ;;
2286 ;;
2287 ;; Completion for comint-mode users
2288 ;;
2289 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2290 ;; hook to add completion functions to. Functions on this list should return
2291 ;; non-nil if completion occurs (i.e., further completion should not occur).
2292 ;; You could use comint-dynamic-simple-complete to do the bulk of the
2293 ;; completion job.
2294 \f
2297 ;; comint.el ends here