| blob | 8b5a107c7d730c70e5e08728dda81bffcff447bb |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988,90,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
40 ;;
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
58 \f
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
62 ;; mode)
63 ;;
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-previous-matching-input Previous input matching a regexp
67 ;; M-s comint-next-matching-input Next input that matches
68 ;; M-C-l comint-show-output Show last batch of process output
69 ;; RET comint-send-input
70 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
71 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
72 ;; second time, move to process-mark.
73 ;; C-c C-u comint-kill-input ^u
74 ;; C-c C-w backward-kill-word ^w
75 ;; C-c C-c comint-interrupt-subjob ^c
76 ;; C-c C-z comint-stop-subjob ^z
77 ;; C-c C-\ comint-quit-subjob ^\
78 ;; C-c C-o comint-delete-output Delete last batch of process output
79 ;; C-c C-r comint-show-output Show last batch of process output
80 ;; C-c C-l comint-dynamic-list-input-ring List input history
81 ;;
82 ;; Not bound by default in comint-mode (some are in shell mode)
83 ;; comint-run Run a program under comint-mode
84 ;; send-invisible Read a line w/o echo, and send to proc
85 ;; comint-dynamic-complete-filename Complete filename at point.
86 ;; comint-dynamic-list-filename-completions List completions in help buffer.
87 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
88 ;; replace with expanded/completed name.
89 ;; comint-replace-by-expanded-history Expand history at point;
90 ;; replace with expanded name.
91 ;; comint-magic-space Expand history and add (a) space(s).
92 ;; comint-kill-subjob No mercy.
93 ;; comint-show-maximum-output Show as much output as possible.
94 ;; comint-continue-subjob Send CONT signal to buffer's process
95 ;; group. Useful if you accidentally
96 ;; suspend your process (with C-c C-z).
97 ;; comint-get-next-from-history Fetch successive input history lines
98 ;; comint-accumulate Combine lines to send them together
99 ;; as input.
100 ;; comint-goto-process-mark Move point to where process-mark is.
101 ;; comint-set-process-mark Set process-mark to point.
103 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
105 ;;; Code:
108 \f
109 ;; Buffer Local Variables:
110 ;;============================================================================
111 ;; Comint mode buffer local variables:
112 ;; comint-prompt-regexp string comint-bol uses to match prompt
113 ;; comint-delimiter-argument-list list For delimiters and arguments
114 ;; comint-last-input-start marker Handy if inferior always echoes
115 ;; comint-last-input-end marker For comint-delete-output command
116 ;; comint-input-ring-size integer For the input history
117 ;; comint-input-ring ring mechanism
118 ;; comint-input-ring-index number ...
119 ;; comint-save-input-ring-index number ...
120 ;; comint-input-autoexpand symbol ...
121 ;; comint-input-ignoredups boolean ...
122 ;; comint-dynamic-complete-functions hook For the completion mechanism
123 ;; comint-completion-fignore list ...
124 ;; comint-file-name-chars string ...
125 ;; comint-file-name-quote-list list ...
126 ;; comint-get-old-input function Hooks for specific
127 ;; comint-input-filter-functions hook process-in-a-buffer
128 ;; comint-output-filter-functions hook function modes.
129 ;; comint-preoutput-filter-functions hook
130 ;; comint-input-filter function ...
131 ;; comint-input-sender function ...
132 ;; comint-eol-on-send boolean ...
133 ;; comint-process-echoes boolean ...
134 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
135 ;; comint-scroll-to-bottom-on-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
138 ;;
139 ;; Comint mode non-buffer local variables:
140 ;; comint-completion-addsuffix boolean/cons For file name
141 ;; comint-completion-autolist boolean completion behavior
142 ;; comint-completion-recexact boolean ...
145 "General command interpreter in a window stuff."
149 "Completion facilities in comint"
153 "Source finding facilities in comint"
158 "Regexp to recognise prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
164 Good choices:
175 "If non-nil, the comint prompt is read only.
176 The read only region includes the newline before the prompt.
177 This does not affect existing prompts.
178 Certain derived modes may override this option.
180 If you set this option to t, then the safe way to temporarily
181 override the read-only-ness of comint prompts is to call
182 `comint-kill-whole-line' or `comint-kill-region' with no
183 narrowing in effect. This way you will be certain that none of
184 the remaining prompts will be accidentally messed up. You may
185 wish to put something like the following in your `.emacs' file:
187 \(add-hook 'comint-mode-hook
188 '(lambda ()
190 (define-key comint-mode-map [C-S-backspace]
191 'comint-kill-whole-line)))
193 If you sometimes use comint-mode on text-only terminals or with `emacs-nw',
194 you might wish to use another binding for `comint-kill-whole-line'."
200 "List of characters to recognise as separate arguments in input.
201 Strings comprising a character in this list will separate the arguments
202 surrounding them, and also be regarded as arguments in their own right (unlike
203 whitespace). See `comint-arguments'.
204 Defaults to the empty list.
211 "*If non-nil, expand input command history references on completion.
212 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
214 If the value is `input', then the expansion is seen on input.
215 If the value is `history', then the expansion is only when inserting
216 into the buffer's input ring. See also `comint-magic-space' and
217 `comint-dynamic-complete'.
219 This variable is buffer-local."
227 "Face to use to highlight user input."
233 "Face to use to highlight prompts."
237 "*If non-nil, don't add input matching the last on the input ring.
238 This mirrors the optional behavior of bash.
240 This variable is buffer-local."
245 "*If non-nil, name of the file to read/write input history.
246 See also `comint-read-input-ring' and `comint-write-input-ring'.
248 This variable is buffer-local, and is a good thing to set in mode hooks."
250 file)
254 "*Controls whether input to interpreter causes window to scroll.
255 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
256 If `this', scroll only the selected window.
258 The default is nil.
260 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
268 "*Controls whether interpreter output moves point to the end of the output.
269 If nil, then output never moves point to the output.
270 (If the output occurs at point, it is inserted before point.)
271 If t or `all', move point in all windows showing the buffer.
272 If `this', move point only the selected window.
273 If `others', move point only in other windows, not in the selected window.
275 The default is nil.
277 See the variable `comint-scroll-show-maximum-output' and the function
278 `comint-postoutput-scroll-to-bottom'.
279 This variable is buffer-local in all Comint buffers."
290 "*Controls how to scroll due to interpreter output.
291 This variable applies when point is at the end of the buffer
292 \(either because it was originally there, or because
293 `comint-move-point-for-output' said to move it there)
294 and output from the subprocess is inserted.
296 Non-nil means scroll so that the window is full of text
297 and point is on the last line. A value of nil
298 means don't do anything special--scroll normally.
300 See also the variable `comint-move-point-for-output' and the function
301 `comint-postoutput-scroll-to-bottom'.
302 This variable is buffer-local in all Comint buffers."
307 "*The maximum size in lines for Comint buffers.
308 Comint buffers are truncated from the top to be no greater than this number, if
309 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
323 "*If non-nil, assume that the subprocess echoes any input.
324 If so, delete one copy of the input so that only one copy eventually
325 appears in the buffer.
327 This variable is buffer-local."
331 ;; AIX puts the name of the person being su'd to in front of the prompt.
332 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
333 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
334 ;; ssh-add prints a prompt like `Enter passphrase: '.
335 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
342 "*Regexp matching prompts for passwords in the inferior process.
343 This is used by `comint-watch-for-password-prompt'."
347 ;; Here are the per-interpreter hooks.
349 "Function that returns old text in Comint mode.
350 This function is called when return is typed while the point is in old
351 text. It returns the text to be submitted as process input. The
352 default is `comint-get-old-input-default', which either grabs the
353 current input field or grabs the current line and strips off leading
354 text matching `comint-prompt-regexp', depending on the value of
359 "List of functions called to perform completion.
360 Functions should return non-nil if completion was performed.
361 See also `comint-dynamic-complete'.
367 "Predicate for filtering additions to input history.
368 Takes one argument, the input. If non-nil, the input may be saved on the input
372 "Functions to call before input is sent to the process.
373 These functions get one argument, a string containing the text to send.
375 You can use `add-hook' to add functions to this list
379 "Functions to call after output is inserted into the buffer.
380 One possible function is `comint-postoutput-scroll-to-bottom'.
381 These functions get one argument, a string containing the text as originally
382 inserted. Note that this might not be the same as the buffer contents between
383 `comint-last-output-start' and the buffer's `process-mark', if other filter
384 functions have already modified the buffer.
386 See also `comint-preoutput-filter-functions'.
388 You can use `add-hook' to add functions to this list
395 "Function to actually send to PROCESS the STRING submitted by user.
396 Usually this is just `comint-simple-send', but if your mode needs to
397 massage the input string, put a different function here.
398 `comint-simple-send' just sends the string plus a newline.
399 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
403 "*Non-nil means go to the end of the line before sending input.
404 See `comint-send-input'."
408 ;; Note: If it is decided to purge comint-prompt-regexp from the source
409 ;; entirely, searching for uses of this variable will help to identify
410 ;; places that need attention.
412 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
413 If nil, then program output and user-input are given different `field'
414 properties, which emacs commands can use to distinguish them (in
415 particular, common movement commands such as begining-of-line respect
416 field boundaries in a natural way)."
421 "Hook run upon entry to `comint-mode'.
422 This is run before the process is cranked up."
427 "Hook run each time a process is exec'd by `comint-exec'.
428 This is called after the process is cranked up. It is useful for things that
429 must be done each time a process is executed in a Comint mode buffer (e.g.,
430 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
431 executed once when the buffer is created."
437 ;; Fixme: Is this still relevant?
439 "Non-nil if communications via pty; false if by pipe. Buffer local.
451 "Last input ring index which you copied.
455 "Non-nil if you are accumulating input lines to send as input together.
474 "Major mode for interacting with an inferior interpreter.
475 Interpreter name is same as buffer name, sans the asterisks.
476 Return at end of buffer sends line as input.
477 Return not at end copies rest of line to end and sends it.
478 Setting variable `comint-eol-on-send' means jump to the end of the line
479 before submitting new input.
481 This mode is customised to create major modes such as Inferior Lisp
482 mode, Shell mode, etc. This can be done by setting the hooks
483 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
484 and `comint-get-old-input' to appropriate functions, and the variable
485 `comint-prompt-regexp' to the appropriate regular expression.
487 An input history is maintained of size `comint-input-ring-size', and
488 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
489 Input ring history expansion can be achieved with the commands
491 Input ring expansion is controlled by the variable `comint-input-autoexpand',
492 and addition is controlled by the variable `comint-input-ignoredups'.
494 Commands with no default key bindings include `send-invisible',
495 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
496 `comint-magic-space'.
498 Input to, and output from, the subprocess can cause the window to scroll to
499 the end of the buffer. See variables `comint-output-filter-functions',
500 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
501 and `comint-move-point-for-output'.
504 to continue it.
508 Entry to this mode runs the hooks on `comint-mode-hook'."
538 ;; This makes it really work to keep point at the bottom.
548 ;; This behavior is not useful in comint buffers, and is annoying
552 nil
553 ;; Keys:
584 ;; Mouse Buttons:
586 ;; Menu bars:
587 ;; completion:
598 ;; Input history:
639 ;; Signals
654 ;; Put them in the menu bar:
656 menu-bar-final-items))
657 )
660 "Return t if there is a living process associated w/buffer BUFFER.
661 Living means the status is `open', `run', or `stop'.
662 BUFFER can be either a buffer or the name of one."
666 ;;;###autoload
668 "Make a Comint process NAME in BUFFER, running PROGRAM.
669 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
670 PROGRAM should be either a string denoting an executable program to create
671 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
672 connection to be opened via `open-network-stream'. If there is already a
673 running process in that buffer, it is not restarted. Optional third arg
674 STARTFILE is the name of a file to send the contents of to the process.
676 If PROGRAM is a string, any more args are arguments to PROGRAM."
680 ;; If no process, or nuked process, crank up a new one and put buffer in
681 ;; comint mode. Otherwise, leave buffer and existing process alone.
687 buffer)
689 ;;;###autoload
691 "Make a Comint process NAME in a buffer, running PROGRAM.
692 The name of the buffer is made by surrounding NAME with `*'s.
693 PROGRAM should be either a string denoting an executable program to create
694 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
695 connection to be opened via `open-network-stream'. If there is already a
696 running process in that buffer, it is not restarted. Optional third arg
697 STARTFILE is the name of a file to send the contents of the process to.
699 If PROGRAM is a string, any more args are arguments to PROGRAM."
702 ;;;###autoload
704 "Run PROGRAM in a Comint buffer and switch to it.
705 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
706 The file name is used to make a symbol name, such as `comint-sh-hook', and any
707 hooks on this symbol are run in the buffer.
708 See `make-comint' and `comint-exec'."
715 "Start up a process named NAME in buffer BUFFER for Comint modes.
716 Runs the given COMMAND with SWITCHES with output to STARTFILE.
717 Blasts any old process running in the buffer. Doesn't set the buffer mode.
718 You can use this to cheaply run a series of processes in the same Comint
719 buffer. The hook `comint-exec-hook' is run after each exec."
723 ;; Crank up a new process
731 ;; Jump to the end, and set the process mark.
734 ;; Feed it the startfile.
736 ;;This is guaranteed to wait long enough
737 ;;but has bad results if the comint does not prompt at all
738 ;; (while (= size (buffer-size))
739 ;; (sleep-for 1))
740 ;;I hope 1 second is enough!
748 buffer)))
750 ;; This auxiliary function cranks up the process for comint-exec in
751 ;; the appropriate environment.
756 ;; If using termcap, we specify `emacs' as the terminal type
757 ;; because that lets us specify a width.
758 ;; If using terminfo, we specify `dumb' because that is
759 ;; a defined terminal type. `emacs' is not a defined terminal type
760 ;; and there is no way for us to define it here.
761 ;; Some programs that use terminfo get very confused
762 ;; if TERM is not a valid terminal type.
763 ;; ;; There is similar code in compile.el.
770 process-environment))
773 default-directory
775 proc decoding encoding changed)
777 ;; If the command has slashes, make sure we
778 ;; first look relative to the current directory.
784 ;; If start-process decided to use some coding system for decoding
785 ;; data sent from the process and the coding system doesn't
786 ;; specify EOL conversion, we had better convert CRLF to LF.
789 changed t))
790 ;; Even if start-process left the coding system for encoding data
791 ;; sent from the process undecided, we had better use the same one
792 ;; as what we use for decoding. But, we should suppress EOL
793 ;; conversion.
796 changed t))
799 proc))
802 "In a Comint buffer, set the current input to the previous input at point."
806 ;; No input at POS, fall back to the global definition.
811 ;; There's previous input at POS, insert it at the end of the buffer.
813 ;; First delete any old unsent input at the end
818 ;; Insert the input at point
824 "In a Comint buffer, set the current input to the previous input you click on."
829 \f
830 ;; Input history processing in a buffer
831 ;; ===========================================================================
832 ;; Useful input history functions, courtesy of the Ergo group.
834 ;; Eleven commands:
835 ;; comint-dynamic-list-input-ring List history in help buffer.
836 ;; comint-previous-input Previous input...
837 ;; comint-previous-matching-input ...matching a string.
838 ;; comint-previous-matching-input-from-input ... matching the current input.
839 ;; comint-next-input Next input...
840 ;; comint-next-matching-input ...matching a string.
841 ;; comint-next-matching-input-from-input ... matching the current input.
842 ;; comint-backward-matching-input Backwards input...
843 ;; comint-forward-matching-input ...matching a string.
844 ;; comint-replace-by-expanded-history Expand history at point;
845 ;; replace with expanded history.
846 ;; comint-magic-space Expand history and insert space.
847 ;;
848 ;; Three functions:
849 ;; comint-read-input-ring Read into comint-input-ring...
850 ;; comint-write-input-ring Write to comint-input-ring-file-name.
851 ;; comint-replace-by-expanded-history-before-point Workhorse function.
854 "Set the buffer's `comint-input-ring' from a history file.
855 The name of the file is given by the variable `comint-input-ring-file-name'.
856 The history ring is of size `comint-input-ring-size', regardless of file size.
857 If `comint-input-ring-file-name' is nil this function does nothing.
859 If the optional argument SILENT is non-nil, we say nothing about a
860 failure to read the history file.
862 This function is useful for major mode commands and mode hooks.
864 The commands stored in the history file are separated by the
865 `comint-input-ring-separator', and entries that match
866 `comint-input-history-ignore' are ignored. The most recent command
867 comes last.
869 See also `comint-input-ignoredups' and `comint-write-input-ring'."
872 nil)
876 comint-input-ring-file-name)))
889 ;; Save restriction in case file is already visited...
890 ;; Watch for those date stamps in history files!
910 comint-input-ring-index nil)))))
913 "Writes the buffer's `comint-input-ring' to a history file.
914 The name of the file is given by the variable `comint-input-ring-file-name'.
915 The original contents of the file are lost if `comint-input-ring' is not empty.
916 If `comint-input-ring-file-name' is nil this function does nothing.
918 Useful within process sentinels.
920 See also `comint-read-input-ring'."
924 nil)
932 ;; Write it all out into a buffer first. Much faster, but messier,
933 ;; than writing it one line at a time.
947 "Choose the input history entry that point is in or next to."
964 "List in help buffer the buffer's input history."
973 ;; We have to build up a list ourselves from the ring vector.
977 ;; Change "completion" to "history reference"
978 ;; to make the display accurate.
999 "Return list of regexp and prefix arg using PROMPT."
1007 regexp)
1011 ;; First make sure there is a ring and that we are after the process mark
1018 ;; arg of zero resets search from beginning, and uses arg of 1
1022 arg)))
1025 "Index to start a directional search, starting at `comint-input-ring-index'."
1027 ;; If a search is running, offset by 1 in direction of arg
1030 ;; For a new search, start from beginning or end, as appropriate
1036 "Return the string ARG places along the input ring.
1037 Moves relative to `comint-input-ring-index'."
1041 arg)))
1044 "Cycle backwards through input history."
1049 "Cycle forwards through input history."
1054 "Return the string matching REGEXP ARG places along the input ring.
1055 Moves relative to `comint-input-ring-index'."
1060 "Return the index matching REGEXP ARG places along the input ring.
1061 Moves relative to START, or `comint-input-ring-index'."
1070 ;; Do the whole search as many times as the argument says.
1072 ;; Step once.
1075 ;; If we haven't reached a match, step some more.
1079 ;; If we have gone all the way around in this search.
1082 ;; Now that we know which ring element to use, if we found it, return that.
1084 n)))
1087 "Search backwards through input history for match for REGEXP.
1088 \(Previous history elements are earlier commands.)
1089 With prefix argument N, search for Nth previous match.
1090 If N is negative, find the next or Nth next match."
1094 ;; Has a match been found?
1100 ;; Can't use kill-region as it sets this-command
1107 "Search forwards through input history for match for REGEXP.
1108 \(Later history elements are more recent commands.)
1109 With prefix argument N, search for Nth following match.
1110 If N is negative, find the previous or Nth previous match."
1115 "Search backwards through input history for match for current input.
1116 \(Previous history elements are earlier commands.)
1117 With prefix argument N, search for Nth previous match.
1118 If N is negative, search forwards for the -Nth following match."
1121 comint-next-matching-input-from-input)))
1122 ;; Starting a new search
1128 comint-input-ring-index nil))
1131 arg))
1134 "Search forwards through input history for match for current input.
1135 \(Following history elements are more recent commands.)
1136 With prefix argument N, search for Nth following match.
1137 If N is negative, search backwards for the -Nth previous match."
1143 "Expand input command history references before point.
1144 Expansion is dependent on the value of `comint-input-autoexpand'.
1146 This function depends on the buffer's idea of the input history, which may not
1147 match the command interpreter's idea, assuming it has one.
1149 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1150 cannot know the interpreter's idea of input line numbers, assuming it has one,
1151 it cannot expand absolute input line number references.
1153 If the optional argument SILENT is non-nil, never complain
1154 even if history reference seems erroneous.
1156 If the optional argument START is non-nil, that specifies the
1157 start of the text to scan for history references, rather
1158 than the logical beginning of line.
1160 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1162 Returns t if successful."
1166 ;; Use comint-prompt-regexp
1170 ;; Use input fields. User input that hasn't been entered
1171 ;; yet, at the end of the buffer, has a nil `field' property.
1174 ;; Looks like there might be history references in the command.
1181 "Expand directory stack reference before point.
1182 See `comint-replace-by-expanded-history'. Returns t if successful.
1184 If the optional argument START is non-nil, that specifies the
1185 start of the text to scan for history references, rather
1186 than the logical beginning of line."
1194 ;; This seems a bit complex. We look for references such as !!, !-num,
1195 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1196 ;; If that wasn't enough, the plings can be suffixed with argument
1197 ;; range specifiers.
1198 ;; Argument ranges are complex too, so we hive off the input line,
1199 ;; referenced with plings, with the range string to `comint-args'.
1203 ;; The history is quoted, or we're in quotes.
1206 ;; We cannot know the interpreter's idea of input line numbers.
1210 ;; Just a number of args from `number' lines backward.
1219 t t)
1225 ;; Just a number of args from the previous input line.
1229 t t)
1233 ;; Most recent input starting with or containing (possibly
1234 ;; protected) string, maybe just a number of args. Phew.
1252 t t)
1255 ;; Quick substitution on the previous input line.
1272 "Expand input history references before point and insert ARG spaces.
1273 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1277 \f
1279 "Return t if the number of quotes between BEG and END is odd.
1280 Quotes are single and double."
1286 "Return number of matches for REGEXP from BEG to END."
1293 count))
1296 ;; From STRING, return the args depending on the range specified in the text
1297 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1298 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1315 "Return a list of arguments from ARG.
1316 Break it up at the delimiters in `comint-delimiter-argument-list'.
1317 Returned list is backwards."
1331 comint-delimiter-argument-list)))
1334 args)))
1337 "Return from STRING the NTH to MTH arguments.
1338 NTH and/or MTH can be nil, which means the last argument.
1339 Returned arguments are separated by single spaces.
1340 We assume whitespace separates arguments, except within quotes
1341 and except for a space or tab that immediately follows a backslash.
1342 Also, a run of one or more of a single character
1343 in `comint-delimiter-argument-list' is a separate argument.
1344 Argument 0 is the command name."
1345 ;; The first line handles ordinary characters and backslash-sequences
1346 ;; (except with w32 msdos-like shells, where backslashes are valid).
1347 ;; The second matches "-quoted strings.
1348 ;; The third matches '-quoted strings.
1349 ;; The fourth matches `-quoted strings.
1350 ;; This seems to fit the syntax of BASH 2.0.
1361 beg str quotes)
1362 ;; Build a list of all the args until we have as many as we want.
1366 ;; It's contiguous, part of the same arg.
1369 ;; It's a new separate arg.
1371 ;; Put the previous arg, if there was one, onto ARGS.
1388 \f
1389 ;;
1390 ;; Input processing stuff
1391 ;;
1393 "Add CMD to the input history.
1394 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1400 cmd))))
1404 "Send input to process.
1405 After the process output mark, sends all text from the process mark to
1406 point as input to the process. Before the process output mark, calls
1407 value of variable `comint-get-old-input' to retrieve old input, copies
1408 it to the process mark, and sends it. A terminal newline is also
1409 inserted into the buffer and sent to the process unless NO-NEWLINE is
1410 non-nil.
1412 Any history reference may be expanded depending on the value of the variable
1413 `comint-input-autoexpand'. The list of function names contained in the value
1414 of `comint-input-filter-functions' is called on the input before sending it.
1415 The input is entered into the input history ring, if the value of variable
1416 `comint-input-filter' returns non-nil when called on the input.
1418 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1419 end of line before sending the input.
1421 After the input has been sent, if `comint-process-echoes' is non-nil,
1422 then `comint-send-input' waits to see if the process outputs a string
1423 matching the input, and if so, deletes that part of the output.
1425 The values of `comint-get-old-input', `comint-input-filter-functions', and
1426 `comint-input-filter' are chosen according to the command interpreter running
1427 in the buffer. E.g.,
1429 If the interpreter is the csh,
1430 `comint-get-old-input' is the default:
1431 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1432 either return the current input field, if point is on an input
1433 field, or the current line, if point is on an output field.
1434 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1435 return the current line with any initial string matching the
1436 regexp `comint-prompt-regexp' removed.
1439 comint-input-filter is the default: returns t if the input isn't all white
1440 space.
1442 If the Comint is Lucid Common Lisp,
1443 comint-get-old-input snarfs the sexp ending at point.
1444 comint-input-filter-functions does nothing.
1445 comint-input-filter returns nil if the input matches input-filter-regexp,
1446 which matches (1) all whitespace (2) :a, :c, etc.
1448 Similarly for Soar, Scheme, etc."
1450 ;; Note that the input string does not include its terminal newline.
1460 copy)))
1462 ;; Just whatever's already there
1463 intxt
1464 ;; Expand and leave it visible in buffer
1468 input
1469 ;; This is messy 'cos ultimately the original
1470 ;; functions used do insertion, rather than return
1471 ;; strings. We have to expand, then insert back.
1477 copy))))
1492 ;; Set text-properties for the input field
1494 beg end
1496 font-lock-face comint-highlight-input
1497 mouse-face highlight
1500 ;; Give old user input a field property of `input', to
1501 ;; distinguish it from both process output and unsent
1502 ;; input. The terminating newline is put into a special
1503 ;; `boundary' field to make cursor movement between input
1504 ;; and output fields smoother.
1507 ;; Cover the terminating newline
1510 field boundary
1511 inhibit-line-move-field-capture t))))
1517 ;; Update the markers before we send the input
1518 ;; in case we get output amidst sending the input.
1522 ;; clear the "accumulation" marker
1527 ;; Optionally delete echoed input (after checking it).
1530 comint-last-input-start)))
1531 ;; Wait for all input to be echoed:
1537 nil comint-last-input-start
1539 ;; Above difference is equivalent to
1540 ;; (+ comint-last-input-start
1541 ;; (- (point-max) comint-last-input-end))
1548 nil comint-last-input-start comint-last-input-end
1549 nil comint-last-input-end
1554 ;; This used to call comint-output-filter-functions,
1555 ;; but that scrolled the buffer in undesirable ways.
1559 "List of functions to call before inserting Comint output into the buffer.
1560 Each function gets one argument, a string containing the text received
1561 from the subprocess. It should return the string to insert, perhaps
1562 the same string that was received, or perhaps a modified or transformed
1563 string.
1565 The functions on the list are called sequentially, and each one is
1566 given the string returned by the previous one. The string returned by
1567 the last function is the text that is actually inserted in the
1568 redirection buffer.
1570 You can use `add-hook' to add functions to this list
1574 "If nil, Comint will interpret `carriage control' characters in output.
1577 ;; When non-nil, this is an overlay over the last recognized prompt in
1578 ;; the buffer; it is used when highlighting the prompt.
1582 "`snapshot' any current `comint-last-prompt-overlay'.
1583 freeze its attributes in place, even when more input comes a long
1584 and moves the prompt overlay."
1593 "Interpret carriage control characters in the region from START to END.
1594 Translate carriage return/linefeed sequences to linefeeds.
1595 Make single carriage returns delete to the beginning of the line.
1596 Make backspaces delete the previous character."
1598 ;; First do a quick check to see if there are any applicable
1599 ;; characters, so we can avoid calling save-match-data and
1600 ;; save-restriction if not.
1608 ;; CR LF -> LF
1609 ;; Note that this won't work properly when the CR and LF
1610 ;; are in different output chunks, but this is probably an
1611 ;; exceedingly rare case (because they are generally
1612 ;; written as a unit), and to delay interpretation of a
1613 ;; trailing CR in a chunk would result in odd interactive
1614 ;; behavior (and this case is probably far more common).
1617 ;; bare CR -> delete preceding line
1621 ;; BS -> delete preceding character
1626 ;; The purpose of using this filter for comint processes
1627 ;; is to keep comint-last-input-end from moving forward
1628 ;; when output is inserted.
1631 ;; First check for killed buffer or no input.
1634 ;; Run preoutput filters
1645 ;; Insert STRING
1647 ;; Avoid the overhead of save-excursion, since we just
1648 ;; fiddle with the point
1651 ;; The point should float after any insertion we do
1654 ;; We temporarly remove any buffer narrowing, in case the
1655 ;; process mark is outside of the restriction
1662 ;; insert-before-markers is a bad thing. XXX
1663 ;;
1664 ;; It is used here to force window-point markers (used to
1665 ;; store the value of point in non-selected windows) to
1666 ;; advance, but it also screws up any other markers that we
1667 ;; don't _want_ to advance, such as the start-marker of some
1668 ;; of the overlays we create.
1669 ;;
1670 ;; We work around the problem with the overlays by
1671 ;; explicitly adjusting them after we do the insertion, but
1672 ;; in the future this problem should be solved correctly, by
1673 ;; using `insert', and making the insertion-type of
1674 ;; window-point markers settable (via a buffer-local
1675 ;; variable). In comint buffers, this variable would be set
1676 ;; to `t', to cause point in non-select windows to advance.
1678 ;; Fixup markers and overlays that got screwed up because we
1679 ;; used `insert-before-markers'.
1681 ;; comint-last-output-start
1683 ;; comint-last-input-end
1688 ;; No overlays we create are set to advance upon insertion
1689 ;; (at the start/end), so we assume that any overlay which
1690 ;; is at the current point was incorrectly advanced by
1691 ;; insert-before-markers. First fixup overlays that might
1692 ;; start at point:
1697 old-point
1699 ;; Then do overlays that might end at point:
1704 old-point))))
1706 ;; Advance process-mark
1710 ;; Interpret any carriage motion characters (newline, backspace)
1722 field output
1723 inhibit-line-move-field-capture t))))
1725 ;; Highlight the prompt, where we define `prompt' to mean
1726 ;; the most recent output that doesn't end with a newline.
1739 ;; Need to create or move the prompt overlay (in the case
1740 ;; where there is no prompt ((bolp) == t), we still do
1741 ;; this if there's already an existing overlay).
1743 ;; Just move an existing overlay
1746 ;; Need to create the overlay
1755 "Go to the end of buffer in all windows showing it.
1756 Movement occurs if point in the selected window is not after the process mark,
1757 and `this-command' is an insertion command. Insertion commands recognised
1758 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1759 Depends on the value of `comint-scroll-to-bottom-on-input'.
1761 This function should be a pre-command hook."
1764 hilit-yank)))
1780 nil t))))))
1783 "Go to the end of buffer in some or all windows showing it.
1784 Does not scroll if the current line is the last line in the buffer.
1785 Depends on the value of `comint-move-point-for-output' and
1786 `comint-scroll-show-maximum-output'.
1788 This function should be in the list `comint-output-filter-functions'."
1802 ;; Maybe user wants point to jump to end.
1805 ;; If point was at the end, keep it at end.
1809 ;; Optionally scroll so that the text
1810 ;; ends at the bottom of the window.
1817 nil t))
1821 "Truncate the buffer to `comint-buffer-maximum-size'.
1822 This function could be on `comint-output-filter-functions' or bound to a key."
1832 "Strip trailing `^M' characters from the current output group.
1833 This function could be on `comint-output-filter-functions' or bound to a key."
1846 "Put the end of the buffer at the bottom of the window."
1852 "Default for `comint-get-old-input'.
1853 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1854 return the current input field, if point is on an input field, or the
1855 current line, if point is on an output field.
1856 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1857 the current line with any initial string matching the regexp
1858 `comint-prompt-regexp' removed."
1866 "Skip past the text matching regexp `comint-prompt-regexp'.
1867 If this takes us past the end of the current line, don't skip at all."
1873 "Return t if point is after the process output marker."
1878 "Default function for sending to PROC input STRING.
1879 This just sends STRING plus a newline. To override this,
1880 set the hook `comint-input-sender'."
1888 "Return the buffer position of the beginning of the line, after any prompt.
1889 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1890 prompt skip is done by skipping text matching the regular expression
1891 `comint-prompt-regexp', a buffer local variable."
1893 ;; Use comint-prompt-regexp
1898 ;; Use input fields. Note that, unlike the behavior of
1899 ;; `line-beginning-position' inside a field, this function will
1900 ;; return the position of the end of a prompt, even if the point is
1901 ;; already inside the prompt. In order to do this, it assumes that
1902 ;; if there are two fields on a line, then the first one is the
1903 ;; prompt, and the second one is an input field, and is front-sticky
1904 ;; (as input fields should be).
1908 "Go to the beginning of line, then skip past the prompt, if any.
1910 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1911 prompt skip is done by skipping text matching the regular expression
1912 `comint-prompt-regexp', a buffer local variable."
1915 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1919 ;; These three functions are for entering text you don't want echoed or
1920 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1921 ;; Just enter m-x send-invisible and type in your line, or add
1922 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1925 "Read a single line of text from user without echoing, and return it.
1926 Prompt with argument PROMPT, a string. Optional argument STARS causes
1927 input to be echoed with '*' characters on the prompt line. Input ends with
1928 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1929 `inhibit-quit' is set because e.g. this function was called from a process
1930 filter and C-g is pressed, this function returns nil rather than a string).
1932 Note that the keystrokes comprising the text can still be recovered
1934 however, `clear-this-command-keys').
1935 Once the caller uses the password, it can erase the password
1936 by doing (clear-string STRING)."
1948 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1951 ;; This function may get called from a process filter, where
1952 ;; inhibit-quit is set. In later versions of emacs read-char
1953 ;; may clear quit-flag itself and return C-g. That would make
1954 ;; it impossible to quit this loop in a simple way, so
1955 ;; re-enable it here (for backward-compatibility the check for
1956 ;; quit-flag below would still be necessary, so this seems
1957 ;; like the simplest way to do things).
1959 done t))
1973 ;; Emulate a true quit, except that we have to return a value.
1979 ans)))
1982 "Read a string without echoing.
1983 Then send it to the process running in the current buffer.
1984 The string is sent using `comint-input-sender'.
1985 Security bug: your string can still be temporarily recovered with
1999 "Prompt in the minibuffer for password and send without echoing.
2000 This function uses `send-invisible' to read and send a password to the buffer's
2001 process if STRING contains a password prompt defined by
2002 `comint-password-prompt-regexp'.
2004 This function could be in the list `comint-output-filter-functions'."
2009 \f
2010 ;; Low-level process communication
2013 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2023 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2032 \f
2033 ;; Random input hackage
2036 "Delete all output from interpreter since last input.
2037 Does not delete the prompt."
2051 ;; Output message and put back prompt
2057 "Write output from interpreter since last input to FILENAME.
2058 Any prompt at the end of the output is not written.
2060 If the optional argument APPEND (the prefix argument when interactive)
2061 is non-nil, the output is appended to the file instead.
2063 If the optional argument MUSTBENEW is non-nil, check for an existing
2064 file with the same name. If MUSTBENEW is `excl', that means to get an
2065 error if the file already exists; never overwrite. If MUSTBENEW is
2066 neither nil nor `excl', that means ask for confirmation before
2067 overwriting, but do go ahead and overwrite the file if the user
2068 confirms. When interactive, MUSTBENEW is nil when appending, and t
2069 otherwise."
2073 "Append output to file: "
2075 current-prefix-arg
2081 append nil nil mustbenew)))
2083 ;; This function exists for the benefit of the menu; from the keyboard,
2084 ;; users can just use `comint-write-output' with a prefix arg.
2086 "Append output from interpreter since last input to FILENAME.
2087 Any prompt at the end of the output is not written."
2092 "Display start of this batch of interpreter output at top of window.
2093 Sets mark to the value of point when this command is run."
2108 "Interrupt the current subjob.
2109 This command also kills the pending input
2110 between the process mark and point."
2114 ;; (process-send-string nil "\n")
2115 )
2118 "Send kill signal to the current subjob.
2119 This command also kills the pending input
2120 between the process mark and point."
2126 "Send quit signal to the current subjob.
2127 This command also kills the pending input
2128 between the process mark and point."
2134 "Stop the current subjob.
2135 This command also kills the pending input
2136 between the process mark and point.
2138 WARNING: if there is no current subjob, you can end up suspending
2139 the top-level process running in the buffer. If you accidentally do
2141 is not a problem with most shells, since they ignore this signal.)"
2147 "Send CONT signal to process buffer's process group.
2148 Useful if you accidentally suspend the top-level process."
2153 "Skip all pending input, from last stuff output by interpreter to point.
2154 This means mark it as if it had been sent as input, without sending it."
2166 "Kill all text from last stuff output by interpreter to point."
2173 "Delete ARG characters forward or send an EOF to subprocess.
2174 Sends an EOF only if point is at the end of the buffer and there is no input."
2182 "Send an EOF to the current buffer's process."
2189 "Search backward through buffer for input fields that match REGEXP.
2190 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2191 fields are identified by lines that match `comint-prompt-regexp'.
2193 With prefix argument N, search for Nth previous match.
2194 If N is negative, find the next or Nth next match."
2197 ;; Use comint-prompt-regexp
2207 ;; Use input fields
2221 "Search forward through buffer for input fields that match REGEXP.
2222 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2223 fields are identified by lines that match `comint-prompt-regexp'.
2225 With prefix argument N, search for Nth following match.
2226 If N is negative, find the previous or Nth previous match."
2232 "Move to end of Nth next prompt in the buffer.
2233 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2234 the beginning of the Nth next `input' field, otherwise, it means the Nth
2235 occurrence of text matching `comint-prompt-regexp'."
2238 ;; Use comint-prompt-regexp
2243 ;; Use input fields
2246 prev-pos)
2254 ;; Ran off the end of the buffer.
2256 ;; There's always an input field at the end of the
2257 ;; buffer, but it has a `field' property of nil.
2259 ;; stop iterating
2269 "Move to end of Nth previous prompt in the buffer.
2270 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2271 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2272 occurrence of text matching `comint-prompt-regexp'."
2276 ;; State used by `comint-insert-previous-argument' when cycling.
2282 ;; Needs fixing:
2283 ;; make comint-arguments understand negative indices as bash does
2285 "Insert the INDEXth argument from the previous Comint command-line at point.
2286 Spaces are added at beginning and/or end of the inserted string if
2287 necessary to ensure that it's separated from adjacent arguments.
2288 Interactively, if no prefix argument is given, the last argument is inserted.
2289 Repeated interactive invocations will cycle through the same argument
2290 from progressively earlier commands (using the value of INDEX specified
2291 with the first command).
2292 This command is like `M-.' in bash."
2297 ;; Delete last input inserted by this command.
2301 ;; This is a non-repeat invocation, so initialize state.
2305 ;; First usage; initialize to a marker
2308 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2312 ;; Remember the beginning of what we insert, so we can delete it if
2313 ;; the command is repeated.
2315 ;; Insert the argument.
2318 ;; strip terminating '&'
2321 ;; Make next invocation return arg from previous input
2323 ;; Add a terminating space if necessary.
2327 \f
2328 ;; Support editing with `comint-prompt-read-only' set to t.
2331 "Update read-only status of newline before point.
2332 The `fence' read-only property is used to indicate that a newline
2334 following front-sticky read-only region. This is used to
2335 implement comint read-only prompts. If the text after a newline
2336 changes, the read-only status of that newline may need updating.
2337 That is what this function does.
2339 This function does nothing if point is not at the beginning of a
2340 line, or is at the beginning of the accessible portion of the buffer.
2341 Otherwise, if the character after point has a front-sticky
2342 read-only property, then the preceding newline is given a
2343 read-only property of `fence', unless it already is read-only.
2344 If the character after point does not have a front-sticky
2345 read-only property, any read-only property of `fence' on the
2346 preceding newline is removed."
2359 "Kill current line, ignoring read-only and field properties.
2360 With prefix arg, kill that many lines starting from the current line.
2361 If arg is negative, kill backward. Also kill the preceding newline,
2362 instead of the trailing one. \(This is meant to make C-x z work well
2363 with negative arguments.)
2364 If arg is zero, kill current line but exclude the trailing newline.
2365 The read-only status of newlines is updated with `comint-update-fence',
2366 if necessary."
2373 "Like `kill-region', but ignores read-only properties, if safe.
2374 This command assumes that the buffer contains read-only
2376 properties at the beginning of a line, with the preceding newline
2377 being read-only to protect the prompt. This is true of the
2378 comint prompts if `comint-prompt-read-only' is non-nil. This
2379 command will not delete the region if this would create mutilated
2380 or out of place prompts. That is, if any part of a prompt is
2381 deleted, the entire prompt must be deleted and all remaining
2382 prompts should stay at the beginning of a line. If this is not
2383 the case, this command just calls `kill-region' with all
2384 read-only properties intact. The read-only status of newlines is
2385 updated using `comint-update-fence', if necessary."
2405 \f
2406 ;; Support for source-file processing commands.
2407 ;;============================================================================
2408 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2409 ;; commands that process files of source text (e.g. loading or compiling
2410 ;; files). So the corresponding process-in-a-buffer modes have commands
2411 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2412 ;; for defining these commands.
2413 ;;
2414 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2415 ;; and Soar, in that they don't know anything about file extensions.
2416 ;; So the compile/load interface gets the wrong default occasionally.
2417 ;; The load-file/compile-file default mechanism could be smarter -- it
2418 ;; doesn't know about the relationship between filename extensions and
2419 ;; whether the file is source or executable. If you compile foo.lisp
2420 ;; with compile-file, then the next load-file should use foo.bin for
2421 ;; the default, not foo.lisp. This is tricky to do right, particularly
2422 ;; because the extension for executable files varies so much (.o, .bin,
2423 ;; .lbin, .mo, .vo, .ao, ...).
2426 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2427 ;; commands.
2428 ;;
2429 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2430 ;; want to save the buffer before issuing any process requests to the command
2431 ;; interpreter.
2432 ;;
2433 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2434 ;; for the file to process.
2437 "Compute the defaults for `load-file' and `compile-file' commands.
2439 PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2440 source-file processing command. nil if there hasn't been one yet.
2441 SOURCE-MODES is a list used to determine what buffers contain source
2442 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2443 Typically, (lisp-mode) or (scheme-mode).
2445 If the command is given while the cursor is inside a string, *and*
2446 the string is an existing filename, *and* the filename is not a directory,
2447 then the string is taken as default. This allows you to just position
2448 your cursor over a string that's a filename and have it taken as default.
2450 If the command is given in a file buffer whose major mode is in
2451 SOURCE-MODES, then the filename is the default file, and the
2452 file's directory is the default directory.
2454 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2455 then the default directory & file are what was used in the last source-file
2456 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2457 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2460 SOURCE-REGEXP is typically going to be something like (tea-mode)
2461 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2462 for Soar programs, etc.
2464 The function returns a pair: (default-directory . default-file)."
2474 "Check whether to save buffers visiting file FNAME.
2475 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2476 process-in-a-buffer modes), this function can be called on the filename.
2477 If the file is loaded into a buffer, and the buffer is modified, the user
2478 is queried to see if he wants to save the buffer before proceeding with
2479 the load or compile."
2484 ;; save BUFF.
2491 "Return string around POINT, or nil."
2502 "Prompt for filenames in commands that process source files,
2503 e.g. loading or compiling a file.
2504 Provides a default, if there is one, and returns the result filename.
2506 See `comint-source-default' for more on determining defaults.
2508 PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2509 from the last source processing command. SOURCE-MODES is a list of major
2510 modes used to determine what file buffers contain source files. (These
2511 two arguments are used for determining defaults). If MUSTMATCH-P is true,
2512 then the filename reader will only accept a file that exists.
2514 A typical use:
2516 '(lisp-mode) t))"
2529 prompt deffile)
2530 prompt)
2531 defdir
2533 mustmatch-p)))
2536 ;; I am somewhat divided on this string-default feature. It seems
2537 ;; to violate the principle-of-least-astonishment, in that it makes
2538 ;; the default harder to predict, so you actually have to look and see
2539 ;; what the default really is before choosing it. This can trip you up.
2540 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2541 ;; on this.
2542 ;; -Olin
2544 \f
2545 ;; Simple process query facility.
2546 ;; ===========================================================================
2547 ;; This function is for commands that want to send a query to the process
2548 ;; and show the response to the user. For example, a command to get the
2549 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2550 ;; to an inferior Common Lisp process.
2551 ;;
2552 ;; This simple facility just sends strings to the inferior process and pops
2553 ;; up a window for the process buffer so you can see what the process
2554 ;; responds with. We don't do anything fancy like try to intercept what the
2555 ;; process responds with and put it in a pop-up window or on the message
2556 ;; line. We just display the buffer. Low tech. Simple. Works good.
2559 "Send to the inferior process PROC the string STR.
2560 Pop-up but do not select a window for the inferior process so that
2561 its response can be seen."
2570 ;; Try to position the proc window so you can see the answer.
2571 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2572 ;; I don't know why. Wizards invited to improve it.
2581 \f
2582 ;; Filename/command/history completion in a buffer
2583 ;; ===========================================================================
2584 ;; Useful completion functions, courtesy of the Ergo group.
2586 ;; Six commands:
2587 ;; comint-dynamic-complete Complete or expand command, filename,
2588 ;; history at point.
2589 ;; comint-dynamic-complete-filename Complete filename at point.
2590 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2591 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2592 ;; replace with expanded/completed name.
2593 ;; comint-dynamic-simple-complete Complete stub given candidates.
2595 ;; These are not installed in the comint-mode keymap. But they are
2596 ;; available for people who want them. Shell-mode installs them:
2597 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2598 ;; (define-key shell-mode-map "\M-?"
2599 ;; 'comint-dynamic-list-filename-completions)))
2600 ;;
2601 ;; Commands like this are fine things to put in load hooks if you
2602 ;; want them present in specific modes.
2605 "*If non-nil, automatically list possibilities on partial completion.
2606 This mirrors the optional behavior of tcsh."
2611 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2612 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2613 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2614 This mirrors the optional behavior of tcsh."
2623 "*If non-nil, use shortest completion if characters cannot be added.
2624 This mirrors the optional behavior of tcsh.
2626 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2631 "*List of suffixes to be disregarded during file completion.
2632 This mirrors the optional behavior of bash and tcsh.
2634 Note that this applies to `comint-dynamic-complete-filename' only."
2639 "Prefix prepended to absolute file names taken from process input.
2640 This is used by Comint's and shell's completion functions, and by shell's
2645 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2647 "String of characters valid in a file name.
2648 Note that all non-ASCII characters are considered valid in a file name
2649 regardless of what this variable says.
2660 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2663 directory)))
2667 "Return the word of WORD-CHARS at point, or nil if none is found.
2668 Word constituents are considered to be those in WORD-CHARS, which is like the
2670 plus all non-ASCII characters."
2673 giveup)
2677 ;; Fixme: This isn't consistent with Bash, at least -- not
2678 ;; all non-ASCII chars should be word constituents.
2687 ;; Set match-data to match the entire string.
2693 "Return FILENAME with environment variables substituted.
2694 Supports additional environment variable syntax of the command
2695 interpreter (e.g., the percent notation of cmd.exe on NT)."
2699 env-var-val)
2708 name))
2711 "Return the filename at point, or nil if non is found.
2712 Environment variables are substituted. See `comint-word'."
2719 "Return FILENAME with magic characters quoted.
2720 Magic characters are those in `comint-file-name-quote-list'."
2722 filename
2731 filename))))
2734 "Return FILENAME with quoted characters unquoted."
2736 filename
2742 filename)))
2746 "Dynamically perform completion at point.
2747 Calls the functions in `comint-dynamic-complete-functions' to perform
2748 completion until a function returns non-nil, at which point completion is
2749 assumed to have occurred."
2755 "Dynamically complete the filename at point.
2756 Completes if after a filename. See `comint-match-partial-filename' and
2757 `comint-dynamic-complete-as-filename'.
2758 This function is similar to `comint-replace-by-expanded-filename', except that
2759 it won't change parts of the filename already entered in the buffer; it just
2760 adds completion characters to the end of the filename. A completions listing
2761 may be shown in a help buffer if completion is ambiguous.
2763 Completion is dependent on the value of `comint-completion-addsuffix',
2764 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2765 completions listing is dependent on the value of `comint-completion-autolist'.
2767 Returns t if successful."
2775 "Dynamically complete at point as a filename.
2776 See `comint-dynamic-complete-filename'. Returns t if successful."
2779 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2780 ;; I think it was originally bound to solve file completion problems,
2781 ;; but subsequent changes may have made this unnecessary. sm.
2782 ;;(file-name-handler-alist nil)
2817 ;; We inserted a unique completion.
2824 ;; It's not unique, but user wants shortest match.
2830 ;; It's not unique, list possible completions.
2835 success))
2839 "Dynamically expand and complete the filename at point.
2840 Replace the filename with an expanded, canonicalised and completed replacement.
2843 removed, and the filename is made absolute instead of relative. For expansion
2844 see `expand-file-name' and `substitute-in-file-name'. For completion see
2845 `comint-dynamic-complete-filename'."
2854 "Dynamically complete STUB from CANDIDATES list.
2855 This function inserts completion characters at point by completing STUB from
2856 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2857 if completion is ambiguous.
2859 Returns nil if no completion was inserted.
2860 Returns `sole' if completed with the only completion match.
2861 Returns `shortest' if completed with the shortest of the completion matches.
2862 Returns `partial' if completed as far as possible with the completion matches.
2863 Returns `listed' if a completion listing was shown.
2865 See also `comint-dynamic-complete-filename'."
2873 nil)
2884 ;; Insert the longest substring.
2889 ;; It's not unique, but user wants shortest match.
2895 ;; It's not unique, list possible completions.
2904 "List in help buffer possible completions of the filename at point."
2907 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2908 ;; I think it was originally bound to solve file completion problems,
2909 ;; but subsequent changes may have made this unnecessary. sm.
2910 ;;(file-name-handler-alist nil)
2922 ;; This is bound locally in a *Completions* buffer to the list of
2923 ;; completions displayed, and is used to detect the case where the same
2924 ;; command is repeatedly used without the set of completions changing.
2930 "List in help buffer sorted COMPLETIONS.
2931 Typing SPC flushes the help buffer."
2937 ;; The above tests are not sufficient to detect the case where we
2938 ;; should scroll, because the top-level interactive command may
2939 ;; not have displayed a completions window the last time it was
2940 ;; invoked, and there may be such a window left over from a
2941 ;; previous completion command with a different set of
2942 ;; completions. To detect that case, we also test that the set
2943 ;; of displayed completions is in fact the same as the previously
2944 ;; displayed set.
2948 ;; If this command was repeated, and
2949 ;; there's a fresh completion window with a live buffer,
2950 ;; and this command is repeated, scroll that window.
2958 ;; Display a completion list for the first time.
2965 ;; Read the next key, to process SPC.
2969 completions)
2976 ;; If the user does mouse-choose-completion with the mouse,
2977 ;; execute the command, then delete the completion window.
2986 \f
2988 "After fetching a line from input history, this fetches the following line.
2989 In other words, this recalls the input line after the line you recalled last.
2990 You can use this to repeat a sequence of input lines."
2999 "Accumulate a line to send as input along with more lines.
3000 This inserts a newline so that you can enter more text
3002 to send all the accumulated input, at once.
3003 The entire accumulated text becomes one item in the input history
3004 when you send it."
3013 "Move point to the process mark.
3014 The process mark separates output, and input already sent,
3015 from input that has not yet been sent."
3024 "Move point to beginning of line (after prompt) or to the process mark.
3025 The first time you use this command, it moves to the beginning of the line
3026 \(but after the prompt, if any). If you repeat it again immediately,
3027 it moves point to the process mark.
3029 The process mark separates the process output, along with input already sent,
3030 from input that has not yet been sent. Ordinarily, the process mark
3031 is at the beginning of the current input line; but if you have
3033 the process mark is at the beginning of the accumulated input."
3040 "Set the process mark at point."
3047 \f
3048 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3050 ;; This little add-on for comint is intended to make it easy to get
3051 ;; output from currently active comint buffers into another buffer,
3052 ;; or buffers, and then go back to using the comint shell.
3053 ;;
3054 ;; My particular use is SQL interpreters; I want to be able to execute a
3055 ;; query using the process associated with a comint-buffer, and save that
3056 ;; somewhere else. Because the process might have state (for example, it
3057 ;; could be in an uncommitted transaction), just running starting a new
3058 ;; process and having it execute the query and then finish, would not
3059 ;; work. I'm sure there are other uses as well, although in many cases
3060 ;; starting a new process is the simpler, and thus preferable, approach.
3061 ;;
3062 ;; The basic implementation is as follows: comint-redirect changes the
3063 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3064 ;; its own filter. The filter puts the output into the designated buffer,
3065 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3066 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3067 ;; sees the stop regexp, it restores the old filter functions, and runs
3068 ;; `comint-redirect-hook'.
3069 ;;
3070 ;; Each comint buffer may only use one redirection at a time, but any number
3071 ;; of different comint buffers may be simultaneously redirected.
3072 ;;
3073 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3074 ;; correct prompt for your interpreter, or that you supply a regexp that says
3075 ;; when the redirection is finished. Otherwise, redirection will continue
3076 ;; indefinitely. The code now does a sanity check to ensure that it can find
3077 ;; a prompt in the comint buffer; however, it is still important to ensure that
3078 ;; this prompt is set correctly.
3079 ;;
3080 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3081 ;; perhaps it should prompt for a terminating string (with an
3082 ;; appropriate magic default by examining what we think is the prompt)?
3083 ;;
3084 ;; Fixme: look for appropriate fields, rather than regexp, if
3085 ;; `comint-use-prompt-regexp-instead-of-fields' is true.
3087 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3088 ;; Variables
3089 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3092 "*If non-nil, print messages each time the redirection filter is invoked.
3093 Also print a message when redirection is completed."
3097 ;; Directly analagous to comint-preoutput-filter-functions
3099 "List of functions to call before inserting redirected process output.
3100 Each function gets one argument, a string containing the text received
3101 from the subprocess. It should return the string to insert, perhaps
3102 the same string that was received, or perhaps a modified or transformed
3103 string.
3105 The functions on the list are called sequentially, and each one is given
3106 the string returned by the previous one. The string returned by the
3107 last function is the text that is actually inserted in the redirection buffer.
3109 You can use `add-hook' to add functions to this list
3112 ;; Internal variables
3118 "Regular expression that determines when to stop redirection in Comint.
3119 When the redirection filter function is given output that matches this regexp,
3123 "If non-nil, the text that ends a redirection is included in it.
3124 More precisely, the text that matches `comint-redirect-finished-regexp'
3125 and therefore terminates an output redirection is inserted in the
3138 "If non-nil, check that redirection is likely to complete successfully.
3139 More precisely, before starting a redirection, verify that the
3140 regular expression `comint-redirect-finished-regexp' that controls
3141 when to terminate it actually matches some text already in the process
3142 buffer. The idea is that this regular expression should match a prompt
3143 string, and that there ought to be at least one copy of your prompt string
3147 "The process filter that was in place when redirection is started.
3148 When redirection is completed, the process filter is restored to
3152 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3153 The readonly status is toggled around insertion.
3154 This is useful, for instance, for insertion into Help mode buffers.
3157 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3158 ;; Functions
3159 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3162 comint-buffer
3163 finished-regexp
3165 "Set up for output redirection.
3166 This function sets local variables that are used by `comint-redirect-filter'
3167 to perform redirection.
3169 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3170 in the output matches FINISHED-REGEXP.
3172 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3173 original Comint buffer.
3175 This function is called by `comint-redirect-send-command-to-process',
3176 and does not normally need to be invoked by the end user or programmer."
3200 "End a Comint redirection. See `comint-redirect-send-command'."
3202 ;; Restore the process filter
3204 comint-redirect-original-filter-function)
3205 ;; Restore the mode line
3207 ;; Set the completed flag
3210 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3211 ;; that it really occurs.
3215 "Filter function which redirects output from PROCESS to a buffer or buffers.
3216 The variable `comint-redirect-output-buffer' says which buffer(s) to
3217 place output in.
3219 INPUT-STRING is the input from the Comint process.
3221 This function runs as a process filter, and does not need to be invoked by the
3222 end user."
3226 ;; If we have to echo output, give it to the original filter function
3228 comint-redirect-original-filter-function
3230 process input-string)))))
3234 "Comint filter function which redirects Comint output to a buffer or buffers.
3235 The variable `comint-redirect-output-buffer' says which buffer(s) to
3236 place output in.
3238 INPUT-STRING is the input from the Comint process.
3240 This function does not need to be invoked by the end user."
3243 comint-redirect-output-buffer
3247 ;; If there are any filter functions, give them a chance to modify the string
3251 ;; If a local value says "use the default value too",
3252 ;; do that.
3262 ;; Clobber `comint-redirect-finished-regexp'
3268 ;; Send output to all registered buffers
3271 ;; Set this buffer to the output buffer
3273 ;; Go to the end of the buffer
3275 ;; Insert the output
3279 ;; Message
3284 ;; If we see the prompt, tidy up
3285 ;; We'll look for the prompt in the original string, so nobody can
3286 ;; clobber it
3293 ;; Echo input?
3295 filtered-input-string
3298 ;;;###autoload
3300 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3301 With prefix arg ECHO, echo output in process buffer.
3303 If NO-DISPLAY is non-nil, do not show the output buffer."
3311 ;;;###autoload
3314 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3315 With prefix arg, echo output in process buffer.
3317 If NO-DISPLAY is non-nil, do not show the output buffer."
3322 process))
3324 ;; Change to the process buffer
3327 ;; Make sure there's a prompt in the current process buffer
3334 ;;;;;;;;;;;;;;;;;;;;;
3335 ;; Set up for redirection
3336 ;;;;;;;;;;;;;;;;;;;;;
3338 ;; Output Buffer
3339 output-buffer
3340 ;; Comint Buffer
3342 ;; Finished Regexp
3343 comint-prompt-regexp
3344 ;; Echo input
3345 echo)
3347 ;;;;;;;;;;;;;;;;;;;;;
3348 ;; Set the filter
3349 ;;;;;;;;;;;;;;;;;;;;;
3350 ;; Save the old filter
3355 ;;;;;;;;;;;;;;;;;;;;;
3356 ;; Send the command
3357 ;;;;;;;;;;;;;;;;;;;;;
3362 ;;;;;;;;;;;;;;;;;;;;;
3363 ;; Show the output
3364 ;;;;;;;;;;;;;;;;;;;;;
3370 output-buffer)))))))
3372 ;;;###autoload
3374 "Send COMMAND to current process.
3375 Return a list of expressions in the output which match REGEXP.
3376 REGEXP-GROUP is the regular expression group in REGEXP to use."
3379 command regexp regexp-group))
3381 ;;;###autoload
3383 "Send COMMAND to PROCESS.
3384 Return a list of expressions in the output which match REGEXP.
3385 REGEXP-GROUP is the regular expression group in REGEXP to use."
3387 results)
3392 output-buffer process nil t)
3393 ;; Wait for the process to complete
3397 ;; Collect the output
3400 ;; Skip past the command, if it was echoed
3408 results)))
3409 results)))
3414 "^Empty input ring$"
3415 "^No history$"
3419 \f
3420 ;; Converting process modes to use comint mode
3421 ;; ===========================================================================
3422 ;; The code in the Emacs 19 distribution has all been modified to use comint
3423 ;; where needed. However, there are `third-party' packages out there that
3424 ;; still use the old shell mode. Here's a guide to conversion.
3425 ;;
3426 ;; Renaming variables
3427 ;; Most of the work is renaming variables and functions. These are the common
3428 ;; ones:
3429 ;; Local variables:
3430 ;; last-input-start comint-last-input-start
3431 ;; last-input-end comint-last-input-end
3432 ;; shell-prompt-pattern comint-prompt-regexp
3433 ;; shell-set-directory-error-hook <no equivalent>
3434 ;; Miscellaneous:
3435 ;; shell-set-directory <unnecessary>
3436 ;; shell-mode-map comint-mode-map
3437 ;; Commands:
3438 ;; shell-send-input comint-send-input
3439 ;; shell-send-eof comint-delchar-or-maybe-eof
3440 ;; kill-shell-input comint-kill-input
3441 ;; interrupt-shell-subjob comint-interrupt-subjob
3442 ;; stop-shell-subjob comint-stop-subjob
3443 ;; quit-shell-subjob comint-quit-subjob
3444 ;; kill-shell-subjob comint-kill-subjob
3445 ;; kill-output-from-shell comint-delete-output
3446 ;; show-output-from-shell comint-show-output
3447 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3448 ;;
3449 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3450 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3451 ;; Comint mode does not provide functionality equivalent to
3452 ;; shell-set-directory-error-hook; it is gone.
3453 ;;
3454 ;; comint-last-input-start is provided for modes which want to munge
3455 ;; the buffer after input is sent, perhaps because the inferior
3456 ;; insists on echoing the input. The LAST-INPUT-START variable in
3457 ;; the old shell package was used to implement a history mechanism,
3458 ;; but you should think twice before using comint-last-input-start
3459 ;; for this; the input history ring often does the job better.
3460 ;;
3461 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3462 ;; *not* create the comint-mode local variables in your foo-mode function.
3463 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3464 ;; necessary comint-specific local variables. Then create the
3465 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3466 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3467 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3468 ;; get-old-input) that need to be different from the defaults. Call
3469 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3470 ;; comint-mode will take care of it. The following example, from shell.el,
3471 ;; is typical:
3472 ;;
3473 ;; (defvar shell-mode-map '())
3474 ;; (cond ((not shell-mode-map)
3475 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3476 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3477 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3478 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3479 ;; (define-key shell-mode-map "\M-?"
3480 ;; 'comint-dynamic-list-filename-completions)))
3481 ;;
3482 ;; (defun shell-mode ()
3483 ;; (interactive)
3484 ;; (comint-mode)
3485 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3486 ;; (setq major-mode 'shell-mode)
3487 ;; (setq mode-name "Shell")
3488 ;; (use-local-map shell-mode-map)
3489 ;; (make-local-variable 'shell-directory-stack)
3490 ;; (setq shell-directory-stack nil)
3491 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3492 ;; (run-hooks 'shell-mode-hook))
3493 ;;
3494 ;;
3495 ;; Completion for comint-mode users
3496 ;;
3497 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3498 ;; hook to add completion functions to. Functions on this list should return
3499 ;; non-nil if completion occurs (i.e., further completion should not occur).
3500 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3501 ;; completion job.
3502 \f
3506 ;;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3507 ;;; comint.el ends here