Mercurial > emacs
annotate lisp/comint.el @ 2522:c93900809245
(rot13-other-window): Add autoload.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 12 Apr 1993 07:49:31 +0000 |
parents | 10509afe2588 |
children | 577c77cfd199 |
rev | line source |
---|---|
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
638
diff
changeset
|
1 ;;; comint.el --- general command interpreter in a window stuff |
2307
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
2 |
1839
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
3 ;; Copyright (C) 1988, 1990, 1992, 1993 Free Software Foundation, Inc. |
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
638
diff
changeset
|
4 |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu> |
2247
2c7997f249eb
Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2025
diff
changeset
|
6 ;; Keywords: processes |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
7 |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
8 ;; This file is part of GNU Emacs. |
114 | 9 |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
10 ;; GNU Emacs is free software; you can redistribute it and/or modify |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
11 ;; it under the terms of the GNU General Public License as published by |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
13 ;; any later version. |
114 | 14 |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
15 ;; GNU Emacs is distributed in the hope that it will be useful, |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
18 ;; GNU General Public License for more details. |
114 | 19 |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
20 ;; You should have received a copy of the GNU General Public License |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
21 ;; along with GNU Emacs; see the file COPYING. If not, write to |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
114 | 23 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
793
diff
changeset
|
24 ;;; Commentary: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
793
diff
changeset
|
25 |
584 | 26 ;;; The changelog is at the end of this file. |
27 | |
28 ;;; Please send me bug reports, bug fixes, and extensions, so that I can | |
29 ;;; merge them into the master source. | |
30 ;;; - Olin Shivers (shivers@cs.cmu.edu) | |
31 | |
114 | 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.). | |
38 | |
584 | 39 ;;; Several packages are already defined using comint mode: |
2518
10509afe2588
Clean up cmu* uses in header comments.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2455
diff
changeset
|
40 ;;; - shell.el defines a shell-in-a-buffer mode. |
584 | 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. | |
50 | |
114 | 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. | |
55 | |
584 | 56 ;;; For hints on converting existing process modes (e.g., tex-mode, |
57 ;;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode | |
114 | 58 ;;; instead of shell-mode, see the notes at the end of this file. |
59 | |
60 | |
584 | 61 ;;; Brief Command Documentation: |
62 ;;;============================================================================ | |
2518
10509afe2588
Clean up cmu* uses in header comments.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2455
diff
changeset
|
63 ;;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp |
584 | 64 ;;; mode) |
65 ;;; | |
66 ;;; m-p comint-previous-input Cycle backwards in input history | |
67 ;;; m-n comint-next-input Cycle forwards | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
68 ;;; m-r comint-previous-similar-input Previous similar input |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
69 ;;; m-s comint-next-similar-input Next similar input |
705 | 70 ;;; c-m-r comint-previous-input-matching Search backwards in input history |
584 | 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 ;;; | |
114 | 82 ;;; Not bound by default in comint-mode |
83 ;;; send-invisible Read a line w/o echo, and send to proc | |
84 ;;; (These are bound in shell-mode) | |
85 ;;; comint-dynamic-complete Complete filename at point. | |
86 ;;; comint-dynamic-list-completions List completions in help buffer. | |
87 ;;; comint-replace-by-expanded-filename Expand and complete filename at point; | |
88 ;;; replace with expanded/completed name. | |
584 | 89 ;;; comint-kill-subjob No mercy. |
90 ;;; comint-continue-subjob Send CONT signal to buffer's process | |
91 ;;; group. Useful if you accidentally | |
92 ;;; suspend your process (with C-c C-z). | |
93 ;;; | |
94 ;;; These used to be bound for RMS -- I prefer the input history stuff, | |
95 ;;; but you might like 'em. | |
96 ;;; m-P comint-msearch-input Search backwards for prompt | |
97 ;;; m-N comint-psearch-input Search forwards for prompt | |
98 ;;; C-cR comint-msearch-input-matching Search backwards for prompt & string | |
114 | 99 |
584 | 100 ;;; comint-mode-hook is the comint mode hook. Basically for your keybindings. |
101 ;;; comint-load-hook is run after loading in this package. | |
102 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
793
diff
changeset
|
103 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
793
diff
changeset
|
104 |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
793
diff
changeset
|
105 (defconst comint-version "2.03") |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
793
diff
changeset
|
106 |
1131 | 107 (require 'ring) |
114 | 108 |
109 ;;; Buffer Local Variables: | |
110 ;;;============================================================================ | |
111 ;;; Comint mode buffer local variables: | |
112 ;;; comint-prompt-regexp - string comint-bol uses to match prompt. | |
705 | 113 ;;; comint-last-input-start - marker Handy if inferior always echos |
584 | 114 ;;; comint-last-input-end - marker For comint-kill-output command |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
115 ;;; comint-input-ring-size - integer For the input history |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
116 ;;; comint-input-ring - ring mechanism |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
117 ;;; comint-input-ring-index - marker ... |
114 | 118 ;;; comint-last-input-match - string ... |
119 ;;; comint-get-old-input - function Hooks for specific | |
120 ;;; comint-input-sentinel - function process-in-a-buffer | |
121 ;;; comint-input-filter - function modes. | |
122 ;;; comint-input-send - function | |
123 ;;; comint-eol-on-send - boolean | |
124 | |
584 | 125 (defvar comint-prompt-regexp "^" |
126 "Regexp to recognise prompts in the inferior process. | |
127 Defaults to \"^\", the null string at BOL. | |
114 | 128 |
129 Good choices: | |
584 | 130 Canonical Lisp: \"^[^> ]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp) |
114 | 131 Lucid Common Lisp: \"^\\(>\\|\\(->\\)+\\) *\" |
584 | 132 franz: \"^\\(->\\|<[0-9]*>:\\) *\" |
133 kcl: \"^>+ *\" | |
134 shell: \"^[^#$%>]*[#$%>] *\" | |
135 T: \"^>+ *\" | |
114 | 136 |
584 | 137 This is a good thing to set in mode hooks.") |
114 | 138 |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
139 (defvar comint-input-ring-size 30 |
584 | 140 "Size of input history ring.") |
114 | 141 |
142 ;;; Here are the per-interpreter hooks. | |
584 | 143 (defvar comint-get-old-input (function comint-get-old-input-default) |
144 "Function that submits old text in comint mode. | |
114 | 145 This function is called when return is typed while the point is in old text. |
146 It returns the text to be submitted as process input. The default is | |
147 comint-get-old-input-default, which grabs the current line, and strips off | |
584 | 148 leading text matching comint-prompt-regexp") |
114 | 149 |
584 | 150 (defvar comint-input-sentinel (function ignore) |
151 "Called on each input submitted to comint mode process by comint-send-input. | |
152 Thus it can, for instance, track cd/pushd/popd commands issued to the csh.") | |
114 | 153 |
584 | 154 (defvar comint-input-filter |
155 (function (lambda (str) (not (string-match "\\`\\s *\\'" str)))) | |
156 "Predicate for filtering additions to input history. | |
114 | 157 Only inputs answering true to this function are saved on the input |
584 | 158 history list. Default is to save anything that isn't all whitespace") |
159 | |
160 (defvar comint-input-sender (function comint-simple-send) | |
161 "Function to actually send to PROCESS the STRING submitted by user. | |
162 Usually this is just 'comint-simple-send, but if your mode needs to | |
163 massage the input string, this is your hook. This is called from | |
164 the user command comint-send-input. comint-simple-send just sends | |
165 the string plus a newline.") | |
166 | |
167 (defvar comint-eol-on-send 'T | |
168 "If non-nil, then jump to the end of the line before sending input to process. | |
169 See comint-send-input") | |
114 | 170 |
171 (defvar comint-mode-hook '() | |
584 | 172 "Called upon entry into comint-mode |
173 This is run before the process is cranked up.") | |
174 | |
175 (defvar comint-exec-hook '() | |
176 "Called each time a process is exec'd by comint-exec. | |
177 This is called after the process is cranked up. It is useful for things that | |
178 must be done each time a process is executed in a comint-mode buffer (e.g., | |
179 (process-kill-without-query)). In contrast, the comint-mode-hook is only | |
180 executed once when the buffer is created.") | |
181 | |
182 (defvar comint-mode-map nil) | |
114 | 183 |
1131 | 184 (defvar comint-ptyp t |
185 "True if communications via pty; false if by pipe. Buffer local. | |
186 This is to work around a bug in emacs process signalling.") | |
187 | |
1376
dd83ec6103fe
(comint-last-input-match): defvar moved up.
Richard M. Stallman <rms@gnu.org>
parents:
1373
diff
changeset
|
188 (defvar comint-last-input-match "" |
dd83ec6103fe
(comint-last-input-match): defvar moved up.
Richard M. Stallman <rms@gnu.org>
parents:
1373
diff
changeset
|
189 "Last string searched for by comint input history search, for defaulting. |
dd83ec6103fe
(comint-last-input-match): defvar moved up.
Richard M. Stallman <rms@gnu.org>
parents:
1373
diff
changeset
|
190 Buffer local variable.") |
dd83ec6103fe
(comint-last-input-match): defvar moved up.
Richard M. Stallman <rms@gnu.org>
parents:
1373
diff
changeset
|
191 |
932
a93f0b1ba909
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
925
diff
changeset
|
192 (defvar comint-input-ring nil) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
193 (defvar comint-last-input-start) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
194 (defvar comint-last-input-end) |
1131 | 195 (defvar comint-input-ring-index) |
196 (put 'comint-input-ring 'permanent-local t) | |
197 (put 'comint-ptyp 'permanent-local t) | |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
198 |
114 | 199 (defun comint-mode () |
200 "Major mode for interacting with an inferior interpreter. | |
201 Interpreter name is same as buffer name, sans the asterisks. | |
202 Return at end of buffer sends line as input. | |
203 Return not at end copies rest of line to end and sends it. | |
584 | 204 Setting mode variable comint-eol-on-send means jump to the end of the line |
205 before submitting new input. | |
114 | 206 |
207 This mode is typically customised to create inferior-lisp-mode, | |
584 | 208 shell-mode, etc.. This can be done by setting the hooks |
209 comint-input-sentinel, comint-input-filter, comint-input-sender and | |
210 comint-get-old-input to appropriate functions, and the variable | |
211 comint-prompt-regexp to the appropriate regular expression. | |
114 | 212 |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
213 An input history is maintained of size comint-input-ring-size, and |
114 | 214 can be accessed with the commands comint-next-input [\\[comint-next-input]] and |
215 comint-previous-input [\\[comint-previous-input]]. Commands not keybound by | |
216 default are send-invisible, comint-dynamic-complete, and | |
217 comint-list-dynamic-completions. | |
218 | |
219 If you accidentally suspend your process, use \\[comint-continue-subjob] | |
220 to continue it. | |
221 | |
222 \\{comint-mode-map} | |
223 | |
584 | 224 Entry to this mode runs the hooks on comint-mode-hook" |
114 | 225 (interactive) |
1131 | 226 ;; Do not remove this. All major modes must do this. |
227 (kill-all-local-variables) | |
584 | 228 (setq major-mode 'comint-mode) |
229 (setq mode-name "Comint") | |
230 (setq mode-line-process '(": %s")) | |
231 (use-local-map comint-mode-map) | |
705 | 232 (make-local-variable 'comint-last-input-start) |
233 (setq comint-last-input-start (make-marker)) | |
584 | 234 (make-local-variable 'comint-last-input-end) |
235 (setq comint-last-input-end (make-marker)) | |
236 (make-local-variable 'comint-last-input-match) | |
237 (setq comint-last-input-match "") | |
238 (make-local-variable 'comint-prompt-regexp) ; Don't set; default | |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
239 (make-local-variable 'comint-input-ring-size) ; ...to global val. |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
240 (make-local-variable 'comint-input-ring) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
241 (make-local-variable 'comint-input-ring-index) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
242 (setq comint-input-ring-index 0) |
584 | 243 (make-local-variable 'comint-get-old-input) |
244 (make-local-variable 'comint-input-sentinel) | |
245 (make-local-variable 'comint-input-filter) | |
246 (make-local-variable 'comint-input-sender) | |
247 (make-local-variable 'comint-eol-on-send) | |
248 (make-local-variable 'comint-ptyp) | |
705 | 249 (make-local-variable 'comint-exec-hook) |
584 | 250 (run-hooks 'comint-mode-hook) |
1131 | 251 (or comint-input-ring |
252 (setq comint-input-ring (make-ring comint-input-ring-size)))) | |
114 | 253 |
584 | 254 (if comint-mode-map |
255 nil | |
256 (setq comint-mode-map (make-sparse-keymap)) | |
257 (define-key comint-mode-map "\ep" 'comint-previous-input) | |
258 (define-key comint-mode-map "\en" 'comint-next-input) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
259 (define-key comint-mode-map "\er" 'comint-previous-similar-input) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
260 (define-key comint-mode-map "\es" 'comint-next-similar-input) |
584 | 261 (define-key comint-mode-map "\C-m" 'comint-send-input) |
262 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof) | |
263 (define-key comint-mode-map "\C-a" 'comint-bol) | |
264 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input) | |
265 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word) | |
266 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob) | |
267 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob) | |
268 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob) | |
269 (define-key comint-mode-map "\C-c\C-o" 'comint-kill-output) | |
270 (define-key comint-mode-map "\C-\M-r" 'comint-previous-input-matching) | |
271 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output) | |
272 ;;; prompt-search commands commented out 3/90 -Olin | |
273 ; (define-key comint-mode-map "\eP" 'comint-msearch-input) | |
274 ; (define-key comint-mode-map "\eN" 'comint-psearch-input) | |
275 ; (define-key comint-mode-map "\C-cR" 'comint-msearch-input-matching) | |
276 ) | |
277 | |
278 | |
279 ;;; This function is used to make a full copy of the comint mode map, | |
280 ;;; so that client modes won't interfere with each other. This function | |
281 ;;; isn't necessary in emacs 18.5x, but we keep it around for 18.4x versions. | |
282 (defun full-copy-sparse-keymap (km) | |
283 "Recursively copy the sparse keymap KM" | |
284 (cond ((consp km) | |
285 (cons (full-copy-sparse-keymap (car km)) | |
286 (full-copy-sparse-keymap (cdr km)))) | |
287 (t km))) | |
288 | |
289 (defun comint-check-proc (buffer) | |
290 "True if there is a process associated w/buffer BUFFER, and | |
291 it is alive (status RUN or STOP). BUFFER can be either a buffer or the | |
292 name of one" | |
293 (let ((proc (get-buffer-process buffer))) | |
114 | 294 (and proc (memq (process-status proc) '(run stop))))) |
295 | |
296 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it () | |
297 ;;; for the second argument (program). | |
870
1b3af6ad85be
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
864
diff
changeset
|
298 ;;;###autoload |
114 | 299 (defun make-comint (name program &optional startfile &rest switches) |
1839
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
300 "Make a comint process NAME in a buffer, running PROGRAM. |
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
301 The name of the buffer is made by surrounding NAME with `*'s. |
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
302 If there is already a running process in that buffer, it is not restarted. |
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
303 Optional third arg STARTFILE is the name of a file to send the contents of to |
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
304 the process. Any more args are arguments to PROGRAM." |
584 | 305 (let ((buffer (get-buffer-create (concat "*" name "*")))) |
114 | 306 ;; If no process, or nuked process, crank up a new one and put buffer in |
1839
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
307 ;; comint mode. Otherwise, leave buffer and existing process alone. |
182 | 308 (cond ((not (comint-check-proc buffer)) |
584 | 309 (save-excursion |
114 | 310 (set-buffer buffer) |
311 (comint-mode)) ; Install local vars, mode, keymap, ... | |
312 (comint-exec buffer name program startfile switches))) | |
313 buffer)) | |
314 | |
315 (defun comint-exec (buffer name command startfile switches) | |
316 "Fires up a process in buffer for comint modes. | |
1839
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
317 Blasts any old process running in the buffer. Doesn't set the buffer mode. |
584 | 318 You can use this to cheaply run a series of processes in the same comint |
1839
e10cdcb857d2
(make-comint): Added docstring.
Roland McGrath <roland@gnu.org>
parents:
1821
diff
changeset
|
319 buffer. The hook comint-exec-hook is run after each exec." |
114 | 320 (save-excursion |
321 (set-buffer buffer) | |
322 (let ((proc (get-buffer-process buffer))) ; Blast any old process. | |
323 (if proc (delete-process proc))) | |
324 ;; Crank up a new process | |
325 (let ((proc (comint-exec-1 name buffer command switches))) | |
584 | 326 (make-local-variable 'comint-ptyp) |
327 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe. | |
114 | 328 ;; Jump to the end, and set the process mark. |
584 | 329 (goto-char (point-max)) |
705 | 330 (set-marker (process-mark proc) (point)) |
114 | 331 ;; Feed it the startfile. |
332 (cond (startfile | |
333 ;;This is guaranteed to wait long enough | |
334 ;;but has bad results if the comint does not prompt at all | |
335 ;; (while (= size (buffer-size)) | |
336 ;; (sleep-for 1)) | |
337 ;;I hope 1 second is enough! | |
338 (sleep-for 1) | |
339 (goto-char (point-max)) | |
340 (insert-file-contents startfile) | |
341 (setq startfile (buffer-substring (point) (point-max))) | |
342 (delete-region (point) (point-max)) | |
584 | 343 (comint-send-string proc startfile))) |
344 (run-hooks 'comint-exec-hook) | |
705 | 345 buffer))) |
114 | 346 |
347 ;;; This auxiliary function cranks up the process for comint-exec in | |
638 | 348 ;;; the appropriate environment. |
114 | 349 |
350 (defun comint-exec-1 (name buffer command switches) | |
638 | 351 (let ((process-environment |
352 (comint-update-env process-environment | |
353 (list (format "TERMCAP=emacs:co#%d:tc=unknown" | |
778 | 354 (frame-width)) |
638 | 355 "TERM=emacs" |
356 "EMACS=t")))) | |
357 (apply 'start-process name buffer command switches))) | |
584 | 358 |
359 | |
114 | 360 |
361 ;; This is just (append new old-env) that compresses out shadowed entries. | |
793
6fb68a1460a6
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
778
diff
changeset
|
362 ;; It's also pretty ugly, mostly due to lisp's horrible iteration structures. |
114 | 363 (defun comint-update-env (old-env new) |
364 (let ((ans (reverse new)) | |
365 (vars (mapcar (function (lambda (vv) | |
366 (and (string-match "^[^=]*=" vv) | |
367 (substring vv 0 (match-end 0))))) | |
368 new))) | |
369 (while old-env | |
370 (let* ((vv (car old-env)) ; vv is var=value | |
371 (var (and (string-match "^[^=]*=" vv) | |
372 (substring vv 0 (match-end 0))))) | |
373 (setq old-env (cdr old-env)) | |
584 | 374 (cond ((not (and var (comint-mem var vars))) |
114 | 375 (if var (setq var (cons var vars))) |
376 (setq ans (cons vv ans)))))) | |
377 (nreverse ans))) | |
584 | 378 |
379 ;;; This should be in emacs, but it isn't. | |
380 (defun comint-mem (item list &optional elt=) | |
381 "Test to see if ITEM is equal to an item in LIST. | |
382 Option comparison function ELT= defaults to equal." | |
383 (let ((elt= (or elt= (function equal))) | |
384 (done nil)) | |
385 (while (and list (not done)) | |
386 (if (funcall elt= item (car list)) | |
387 (setq done list) | |
388 (setq list (cdr list)))) | |
389 done)) | |
390 | |
114 | 391 |
392 ;;; Input history retrieval commands | |
393 ;;; M-p -- previous input M-n -- next input | |
584 | 394 ;;; M-C-r -- previous input matching |
114 | 395 ;;; =========================================================================== |
396 | |
397 (defun comint-previous-input (arg) | |
398 "Cycle backwards through input history." | |
399 (interactive "*p") | |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
400 (let ((len (ring-length comint-input-ring))) |
584 | 401 (cond ((<= len 0) |
402 (message "Empty input ring") | |
403 (ding)) | |
404 ((not (comint-after-pmark-p)) | |
405 (message "Not after process mark") | |
406 (ding)) | |
407 (t | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
408 (delete-region (point) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
409 (process-mark (get-buffer-process (current-buffer)))) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
410 ;; Initialize the index on the first use of this command |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
411 ;; so that the first M-p gets index 0, and the first M-n gets |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
412 ;; index -1. |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
413 (if (null comint-input-ring-index) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
414 (setq comint-input-ring-index |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
415 (if (> arg 0) -1 |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
416 (if (< arg 0) 1 0)))) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
417 (setq comint-input-ring-index |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
418 (comint-mod (+ comint-input-ring-index arg) len)) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
419 (message "%d" (1+ comint-input-ring-index)) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
420 (insert (ring-ref comint-input-ring comint-input-ring-index)))))) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
421 |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
422 (defun comint-mod (n m) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
423 "Returns N mod M. M is positive. |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
424 Answer is guaranteed to be non-negative, and less than m." |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
425 (let ((n (% n m))) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
426 (if (>= n 0) n |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
427 (+ n |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
428 (if (>= m 0) m (- m)))))) ; (abs m) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
429 |
114 | 430 (defun comint-next-input (arg) |
431 "Cycle forwards through input history." | |
432 (interactive "*p") | |
433 (comint-previous-input (- arg))) | |
434 | |
435 (defun comint-previous-input-matching (str) | |
436 "Searches backwards through input history for substring match." | |
437 (interactive (let* ((last-command last-command) ; preserve around r-f-m | |
438 (s (read-from-minibuffer | |
864
fe5f6b7c9727
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
861
diff
changeset
|
439 (format "Command substring (default %s): " |
fe5f6b7c9727
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
861
diff
changeset
|
440 comint-last-input-match)))) |
114 | 441 (list (if (string= s "") comint-last-input-match s)))) |
442 ; (interactive "sCommand substring: ") | |
443 (setq comint-last-input-match str) ; update default | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
444 (if (null comint-input-ring-index) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
445 (setq comint-input-ring-index -1)) |
114 | 446 (let ((str (regexp-quote str)) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
447 (len (ring-length comint-input-ring)) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
448 (n (+ comint-input-ring-index 1))) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
449 (while (and (< n len) (not (string-match str (ring-ref comint-input-ring n)))) |
114 | 450 (setq n (+ n 1))) |
451 (cond ((< n len) | |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
452 (comint-previous-input (- n comint-input-ring-index))) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
453 (t (error "Not found"))))) |
584 | 454 |
455 | |
456 ;;; These next three commands are alternatives to the input history commands | |
457 ;;; -- comint-next-input, comint-previous-input and | |
458 ;;; comint-previous-input-matching. They search through the process buffer | |
459 ;;; text looking for occurrences of the prompt. Bound to M-P, M-N, and C-c R | |
460 ;;; (uppercase P, N, and R) for now. Try'em out. Go with what you like... | |
461 | |
462 ;;; comint-msearch-input-matching prompts for a string, not a regexp. | |
463 ;;; This could be considered to be the wrong thing. I decided to keep it | |
464 ;;; simple, and not make the user worry about regexps. This, of course, | |
465 ;;; limits functionality. | |
466 | |
467 ;;; These commands were deemed non-winning and have been commented out. | |
468 ;;; Feel free to re-enable them if you like. -Olin 3/91 | |
469 | |
470 ;(defun comint-psearch-input () | |
471 ; "Search forwards for next occurrence of prompt and skip to end of line. | |
472 ;\(prompt is anything matching regexp comint-prompt-regexp)" | |
473 ; (interactive) | |
474 ; (if (re-search-forward comint-prompt-regexp (point-max) t) | |
475 ; (end-of-line) | |
476 ; (error "No occurrence of prompt found"))) | |
477 ; | |
478 ;(defun comint-msearch-input () | |
479 ; "Search backwards for previous occurrence of prompt and skip to end of line. | |
480 ;Search starts from beginning of current line." | |
481 ; (interactive) | |
482 ; (let ((p (save-excursion | |
483 ; (beginning-of-line) | |
484 ; (cond ((re-search-backward comint-prompt-regexp (point-min) t) | |
485 ; (end-of-line) | |
486 ; (point)) | |
487 ; (t nil))))) | |
488 ; (if p (goto-char p) | |
489 ; (error "No occurrence of prompt found")))) | |
490 ; | |
491 ;(defun comint-msearch-input-matching (str) | |
492 ; "Search backwards for occurrence of prompt followed by STRING. | |
493 ;STRING is prompted for, and is NOT a regular expression." | |
494 ; (interactive (let ((s (read-from-minibuffer | |
495 ; (format "Command (default %s): " | |
496 ; comint-last-input-match)))) | |
497 ; (list (if (string= s "") comint-last-input-match s)))) | |
498 ;; (interactive "sCommand: ") | |
499 ; (setq comint-last-input-match str) ; update default | |
500 ; (let* ((r (concat comint-prompt-regexp (regexp-quote str))) | |
501 ; (p (save-excursion | |
502 ; (beginning-of-line) | |
503 ; (cond ((re-search-backward r (point-min) t) | |
504 ; (end-of-line) | |
505 ; (point)) | |
506 ; (t nil))))) | |
507 ; (if p (goto-char p) | |
508 ; (error "No match")))) | |
114 | 509 |
510 ;;; | |
511 ;;; Similar input -- contributed by ccm and highly winning. | |
512 ;;; | |
513 ;;; Reenter input, removing back to the last insert point if it exists. | |
514 ;;; | |
584 | 515 (defvar comint-last-similar-string "" |
516 "The string last used in a similar string search.") | |
114 | 517 (defun comint-previous-similar-input (arg) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
518 "Fetch the previous (older) input that matches the string typed so far. |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
519 Successive repetitions find successively older matching inputs. |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
520 A prefix argument serves as a repeat count; a negative argument |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
521 fetches following (more recent) inputs." |
114 | 522 (interactive "p") |
584 | 523 (if (not (comint-after-pmark-p)) |
114 | 524 (error "Not after process mark")) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
525 (if (null comint-input-ring-index) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
526 (setq comint-input-ring-index |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
527 (if (> arg 0) -1 |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
528 (if (< arg 0) 1 0)))) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
529 (if (not (or (eq last-command 'comint-previous-similar-input) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
530 (eq last-command 'comint-next-similar-input))) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
531 (setq comint-last-similar-string |
584 | 532 (buffer-substring |
533 (process-mark (get-buffer-process (current-buffer))) | |
534 (point)))) | |
114 | 535 (let* ((size (length comint-last-similar-string)) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
536 (len (ring-length comint-input-ring)) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
537 (n (+ comint-input-ring-index arg)) |
114 | 538 entry) |
539 (while (and (< n len) | |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
540 (or (< (length (setq entry (ring-ref comint-input-ring n))) size) |
114 | 541 (not (equal comint-last-similar-string |
542 (substring entry 0 size))))) | |
543 (setq n (+ n arg))) | |
544 (cond ((< n len) | |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
545 (setq comint-input-ring-index n) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
546 (if (or (eq last-command 'comint-previous-similar-input) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
547 (eq last-command 'comint-next-similar-input)) |
584 | 548 (delete-region (mark) (point)) ; repeat |
549 (push-mark (point))) ; 1st time | |
114 | 550 (insert (substring entry size))) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
551 (t (error "Not found"))) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
552 (message "%d" (1+ comint-input-ring-index)))) |
584 | 553 |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
554 (defun comint-next-similar-input (arg) |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
555 "Fetch the next (newer) input that matches the string typed so far. |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
556 Successive repetitions find successively newer matching inputs. |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
557 A prefix argument serves as a repeat count; a negative argument |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
558 fetches previous (older) inputs." |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
559 (interactive "p") |
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
560 (comint-previous-similar-input (- arg))) |
114 | 561 |
584 | 562 (defun comint-send-input () |
1356 | 563 "Send input to process. |
564 After the process output mark, sends all text from the process mark to | |
565 point as input to the process. Before the process output mark, calls value | |
566 of variable comint-get-old-input to retrieve old input, copies it to the | |
567 process mark, and sends it. A terminal newline is also inserted into the | |
568 buffer and sent to the process. In either case, value of variable | |
569 comint-input-sentinel is called on the input before sending it. The input | |
570 is entered into the input history ring, if the value of variable | |
584 | 571 comint-input-filter returns non-nil when called on the input. |
114 | 572 |
584 | 573 If variable comint-eol-on-send is non-nil, then point is moved to the end of |
574 line before sending the input. | |
114 | 575 |
576 comint-get-old-input, comint-input-sentinel, and comint-input-filter are chosen | |
584 | 577 according to the command interpreter running in the buffer. E.g., |
114 | 578 If the interpreter is the csh, |
584 | 579 comint-get-old-input is the default: take the current line, discard any |
580 initial string matching regexp comint-prompt-regexp. | |
581 comint-input-sentinel monitors input for \"cd\", \"pushd\", and \"popd\" | |
582 commands. When it sees one, it cd's the buffer. | |
583 comint-input-filter is the default: returns T if the input isn't all white | |
584 space. | |
114 | 585 |
586 If the comint is Lucid Common Lisp, | |
584 | 587 comint-get-old-input snarfs the sexp ending at point. |
588 comint-input-sentinel does nothing. | |
589 comint-input-filter returns NIL if the input matches input-filter-regexp, | |
114 | 590 which matches (1) all whitespace (2) :a, :c, etc. |
591 | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
592 Similarly for Soar, Scheme, etc." |
114 | 593 (interactive) |
594 ;; Note that the input string does not include its terminal newline. | |
584 | 595 (let ((proc (get-buffer-process (current-buffer)))) |
596 (if (not proc) (error "Current buffer has no process") | |
597 (let* ((pmark (process-mark proc)) | |
598 (pmark-val (marker-position pmark)) | |
599 (input (if (>= (point) pmark-val) | |
600 (progn (if comint-eol-on-send (end-of-line)) | |
601 (buffer-substring pmark (point))) | |
705 | 602 (let ((copy (funcall comint-get-old-input))) |
603 (goto-char pmark) | |
604 (insert copy) | |
605 copy)))) | |
584 | 606 (insert ?\n) |
861
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
607 (if (funcall comint-input-filter input) |
345296f94a1e
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
608 (ring-insert comint-input-ring input)) |
584 | 609 (funcall comint-input-sentinel input) |
610 (funcall comint-input-sender proc input) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
611 (setq comint-input-ring-index nil) |
705 | 612 (set-marker comint-last-input-start pmark) |
613 (set-marker comint-last-input-end (point)) | |
614 (set-marker (process-mark proc) (point)))))) | |
114 | 615 |
616 (defun comint-get-old-input-default () | |
1356 | 617 "Default for comint-get-old-input. |
618 Take the current line, and discard any initial text matching | |
619 comint-prompt-regexp." | |
114 | 620 (save-excursion |
584 | 621 (beginning-of-line) |
622 (comint-skip-prompt) | |
623 (let ((beg (point))) | |
624 (end-of-line) | |
625 (buffer-substring beg (point))))) | |
626 | |
627 (defun comint-skip-prompt () | |
628 "Skip past the text matching regexp comint-prompt-regexp. | |
629 If this takes us past the end of the current line, don't skip at all." | |
630 (let ((eol (save-excursion (end-of-line) (point)))) | |
631 (if (and (looking-at comint-prompt-regexp) | |
632 (<= (match-end 0) eol)) | |
633 (goto-char (match-end 0))))) | |
634 | |
635 | |
636 (defun comint-after-pmark-p () | |
637 "Is point after the process output marker?" | |
638 ;; Since output could come into the buffer after we looked at the point | |
639 ;; but before we looked at the process marker's value, we explicitly | |
640 ;; serialise. This is just because I don't know whether or not emacs | |
641 ;; services input during execution of lisp commands. | |
642 (let ((proc-pos (marker-position | |
643 (process-mark (get-buffer-process (current-buffer)))))) | |
644 (<= proc-pos (point)))) | |
645 | |
646 (defun comint-simple-send (proc string) | |
647 "Default function for sending to PROC input STRING. | |
648 This just sends STRING plus a newline. To override this, | |
649 set the hook COMINT-INPUT-SENDER." | |
650 (comint-send-string proc string) | |
651 (comint-send-string proc "\n")) | |
114 | 652 |
653 (defun comint-bol (arg) | |
654 "Goes to the beginning of line, then skips past the prompt, if any. | |
584 | 655 If a prefix argument is given (\\[universal-argument]), then no prompt skip |
656 -- go straight to column 0. | |
114 | 657 |
584 | 658 The prompt skip is done by skipping text matching the regular expression |
659 comint-prompt-regexp, a buffer local variable. | |
660 | |
661 If you don't like this command, reset c-a to beginning-of-line | |
662 in your hook, comint-mode-hook." | |
114 | 663 (interactive "P") |
664 (beginning-of-line) | |
584 | 665 (if (null arg) (comint-skip-prompt))) |
114 | 666 |
667 ;;; These two functions are for entering text you don't want echoed or | |
668 ;;; saved -- typically passwords to ftp, telnet, or somesuch. | |
584 | 669 ;;; Just enter m-x send-invisible and type in your line. |
670 | |
705 | 671 (defun comint-read-noecho (prompt &optional stars) |
2455
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
672 "Read a single line of text from user without echoing, and return it. |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
673 Prompt with argument PROMPT, a string. Optional argument STARS causes |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
674 input to be echoed with '*' characters on the prompt line. Input ends with |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
675 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
676 inhibit-quit is set because e.g. this function was called from a process |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
677 filter and C-g is pressed, this function will return `nil', rather than a |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
678 string). |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
679 |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
680 Note that the keystrokes comprising the text can still be recovered |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
681 (temporarily) with \\[view-lossage]. This may be a security bug for some |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
682 applications." |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
683 (let ((ans "") |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
684 (c 0) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
685 (echo-keystrokes 0) |
705 | 686 (cursor-in-echo-area t) |
2455
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
687 (done nil)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
688 (while (not done) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
689 (if stars |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
690 (message "%s%s" prompt (make-string (length ans) ?*)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
691 (message prompt)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
692 (setq c (read-char)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
693 (cond ((= c ?\C-g) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
694 ;; This function may get called from a process filter, where |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
695 ;; inhibit-quit is set. In later versions of emacs read-char |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
696 ;; may clear quit-flag itself and return C-g. That would make |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
697 ;; it impossible to quit this loop in a simple way, so |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
698 ;; re-enable it here (for backward-compatibility the check for |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
699 ;; quit-flag below would still be necessary, so this is seems |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
700 ;; like the simplest way to do things). |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
701 (setq quit-flag t |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
702 done t)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
703 ((or (= c ?\r) (= c ?\n) (= c ?\e)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
704 (setq done t)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
705 ((= c ?\C-u) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
706 (setq ans "")) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
707 ((and (/= c ?\b) (/= c ?\177)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
708 (setq ans (concat ans (char-to-string c)))) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
709 ((> (length ans) 0) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
710 (setq ans (substring ans 0 -1))))) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
711 (if quit-flag |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
712 ;; Emulate a true quit, except that we have to return a value. |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
713 (prog1 |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
714 (setq quit-flag nil) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
715 (message "Quit") |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
716 (beep t)) |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
717 (message "") |
27d28402ee59
new comint-read-noecho.
Noah Friedman <friedman@splode.com>
parents:
2307
diff
changeset
|
718 ans))) |
705 | 719 |
114 | 720 (defun send-invisible (str) |
1356 | 721 "Read a string without echoing. |
722 Then send it to the process running in the current buffer. A new-line | |
723 is additionally sent. String is not saved on comint input history list. | |
584 | 724 Security bug: your string can still be temporarily recovered with |
725 \\[view-lossage]." | |
114 | 726 ; (interactive (list (comint-read-noecho "Enter non-echoed text"))) |
727 (interactive "P") ; Defeat snooping via C-x esc | |
728 (let ((proc (get-buffer-process (current-buffer)))) | |
729 (if (not proc) (error "Current buffer has no process") | |
730 (comint-send-string proc | |
731 (if (stringp str) str | |
705 | 732 (comint-read-noecho "Non-echoed text: " t))) |
114 | 733 (comint-send-string proc "\n")))) |
734 | |
735 | |
736 ;;; Low-level process communication | |
737 | |
738 (defvar comint-input-chunk-size 512 | |
739 "*Long inputs send to comint processes are broken up into chunks of this size. | |
740 If your process is choking on big inputs, try lowering the value.") | |
741 | |
742 (defun comint-send-string (proc str) | |
743 "Send PROCESS the contents of STRING as input. | |
744 This is equivalent to process-send-string, except that long input strings | |
745 are broken up into chunks of size comint-input-chunk-size. Processes | |
746 are given a chance to output between chunks. This can help prevent processes | |
747 from hanging when you send them long inputs on some OS's." | |
748 (let* ((len (length str)) | |
749 (i (min len comint-input-chunk-size))) | |
750 (process-send-string proc (substring str 0 i)) | |
751 (while (< i len) | |
752 (let ((next-i (+ i comint-input-chunk-size))) | |
753 (accept-process-output) | |
754 (process-send-string proc (substring str i (min len next-i))) | |
755 (setq i next-i))))) | |
756 | |
757 (defun comint-send-region (proc start end) | |
758 "Sends to PROC the region delimited by START and END. | |
759 This is a replacement for process-send-region that tries to keep | |
760 your process from hanging on long inputs. See comint-send-string." | |
761 (comint-send-string proc (buffer-substring start end))) | |
762 | |
763 | |
764 ;;; Random input hackage | |
765 | |
584 | 766 (defun comint-kill-output () |
114 | 767 "Kill all output from interpreter since last input." |
768 (interactive) | |
584 | 769 (let ((pmark (process-mark (get-buffer-process (current-buffer))))) |
770 (kill-region comint-last-input-end pmark) | |
771 (goto-char pmark) | |
772 (insert "*** output flushed ***\n") | |
773 (set-marker pmark (point)))) | |
114 | 774 |
775 (defun comint-show-output () | |
584 | 776 "Display start of this batch of interpreter output at top of window. |
777 Also put cursor there." | |
114 | 778 (interactive) |
779 (goto-char comint-last-input-end) | |
584 | 780 (backward-char) |
114 | 781 (beginning-of-line) |
782 (set-window-start (selected-window) (point)) | |
584 | 783 (end-of-line)) |
114 | 784 |
785 (defun comint-interrupt-subjob () | |
584 | 786 "Interrupt the current subjob." |
114 | 787 (interactive) |
584 | 788 (interrupt-process nil comint-ptyp)) |
114 | 789 |
790 (defun comint-kill-subjob () | |
584 | 791 "Send kill signal to the current subjob." |
114 | 792 (interactive) |
584 | 793 (kill-process nil comint-ptyp)) |
114 | 794 |
795 (defun comint-quit-subjob () | |
584 | 796 "Send quit signal to the current subjob." |
114 | 797 (interactive) |
584 | 798 (quit-process nil comint-ptyp)) |
114 | 799 |
800 (defun comint-stop-subjob () | |
584 | 801 "Stop the current subjob. |
114 | 802 WARNING: if there is no current subjob, you can end up suspending |
584 | 803 the top-level process running in the buffer. If you accidentally do |
804 this, use \\[comint-continue-subjob] to resume the process. (This | |
805 is not a problem with most shells, since they ignore this signal.)" | |
114 | 806 (interactive) |
584 | 807 (stop-process nil comint-ptyp)) |
114 | 808 |
809 (defun comint-continue-subjob () | |
584 | 810 "Send CONT signal to process buffer's process group. |
114 | 811 Useful if you accidentally suspend the top-level process." |
812 (interactive) | |
584 | 813 (continue-process nil comint-ptyp)) |
114 | 814 |
815 (defun comint-kill-input () | |
584 | 816 "Kill all text from last stuff output by interpreter to point." |
114 | 817 (interactive) |
584 | 818 (let* ((pmark (process-mark (get-buffer-process (current-buffer)))) |
819 (p-pos (marker-position pmark))) | |
820 (if (> (point) p-pos) | |
821 (kill-region pmark (point))))) | |
114 | 822 |
823 (defun comint-delchar-or-maybe-eof (arg) | |
824 "Delete ARG characters forward, or send an EOF to process if at end of buffer." | |
825 (interactive "p") | |
826 (if (eobp) | |
827 (process-send-eof) | |
584 | 828 (delete-char arg))) |
829 | |
830 | |
831 | |
114 | 832 |
833 ;;; Support for source-file processing commands. | |
834 ;;;============================================================================ | |
835 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have | |
836 ;;; commands that process files of source text (e.g. loading or compiling | |
837 ;;; files). So the corresponding process-in-a-buffer modes have commands | |
838 ;;; for doing this (e.g., lisp-load-file). The functions below are useful | |
839 ;;; for defining these commands. | |
840 ;;; | |
841 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme | |
842 ;;; and Soar, in that they don't know anything about file extensions. | |
843 ;;; So the compile/load interface gets the wrong default occasionally. | |
844 ;;; The load-file/compile-file default mechanism could be smarter -- it | |
845 ;;; doesn't know about the relationship between filename extensions and | |
846 ;;; whether the file is source or executable. If you compile foo.lisp | |
847 ;;; with compile-file, then the next load-file should use foo.bin for | |
848 ;;; the default, not foo.lisp. This is tricky to do right, particularly | |
849 ;;; because the extension for executable files varies so much (.o, .bin, | |
850 ;;; .lbin, .mo, .vo, .ao, ...). | |
851 | |
852 | |
853 ;;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing | |
854 ;;; commands. | |
855 ;;; | |
856 ;;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you | |
857 ;;; want to save the buffer before issuing any process requests to the command | |
858 ;;; interpreter. | |
859 ;;; | |
860 ;;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt | |
861 ;;; for the file to process. | |
862 | |
863 ;;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes) | |
864 ;;;============================================================================ | |
865 ;;; This function computes the defaults for the load-file and compile-file | |
584 | 866 ;;; commands for tea, soar, cmulisp, and cmuscheme modes. |
114 | 867 ;;; |
868 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last | |
869 ;;; source-file processing command. NIL if there hasn't been one yet. | |
870 ;;; - SOURCE-MODES is a list used to determine what buffers contain source | |
871 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source. | |
872 ;;; Typically, (lisp-mode) or (scheme-mode). | |
873 ;;; | |
874 ;;; If the command is given while the cursor is inside a string, *and* | |
875 ;;; the string is an existing filename, *and* the filename is not a directory, | |
876 ;;; then the string is taken as default. This allows you to just position | |
877 ;;; your cursor over a string that's a filename and have it taken as default. | |
878 ;;; | |
879 ;;; If the command is given in a file buffer whose major mode is in | |
880 ;;; SOURCE-MODES, then the the filename is the default file, and the | |
881 ;;; file's directory is the default directory. | |
882 ;;; | |
883 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer), | |
884 ;;; then the default directory & file are what was used in the last source-file | |
885 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time | |
886 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory | |
887 ;;; is the cwd, with no default file. (\"no default file\" = nil) | |
888 ;;; | |
889 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode) | |
890 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode) | |
891 ;;; for Soar programs, etc. | |
892 ;;; | |
893 ;;; The function returns a pair: (default-directory . default-file). | |
894 | |
895 (defun comint-source-default (previous-dir/file source-modes) | |
896 (cond ((and buffer-file-name (memq major-mode source-modes)) | |
897 (cons (file-name-directory buffer-file-name) | |
898 (file-name-nondirectory buffer-file-name))) | |
899 (previous-dir/file) | |
900 (t | |
901 (cons default-directory nil)))) | |
902 | |
584 | 903 |
114 | 904 ;;; (COMINT-CHECK-SOURCE fname) |
905 ;;;============================================================================ | |
584 | 906 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU |
114 | 907 ;;; process-in-a-buffer modes), this function can be called on the filename. |
908 ;;; If the file is loaded into a buffer, and the buffer is modified, the user | |
909 ;;; is queried to see if he wants to save the buffer before proceeding with | |
910 ;;; the load or compile. | |
911 | |
912 (defun comint-check-source (fname) | |
913 (let ((buff (get-file-buffer fname))) | |
914 (if (and buff | |
915 (buffer-modified-p buff) | |
916 (y-or-n-p (format "Save buffer %s first? " | |
917 (buffer-name buff)))) | |
918 ;; save BUFF. | |
919 (let ((old-buffer (current-buffer))) | |
920 (set-buffer buff) | |
921 (save-buffer) | |
922 (set-buffer old-buffer))))) | |
923 | |
584 | 924 |
114 | 925 ;;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p) |
926 ;;;============================================================================ | |
927 ;;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter | |
928 ;;; commands that process source files (like loading or compiling a file). | |
929 ;;; It prompts for the filename, provides a default, if there is one, | |
930 ;;; and returns the result filename. | |
931 ;;; | |
932 ;;; See COMINT-SOURCE-DEFAULT for more on determining defaults. | |
933 ;;; | |
934 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair | |
935 ;;; from the last source processing command. SOURCE-MODES is a list of major | |
936 ;;; modes used to determine what file buffers contain source files. (These | |
937 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true, | |
938 ;;; then the filename reader will only accept a file that exists. | |
939 ;;; | |
940 ;;; A typical use: | |
941 ;;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file | |
942 ;;; '(lisp-mode) t)) | |
943 | |
944 ;;; This is pretty stupid about strings. It decides we're in a string | |
945 ;;; if there's a quote on both sides of point on the current line. | |
946 (defun comint-extract-string () | |
1373 | 947 "Returns string around POINT that starts the current line or nil." |
114 | 948 (save-excursion |
949 (let* ((point (point)) | |
950 (bol (progn (beginning-of-line) (point))) | |
951 (eol (progn (end-of-line) (point))) | |
952 (start (progn (goto-char point) | |
953 (and (search-backward "\"" bol t) | |
954 (1+ (point))))) | |
955 (end (progn (goto-char point) | |
956 (and (search-forward "\"" eol t) | |
957 (1- (point)))))) | |
958 (and start end | |
959 (buffer-substring start end))))) | |
960 | |
961 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p) | |
962 (let* ((def (comint-source-default prev-dir/file source-modes)) | |
963 (stringfile (comint-extract-string)) | |
964 (sfile-p (and stringfile | |
584 | 965 (condition-case () |
966 (file-exists-p stringfile) | |
967 (error nil)) | |
114 | 968 (not (file-directory-p stringfile)))) |
969 (defdir (if sfile-p (file-name-directory stringfile) | |
970 (car def))) | |
971 (deffile (if sfile-p (file-name-nondirectory stringfile) | |
972 (cdr def))) | |
973 (ans (read-file-name (if deffile (format "%s(default %s) " | |
974 prompt deffile) | |
975 prompt) | |
976 defdir | |
977 (concat defdir deffile) | |
978 mustmatch-p))) | |
979 (list (expand-file-name (substitute-in-file-name ans))))) | |
980 | |
584 | 981 ;;; I am somewhat divided on this string-default feature. It seems |
982 ;;; to violate the principle-of-least-astonishment, in that it makes | |
983 ;;; the default harder to predict, so you actually have to look and see | |
984 ;;; what the default really is before choosing it. This can trip you up. | |
985 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback | |
986 ;;; on this. | |
987 ;;; -Olin | |
988 | |
114 | 989 |
990 ;;; Simple process query facility. | |
991 ;;; =========================================================================== | |
992 ;;; This function is for commands that want to send a query to the process | |
993 ;;; and show the response to the user. For example, a command to get the | |
994 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query | |
995 ;;; to an inferior Common Lisp process. | |
996 ;;; | |
997 ;;; This simple facility just sends strings to the inferior process and pops | |
998 ;;; up a window for the process buffer so you can see what the process | |
999 ;;; responds with. We don't do anything fancy like try to intercept what the | |
1000 ;;; process responds with and put it in a pop-up window or on the message | |
1001 ;;; line. We just display the buffer. Low tech. Simple. Works good. | |
1002 | |
1003 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select | |
1004 ;;; a window for the inferior process so that its response can be seen. | |
1005 (defun comint-proc-query (proc str) | |
1006 (let* ((proc-buf (process-buffer proc)) | |
1007 (proc-mark (process-mark proc))) | |
1008 (display-buffer proc-buf) | |
1009 (set-buffer proc-buf) ; but it's not the selected *window* | |
1010 (let ((proc-win (get-buffer-window proc-buf)) | |
1011 (proc-pt (marker-position proc-mark))) | |
1012 (comint-send-string proc str) ; send the query | |
1013 (accept-process-output proc) ; wait for some output | |
1014 ;; Try to position the proc window so you can see the answer. | |
1015 ;; This is bogus code. If you delete the (sit-for 0), it breaks. | |
1016 ;; I don't know why. Wizards invited to improve it. | |
1017 (if (not (pos-visible-in-window-p proc-pt proc-win)) | |
1018 (let ((opoint (window-point proc-win))) | |
1019 (set-window-point proc-win proc-mark) (sit-for 0) | |
1020 (if (not (pos-visible-in-window-p opoint proc-win)) | |
1021 (push-mark opoint) | |
1022 (set-window-point proc-win opoint))))))) | |
1023 | |
1024 | |
1025 ;;; Filename completion in a buffer | |
1026 ;;; =========================================================================== | |
1027 ;;; Useful completion functions, courtesy of the Ergo group. | |
1028 | |
1029 ;;; Three commands: | |
1030 ;;; comint-dynamic-complete Complete filename at point. | |
1031 ;;; comint-dynamic-list-completions List completions in help buffer. | |
1032 ;;; comint-replace-by-expanded-filename Expand and complete filename at point; | |
1033 ;;; replace with expanded/completed name. | |
1034 | |
1035 ;;; These are not installed in the comint-mode keymap. But they are | |
584 | 1036 ;;; available for people who want them. Shell-mode installs them: |
2518
10509afe2588
Clean up cmu* uses in header comments.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2455
diff
changeset
|
1037 ;;; (define-key shell-mode-map "\t" 'comint-dynamic-complete) |
10509afe2588
Clean up cmu* uses in header comments.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2455
diff
changeset
|
1038 ;;; (define-key shell-mode-map "\M-?" 'comint-dynamic-list-completions))) |
584 | 1039 ;;; |
1040 ;;; Commands like this are fine things to put in load hooks if you | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1041 ;;; want them present in specific modes. |
584 | 1042 |
114 | 1043 |
1044 (defun comint-match-partial-pathname () | |
584 | 1045 "Returns the filename at point or causes an error." |
1046 (save-excursion | |
1047 (if (re-search-backward "[^~/A-Za-z0-9---_.$#,=]" nil 'move) | |
1048 (forward-char 1)) | |
1049 ;; Anchor the search forwards. | |
1050 (if (not (looking-at "[~/A-Za-z0-9---_.$#,=]")) (error "")) | |
1051 (re-search-forward "[~/A-Za-z0-9---_.$#,=]+") | |
1052 (substitute-in-file-name | |
1053 (buffer-substring (match-beginning 0) (match-end 0))))) | |
1054 | |
114 | 1055 |
1056 (defun comint-replace-by-expanded-filename () | |
1356 | 1057 "Expand the filename at point. |
1058 Replace the filename with an expanded, canonicalised, and completed | |
1059 replacement. | |
114 | 1060 \"Expanded\" means environment variables (e.g., $HOME) and ~'s are |
1061 replaced with the corresponding directories. \"Canonicalised\" means .. | |
584 | 1062 and \. are removed, and the filename is made absolute instead of relative. |
1063 See functions expand-file-name and substitute-in-file-name. See also | |
114 | 1064 comint-dynamic-complete." |
1065 (interactive) | |
1066 (let* ((pathname (comint-match-partial-pathname)) | |
1067 (pathdir (file-name-directory pathname)) | |
1068 (pathnondir (file-name-nondirectory pathname)) | |
1069 (completion (file-name-completion pathnondir | |
1070 (or pathdir default-directory)))) | |
1071 (cond ((null completion) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1072 (message "No completions of %s" pathname) |
584 | 1073 (ding)) |
114 | 1074 ((eql completion t) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1075 (message "Unique completion")) |
114 | 1076 (t ; this means a string was returned. |
1077 (delete-region (match-beginning 0) (match-end 0)) | |
1078 (insert (expand-file-name (concat pathdir completion))))))) | |
1079 | |
584 | 1080 |
114 | 1081 (defun comint-dynamic-complete () |
584 | 1082 "Dynamically complete the filename at point. |
1373 | 1083 This function is similar to `comint-replace-by-expanded-filename', except |
114 | 1084 that it won't change parts of the filename already entered in the buffer; |
1085 it just adds completion characters to the end of the filename." | |
1086 (interactive) | |
1087 (let* ((pathname (comint-match-partial-pathname)) | |
1088 (pathdir (file-name-directory pathname)) | |
1089 (pathnondir (file-name-nondirectory pathname)) | |
584 | 1090 (completion (file-name-completion pathnondir |
114 | 1091 (or pathdir default-directory)))) |
1092 (cond ((null completion) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1093 (message "No completions of %s" pathname) |
584 | 1094 (ding)) |
114 | 1095 ((eql completion t) |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1096 (message "Unique completion")) |
114 | 1097 (t ; this means a string was returned. |
1098 (goto-char (match-end 0)) | |
1099 (insert (substring completion (length pathnondir))))))) | |
1100 | |
1101 (defun comint-dynamic-list-completions () | |
584 | 1102 "List in help buffer all possible completions of the filename at point." |
114 | 1103 (interactive) |
1104 (let* ((pathname (comint-match-partial-pathname)) | |
1105 (pathdir (file-name-directory pathname)) | |
1106 (pathnondir (file-name-nondirectory pathname)) | |
1107 (completions | |
1108 (file-name-all-completions pathnondir | |
1109 (or pathdir default-directory)))) | |
1110 (cond ((null completions) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1111 (message "No completions of %s" pathname) |
584 | 1112 (ding)) |
114 | 1113 (t |
1114 (let ((conf (current-window-configuration))) | |
584 | 1115 (with-output-to-temp-buffer "*Help*" |
114 | 1116 (display-completion-list completions)) |
1117 (sit-for 0) | |
909
4c6cdb66c74c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
870
diff
changeset
|
1118 (message "Hit space to flush") |
2022
9a765951a9b9
(comint-dynamic-list-completions): Handle any event when flushing the display.
Richard M. Stallman <rms@gnu.org>
parents:
1839
diff
changeset
|
1119 (let ((ch (read-event))) |
2025
3f02dc3e10a8
Fix bug in previous change.
Richard M. Stallman <rms@gnu.org>
parents:
2022
diff
changeset
|
1120 (if (eq ch ?\ ) |
114 | 1121 (set-window-configuration conf) |
2022
9a765951a9b9
(comint-dynamic-list-completions): Handle any event when flushing the display.
Richard M. Stallman <rms@gnu.org>
parents:
1839
diff
changeset
|
1122 (setq unread-command-events (list ch))))))))) |
114 | 1123 |
1124 ;;; Converting process modes to use comint mode | |
1125 ;;; =========================================================================== | |
768
4abf65b235d9
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
705
diff
changeset
|
1126 ;;; The code in the Emacs 19 distribution has all been modified to use comint |
4abf65b235d9
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
705
diff
changeset
|
1127 ;;; where needed. However, there are `third-party' packages out there that |
4abf65b235d9
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
705
diff
changeset
|
1128 ;;; still use the old shell mode. Here's a guide to conversion. |
584 | 1129 ;;; |
114 | 1130 ;;; Renaming variables |
584 | 1131 ;;; Most of the work is renaming variables and functions. These are the common |
1132 ;;; ones: | |
1133 ;;; Local variables: | |
705 | 1134 ;;; last-input-start comint-last-input-start |
584 | 1135 ;;; last-input-end comint-last-input-end |
1136 ;;; shell-prompt-pattern comint-prompt-regexp | |
1137 ;;; shell-set-directory-error-hook <no equivalent> | |
1138 ;;; Miscellaneous: | |
114 | 1139 ;;; shell-set-directory <unnecessary> |
1140 ;;; shell-mode-map comint-mode-map | |
584 | 1141 ;;; Commands: |
114 | 1142 ;;; shell-send-input comint-send-input |
1143 ;;; shell-send-eof comint-delchar-or-maybe-eof | |
1144 ;;; kill-shell-input comint-kill-input | |
1145 ;;; interrupt-shell-subjob comint-interrupt-subjob | |
1146 ;;; stop-shell-subjob comint-stop-subjob | |
1147 ;;; quit-shell-subjob comint-quit-subjob | |
1148 ;;; kill-shell-subjob comint-kill-subjob | |
1149 ;;; kill-output-from-shell comint-kill-output | |
1150 ;;; show-output-from-shell comint-show-output | |
1151 ;;; copy-last-shell-input Use comint-previous-input/comint-next-input | |
1152 ;;; | |
705 | 1153 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by |
1154 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-sentinel. | |
1155 ;;; Comint mode does not provide functionality equivalent to | |
114 | 1156 ;;; shell-set-directory-error-hook; it is gone. |
705 | 1157 ;;; |
1158 ;;; comint-last-input-start is provided for modes which want to munge | |
1159 ;;; the buffer after input is sent, perhaps because the inferior | |
1160 ;;; insists on echoing the input. The LAST-INPUT-START variable in | |
1161 ;;; the old shell package was used to implement a history mechanism, | |
1162 ;;; but you should think twice before using comint-last-input-start | |
1163 ;;; for this; the input history ring often does the job better. | |
114 | 1164 ;;; |
1165 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do | |
1166 ;;; *not* create the comint-mode local variables in your foo-mode function. | |
1167 ;;; This is not modular. Instead, call comint-mode, and let *it* create the | |
1168 ;;; necessary comint-specific local variables. Then create the | |
1169 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to | |
1170 ;;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks | |
1171 ;;; (comint-prompt-regexp, comint-input-filter, comint-input-sentinel, | |
1172 ;;; comint-get-old-input) that need to be different from the defaults. Call | |
1173 ;;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself; | |
2518
10509afe2588
Clean up cmu* uses in header comments.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2455
diff
changeset
|
1174 ;;; comint-mode will take care of it. The following example, from shell.el, |
584 | 1175 ;;; is typical: |
1176 ;;; | |
1177 ;;; (defun shell-mode () | |
1178 ;;; (interactive) | |
1179 ;;; (comint-mode) | |
1180 ;;; (setq comint-prompt-regexp shell-prompt-pattern) | |
1181 ;;; (setq major-mode 'shell-mode) | |
1182 ;;; (setq mode-name "Shell") | |
1183 ;;; (cond ((not shell-mode-map) | |
1184 ;;; (setq shell-mode-map (full-copy-sparse-keymap comint-mode-map)) | |
1185 ;;; (define-key shell-mode-map "\M-\t" 'comint-dynamic-complete) | |
1186 ;;; (define-key shell-mode-map "\M-?" | |
1187 ;;; 'comint-dynamic-list-completions))) | |
1188 ;;; (use-local-map shell-mode-map) | |
1189 ;;; (make-local-variable 'shell-directory-stack) | |
1190 ;;; (setq shell-directory-stack nil) | |
1191 ;;; (setq comint-input-sentinel 'shell-directory-tracker) | |
1192 ;;; (run-hooks 'shell-mode-hook)) | |
1193 ;;; | |
114 | 1194 ;;; |
1195 ;;; Note that make-comint is different from make-shell in that it | |
1196 ;;; doesn't have a default program argument. If you give make-shell | |
1197 ;;; a program name of NIL, it cleverly chooses one of explicit-shell-name, | |
1198 ;;; $ESHELL, $SHELL, or /bin/sh. If you give make-comint a program argument | |
1199 ;;; of NIL, it barfs. Adjust your code accordingly... | |
584 | 1200 ;;; |
1201 | |
1202 ;;; Do the user's customisation... | |
1203 | |
1204 (defvar comint-load-hook nil | |
1205 "This hook is run when comint is loaded in. | |
1206 This is a good place to put keybindings.") | |
1207 | |
1208 (run-hooks 'comint-load-hook) | |
1209 | |
1210 ;;; Change log: | |
1211 ;;; 9/12/89 | |
1212 ;;; - Souped up the filename expansion procedures. | |
1213 ;;; Doc strings are much clearer and more detailed. | |
1214 ;;; Fixed a bug where doing a filename completion when the point | |
1215 ;;; was in the middle of the filename instead of at the end would lose. | |
1216 ;;; | |
1217 ;;; 2/17/90 | |
1218 ;;; - Souped up the command history stuff so that text inserted | |
1219 ;;; by comint-previous-input-matching is removed by following | |
1220 ;;; command history recalls. comint-next/previous-input-matching | |
1221 ;;; is now much more smoothly integrated w/the command history stuff. | |
1222 ;;; - Added comint-eol-on-send flag and comint-input-sender hook. | |
1223 ;;; Comint-input-sender based on code contributed by Jeff Peck | |
1224 ;;; (peck@sun.com). | |
1225 ;;; | |
1226 ;;; 3/13/90 ccm@cmu.cs.edu | |
1227 ;;; - Added comint-previous-similar-input for looking up similar inputs. | |
1228 ;;; - Added comint-send-and-get-output to allow snarfing input from | |
1229 ;;; buffer. | |
1230 ;;; - Added the ability to pick up a source file by positioning over | |
1231 ;;; a string in comint-get-source. | |
1232 ;;; - Added add-hook to make it a little easier for the user to use | |
1233 ;;; multiple hooks. | |
1234 ;;; | |
1235 ;;; 5/22/90 shivers | |
1236 ;;; - Moved Chris' multiplexed ipc stuff to comint-ipc.el. | |
1237 ;;; - Altered Chris' comint-get-source string feature. The string | |
1238 ;;; is only offered as a default if it names an existing file. | |
1239 ;;; - Changed comint-exec to directly crank up the process, instead | |
1240 ;;; of calling the env program. This made background.el happy. | |
1241 ;;; - Added new buffer-local var comint-ptyp. The problem is that | |
1242 ;;; the signalling functions don't work as advertised. If you are | |
1243 ;;; communicating via pipes, the CURRENT-GROUP arg is supposed to | |
1244 ;;; be ignored, but, unfortunately it seems to be the case that you | |
1245 ;;; must pass a NIL for this arg in the pipe case. COMINT-PTYP | |
1246 ;;; is a flag that tells whether the process is communicating | |
1247 ;;; via pipes or a pty. The comint signalling functions use it | |
1248 ;;; to determine the necessary CURRENT-GROUP arg value. The bug | |
1249 ;;; has been reported to the Gnu folks. | |
1250 ;;; - comint-dynamic-complete flushes the help window if you hit space | |
1251 ;;; after you execute it. | |
1252 ;;; - Added functions comint-send-string, comint-send-region and var | |
1253 ;;; comint-input-chunk-size. comint-send-string tries to prevent processes | |
1254 ;;; from hanging when you send them long strings by breaking them into | |
1255 ;;; chunks and allowing process output between chunks. I got the idea from | |
1256 ;;; Eero Simoncelli's Common Lisp package. Note that using | |
1257 ;;; comint-send-string means that the process buffer's contents can change | |
1258 ;;; during a call! If you depend on process output only happening between | |
1259 ;;; toplevel commands, this could be a problem. In such a case, use | |
1260 ;;; process-send-string instead. If this is a problem for people, I'd like | |
1261 ;;; to hear about it. | |
1262 ;;; - Added comint-proc-query as a simple mechanism for commands that | |
1263 ;;; want to query an inferior process and display its response. For a | |
1264 ;;; typical use, see lisp-show-arglist in cmulisp.el. | |
1265 ;;; - Added constant comint-version, which is now "2.01". | |
1266 ;;; | |
1267 ;;; 6/14/90 shivers | |
1268 ;;; - Had comint-update-env defined twice. Removed extra copy. Also | |
1269 ;;; renamed mem to be comint-mem, for modularity. The duplication | |
1270 ;;; was reported by Michael Meissner. | |
1271 ;;; 6/16/90 shivers | |
1272 ;;; - Emacs has two different mechanisms for maintaining the process | |
1273 ;;; environment, determined at compile time by the MAINTAIN-ENVIRONMENT | |
1274 ;;; #define. One uses the process-environment global variable, and | |
1275 ;;; one uses a getenv/setenv interface. comint-exec assumed the | |
1276 ;;; process-environment interface; it has been generalised (with | |
1277 ;;; comint-exec-1) to handle both cases. Pretty bogus. We could, | |
1278 ;;; of course, skip all this and just use the etc/env program to | |
1279 ;;; handle the environment tweaking, but that obscures process | |
1280 ;;; queries that other modules (like background.el) depend on. etc/env | |
1281 ;;; is also fairly bogus. This bug, and some of the fix code was | |
1282 ;;; reported by Dan Pierson. | |
1283 ;;; | |
1284 ;;; 9/5/90 shivers | |
1285 ;;; - Changed make-variable-buffer-local's to make-local-variable's. | |
1286 ;;; This leaves non-comint-mode buffers alone. Stephane Payrard | |
1287 ;;; reported the sloppy useage. | |
1288 ;;; - You can now go from comint-previous-similar-input to | |
1289 ;;; comint-previous-input with no problem. | |
1290 ;;; | |
1291 ;;; 12/21/90 shivers | |
1292 ;;; - Added a condition-case to comint-get-source. Bogus strings | |
1293 ;;; beginning with ~ were making the file-exists-p barf. | |
1294 ;;; - Added "=" to the set of chars recognised by file completion | |
1295 ;;; as constituting a filename. | |
1296 ;;; | |
1297 ;;; 1/90 shivers | |
1298 ;;; These changes comprise release 2.02: | |
1299 ;;; - Removed the kill-all-local-variables in comint-mode. This | |
1300 ;;; made it impossible for client modes to set things before calling | |
1301 ;;; comint-mode. (In particular, it messed up ilisp.el) In general, | |
1302 ;;; the client mode should be responsible for a k-a-l-v's. | |
1303 ;;; - Fixed comint-match-partial-pathname so that it works in | |
1304 ;;; more cases: if the filename begins at the start-of-buffer; | |
1305 ;;; if point is on the first char of the filename. Just a question | |
1306 ;;; of getting the tricky bits right. | |
1307 ;;; - Added a hook, comint-exec-hook that is run each time a process | |
1308 ;;; is cranked up. Useful for things like process-kill-without-query. | |
1309 ;;; | |
705 | 1310 ;;; These two were pointed out by tale: |
584 | 1311 ;;; - Improved the doc string in comint-send-input a little bit. |
1312 ;;; - Tweaked make-comint to check process status with comint-check-proc | |
1313 ;;; instead of equivalent inline code. | |
705 | 1314 ;;; |
584 | 1315 ;;; - Prompt-search history commands have been commented out. I never |
1316 ;;; liked them; I don't think anyone used them. | |
705 | 1317 ;;; - Made comint-exec-hook a local var, as it should have been. |
2518
10509afe2588
Clean up cmu* uses in header comments.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2455
diff
changeset
|
1318 ;;; (This way, for instance, you can have shell procs kill-w/o-query, |
705 | 1319 ;;; but let Scheme procs be default.) |
1320 ;;; | |
1321 ;;; 7/91 Shivers | |
1322 ;;; - Souped up comint-read-noecho with an optional argument, STARS. | |
1323 ;;; Suggested by mjlx@EAGLE.CNSF.CORNELL.EDU. | |
1324 ;;; - Moved comint-previous-input-matching from C-c r to C-M-r. | |
1325 ;;; C-c <letter> bindings are reserved for the user. | |
1326 ;;; These bindings were done by Jim Blandy. | |
1327 ;;; These changes comprise version 2.03. | |
584 | 1328 |
1329 (provide 'comint) | |
662
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
638
diff
changeset
|
1330 |
8a533acedb77
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
638
diff
changeset
|
1331 ;;; comint.el ends here |