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