| blob | 11e49d4fdb7965cd01ef53934fdbb22329e4c63e |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993, 1994 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Adapted-by: Simon Marshall <s.marshall@dcs.hull.ac.uk>
7 ;; Keywords: processes
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;;; Commentary:
27 ;;; Please send me bug reports, bug fixes, and extensions, so that I can
28 ;;; merge them into the master source.
29 ;;; - Olin Shivers (shivers@cs.cmu.edu)
30 ;;; - Simon Marshall (s.marshall@dcs.hull.ac.uk)
32 ;;; This file defines a general command-interpreter-in-a-buffer package
33 ;;; (comint mode). The idea is that you can build specific process-in-a-buffer
34 ;;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
35 ;;; This way, all these specific packages share a common base functionality,
36 ;;; and a common set of bindings, which makes them easier to use (and
37 ;;; saves code, implementation time, etc., etc.).
39 ;;; Several packages are already defined using comint mode:
40 ;;; - shell.el defines a shell-in-a-buffer mode.
41 ;;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
42 ;;;
43 ;;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
44 ;;; - The file tea.el tunes scheme and inferior-scheme modes for T.
45 ;;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
46 ;;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
47 ;;; previewers, and printers from within emacs.
48 ;;; - background.el allows csh-like job control inside emacs.
49 ;;; It is pretty easy to make new derived modes for other processes.
51 ;;; For documentation on the functionality provided by comint mode, and
52 ;;; the hooks available for customising it, see the comments below.
53 ;;; For further information on the standard derived modes (shell,
54 ;;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
56 ;;; For hints on converting existing process modes (e.g., tex-mode,
57 ;;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
58 ;;; instead of shell-mode, see the notes at the end of this file.
60 \f
61 ;;; Brief Command Documentation:
62 ;;;============================================================================
63 ;;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
64 ;;; mode)
65 ;;;
66 ;;; m-p comint-previous-input Cycle backwards in input history
67 ;;; m-n comint-next-input Cycle forwards
68 ;;; m-r comint-previous-matching-input Previous input matching a regexp
69 ;;; m-s comint-next-matching-input Next input that matches
70 ;;; m-c-l comint-show-output Show last batch of process output
71 ;;; return comint-send-input
72 ;;; c-a comint-bol Beginning of line; skip prompt
73 ;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
74 ;;; c-c c-u comint-kill-input ^u
75 ;;; c-c c-w backward-kill-word ^w
76 ;;; c-c c-c comint-interrupt-subjob ^c
77 ;;; c-c c-z comint-stop-subjob ^z
78 ;;; c-c c-\ comint-quit-subjob ^\
79 ;;; c-c c-o comint-kill-output Delete last batch of process output
80 ;;; c-c c-r comint-show-output Show last batch of process output
81 ;;; c-c c-h comint-dynamic-list-input-ring List input history
82 ;;;
83 ;;; Not bound by default in comint-mode (some are in shell mode)
84 ;;; comint-run Run a program under comint-mode
85 ;;; send-invisible Read a line w/o echo, and send to proc
86 ;;; comint-dynamic-complete-filename Complete filename at point.
87 ;;; comint-dynamic-complete-variable Complete variable name at point.
88 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
89 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
90 ;;; replace with expanded/completed name.
91 ;;; comint-replace-by-expanded-history Expand history at point;
92 ;;; replace with expanded name.
93 ;;; comint-magic-space Expand history and add (a) space(s).
94 ;;; comint-kill-subjob No mercy.
95 ;;; comint-show-maximum-output Show as much output as possible.
96 ;;; comint-continue-subjob Send CONT signal to buffer's process
97 ;;; group. Useful if you accidentally
98 ;;; suspend your process (with C-c C-z).
100 ;;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
102 ;;; Code:
105 \f
106 ;;; Buffer Local Variables:
107 ;;;============================================================================
108 ;;; Comint mode buffer local variables:
109 ;;; comint-prompt-regexp - string comint-bol uses to match prompt
110 ;;; comint-delimiter-argument-list - list For delimiters and arguments
111 ;;; comint-last-input-start - marker Handy if inferior always echoes
112 ;;; comint-last-input-end - marker For comint-kill-output command
113 ;;; comint-input-ring-size - integer For the input history
114 ;;; comint-input-ring - ring mechanism
115 ;;; comint-input-ring-index - number ...
116 ;;; comint-input-autoexpand - symbol ...
117 ;;; comint-input-ignoredups - boolean ...
118 ;;; comint-last-input-match - string ...
119 ;;; comint-dynamic-complete-functions - hook For the completion mechanism
120 ;;; comint-completion-fignore - list ...
121 ;;; comint-get-old-input - function Hooks for specific
122 ;;; comint-input-filter-functions - hook process-in-a-buffer
123 ;;; comint-output-filter-functions - hook function modes.
124 ;;; comint-input-filter - function ...
125 ;;; comint-input-send - function ...
126 ;;; comint-eol-on-send - boolean ...
127 ;;; comint-process-echoes - boolean ...
128 ;;; comint-scroll-to-bottom-on-input - symbol For scroll behavior
129 ;;; comint-scroll-to-bottom-on-output - symbol ...
130 ;;; comint-scroll-show-maximum-output - boolean...
131 ;;;
132 ;;; Comint mode non-buffer local variables:
133 ;;; comint-completion-addsuffix - boolean For file name completion
134 ;;; comint-completion-autolist - boolean behavior
135 ;;; comint-completion-recexact - boolean ...
138 "Regexp to recognise prompts in the inferior process.
141 Good choices:
152 "List of characters to recognise as separate arguments in input.
153 Strings comprising a character in this list will separate the arguments
154 surrounding them, and also be regarded as arguments in their own right (unlike
155 whitespace). See `comint-arguments'.
156 Defaults to the empty list.
163 "*If non-nil, expand input command history references on completion.
164 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
166 If the value is `input', then the expansion is seen on input.
167 If the value is `history', then the expansion is only when inserting
168 into the buffer's input ring. See also `comint-magic-space' and
169 `comint-dynamic-complete'.
174 "*If non-nil, don't add input matching the last on the input ring.
175 This mirrors the optional behavior of bash.
180 "*If non-nil, name of the file to read/write input history.
181 See also `comint-read-input-ring' and `comint-write-input-ring'.
186 "*Controls whether input to interpreter causes window to scroll.
187 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
188 If `this', scroll only the selected window.
190 The default is nil.
195 "*Controls whether interpreter output causes window to scroll.
196 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
197 If `this', scroll only the selected window.
198 If `others', scroll only those that are not the selected window.
200 The default is nil.
202 See variable `comint-scroll-show-maximum-output' and function
206 "*Controls how interpreter output causes window to scroll.
207 If non-nil, then show the maximum output when the window is scrolled.
209 See variable `comint-scroll-to-bottom-on-output' and function
216 "*If non-nil, assume that the subprocess echoes any input.
217 If so, delete one copy of the input so that only one copy eventually
218 appears in the buffer.
222 ;;; Here are the per-interpreter hooks.
224 "Function that returns old text in comint mode.
225 This function is called when return is typed while the point is in old text.
226 It returns the text to be submitted as process input. The default is
227 `comint-get-old-input-default', which grabs the current line, and strips off
232 "List of functions called to perform completion.
233 Functions should return non-nil if completion was performed.
234 See also `comint-dynamic-complete'.
240 "Predicate for filtering additions to input history.
241 Takes one argument, the input. If non-nil, the input may be saved on the input
245 "Functions to call before input is sent to the process.
246 These functions get one argument, a string containing the text to send.
251 "Functions to call after output is inserted into the buffer.
252 One possible function is `comint-postoutput-scroll-to-bottom'.
253 These functions get one argument, a string containing the text just inserted.
258 "Function to actually send to PROCESS the STRING submitted by user.
259 Usually this is just `comint-simple-send', but if your mode needs to
260 massage the input string, put a different function here.
261 `comint-simple-send' just sends the string plus a newline.
265 "*Non-nil means go to the end of the line before sending input.
269 "Called upon entry into comint-mode
273 "Called each time a process is exec'd by `comint-exec'.
274 This is called after the process is cranked up. It is useful for things that
275 must be done each time a process is executed in a comint mode buffer (e.g.,
276 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
282 "Non-nil if communications via pty; false if by pipe. Buffer local.
306 "Major mode for interacting with an inferior interpreter.
307 Interpreter name is same as buffer name, sans the asterisks.
308 Return at end of buffer sends line as input.
309 Return not at end copies rest of line to end and sends it.
310 Setting variable `comint-eol-on-send' means jump to the end of the line
311 before submitting new input.
313 This mode is customised to create major modes such as Inferior Lisp
314 mode, Shell mode, etc. This can be done by setting the hooks
315 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
316 and `comint-get-old-input' to appropriate functions, and the variable
317 `comint-prompt-regexp' to the appropriate regular expression.
319 An input history is maintained of size `comint-input-ring-size', and
320 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
321 Input ring history expansion can be achieved with the commands
323 Input ring expansion is controlled by the variable `comint-input-autoexpand',
324 and addition is controlled by the variable `comint-input-ignoredups'.
326 Commands with no default key bindings include `send-invisible',
327 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
328 `comint-magic-space'.
330 Input to, and output from, the subprocess can cause the window to scroll to
331 the end of the buffer. See variables `comint-output-filter-functions',
332 `comint-scroll-to-bottom-on-input', and `comint-scroll-to-bottom-on-output'.
335 to continue it.
339 Entry to this mode runs the hooks on `comint-mode-hook'."
341 ;; Do not remove this. All major modes must do this.
385 nil
386 ;; Keys:
411 ;; Menu bars:
412 ;; completion:
423 ;; Input history:
460 ;; Signals
475 ;; Put them in the menu bar:
477 menu-bar-final-items))
478 )
481 "Return t if there is a living process associated w/buffer BUFFER.
482 Living means the status is `run' or `stop'.
483 BUFFER can be either a buffer or the name of one."
487 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
488 ;;; for the second argument (program).
489 ;;;###autoload
491 "Make a comint process NAME in a buffer, running PROGRAM.
492 The name of the buffer is made by surrounding NAME with `*'s.
493 If there is already a running process in that buffer, it is not restarted.
494 Optional third arg STARTFILE is the name of a file to send the contents of to
495 the process. Any more args are arguments to PROGRAM."
497 ;; If no process, or nuked process, crank up a new one and put buffer in
498 ;; comint mode. Otherwise, leave buffer and existing process alone.
504 buffer))
506 ;;;###autoload
508 "Run PROGRAM in a comint buffer and switch to it.
509 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
510 The file name is used to make a symbol name, such as `comint-sh-hook', and any
511 hooks on this symbol are run in the buffer.
512 See `make-comint' and `comint-exec'."
519 "Start up a process in buffer BUFFER for comint modes.
520 Blasts any old process running in the buffer. Doesn't set the buffer mode.
521 You can use this to cheaply run a series of processes in the same comint
522 buffer. The hook `comint-exec-hook' is run after each exec."
527 ;; Crank up a new process
532 ;; Jump to the end, and set the process mark.
535 ;; Feed it the startfile.
537 ;;This is guaranteed to wait long enough
538 ;;but has bad results if the comint does not prompt at all
539 ;; (while (= size (buffer-size))
540 ;; (sleep-for 1))
541 ;;I hope 1 second is enough!
549 buffer)))
551 ;;; This auxiliary function cranks up the process for comint-exec in
552 ;;; the appropriate environment.
558 process-environment)))
560 \f
561 ;;; Input history processing in a buffer
562 ;;; ===========================================================================
563 ;;; Useful input history functions, courtesy of the Ergo group.
565 ;;; Eleven commands:
566 ;;; comint-dynamic-list-input-ring List history in help buffer.
567 ;;; comint-previous-input Previous input...
568 ;;; comint-previous-matching-input ...matching a string.
569 ;;; comint-previous-matching-input-from-input ... matching the current input.
570 ;;; comint-next-input Next input...
571 ;;; comint-next-matching-input ...matching a string.
572 ;;; comint-next-matching-input-from-input ... matching the current input.
573 ;;; comint-backward-matching-input Backwards input...
574 ;;; comint-forward-matching-input ...matching a string.
575 ;;; comint-replace-by-expanded-history Expand history at point;
576 ;;; replace with expanded history.
577 ;;; comint-magic-space Expand history and insert space.
578 ;;;
579 ;;; Three functions:
580 ;;; comint-read-input-ring Read into comint-input-ring...
581 ;;; comint-write-input-ring Write to comint-input-ring-file-name.
582 ;;; comint-replace-by-expanded-history-before-point Workhorse function.
585 "Sets the buffer's `comint-input-ring' from a history file.
586 The name of the file is given by the variable `comint-input-ring-file-name'.
587 The history ring is of size `comint-input-ring-size', regardless of file size.
588 If `comint-input-ring-file-name' is nil this function does nothing.
590 If the optional argument SILENT is non-nil, we say nothing about a
591 failure to read the history file.
593 This function is useful for major mode commands and mode hooks.
595 The structure of the history file should be one input command per line,
596 with the most recent command last.
597 See also `comint-input-ignoredups' and `comint-write-input-ring'."
600 nil)
604 comint-input-ring-file-name)))
611 ;; Save restriction in case file is already visited...
612 ;; Watch for those date stamps in history files!
624 ;; Kill buffer unless already visited.
628 comint-input-ring-index nil)))))
631 "Writes the buffer's `comint-input-ring' to a history file.
632 The name of the file is given by the variable `comint-input-ring-file-name'.
633 The original contents of the file are lost if `comint-input-ring' is not empty.
634 If `comint-input-ring-file-name' is nil this function does nothing.
636 Useful within process sentinels.
638 See also `comint-read-input-ring'."
642 nil)
650 ;; Write it all out into a buffer first. Much faster, but messier,
651 ;; than writing it one line at a time.
663 "List in help buffer the buffer's input history."
672 ;; We have to build up a list ourselves from the ring vector.
676 ;; Change "completion" to "history reference"
677 ;; to make the display accurate.
693 ;; Return list of regexp and prefix arg using PROMPT.
695 ;; Don't clobber this.
702 regexp)
706 ;; First make sure there is a ring and that we are after the process mark
713 ;; arg of zero resets search from beginning, and uses arg of 1
717 arg)))
720 ;; Index to start a directional search, starting at comint-input-ring-index
722 ;; If a search is running, offset by 1 in direction of arg
725 ;; For a new search, start from beginning or end, as appropriate
731 "Return the string ARG places along the input ring.
732 Moves relative to `comint-input-ring-index'."
736 arg)))
739 "Cycle backwards through input history."
744 "Cycle forwards through input history."
749 "Return the string matching REGEXP ARG places along the input ring.
750 Moves relative to `comint-input-ring-index'."
755 "Return the index matching REGEXP ARG places along the input ring.
756 Moves relative to START, or `comint-input-ring-index'."
765 ;; Do the whole search as many times as the argument says.
767 ;; Step once.
770 ;; If we haven't reached a match, step some more.
774 ;; If we have gone all the way around in this search.
777 ;; Now that we know which ring element to use, if we found it, return that.
779 n)))
782 "Search backwards through input history for match for REGEXP.
783 \(Previous history elements are earlier commands.)
784 With prefix argument N, search for Nth previous match.
785 If N is negative, find the next or Nth next match."
789 ;; Has a match been found?
795 ;; Can't use kill-region as it sets this-command
800 "Search forwards through input history for match for REGEXP.
801 \(Later history elements are more recent commands.)
802 With prefix argument N, search for Nth following match.
803 If N is negative, find the previous or Nth previous match."
808 "Search backwards through input history for match for current input.
809 \(Previous history elements are earlier commands.)
810 With prefix argument N, search for Nth previous match.
811 If N is negative, search forwards for the -Nth following match."
814 comint-next-matching-input-from-input)))
815 ;; Starting a new search
820 comint-input-ring-index nil))
823 arg))
826 "Search forwards through input history for match for current input.
827 \(Following history elements are more recent commands.)
828 With prefix argument N, search for Nth following match.
829 If N is negative, search backwards for the -Nth previous match."
835 "Expand input command history references before point.
836 Expansion is dependent on the value of `comint-input-autoexpand'.
838 This function depends on the buffer's idea of the input history, which may not
839 match the command interpreter's idea, assuming it has one.
841 Assumes history syntax is like typical Un*x shells'. However, since emacs
842 cannot know the interpreter's idea of input line numbers, assuming it has one,
843 it cannot expand absolute input line number references.
845 If the optional argument SILENT is non-nil, never complain
846 even if history reference seems erroneous.
848 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
850 Returns t if successful."
854 ;; Looks like there might be history references in the command.
862 "Expand directory stack reference before point.
863 See `comint-replace-by-expanded-history'. Returns t if successful."
874 ;; This seems a bit complex. We look for references such as !!, !-num,
875 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
876 ;; If that wasn't enough, the plings can be suffixed with argument
877 ;; range specifiers.
878 ;; Argument ranges are complex too, so we hive off the input line,
879 ;; referenced with plings, with the range string to `comint-args'.
883 ;; The history is quoted, or we're in quotes.
886 ;; We cannot know the interpreter's idea of input line numbers.
890 ;; Just a number of args from `number' lines backward.
899 t t)
905 ;; Just a number of args from the previous input line.
909 t t)
913 ;; Most recent input starting with or containing (possibly
914 ;; protected) string, maybe just a number of args. Phew.
931 t t)
934 ;; Quick substitution on the previous input line.
951 "Expand input history references before point and insert ARG spaces.
952 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
956 \f
958 "Return t if the number of quotes between BEG and END is odd.
959 Quotes are single and double."
965 "Return number of matches for REGEXP from BEG to END."
972 count))
975 ;; From STRING, return the args depending on the range specified in the text
976 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
977 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
993 ;; Return a list of arguments from ARG. Break it up at the
994 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1009 comint-delimiter-argument-list)))
1012 args)))
1015 "Return from STRING the NTH to MTH arguments.
1016 NTH and/or MTH can be nil, which means the last argument.
1017 Returned arguments are separated by single spaces.
1018 We assume whitespace separates arguments, except within quotes.
1019 Also, a run of one or more of a single character
1020 in `comint-delimiter-argument-list' is a separate argument.
1021 Argument 0 is the command name."
1024 ;; We build a list of all the args. Unnecessary, but more efficient, when
1025 ;; ranges of args are required, than picking out one by one and recursing.
1029 ;; (match-end 2) is non-nil if we found quotes.
1036 \f
1037 ;;;
1038 ;;; Input processing stuff
1039 ;;;
1042 "Send input to process.
1043 After the process output mark, sends all text from the process mark to
1044 point as input to the process. Before the process output mark, calls value
1045 of variable `comint-get-old-input' to retrieve old input, copies it to the
1046 process mark, and sends it. If variable `comint-process-echoes' is nil,
1047 a terminal newline is also inserted into the buffer and sent to the process
1048 \(if it is non-nil, all text from the process mark to point is deleted,
1049 since it is assumed the remote process will re-echo it).
1051 Any history reference may be expanded depending on the value of the variable
1052 `comint-input-autoexpand'. The list of function names contained in the value
1053 of `comint-input-filter-functions' is called on the input before sending it.
1054 The input is entered into the input history ring, if the value of variable
1055 `comint-input-filter' returns non-nil when called on the input.
1057 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1058 end of line before sending the input.
1060 The values of `comint-get-old-input', `comint-input-filter-functions', and
1061 `comint-input-filter' are chosen according to the command interpreter running
1062 in the buffer. E.g.,
1064 If the interpreter is the csh,
1065 comint-get-old-input is the default: take the current line, discard any
1066 initial string matching regexp comint-prompt-regexp.
1069 comint-input-filter is the default: returns t if the input isn't all white
1070 space.
1072 If the comint is Lucid Common Lisp,
1073 comint-get-old-input snarfs the sexp ending at point.
1074 comint-input-filter-functions does nothing.
1075 comint-input-filter returns nil if the input matches input-filter-regexp,
1076 which matches (1) all whitespace (2) :a, :c, etc.
1078 Similarly for Soar, Scheme, etc."
1080 ;; Note that the input string does not include its terminal newline.
1090 copy)))
1092 ;; Just whatever's already there
1093 intxt
1094 ;; Expand and leave it visible in buffer
1098 input
1099 ;; This is messy 'cos ultimately the original
1100 ;; functions used do insertion, rather than return
1101 ;; strings. We have to expand, then insert back.
1106 copy))))
1115 history))))
1126 ;; A kludge to prevent the delay between insert and process output
1127 ;; affecting the display. A case for a comint-send-input-hook?
1134 ;; The purpose of using this filter for comint processes
1135 ;; is to keep comint-last-input-end from moving forward
1136 ;; when output is inserted.
1138 ;; First check for killed buffer
1155 ;; Insert after old_begv, but before old_zv.
1161 ;; Don't insert initial prompt outside the top of the window.
1181 "Go to the end of buffer in all windows showing it.
1182 Movement occurs if point in the selected window is not after the process mark,
1183 and `this-command' is an insertion command. Insertion commands recognised
1184 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1185 Depends on the value of `comint-scroll-to-bottom-on-input'.
1187 This function should be a pre-command hook."
1190 hilit-yank)))
1206 nil t))))))
1209 "Go to the end of buffer in all windows showing it.
1210 Does not scroll if the current line is the last line in the buffer.
1211 Depends on the value of `comint-scroll-to-bottom-on-output' and
1212 `comint-scroll-show-maximum-output'.
1214 This function should be in the list `comint-output-filter-functions'."
1228 ;; Maybe user wants point to jump to the end.
1231 ;; If point was at the end, keep it at the end.
1235 ;; Optionally scroll so that the text
1236 ;; ends at the bottom of the window.
1243 nil t))
1247 "Put the end of the buffer at the bottom of the window."
1253 "Default for `comint-get-old-input'.
1254 Take the current line, and discard any initial text matching
1255 `comint-prompt-regexp'."
1264 "Insert after prompt old input at point as new input to be edited.
1265 Calls `comint-get-old-input' to get old input."
1275 "Skip past the text matching regexp `comint-prompt-regexp'.
1276 If this takes us past the end of the current line, don't skip at all."
1283 "Return t if point is after the process output marker."
1288 "Default function for sending to PROC input STRING.
1289 This just sends STRING plus a newline. To override this,
1290 set the hook `comint-input-sender'."
1295 "Goes to the beginning of line, then skips past the prompt, if any.
1298 The prompt skip is done by skipping text matching the regular expression
1299 `comint-prompt-regexp', a buffer local variable.
1301 If you don't like this command, bind C-a to `beginning-of-line'
1302 in your hook, `comint-mode-hook'."
1307 ;;; These three functions are for entering text you don't want echoed or
1308 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
1309 ;;; Just enter m-x send-invisible and type in your line, or add
1310 ;;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1313 "Read a single line of text from user without echoing, and return it.
1314 Prompt with argument PROMPT, a string. Optional argument STARS causes
1315 input to be echoed with '*' characters on the prompt line. Input ends with
1316 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1317 `inhibit-quit' is set because e.g. this function was called from a process
1318 filter and C-g is pressed, this function returns nil rather than a string).
1320 Note that the keystrokes comprising the text can still be recovered
1322 applications."
1334 ;; This function may get called from a process filter, where
1335 ;; inhibit-quit is set. In later versions of emacs read-char
1336 ;; may clear quit-flag itself and return C-g. That would make
1337 ;; it impossible to quit this loop in a simple way, so
1338 ;; re-enable it here (for backward-compatibility the check for
1339 ;; quit-flag below would still be necessary, so this seems
1340 ;; like the simplest way to do things).
1342 done t))
1352 ;; Emulate a true quit, except that we have to return a value.
1358 ans)))
1361 "Read a string without echoing.
1362 Then send it to the process running in the current buffer. A new-line
1363 is additionally sent. String is not saved on comint input history list.
1364 Security bug: your string can still be temporarily recovered with
1375 "Prompt in the minibuffer for password and send without echoing.
1376 This function uses `send-invisible' to read and send a password to the buffer's
1379 This function could be in the list `comint-output-filter-functions'."
1382 \f
1383 ;;; Low-level process communication
1386 "*Long inputs are sent to comint processes in chunks of this size.
1390 "Send PROCESS the contents of STRING as input.
1391 This is equivalent to `process-send-string', except that long input strings
1392 are broken up into chunks of size `comint-input-chunk-size'. Processes
1393 are given a chance to output between chunks. This can help prevent processes
1394 from hanging when you send them long inputs on some OS's."
1406 "Sends to PROC the region delimited by START and END.
1407 This is a replacement for `process-send-region' that tries to keep
1408 your process from hanging on long inputs. See `comint-send-string'."
1410 \f
1411 ;;; Random input hackage
1414 "Kill all output from interpreter since last input.
1415 Does not delete the prompt."
1427 "Display start of this batch of interpreter output at top of window.
1428 Sets mark to the value of point when this command is run."
1438 "Interrupt the current subjob."
1443 "Send kill signal to the current subjob."
1448 "Send quit signal to the current subjob."
1453 "Stop the current subjob.
1454 WARNING: if there is no current subjob, you can end up suspending
1455 the top-level process running in the buffer. If you accidentally do
1457 is not a problem with most shells, since they ignore this signal.)"
1462 "Send CONT signal to process buffer's process group.
1463 Useful if you accidentally suspend the top-level process."
1468 "Kill all text from last stuff output by interpreter to point."
1475 "Delete ARG characters forward, or (if at eob) send an EOF to subprocess."
1482 "Send an EOF to the current buffer's process."
1488 "Search backward through buffer for match for REGEXP.
1489 Matches are searched for on lines that match `comint-prompt-regexp'.
1490 With prefix argument N, search for Nth previous match.
1491 If N is negative, find the next or Nth next match."
1504 "Search forward through buffer for match for REGEXP.
1505 Matches are searched for on lines that match `comint-prompt-regexp'.
1506 With prefix argument N, search for Nth following match.
1507 If N is negative, find the previous or Nth previous match."
1513 "Move to end of Nth next prompt in the buffer.
1514 See `comint-prompt-regexp'."
1522 "Move to end of Nth previous prompt in the buffer.
1523 See `comint-prompt-regexp'."
1526 \f
1527 ;;; Support for source-file processing commands.
1528 ;;;============================================================================
1529 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1530 ;;; commands that process files of source text (e.g. loading or compiling
1531 ;;; files). So the corresponding process-in-a-buffer modes have commands
1532 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
1533 ;;; for defining these commands.
1534 ;;;
1535 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1536 ;;; and Soar, in that they don't know anything about file extensions.
1537 ;;; So the compile/load interface gets the wrong default occasionally.
1538 ;;; The load-file/compile-file default mechanism could be smarter -- it
1539 ;;; doesn't know about the relationship between filename extensions and
1540 ;;; whether the file is source or executable. If you compile foo.lisp
1541 ;;; with compile-file, then the next load-file should use foo.bin for
1542 ;;; the default, not foo.lisp. This is tricky to do right, particularly
1543 ;;; because the extension for executable files varies so much (.o, .bin,
1544 ;;; .lbin, .mo, .vo, .ao, ...).
1547 ;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
1548 ;;; commands.
1549 ;;;
1550 ;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1551 ;;; want to save the buffer before issuing any process requests to the command
1552 ;;; interpreter.
1553 ;;;
1554 ;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
1555 ;;; for the file to process.
1557 ;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
1558 ;;;============================================================================
1559 ;;; This function computes the defaults for the load-file and compile-file
1560 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
1561 ;;;
1562 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1563 ;;; source-file processing command. NIL if there hasn't been one yet.
1564 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
1565 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1566 ;;; Typically, (lisp-mode) or (scheme-mode).
1567 ;;;
1568 ;;; If the command is given while the cursor is inside a string, *and*
1569 ;;; the string is an existing filename, *and* the filename is not a directory,
1570 ;;; then the string is taken as default. This allows you to just position
1571 ;;; your cursor over a string that's a filename and have it taken as default.
1572 ;;;
1573 ;;; If the command is given in a file buffer whose major mode is in
1574 ;;; SOURCE-MODES, then the the filename is the default file, and the
1575 ;;; file's directory is the default directory.
1576 ;;;
1577 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1578 ;;; then the default directory & file are what was used in the last source-file
1579 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1580 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1581 ;;; is the cwd, with no default file. (\"no default file\" = nil)
1582 ;;;
1583 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1584 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1585 ;;; for Soar programs, etc.
1586 ;;;
1587 ;;; The function returns a pair: (default-directory . default-file).
1598 ;;; (COMINT-CHECK-SOURCE fname)
1599 ;;;============================================================================
1600 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1601 ;;; process-in-a-buffer modes), this function can be called on the filename.
1602 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
1603 ;;; is queried to see if he wants to save the buffer before proceeding with
1604 ;;; the load or compile.
1611 ;; save BUFF.
1618 ;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1619 ;;;============================================================================
1620 ;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
1621 ;;; commands that process source files (like loading or compiling a file).
1622 ;;; It prompts for the filename, provides a default, if there is one,
1623 ;;; and returns the result filename.
1624 ;;;
1625 ;;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
1626 ;;;
1627 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1628 ;;; from the last source processing command. SOURCE-MODES is a list of major
1629 ;;; modes used to determine what file buffers contain source files. (These
1630 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1631 ;;; then the filename reader will only accept a file that exists.
1632 ;;;
1633 ;;; A typical use:
1634 ;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
1635 ;;; '(lisp-mode) t))
1637 ;;; This is pretty stupid about strings. It decides we're in a string
1638 ;;; if there's a quote on both sides of point on the current line.
1640 "Return string around POINT that starts the current line, or nil."
1667 prompt deffile)
1668 prompt)
1669 defdir
1671 mustmatch-p)))
1674 ;;; I am somewhat divided on this string-default feature. It seems
1675 ;;; to violate the principle-of-least-astonishment, in that it makes
1676 ;;; the default harder to predict, so you actually have to look and see
1677 ;;; what the default really is before choosing it. This can trip you up.
1678 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1679 ;;; on this.
1680 ;;; -Olin
1682 \f
1683 ;;; Simple process query facility.
1684 ;;; ===========================================================================
1685 ;;; This function is for commands that want to send a query to the process
1686 ;;; and show the response to the user. For example, a command to get the
1687 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1688 ;;; to an inferior Common Lisp process.
1689 ;;;
1690 ;;; This simple facility just sends strings to the inferior process and pops
1691 ;;; up a window for the process buffer so you can see what the process
1692 ;;; responds with. We don't do anything fancy like try to intercept what the
1693 ;;; process responds with and put it in a pop-up window or on the message
1694 ;;; line. We just display the buffer. Low tech. Simple. Works good.
1696 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1697 ;;; a window for the inferior process so that its response can be seen.
1707 ;; Try to position the proc window so you can see the answer.
1708 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1709 ;; I don't know why. Wizards invited to improve it.
1718 \f
1719 ;;; Filename/command/history completion in a buffer
1720 ;;; ===========================================================================
1721 ;;; Useful completion functions, courtesy of the Ergo group.
1723 ;;; Six commands:
1724 ;;; comint-dynamic-complete Complete or expand command, filename,
1725 ;;; history at point.
1726 ;;; comint-dynamic-complete-filename Complete filename at point.
1727 ;;; comint-dynamic-list-filename-completions List completions in help buffer.
1728 ;;; comint-replace-by-expanded-filename Expand and complete filename at point;
1729 ;;; replace with expanded/completed name.
1730 ;;; comint-dynamic-simple-complete Complete stub given candidates.
1732 ;;; These are not installed in the comint-mode keymap. But they are
1733 ;;; available for people who want them. Shell-mode installs them:
1734 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
1735 ;;; (define-key shell-mode-map "\M-?"
1736 ;;; 'comint-dynamic-list-filename-completions)))
1737 ;;;
1738 ;;; Commands like this are fine things to put in load hooks if you
1739 ;;; want them present in specific modes.
1742 "*If non-nil, automatically list possiblities on partial completion.
1746 "*If non-nil, add a `/' to completed directories, ` ' to file names.
1750 "*If non-nil, use shortest completion if characters cannot be added.
1751 This mirrors the optional behavior of tcsh.
1756 "*List of suffixes to be disregarded during file completion.
1757 This mirrors the optional behavior of bash and tcsh.
1762 "Prefix prepended to absolute file names taken from process input.
1763 This is used by comint's and shell's completion functions, and by shell's
1768 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
1771 directory)))
1775 "Return the word of WORD-CHARS at point, or nil if non is found.
1776 Word constituents are considered to be those in WORD-CHARS, which is like the
1784 ;; Anchor the search forwards.
1786 nil
1792 "Return the filename at point, or nil if non is found.
1793 Environment variables are substituted. See `comint-word'."
1799 "Dynamically perform completion at point.
1800 Calls the functions in `comint-dynamic-complete-functions' to perform
1801 completion until a function returns non-nil, at which point completion is
1802 assumed to have occurred."
1810 "Dynamically complete the filename at point.
1811 Completes if after a filename. See `comint-match-partial-filename' and
1812 `comint-dynamic-complete-as-filename'.
1813 This function is similar to `comint-replace-by-expanded-filename', except that
1814 it won't change parts of the filename already entered in the buffer; it just
1815 adds completion characters to the end of the filename. A completions listing
1816 may be shown in a help buffer if completion is ambiguous.
1818 Completion is dependent on the value of `comint-completion-addsuffix',
1819 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
1820 completions listing is dependent on the value of `comint-completion-autolist'.
1822 Returns t if successful."
1830 "Dynamically complete at point as a filename.
1831 See `comint-dynamic-complete-filename'. Returns t if successful."
1854 ;; We inserted a unique completion.
1861 ;; It's not unique, but user wants shortest match.
1866 ;; It's not unique, list possible completions.
1870 success))
1874 "Dynamically expand and complete the filename at point.
1875 Replace the filename with an expanded, canonicalised and completed replacement.
1878 removed, and the filename is made absolute instead of relative. For expansion
1879 see `expand-file-name' and `substitute-in-file-name'. For completion see
1880 `comint-dynamic-complete-filename'."
1887 "Dynamically complete STUB from CANDIDATES list.
1888 This function inserts completion characters at point by completing STUB from
1889 the strings in CANDIDATES. A completions listing may be shown in a help buffer
1890 if completion is ambiguous.
1892 Returns nil if no completion was inserted.
1893 Returns `sole' if completed with the only completion match.
1894 Returns `shortest' if completed with the shortest of the completion matches.
1895 Returns `partial' if completed as far as possible with the completion matches.
1896 Returns `listed' if a completion listing was shown.
1898 See also `comint-dynamic-complete-filename'."
1904 nil)
1915 ;; Insert the longest substring.
1920 ;; It's not unique, but user wants shortest match.
1926 ;; It's not unique, list possible completions.
1935 "List in help buffer possible completions of the filename at point."
1949 "List in help buffer sorted COMPLETIONS.
1950 Typing SPC flushes the help buffer."
1964 ;; If the user does mouse-choose-completion with the mouse,
1965 ;; execute the command, then delete the completion window.
1972 \f
1973 ;;; Converting process modes to use comint mode
1974 ;;; ===========================================================================
1975 ;;; The code in the Emacs 19 distribution has all been modified to use comint
1976 ;;; where needed. However, there are `third-party' packages out there that
1977 ;;; still use the old shell mode. Here's a guide to conversion.
1978 ;;;
1979 ;;; Renaming variables
1980 ;;; Most of the work is renaming variables and functions. These are the common
1981 ;;; ones:
1982 ;;; Local variables:
1983 ;;; last-input-start comint-last-input-start
1984 ;;; last-input-end comint-last-input-end
1985 ;;; shell-prompt-pattern comint-prompt-regexp
1986 ;;; shell-set-directory-error-hook <no equivalent>
1987 ;;; Miscellaneous:
1988 ;;; shell-set-directory <unnecessary>
1989 ;;; shell-mode-map comint-mode-map
1990 ;;; Commands:
1991 ;;; shell-send-input comint-send-input
1992 ;;; shell-send-eof comint-delchar-or-maybe-eof
1993 ;;; kill-shell-input comint-kill-input
1994 ;;; interrupt-shell-subjob comint-interrupt-subjob
1995 ;;; stop-shell-subjob comint-stop-subjob
1996 ;;; quit-shell-subjob comint-quit-subjob
1997 ;;; kill-shell-subjob comint-kill-subjob
1998 ;;; kill-output-from-shell comint-kill-output
1999 ;;; show-output-from-shell comint-show-output
2000 ;;; copy-last-shell-input Use comint-previous-input/comint-next-input
2001 ;;;
2002 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
2003 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
2004 ;;; Comint mode does not provide functionality equivalent to
2005 ;;; shell-set-directory-error-hook; it is gone.
2006 ;;;
2007 ;;; comint-last-input-start is provided for modes which want to munge
2008 ;;; the buffer after input is sent, perhaps because the inferior
2009 ;;; insists on echoing the input. The LAST-INPUT-START variable in
2010 ;;; the old shell package was used to implement a history mechanism,
2011 ;;; but you should think twice before using comint-last-input-start
2012 ;;; for this; the input history ring often does the job better.
2013 ;;;
2014 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
2015 ;;; *not* create the comint-mode local variables in your foo-mode function.
2016 ;;; This is not modular. Instead, call comint-mode, and let *it* create the
2017 ;;; necessary comint-specific local variables. Then create the
2018 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
2019 ;;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
2020 ;;; (comint-{prompt-regexp, input-filter, input-filter-functions,
2021 ;;; get-old-input) that need to be different from the defaults. Call
2022 ;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
2023 ;;; comint-mode will take care of it. The following example, from shell.el,
2024 ;;; is typical:
2025 ;;;
2026 ;;; (defvar shell-mode-map '())
2027 ;;; (cond ((not shell-mode-map)
2028 ;;; (setq shell-mode-map (full-copy-sparse-keymap comint-mode-map))
2029 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
2030 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
2031 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2032 ;;; (define-key shell-mode-map "\M-?"
2033 ;;; 'comint-dynamic-list-filename-completions)))
2034 ;;;
2035 ;;; (defun shell-mode ()
2036 ;;; (interactive)
2037 ;;; (comint-mode)
2038 ;;; (setq comint-prompt-regexp shell-prompt-pattern)
2039 ;;; (setq major-mode 'shell-mode)
2040 ;;; (setq mode-name "Shell")
2041 ;;; (use-local-map shell-mode-map)
2042 ;;; (make-local-variable 'shell-directory-stack)
2043 ;;; (setq shell-directory-stack nil)
2044 ;;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
2045 ;;; (run-hooks 'shell-mode-hook))
2046 ;;;
2047 ;;;
2048 ;;; Note that make-comint is different from make-shell in that it
2049 ;;; doesn't have a default program argument. If you give make-shell
2050 ;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
2051 ;;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument
2052 ;;; of NIL, it barfs. Adjust your code accordingly...
2053 ;;;
2054 ;;; Completion for comint-mode users
2055 ;;;
2056 ;;; For modes that use comint-mode, comint-dynamic-complete-functions is the
2057 ;;; hook to add completion functions to. Functions on this list should return
2058 ;;; non-nil if completion occurs (i.e., further completion should not occur).
2059 ;;; You could use comint-dynamic-simple-complete to do the bulk of the
2060 ;;; completion job.
2061 \f
2064 ;;; comint.el ends here