1 ;;; term.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Per Bothner <bothner@cygnus.com>
6 ;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 ;;; The changelog is at the end of this file.
29 ;;; Please send me bug reports, bug fixes, and extensions, so that I can
30 ;;; merge them into the master source.
31 ;;; - Per Bothner (bothner@cygnus.com)
33 ;;; This file defines a general command-interpreter-in-a-buffer package
34 ;;; (term mode). The idea is that you can build specific process-in-a-buffer
35 ;;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
36 ;;; This way, all these specific packages share a common base functionality,
37 ;;; and a common set of bindings, which makes them easier to use (and
38 ;;; saves code, implementation time, etc., etc.).
40 ;;; For hints on converting existing process modes (e.g., tex-mode,
41 ;;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
42 ;;; instead of shell-mode, see the notes at the end of this file.
45 ;;; Brief Command Documentation:
46 ;;;============================================================================
47 ;;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
50 ;;; m-p term-previous-input Cycle backwards in input history
51 ;;; m-n term-next-input Cycle forwards
52 ;;; m-r term-previous-matching-input Previous input matching a regexp
53 ;;; m-s comint-next-matching-input Next input that matches
54 ;;; return term-send-input
55 ;;; c-c c-a term-bol Beginning of line; skip prompt.
56 ;;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
57 ;;; c-c c-u term-kill-input ^u
58 ;;; c-c c-w backward-kill-word ^w
59 ;;; c-c c-c term-interrupt-subjob ^c
60 ;;; c-c c-z term-stop-subjob ^z
61 ;;; c-c c-\ term-quit-subjob ^\
62 ;;; c-c c-o term-kill-output Delete last batch of process output
63 ;;; c-c c-r term-show-output Show last batch of process output
64 ;;; c-c c-h term-dynamic-list-input-ring List input history
66 ;;; Not bound by default in term-mode
67 ;;; term-send-invisible Read a line w/o echo, and send to proc
68 ;;; (These are bound in shell-mode)
69 ;;; term-dynamic-complete Complete filename at point.
70 ;;; term-dynamic-list-completions List completions in help buffer.
71 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
72 ;;; replace with expanded/completed name.
73 ;;; term-kill-subjob No mercy.
74 ;;; term-show-maximum-output Show as much output as possible.
75 ;;; term-continue-subjob Send CONT signal to buffer's process
76 ;;; group. Useful if you accidentally
77 ;;; suspend your process (with C-c C-z).
79 ;;; term-mode-hook is the term mode hook. Basically for your keybindings.
80 ;;; term-load-hook is run after loading in this package.
84 ;;; This is passed to the inferior in the EMACS environment variable,
85 ;;; so it is important to increase it if there are protocol-relevant changes.
86 (defconst term-protocol-version
"0.95")
91 ;;; Buffer Local Variables:
92 ;;;============================================================================
93 ;;; Term mode buffer local variables:
94 ;;; term-prompt-regexp - string term-bol uses to match prompt.
95 ;;; term-delimiter-argument-list - list For delimiters and arguments
96 ;;; term-last-input-start - marker Handy if inferior always echoes
97 ;;; term-last-input-end - marker For term-kill-output command
98 ;; For the input history mechanism:
99 (defvar term-input-ring-size
32 "Size of input history ring.")
100 ;;; term-input-ring-size - integer
101 ;;; term-input-ring - ring
102 ;;; term-input-ring-index - number ...
103 ;;; term-input-autoexpand - symbol ...
104 ;;; term-input-ignoredups - boolean ...
105 ;;; term-last-input-match - string ...
106 ;;; term-dynamic-complete-functions - hook For the completion mechanism
107 ;;; term-completion-fignore - list ...
108 ;;; term-get-old-input - function Hooks for specific
109 ;;; term-input-filter-functions - hook process-in-a-buffer
110 ;;; term-input-filter - function modes.
111 ;;; term-input-send - function
112 ;;; term-scroll-to-bottom-on-output - symbol ...
113 ;;; term-scroll-show-maximum-output - boolean...
114 (defvar term-height
) ;; Number of lines in window.
115 (defvar term-width
) ;; Number of columns in window.
116 (defvar term-home-marker
) ;; Marks the "home" position for cursor addressing.
117 (defvar term-saved-home-marker nil
) ;; When using alternate sub-buffer,
118 ;; contains saved term-home-marker from original sub-buffer .
119 (defvar term-start-line-column
0) ;; (current-column) at start of screen line,
120 ;; or nil if unknown.
121 (defvar term-current-column
0) ;; If non-nil, is cache for (current-column).
122 (defvar term-current-row
0) ;; Current vertical row (relative to home-marker)
123 ;; or nil if unknown.
124 (defvar term-insert-mode nil
)
125 (defvar term-vertical-motion
)
126 (defvar term-terminal-state
0) ;; State of the terminal emulator:
127 ;; state 0: Normal state
128 ;; state 1: Last character was a graphic in the last column.
129 ;; If next char is graphic, first move one column right
130 ;; (and line warp) before displaying it.
131 ;; This emulates (more or less) the behavior of xterm.
133 ;; state 3: seen ESC [ (or ESC [ ?)
134 ;; state 4: term-terminal-parameter contains pending output.
135 (defvar term-kill-echo-list nil
) ;; A queue of strings whose echo
136 ;; we want suppressed.
137 (defvar term-terminal-parameter
)
138 (defvar term-terminal-previous-parameter
)
139 (defvar term-current-face
'default
)
140 (defvar term-scroll-start
0) ;; Top-most line (inclusive) of scrolling region.
141 (defvar term-scroll-end
) ;; Number of line (zero-based) after scrolling region.
142 (defvar term-pager-count nil
) ;; If nil, paging is disabled.
143 ;; Otherwise, number of lines before we need to page.
144 (defvar term-saved-cursor nil
)
145 (defvar term-command-hook
)
146 (defvar term-log-buffer nil
)
147 (defvar term-scroll-with-delete nil
) ;; term-scroll-with-delete is t if
148 ;; forward scrolling should be implemented by delete to
149 ;; top-most line(s); and nil if scrolling should be implemented
150 ;; by moving term-home-marker. It is set to t iff there is a
151 ;; (non-default) scroll-region OR the alternate buffer is used.
152 (defvar term-pending-delete-marker
) ;; New user input in line mode needs to
153 ;; be deleted, because it gets echoed by the inferior.
154 ;; To reduce flicker, we defer the delete until the next output.
155 (defvar term-old-mode-map nil
) ;; Saves the old keymap when in char mode.
156 (defvar term-old-mode-line-format
) ;; Saves old mode-line-format while paging.
157 (defvar term-pager-old-local-map nil
) ;; Saves old keymap while paging.
158 (defvar term-pager-old-filter
) ;; Saved process-filter while paging.
160 (defvar explicit-shell-file-name nil
161 "*If non-nil, is file name to use for explicitly requested inferior shell.")
163 (defvar term-prompt-regexp
"^"
164 "Regexp to recognise prompts in the inferior process.
165 Defaults to \"^\", the null string at BOL.
168 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
169 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
170 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
172 shell: \"^[^#$%>\\n]*[#$%>] *\"
175 This is a good thing to set in mode hooks.")
177 (defvar term-delimiter-argument-list
()
178 "List of characters to recognise as separate arguments in input.
179 Strings comprising a character in this list will separate the arguments
180 surrounding them, and also be regarded as arguments in their own right (unlike
181 whitespace). See `term-arguments'.
182 Defaults to the empty list.
184 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
186 This is a good thing to set in mode hooks.")
188 (defvar term-input-autoexpand nil
189 "*If non-nil, expand input command history references on completion.
190 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
192 If the value is `input', then the expansion is seen on input.
193 If the value is `history', then the expansion is only when inserting
194 into the buffer's input ring. See also `term-magic-space' and
195 `term-dynamic-complete'.
197 This variable is buffer-local.")
199 (defvar term-input-ignoredups nil
200 "*If non-nil, don't add input matching the last on the input ring.
201 This mirrors the optional behavior of bash.
203 This variable is buffer-local.")
205 (defvar term-input-ring-file-name nil
206 "*If non-nil, name of the file to read/write input history.
207 See also `term-read-input-ring' and `term-write-input-ring'.
209 This variable is buffer-local, and is a good thing to set in mode hooks.")
211 (defvar term-scroll-to-bottom-on-output nil
212 "*Controls whether interpreter output causes window to scroll.
213 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
214 If `this', scroll only the selected window.
215 If `others', scroll only those that are not the selected window.
219 See variable `term-scroll-show-maximum-output'.
220 This variable is buffer-local.")
222 (defvar term-scroll-show-maximum-output nil
223 "*Controls how interpreter output causes window to scroll.
224 If non-nil, then show the maximum output when the window is scrolled.
226 See variable `term-scroll-to-bottom-on-output'.
227 This variable is buffer-local.")
229 ;; Where gud-display-frame should put the debugging arrow. This is
230 ;; set by the marker-filter, which scans the debugger's output for
231 ;; indications of the current pc.
232 (defvar term-pending-frame nil
)
234 ;;; Here are the per-interpreter hooks.
235 (defvar term-get-old-input
(function term-get-old-input-default
)
236 "Function that submits old text in term mode.
237 This function is called when return is typed while the point is in old text.
238 It returns the text to be submitted as process input. The default is
239 term-get-old-input-default, which grabs the current line, and strips off
240 leading text matching term-prompt-regexp")
242 (defvar term-dynamic-complete-functions
243 '(term-replace-by-expanded-history term-dynamic-complete-filename
)
244 "List of functions called to perform completion.
245 Functions should return non-nil if completion was performed.
246 See also `term-dynamic-complete'.
248 This is a good thing to set in mode hooks.")
250 (defvar term-input-filter
251 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
252 "Predicate for filtering additions to input history.
253 Only inputs answering true to this function are saved on the input
254 history list. Default is to save anything that isn't all whitespace")
256 (defvar term-input-filter-functions
'()
257 "Functions to call before input is sent to the process.
258 These functions get one argument, a string containing the text to send.
260 This variable is buffer-local.")
262 (defvar term-input-sender
(function term-simple-send
)
263 "Function to actually send to PROCESS the STRING submitted by user.
264 Usually this is just 'term-simple-send, but if your mode needs to
265 massage the input string, this is your hook. This is called from
266 the user command term-send-input. term-simple-send just sends
267 the string plus a newline.")
269 (defvar term-eol-on-send t
270 "*Non-nil means go to the end of the line before sending input.
271 See `term-send-input'.")
273 (defvar term-mode-hook
'()
274 "Called upon entry into term-mode
275 This is run before the process is cranked up.")
277 (defvar term-exec-hook
'()
278 "Called each time a process is exec'd by term-exec.
279 This is called after the process is cranked up. It is useful for things that
280 must be done each time a process is executed in a term-mode buffer (e.g.,
281 (process-kill-without-query)). In contrast, the term-mode-hook is only
282 executed once when the buffer is created.")
284 (defvar term-mode-map nil
)
285 (defvar term-raw-map nil
286 "Keyboard map for sending characters directly to the inferior process.")
287 (defvar term-escape-char nil
288 "Escape character for char-sub-mode of term mode.
289 Do not change it directly; use term-set-escape-char instead.")
290 (defvar term-raw-escape-map nil
)
292 (defvar term-pager-break-map nil
)
295 "True if communications via pty; false if by pipe. Buffer local.
296 This is to work around a bug in emacs process signalling.")
298 (defvar term-last-input-match
""
299 "Last string searched for by term input history search, for defaulting.
300 Buffer local variable.")
302 (defvar term-input-ring nil
)
303 (defvar term-last-input-start
)
304 (defvar term-last-input-end
)
305 (defvar term-input-ring-index nil
306 "Index of last matched history element.")
307 (defvar term-matching-input-from-input-string
""
308 "Input previously used to match input history.")
309 ; This argument to set-process-filter disables reading from the process,
310 ; assuming this is emacs-19.20 or newer.
311 (defvar term-pager-filter t
)
313 (put 'term-replace-by-expanded-history
'menu-enable
'term-input-autoexpand
)
314 (put 'term-input-ring
'permanent-local t
)
315 (put 'term-input-ring-index
'permanent-local t
)
316 (put 'term-input-autoexpand
'permanent-local t
)
317 (put 'term-input-filter-functions
'permanent-local t
)
318 (put 'term-scroll-to-bottom-on-output
'permanent-local t
)
319 (put 'term-scroll-show-maximum-output
'permanent-local t
)
320 (put 'term-ptyp
'permanent-local t
)
322 ;; Do FORMS if running under Emacs-19.
323 (defmacro term-if-emacs19
(&rest forms
)
324 (if (string-match "^19" emacs-version
) (cons 'progn forms
)))
325 ;; True if running under XEmacs (previously Lucid emacs).
326 (defmacro term-is-xemacs
() '(string-match "Lucid" emacs-version
))
327 ;; Do FORM if running under XEmacs (previously Lucid emacs).
328 (defmacro term-if-xemacs
(&rest forms
)
329 (if (term-is-xemacs) (cons 'progn forms
)))
330 ;; Do FORM if NOT running under XEmacs (previously Lucid emacs).
331 (defmacro term-ifnot-xemacs
(&rest forms
)
332 (if (not (term-is-xemacs)) (cons 'progn forms
)))
334 (defmacro term-in-char-mode
() '(eq (current-local-map) term-raw-map
))
335 (defmacro term-in-line-mode
() '(not (term-in-char-mode)))
336 ;; True if currently doing PAGER handling.
337 (defmacro term-pager-enabled
() 'term-pager-count
)
338 (defmacro term-handling-pager
() 'term-pager-old-local-map
)
339 (defmacro term-using-alternate-sub-buffer
() 'term-saved-home-marker
)
341 (defvar term-signals-menu
)
342 (defvar term-terminal-menu
)
345 (defvar term-terminal-menu
347 [ "Character mode" term-char-mode
(term-in-line-mode)]
348 [ "Line mode" term-line-mode
(term-in-char-mode)]
349 [ "Enable paging" term-pager-toggle
(not term-pager-count
)]
350 [ "Disable paging" term-pager-toggle term-pager-count
])))
353 "Major mode for interacting with an inferior interpreter.
354 Interpreter name is same as buffer name, sans the asterisks.
355 In line sub-mode, return at end of buffer sends line as input,
356 while return not at end copies rest of line to end and sends it.
357 In char sub-mode, each character (except `term-escape-char`) is
360 This mode is typically customised to create inferior-lisp-mode,
361 shell-mode, etc.. This can be done by setting the hooks
362 term-input-filter-functions, term-input-filter, term-input-sender and
363 term-get-old-input to appropriate functions, and the variable
364 term-prompt-regexp to the appropriate regular expression.
366 An input history is maintained of size `term-input-ring-size', and
367 can be accessed with the commands \\[term-next-input], \\[term-previous-input], and \\[term-dynamic-list-input-ring].
368 Input ring history expansion can be achieved with the commands
369 \\[term-replace-by-expanded-history] or \\[term-magic-space].
370 Input ring expansion is controlled by the variable `term-input-autoexpand',
371 and addition is controlled by the variable `term-input-ignoredups'.
373 Input to, and output from, the subprocess can cause the window to scroll to
374 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
375 and `term-scroll-to-bottom-on-output'.
377 If you accidentally suspend your process, use \\[term-continue-subjob]
382 Entry to this mode runs the hooks on term-mode-hook"
384 ;; Do not remove this. All major modes must do this.
385 (kill-all-local-variables)
386 (setq major-mode
'term-mode
)
387 (setq mode-name
"Term")
388 (use-local-map term-mode-map
)
389 (make-local-variable 'term-home-marker
)
390 (setq term-home-marker
(copy-marker 0))
391 (make-local-variable 'term-saved-home-marker
)
392 (make-local-variable 'term-height
)
393 (make-local-variable 'term-width
)
394 (setq term-width
(1- (window-width)))
395 (setq term-height
(1- (window-height)))
396 (make-local-variable 'term-terminal-parameter
)
397 (make-local-variable 'term-saved-cursor
)
398 (make-local-variable 'term-last-input-start
)
399 (setq term-last-input-start
(make-marker))
400 (make-local-variable 'term-last-input-end
)
401 (setq term-last-input-end
(make-marker))
402 (make-local-variable 'term-last-input-match
)
403 (setq term-last-input-match
"")
404 (make-local-variable 'term-prompt-regexp
) ; Don't set; default
405 (make-local-variable 'term-input-ring-size
) ; ...to global val.
406 (make-local-variable 'term-input-ring
)
407 (make-local-variable 'term-input-ring-file-name
)
408 (or (and (boundp 'term-input-ring
) term-input-ring
)
409 (setq term-input-ring
(make-ring term-input-ring-size
)))
410 (make-local-variable 'term-input-ring-index
)
411 (or (and (boundp 'term-input-ring-index
) term-input-ring-index
)
412 (setq term-input-ring-index nil
))
414 (make-local-variable 'term-command-hook
)
415 (setq term-command-hook
(symbol-function 'term-command-hook
))
417 (make-local-variable 'term-terminal-state
)
418 (make-local-variable 'term-kill-echo-list
)
419 (make-local-variable 'term-start-line-column
)
420 (make-local-variable 'term-current-column
)
421 (make-local-variable 'term-current-row
)
422 (make-local-variable 'term-log-buffer
)
423 (make-local-variable 'term-scroll-start
)
424 (make-local-variable 'term-scroll-end
)
425 (setq term-scroll-end term-height
)
426 (make-local-variable 'term-scroll-with-delete
)
427 (make-local-variable 'term-pager-count
)
428 (make-local-variable 'term-pager-old-local-map
)
429 (make-local-variable 'term-old-mode-map
)
430 (make-local-variable 'term-insert-mode
)
431 (make-local-variable 'term-dynamic-complete-functions
)
432 (make-local-variable 'term-completion-fignore
)
433 (make-local-variable 'term-get-old-input
)
434 (make-local-variable 'term-matching-input-from-input-string
)
435 (make-local-variable 'term-input-autoexpand
)
436 (make-local-variable 'term-input-ignoredups
)
437 (make-local-variable 'term-delimiter-argument-list
)
438 (make-local-variable 'term-input-filter-functions
)
439 (make-local-variable 'term-input-filter
)
440 (make-local-variable 'term-input-sender
)
441 (make-local-variable 'term-eol-on-send
)
442 (make-local-variable 'term-scroll-to-bottom-on-output
)
443 (make-local-variable 'term-scroll-show-maximum-output
)
444 (make-local-variable 'term-ptyp
)
445 (make-local-variable 'term-exec-hook
)
446 (make-local-variable 'term-vertical-motion
)
447 (make-local-variable 'term-pending-delete-marker
)
448 (setq term-pending-delete-marker
(make-marker))
449 (make-local-variable 'term-current-face
)
450 (make-local-variable 'term-pending-frame
)
451 (setq term-pending-frame nil
)
452 (run-hooks 'term-mode-hook
)
455 (append current-menubar
(list term-terminal-menu
))))
457 (setq term-input-ring
(make-ring term-input-ring-size
)))
458 (term-update-mode-line))
462 (setq term-mode-map
(make-sparse-keymap))
463 (define-key term-mode-map
"\ep" 'term-previous-input
)
464 (define-key term-mode-map
"\en" 'term-next-input
)
465 (define-key term-mode-map
"\er" 'term-previous-matching-input
)
466 (define-key term-mode-map
"\es" 'term-next-matching-input
)
468 (define-key term-mode-map
[?\A-\M-r
] 'term-previous-matching-input-from-input
)
469 (define-key term-mode-map
[?\A-\M-s
] 'term-next-matching-input-from-input
))
470 (define-key term-mode-map
"\e\C-l" 'term-show-output
)
471 (define-key term-mode-map
"\C-m" 'term-send-input
)
472 (define-key term-mode-map
"\C-d" 'term-delchar-or-maybe-eof
)
473 (define-key term-mode-map
"\C-c\C-a" 'term-bol
)
474 (define-key term-mode-map
"\C-c\C-u" 'term-kill-input
)
475 (define-key term-mode-map
"\C-c\C-w" 'backward-kill-word
)
476 (define-key term-mode-map
"\C-c\C-c" 'term-interrupt-subjob
)
477 (define-key term-mode-map
"\C-c\C-z" 'term-stop-subjob
)
478 (define-key term-mode-map
"\C-c\C-\\" 'term-quit-subjob
)
479 (define-key term-mode-map
"\C-c\C-m" 'term-copy-old-input
)
480 (define-key term-mode-map
"\C-c\C-o" 'term-kill-output
)
481 (define-key term-mode-map
"\C-c\C-r" 'term-show-output
)
482 (define-key term-mode-map
"\C-c\C-e" 'term-show-maximum-output
)
483 (define-key term-mode-map
"\C-c\C-l" 'term-dynamic-list-input-ring
)
484 (define-key term-mode-map
"\C-c\C-n" 'term-next-prompt
)
485 (define-key term-mode-map
"\C-c\C-p" 'term-previous-prompt
)
486 (define-key term-mode-map
"\C-c\C-d" 'term-send-eof
)
487 (define-key term-mode-map
"\C-c\C-k" 'term-char-mode
)
488 (define-key term-mode-map
"\C-c\C-j" 'term-line-mode
)
489 (define-key term-mode-map
"\C-c\C-q" 'term-pager-toggle
)
491 (copy-face 'default
'term-underline-face
)
492 (set-face-underline-p 'term-underline-face t
)
495 ; (define-key term-mode-map [menu-bar completion]
496 ; (cons "Complete" (make-sparse-keymap "Complete")))
497 ; (define-key term-mode-map [menu-bar completion complete-expand]
498 ; '("Expand File Name" . term-replace-by-expanded-filename))
499 ; (define-key term-mode-map [menu-bar completion complete-listing]
500 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
501 ; (define-key term-mode-map [menu-bar completion complete-file]
502 ; '("Complete File Name" . term-dynamic-complete-filename))
503 ; (define-key term-mode-map [menu-bar completion complete]
504 ; '("Complete Before Point" . term-dynamic-complete))
505 ; ;; Put them in the menu bar:
506 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
507 ; menu-bar-final-items))
516 (setq newmap
(make-sparse-keymap "Terminal"))
517 (define-key newmap
[terminal-pager-enable
]
518 '("Enable paging" . term-fake-pager-enable
))
519 (define-key newmap
[terminal-pager-disable
]
520 '("Disable paging" . term-fake-pager-disable
))
521 (define-key newmap
[terminal-char-mode
]
522 '("Character mode" . term-char-mode
))
523 (define-key newmap
[terminal-line-mode
]
524 '("Line mode" . term-line-mode
))
525 (define-key newmap
[menu-bar terminal
]
526 (setq term-terminal-menu
(cons "Terminal" newmap
)))
528 ;; completion: (line mode only)
529 (defvar term-completion-menu
(make-sparse-keymap "Complete"))
530 (define-key term-mode-map
[menu-bar completion
]
531 (cons "Complete" term-completion-menu
))
532 (define-key term-completion-menu
[complete-expand
]
533 '("Expand File Name" . term-replace-by-expanded-filename
))
534 (define-key term-completion-menu
[complete-listing
]
535 '("File Completion Listing" . term-dynamic-list-filename-completions
))
536 (define-key term-completion-menu
[menu-bar completion complete-file
]
537 '("Complete File Name" . term-dynamic-complete-filename
))
538 (define-key term-completion-menu
[menu-bar completion complete
]
539 '("Complete Before Point" . term-dynamic-complete
))
541 ;; Input history: (line mode only)
542 (defvar term-inout-menu
(make-sparse-keymap "In/Out"))
543 (define-key term-mode-map
[menu-bar inout
]
544 (cons "In/Out" term-inout-menu
))
545 (define-key term-inout-menu
[kill-output
]
546 '("Kill Current Output Group" . term-kill-output
))
547 (define-key term-inout-menu
[next-prompt
]
548 '("Forward Output Group" . term-next-prompt
))
549 (define-key term-inout-menu
[previous-prompt
]
550 '("Backward Output Group" . term-previous-prompt
))
551 (define-key term-inout-menu
[show-maximum-output
]
552 '("Show Maximum Output" . term-show-maximum-output
))
553 (define-key term-inout-menu
[show-output
]
554 '("Show Current Output Group" . term-show-output
))
555 (define-key term-inout-menu
[kill-input
]
556 '("Kill Current Input" . term-kill-input
))
557 (define-key term-inout-menu
[copy-input
]
558 '("Copy Old Input" . term-copy-old-input
))
559 (define-key term-inout-menu
[forward-matching-history
]
560 '("Forward Matching Input..." . term-forward-matching-input
))
561 (define-key term-inout-menu
[backward-matching-history
]
562 '("Backward Matching Input..." . term-backward-matching-input
))
563 (define-key term-inout-menu
[next-matching-history
]
564 '("Next Matching Input..." . term-next-matching-input
))
565 (define-key term-inout-menu
[previous-matching-history
]
566 '("Previous Matching Input..." . term-previous-matching-input
))
567 (define-key term-inout-menu
[next-matching-history-from-input
]
568 '("Next Matching Current Input" . term-next-matching-input-from-input
))
569 (define-key term-inout-menu
[previous-matching-history-from-input
]
570 '("Previous Matching Current Input" . term-previous-matching-input-from-input
))
571 (define-key term-inout-menu
[next-history
]
572 '("Next Input" . term-next-input
))
573 (define-key term-inout-menu
[previous-history
]
574 '("Previous Input" . term-previous-input
))
575 (define-key term-inout-menu
[list-history
]
576 '("List Input History" . term-dynamic-list-input-ring
))
577 (define-key term-inout-menu
[expand-history
]
578 '("Expand History Before Point" . term-replace-by-expanded-history
))
581 (setq newmap
(make-sparse-keymap "Signals"))
582 (define-key newmap
[eof] '("EOF" . term-send-eof))
583 (define-key newmap [kill] '("KILL" . term-kill-subjob))
584 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
585 (define-key newmap [cont] '("CONT" . term-continue-subjob))
586 (define-key newmap [stop] '("STOP" . term-stop-subjob))
587 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
588 (define-key term-mode-map [menu-bar signals]
589 (setq term-signals-menu (cons "Signals" newmap)))
592 (defun term-reset-size (height width)
593 (setq term-height height)
594 (setq term-width width)
595 (setq term-start-line-column nil)
596 (setq term-current-row nil)
597 (setq term-current-column nil)
598 (term-scroll-region 0 height))
600 ;; Recursive routine used to check if any string in term-kill-echo-list
601 ;; matches part of the buffer before point.
602 ;; If so, delete that matched part of the buffer - this suppresses echo.
603 ;; Also, remove that string from the term-kill-echo-list.
604 ;; We *also* remove any older string on the list, as a sanity measure,
605 ;; in case something gets out of sync. (Except for type-ahead, there
606 ;; should only be one element in the list.)
608 (defun term-check-kill-echo-list ()
609 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
614 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
615 (if (and (>= start (point-min))
616 (string= str (buffer-substring start (point))))
617 (progn (delete-backward-char len)
618 (setq term-kill-echo-list (cdr cur))
619 (setq term-current-column nil)
620 (setq term-current-row nil)
621 (setq term-start-line-column nil)
622 (setq cur nil found t))
623 (setq cur (cdr cur))))))
625 (goto-char save-point)))
628 (defun term-check-size (process)
629 (if (or (/= term-height (1- (window-height)))
630 (/= term-width (1- (window-width))))
632 (term-reset-size (1- (window-height)) (1- (window-width)))
633 (set-process-window-size process term-height term-width))))
635 (defun term-send-raw-string (chars)
636 (let ((proc (get-buffer-process (current-buffer))))
638 (error "Current buffer has no process")
639 ;; Note that (term-current-row) must be called *after*
640 ;; (point) has been updated to (process-mark proc).
641 (goto-char (process-mark proc))
642 (if (term-pager-enabled)
643 (setq term-pager-count (term-current-row)))
644 (send-string proc chars))))
646 (defun term-send-raw ()
647 "Send the last character typed through the terminal-emulator
648 without any interpretation."
650 ;; Convert `return' to C-m, etc.
651 (if (and (symbolp last-input-char)
652 (get last-input-char 'ascii-character))
653 (setq last-input-char (get last-input-char 'ascii-character)))
654 (term-send-raw-string (make-string 1 last-input-char)))
656 (defun term-send-raw-meta ()
658 (if (symbolp last-input-char)
659 ;; Convert `return' to C-m, etc.
660 (let ((tmp (get last-input-char 'event-symbol-elements)))
662 (setq last-input-char (car tmp)))
663 (if (symbolp last-input-char)
665 (setq tmp (get last-input-char 'ascii-character))
666 (if tmp (setq last-input-char tmp))))))
667 (term-send-raw-string (if (and (numberp last-input-char)
668 (> last-input-char 127)
669 (< last-input-char 256))
670 (make-string 1 last-input-char)
671 (format "\e%c" last-input-char))))
673 (defun term-mouse-paste (click arg)
674 "Insert the last stretch of killed text at the position clicked on."
677 (term-send-raw-string (or (condition-case () (x-get-selection) (error ()))
679 (error "No selection or cut buffer available"))))
681 ;; Give temporary modes such as isearch a chance to turn off.
682 (run-hooks 'mouse-leave-buffer-hook)
683 (setq this-command 'yank)
684 (term-send-raw-string (current-kill (cond
689 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
690 (defun term-send-up () (interactive) (term-send-raw-string "\e[A"))
691 (defun term-send-down () (interactive) (term-send-raw-string "\e[B"))
692 (defun term-send-right () (interactive) (term-send-raw-string "\e[C"))
693 (defun term-send-left () (interactive) (term-send-raw-string "\e[D"))
695 (defun term-set-escape-char (c)
696 "Change term-escape-char and keymaps that depend on it."
698 (define-key term-raw-map term-escape-char 'term-send-raw))
699 (setq c (make-string 1 c))
700 (define-key term-raw-map c term-raw-escape-map)
701 ;; Define standard binings in term-raw-escape-map
702 (define-key term-raw-escape-map "\C-x"
703 (lookup-key (current-global-map) "\C-x"))
704 (define-key term-raw-escape-map "\C-v"
705 (lookup-key (current-global-map) "\C-v"))
706 (define-key term-raw-escape-map "\C-u"
707 (lookup-key (current-global-map) "\C-u"))
708 (define-key term-raw-escape-map c 'term-send-raw)
709 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
710 ;; The keybinding for term-char-mode is needed by the menubar code.
711 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
712 (define-key term-raw-escape-map "\C-j" 'term-line-mode))
714 (defun term-char-mode ()
715 "Switch to char (\"raw\") sub-mode of term mode.
716 Each character you type is sent directly to the inferior without
717 intervention from emacs, except for the escape character (usually C-c)."
719 (if (not term-raw-map)
720 (let* ((map (make-keymap))
721 (esc-map (make-keymap))
724 (define-key map (make-string 1 i) 'term-send-raw)
725 (define-key esc-map (make-string 1 i) 'term-send-raw-meta)
727 (define-key map "\e" esc-map)
728 (setq term-raw-map map)
729 (setq term-raw-escape-map
730 (copy-keymap (lookup-key (current-global-map) "\C-x")))
733 (define-key term-raw-map [button2] 'term-mouse-paste))
735 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
736 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
737 (define-key term-raw-map [menu-bar signals] term-signals-menu))
738 (define-key term-raw-map [up] 'term-send-up)
739 (define-key term-raw-map [down] 'term-send-down)
740 (define-key term-raw-map [right] 'term-send-right)
741 (define-key term-raw-map [left] 'term-send-left))
742 (term-set-escape-char ?\C-c)))
743 ;; FIXME: Emit message? Cfr ilisp-raw-message
744 (if (term-in-line-mode)
746 (setq term-old-mode-map (current-local-map))
747 (use-local-map term-raw-map)
749 ;; Send existing partial line to inferior (without newline).
750 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
751 (save-input-sender term-input-sender))
752 (if (> (point) pmark)
755 (setq term-input-sender
756 (symbol-function 'term-send-string))
759 (setq term-input-sender save-input-sender))))
760 (term-update-mode-line))))
762 (defun term-line-mode ()
763 "Switch to line (\"cooked\") sub-mode of term mode.
764 This means that emacs editing commands work as normally, until
765 you type \\[term-send-input] which sends the current line to the inferior."
767 (if (term-in-char-mode)
769 (use-local-map term-old-mode-map)
770 (term-update-mode-line))))
772 (defun term-update-mode-line ()
773 (setq mode-line-process
774 (if (term-in-char-mode)
775 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
776 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
777 (force-mode-line-update))
779 (defun term-check-proc (buffer)
780 "True if there is a process associated w/buffer BUFFER, and
781 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
783 (let ((proc (get-buffer-process buffer)))
784 (and proc (memq (process-status proc) '(run stop)))))
786 ;;; Note that this guy, unlike shell.el's make-shell, barfs if you pass it ()
787 ;;; for the second argument (program).
789 (defun make-term (name program &optional startfile &rest switches)
790 "Make a term process NAME in a buffer, running PROGRAM.
791 The name of the buffer is made by surrounding NAME with `*'s.
792 If there is already a running process in that buffer, it is not restarted.
793 Optional third arg STARTFILE is the name of a file to send the contents of to
794 the process. Any more args are arguments to PROGRAM."
795 (let ((buffer (get-buffer-create (concat "*" name "*"))))
796 ;; If no process, or nuked process, crank up a new one and put buffer in
797 ;; term mode. Otherwise, leave buffer and existing process alone.
798 (cond ((not (term-check-proc buffer))
801 (term-mode)) ; Install local vars, mode, keymap, ...
802 (term-exec buffer name program startfile switches)))
806 (defun term (program)
807 "Start a terminal-emulator in a new buffer."
808 (interactive (list (read-from-minibuffer "Run program: "
809 (or explicit-shell-file-name
813 (set-buffer (make-term "terminal" program))
816 (switch-to-buffer "*terminal*"))
818 (defun term-exec (buffer name command startfile switches)
819 "Start up a process in buffer for term modes.
820 Blasts any old process running in the buffer. Doesn't set the buffer mode.
821 You can use this to cheaply run a series of processes in the same term
822 buffer. The hook term-exec-hook is run after each exec."
825 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
826 (if proc (delete-process proc)))
827 ;; Crank up a new process
828 (let ((proc (term-exec-1 name buffer command switches)))
829 (make-local-variable 'term-ptyp)
830 (setq term-ptyp process-connection-type) ; T if pty, NIL if pipe.
831 ;; Jump to the end, and set the process mark.
832 (goto-char (point-max))
833 (set-marker (process-mark proc) (point))
834 (set-process-filter proc 'term-emulate-terminal)
835 ;; Feed it the startfile.
837 ;;This is guaranteed to wait long enough
838 ;;but has bad results if the term does not prompt at all
839 ;; (while (= size (buffer-size))
841 ;;I hope 1 second is enough!
843 (goto-char (point-max))
844 (insert-file-contents startfile)
845 (setq startfile (buffer-substring (point) (point-max)))
846 (delete-region (point) (point-max))
847 (term-send-string proc startfile)))
848 (run-hooks 'term-exec-hook)
851 ;;; Name to use for TERM.
852 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
853 (defvar term-term-name "eterm")
854 ; Format string, usage: (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
855 (defvar term-termcap-format
856 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
857 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
858 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=\\n\
859 :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
860 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
861 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
862 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC"
864 "termcap capabilties supported")
866 ;;; This auxiliary function cranks up the process for term-exec in
867 ;;; the appropriate environment.
869 (defun term-exec-1 (name buffer command switches)
870 ;; We need to do an extra (fork-less) exec to run stty.
871 ;; (This would not be needed if we had suitable emacs primitives.)
872 ;; The 'if ...; then shift; fi' hack is because Bourne shell
873 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
874 ;; Thus we add an extra dummy argument "..", and then remove it.
875 (let ((process-environment
878 (format "TERM=%s" term-term-name)
879 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
880 (format "TERMINFO=%s" data-directory)
881 (format term-termcap-format "TERMCAP="
882 term-term-name term-height term-width))
883 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
884 (format "LINES=%d" term-height)
885 (format "COLUMNS=%d" term-width))
886 process-environment)))
887 (apply 'start-process name buffer
889 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
890 if [ $1 = .. ]; then shift; fi; exec \"$@\""
891 term-height term-width)
895 ;;; This should be in emacs, but it isn't.
896 (defun term-mem (item list &optional elt=)
897 "Test to see if ITEM is equal to an item in LIST.
898 Option comparison function ELT= defaults to equal."
899 (let ((elt= (or elt= (function equal)))
901 (while (and list (not done))
902 (if (funcall elt= item (car list))
904 (setq list (cdr list))))
908 ;;; Input history processing in a buffer
909 ;;; ===========================================================================
910 ;;; Useful input history functions, courtesy of the Ergo group.
913 ;;; term-dynamic-list-input-ring List history in help buffer.
914 ;;; term-previous-input Previous input...
915 ;;; term-previous-matching-input ...matching a string.
916 ;;; term-previous-matching-input-from-input ... matching the current input.
917 ;;; term-next-input Next input...
918 ;;; term-next-matching-input ...matching a string.
919 ;;; term-next-matching-input-from-input ... matching the current input.
920 ;;; term-backward-matching-input Backwards input...
921 ;;; term-forward-matching-input ...matching a string.
922 ;;; term-replace-by-expanded-history Expand history at point;
923 ;;; replace with expanded history.
924 ;;; term-magic-space Expand history and insert space.
927 ;;; term-read-input-ring Read into term-input-ring...
928 ;;; term-write-input-ring Write to term-input-ring-file-name.
929 ;;; term-replace-by-expanded-history-before-point Workhorse function.
931 (defun term-read-input-ring (&optional silent)
932 "Sets the buffer's `term-input-ring' from a history file.
933 The name of the file is given by the variable `term-input-ring-file-name'.
934 The history ring is of size `term-input-ring-size', regardless of file size.
935 If `term-input-ring-file-name' is nil this function does nothing.
937 If the optional argument SILENT is non-nil, we say nothing about a
938 failure to read the history file.
940 This function is useful for major mode commands and mode hooks.
942 The structure of the history file should be one input command per line,
943 with the most recent command last.
944 See also `term-input-ignoredups' and `term-write-input-ring'."
945 (cond ((or (null term-input-ring-file-name)
946 (equal term-input-ring-file-name ""))
948 ((not (file-readable-p term-input-ring-file-name))
950 (message "Cannot read history file %s"
951 term-input-ring-file-name)))
953 (let ((history-buf (get-buffer-create " *temp*"))
954 (file term-input-ring-file-name)
956 (ring (make-ring term-input-ring-size)))
959 (set-buffer history-buf)
962 (insert-file-contents file)
963 ;; Save restriction in case file is already visited...
964 ;; Watch for those date stamps in history files!
965 (goto-char (point-max))
966 (while (and (< count term-input-ring-size)
967 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
969 (let ((history (buffer-substring (match-beginning 1)
971 (if (or (null term-input-ignoredups)
973 (not (string-equal (ring-ref ring 0) history)))
974 (ring-insert-at-beginning ring history)))
975 (setq count (1+ count))))
976 (kill-buffer history-buf))
977 (setq term-input-ring ring
978 term-input-ring-index nil)))))
980 (defun term-write-input-ring ()
981 "Writes the buffer's `term-input-ring' to a history file.
982 The name of the file is given by the variable `term-input-ring-file-name'.
983 The original contents of the file are lost if `term-input-ring' is not empty.
984 If `term-input-ring-file-name' is nil this function does nothing.
986 Useful within process sentinels.
988 See also `term-read-input-ring'."
989 (cond ((or (null term-input-ring-file-name)
990 (equal term-input-ring-file-name "")
991 (null term-input-ring) (ring-empty-p term-input-ring))
993 ((not (file-writable-p term-input-ring-file-name))
994 (message "Cannot write history file %s" term-input-ring-file-name))
996 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
997 (ring term-input-ring)
998 (file term-input-ring-file-name)
999 (index (ring-length ring)))
1000 ;; Write it all out into a buffer first. Much faster, but messier,
1001 ;; than writing it one line at a time.
1003 (set-buffer history-buf)
1006 (setq index (1- index))
1007 (insert (ring-ref ring index) ?\n))
1008 (write-region (buffer-string) nil file nil 'no-message)
1009 (kill-buffer nil))))))
1012 (defun term-dynamic-list-input-ring ()
1013 "List in help buffer the buffer's input history."
1015 (if (or (not (ring-p term-input-ring))
1016 (ring-empty-p term-input-ring))
1017 (message "No history")
1019 (history-buffer " *Input History*")
1020 (index (1- (ring-length term-input-ring)))
1021 (conf (current-window-configuration)))
1022 ;; We have to build up a list ourselves from the ring vector.
1024 (setq history (cons (ring-ref term-input-ring index) history)
1026 ;; Change "completion" to "history reference"
1027 ;; to make the display accurate.
1028 (with-output-to-temp-buffer history-buffer
1029 (display-completion-list history)
1030 (set-buffer history-buffer)
1032 (while (search-backward "completion" nil 'move)
1033 (replace-match "history reference")))
1035 (message "Hit space to flush")
1036 (let ((ch (read-event)))
1038 (set-window-configuration conf)
1039 (setq unread-command-events (list ch)))))))
1042 (defun term-regexp-arg (prompt)
1043 ;; Return list of regexp and prefix arg using PROMPT.
1044 (let* ((minibuffer-history-sexp-flag nil)
1045 ;; Don't clobber this.
1046 (last-command last-command)
1047 (regexp (read-from-minibuffer prompt nil nil nil
1048 'minibuffer-history-search-history)))
1049 (list (if (string-equal regexp "")
1050 (setcar minibuffer-history-search-history
1051 (nth 1 minibuffer-history-search-history))
1053 (prefix-numeric-value current-prefix-arg))))
1055 (defun term-search-arg (arg)
1056 ;; First make sure there is a ring and that we are after the process mark
1057 (cond ((not (term-after-pmark-p))
1058 (error "Not at command line"))
1059 ((or (null term-input-ring)
1060 (ring-empty-p term-input-ring))
1061 (error "Empty input ring"))
1063 ;; arg of zero resets search from beginning, and uses arg of 1
1064 (setq term-input-ring-index nil)
1069 (defun term-search-start (arg)
1070 ;; Index to start a directional search, starting at term-input-ring-index
1071 (if term-input-ring-index
1072 ;; If a search is running, offset by 1 in direction of arg
1073 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1074 (ring-length term-input-ring))
1075 ;; For a new search, start from beginning or end, as appropriate
1077 0 ; First elt for forward search
1078 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1080 (defun term-previous-input-string (arg)
1081 "Return the string ARG places along the input ring.
1082 Moves relative to `term-input-ring-index'."
1083 (ring-ref term-input-ring (if term-input-ring-index
1084 (mod (+ arg term-input-ring-index)
1085 (ring-length term-input-ring))
1088 (defun term-previous-input (arg)
1089 "Cycle backwards through input history."
1091 (term-previous-matching-input "." arg))
1093 (defun term-next-input (arg)
1094 "Cycle forwards through input history."
1096 (term-previous-input (- arg)))
1098 (defun term-previous-matching-input-string (regexp arg)
1099 "Return the string matching REGEXP ARG places along the input ring.
1100 Moves relative to `term-input-ring-index'."
1101 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1102 (if pos (ring-ref term-input-ring pos))))
1104 (defun term-previous-matching-input-string-position (regexp arg &optional start)
1105 "Return the index matching REGEXP ARG places along the input ring.
1106 Moves relative to START, or `term-input-ring-index'."
1107 (if (or (not (ring-p term-input-ring))
1108 (ring-empty-p term-input-ring))
1109 (error "No history"))
1110 (let* ((len (ring-length term-input-ring))
1111 (motion (if (> arg 0) 1 -1))
1112 (n (mod (- (or start (term-search-start arg)) motion) len))
1113 (tried-each-ring-item nil)
1115 ;; Do the whole search as many times as the argument says.
1116 (while (and (/= arg 0) (not tried-each-ring-item))
1119 n (mod (+ n motion) len))
1120 ;; If we haven't reached a match, step some more.
1121 (while (and (< n len) (not tried-each-ring-item)
1122 (not (string-match regexp (ring-ref term-input-ring n))))
1123 (setq n (mod (+ n motion) len)
1124 ;; If we have gone all the way around in this search.
1125 tried-each-ring-item (= n prev)))
1126 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1127 ;; Now that we know which ring element to use, if we found it, return that.
1128 (if (string-match regexp (ring-ref term-input-ring n))
1131 (defun term-previous-matching-input (regexp arg)
1132 "Search backwards through input history for match for REGEXP.
1133 \(Previous history elements are earlier commands.)
1134 With prefix argument N, search for Nth previous match.
1135 If N is negative, find the next or Nth next match."
1136 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1137 (setq arg (term-search-arg arg))
1138 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1139 ;; Has a match been found?
1142 (setq term-input-ring-index pos)
1143 (message "History item: %d" (1+ pos))
1145 ;; Can't use kill-region as it sets this-command
1146 (process-mark (get-buffer-process (current-buffer))) (point))
1147 (insert (ring-ref term-input-ring pos)))))
1149 (defun term-next-matching-input (regexp arg)
1150 "Search forwards through input history for match for REGEXP.
1151 \(Later history elements are more recent commands.)
1152 With prefix argument N, search for Nth following match.
1153 If N is negative, find the previous or Nth previous match."
1154 (interactive (term-regexp-arg "Next input matching (regexp): "))
1155 (term-previous-matching-input regexp (- arg)))
1157 (defun term-previous-matching-input-from-input (arg)
1158 "Search backwards through input history for match for current input.
1159 \(Previous history elements are earlier commands.)
1160 With prefix argument N, search for Nth previous match.
1161 If N is negative, search forwards for the -Nth following match."
1163 (if (not (memq last-command '(term-previous-matching-input-from-input
1164 term-next-matching-input-from-input)))
1165 ;; Starting a new search
1166 (setq term-matching-input-from-input-string
1168 (process-mark (get-buffer-process (current-buffer)))
1170 term-input-ring-index nil))
1171 (term-previous-matching-input
1172 (concat "^" (regexp-quote term-matching-input-from-input-string))
1175 (defun term-next-matching-input-from-input (arg)
1176 "Search forwards through input history for match for current input.
1177 \(Following history elements are more recent commands.)
1178 With prefix argument N, search for Nth following match.
1179 If N is negative, search backwards for the -Nth previous match."
1181 (term-previous-matching-input-from-input (- arg)))
1184 (defun term-replace-by-expanded-history (&optional silent)
1185 "Expand input command history references before point.
1186 Expansion is dependent on the value of `term-input-autoexpand'.
1188 This function depends on the buffer's idea of the input history, which may not
1189 match the command interpreter's idea, assuming it has one.
1191 Assumes history syntax is like typical Un*x shells'. However, since emacs
1192 cannot know the interpreter's idea of input line numbers, assuming it has one,
1193 it cannot expand absolute input line number references.
1195 If the optional argument SILENT is non-nil, never complain
1196 even if history reference seems erroneous.
1198 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1200 Returns t if successful."
1202 (if (and term-input-autoexpand
1203 (string-match "[!^]" (funcall term-get-old-input))
1204 (save-excursion (beginning-of-line)
1205 (looking-at term-prompt-regexp)))
1206 ;; Looks like there might be history references in the command.
1207 (let ((previous-modified-tick (buffer-modified-tick)))
1208 (message "Expanding history references...")
1209 (term-replace-by-expanded-history-before-point silent)
1210 (/= previous-modified-tick (buffer-modified-tick)))))
1213 (defun term-replace-by-expanded-history-before-point (silent)
1214 "Expand directory stack reference before point.
1215 See `term-replace-by-expanded-history'. Returns t if successful."
1217 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1218 (start (progn (term-bol nil) (point))))
1220 (skip-chars-forward "^!^"
1222 (end-of-line nil) (- (point) toend)))
1225 (end-of-line nil) (- (point) toend))))
1226 ;; This seems a bit complex. We look for references such as !!, !-num,
1227 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1228 ;; If that wasn't enough, the plings can be suffixed with argument
1229 ;; range specifiers.
1230 ;; Argument ranges are complex too, so we hive off the input line,
1231 ;; referenced with plings, with the range string to `term-args'.
1232 (setq term-input-ring-index nil)
1233 (cond ((or (= (preceding-char) ?\\)
1234 (term-within-quotes start (point)))
1235 ;; The history is quoted, or we're in quotes.
1236 (goto-char (1+ (point))))
1237 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1238 ;; We cannot know the interpreter's idea of input line numbers.
1239 (goto-char (match-end 0))
1240 (message "Absolute reference cannot be expanded"))
1241 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1242 ;; Just a number of args from `number' lines backward.
1243 (let ((number (1- (string-to-number
1244 (buffer-substring (match-beginning 1)
1246 (if (<= number (ring-length term-input-ring))
1249 (term-args (term-previous-input-string number)
1250 (match-beginning 2) (match-end 2))
1252 (setq term-input-ring-index number)
1253 (message "History item: %d" (1+ number)))
1254 (goto-char (match-end 0))
1255 (message "Relative reference exceeds input history size"))))
1256 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1257 ;; Just a number of args from the previous input line.
1259 (term-args (term-previous-input-string 0)
1260 (match-beginning 1) (match-end 1))
1262 (message "History item: previous"))
1264 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1265 ;; Most recent input starting with or containing (possibly
1266 ;; protected) string, maybe just a number of args. Phew.
1267 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1268 (mb2 (match-beginning 2)) (me2 (match-end 2))
1269 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1270 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1271 (pos (save-match-data
1272 (term-previous-matching-input-string-position
1273 (concat pref (regexp-quote exp)) 1))))
1276 (goto-char (match-end 0))
1278 (progn (message "Not found")
1280 (setq term-input-ring-index pos)
1282 (term-args (ring-ref term-input-ring pos)
1283 (match-beginning 4) (match-end 4))
1285 (message "History item: %d" (1+ pos)))))
1286 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1287 ;; Quick substitution on the previous input line.
1288 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1289 (new (buffer-substring (match-beginning 2) (match-end 2)))
1291 (replace-match (term-previous-input-string 0) t t)
1293 (goto-char (match-beginning 0))
1294 (if (not (search-forward old pos t))
1296 (error "Not found"))
1297 (replace-match new t t)
1298 (message "History item: substituted"))))
1300 (goto-char (match-end 0))))))))
1303 (defun term-magic-space (arg)
1304 "Expand input history references before point and insert ARG spaces.
1305 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1307 (term-replace-by-expanded-history)
1308 (self-insert-command arg))
1310 (defun term-within-quotes (beg end)
1311 "Return t if the number of quotes between BEG and END is odd.
1312 Quotes are single and double."
1313 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1314 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1315 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1317 (defun term-how-many-region (regexp beg end)
1318 "Return number of matches for REGEXP from BEG to END."
1323 (while (re-search-forward regexp end t)
1324 (setq count (1+ count)))))
1327 (defun term-args (string begin end)
1328 ;; From STRING, return the args depending on the range specified in the text
1329 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1330 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1333 (term-arguments string 0 nil)
1334 (let* ((range (buffer-substring
1335 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1336 (nth (cond ((string-match "^[*^]" range) 1)
1337 ((string-match "^-" range) 0)
1338 ((string-equal range "$") nil)
1339 (t (string-to-number range))))
1340 (mth (cond ((string-match "[-*$]$" range) nil)
1341 ((string-match "-" range)
1342 (string-to-number (substring range (match-end 0))))
1344 (term-arguments string nth mth)))))
1346 ;; Return a list of arguments from ARG. Break it up at the
1347 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1348 (defun term-delim-arg (arg)
1349 (if (null term-delimiter-argument-list)
1355 (let ((char (aref arg pos))
1357 (if (memq char term-delimiter-argument-list)
1358 (while (and (< pos len) (eq (aref arg pos) char))
1359 (setq pos (1+ pos)))
1360 (while (and (< pos len)
1361 (not (memq (aref arg pos)
1362 term-delimiter-argument-list)))
1363 (setq pos (1+ pos))))
1364 (setq args (cons (substring arg start pos) args))))
1367 (defun term-arguments (string nth mth)
1368 "Return from STRING the NTH to MTH arguments.
1369 NTH and/or MTH can be nil, which means the last argument.
1370 Returned arguments are separated by single spaces.
1371 We assume whitespace separates arguments, except within quotes.
1372 Also, a run of one or more of a single character
1373 in `term-delimiter-argument-list' is a separate argument.
1374 Argument 0 is the command name."
1375 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1378 beg str value quotes)
1379 ;; Build a list of all the args until we have as many as we want.
1380 (while (and (or (null mth) (<= count mth))
1381 (string-match argpart string pos))
1382 (if (and beg (= pos (match-beginning 0)))
1383 ;; It's contiguous, part of the same arg.
1384 (setq pos (match-end 0)
1385 quotes (or quotes (match-beginning 1)))
1386 ;; It's a new separate arg.
1388 ;; Put the previous arg, if there was one, onto ARGS.
1389 (setq str (substring string beg pos)
1390 args (if quotes (cons str args)
1391 (nconc (term-delim-arg str) args))
1393 (setq quotes (match-beginning 1))
1394 (setq beg (match-beginning 0))
1395 (setq pos (match-end 0))))
1397 (setq str (substring string beg pos)
1398 args (if quotes (cons str args)
1399 (nconc (term-delim-arg str) args))
1401 (let ((n (or nth (1- count)))
1402 (m (if mth (1- (- count mth)) 0)))
1404 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1407 ;;; Input processing stuff [line mode]
1410 (defun term-send-input ()
1411 "Send input to process.
1412 After the process output mark, sends all text from the process mark to
1413 point as input to the process. Before the process output mark, calls value
1414 of variable term-get-old-input to retrieve old input, copies it to the
1415 process mark, and sends it. A terminal newline is also inserted into the
1416 buffer and sent to the process. The list of function names contained in the
1417 value of `term-input-filter-functions' is called on the input before sending
1418 it. The input is entered into the input history ring, if the value of variable
1419 term-input-filter returns non-nil when called on the input.
1421 Any history reference may be expanded depending on the value of the variable
1422 `term-input-autoexpand'. The list of function names contained in the value
1423 of `term-input-filter-functions' is called on the input before sending it.
1424 The input is entered into the input history ring, if the value of variable
1425 `term-input-filter' returns non-nil when called on the input.
1427 If variable `term-eol-on-send' is non-nil, then point is moved to the
1428 end of line before sending the input.
1430 The values of `term-get-old-input', `term-input-filter-functions', and
1431 `term-input-filter' are chosen according to the command interpreter running
1432 in the buffer. E.g.,
1434 If the interpreter is the csh,
1435 term-get-old-input is the default: take the current line, discard any
1436 initial string matching regexp term-prompt-regexp.
1437 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
1438 \"popd\" commands. When it sees one, it cd's the buffer.
1439 term-input-filter is the default: returns T if the input isn't all white
1442 If the term is Lucid Common Lisp,
1443 term-get-old-input snarfs the sexp ending at point.
1444 term-input-filter-functions does nothing.
1445 term-input-filter returns NIL if the input matches input-filter-regexp,
1446 which matches (1) all whitespace (2) :a, :c, etc.
1448 Similarly for Soar, Scheme, etc."
1450 ;; Note that the input string does not include its terminal newline.
1451 (let ((proc (get-buffer-process (current-buffer))))
1452 (if (not proc) (error "Current buffer has no process")
1453 (let* ((pmark (process-mark proc))
1454 (pmark-val (marker-position pmark))
1455 (input-is-new (>= (point) pmark-val))
1456 (intxt (if input-is-new
1457 (progn (if term-eol-on-send (end-of-line))
1458 (buffer-substring pmark (point)))
1459 (funcall term-get-old-input)))
1460 (input (if (not (eq term-input-autoexpand 'input))
1461 ;; Just whatever's already there
1463 ;; Expand and leave it visible in buffer
1464 (term-replace-by-expanded-history t)
1465 (buffer-substring pmark (point))))
1466 (history (if (not (eq term-input-autoexpand 'history))
1468 ;; This is messy 'cos ultimately the original
1469 ;; functions used do insertion, rather than return
1470 ;; strings. We have to expand, then insert back.
1471 (term-replace-by-expanded-history t)
1472 (let ((copy (buffer-substring pmark (point))))
1473 (delete-region pmark (point))
1476 (if (term-pager-enabled)
1478 (goto-char (process-mark proc))
1479 (setq term-pager-count (term-current-row))))
1480 (if (and (funcall term-input-filter history)
1481 (or (null term-input-ignoredups)
1482 (not (ring-p term-input-ring))
1483 (ring-empty-p term-input-ring)
1484 (not (string-equal (ring-ref term-input-ring 0)
1486 (ring-insert term-input-ring history))
1487 (let ((functions term-input-filter-functions))
1489 (funcall (car functions) (concat input "\n"))
1490 (setq functions (cdr functions))))
1491 (setq term-input-ring-index nil)
1493 ;; Update the markers before we send the input
1494 ;; in case we get output amidst sending the input.
1495 (set-marker term-last-input-start pmark)
1496 (set-marker term-last-input-end (point))
1499 ;; Set up to delete, because inferior should echo.
1500 (if (marker-buffer term-pending-delete-marker)
1501 (delete-region term-pending-delete-marker pmark))
1502 (set-marker term-pending-delete-marker pmark-val)
1503 (set-marker (process-mark proc) (point))))
1505 (funcall term-input-sender proc input)))))
1507 (defun term-get-old-input-default ()
1508 "Default for term-get-old-input.
1509 Take the current line, and discard any initial text matching
1510 term-prompt-regexp."
1514 (let ((beg (point)))
1516 (buffer-substring beg (point)))))
1518 (defun term-copy-old-input ()
1519 "Insert after prompt old input at point as new input to be edited.
1520 Calls `term-get-old-input' to get old input."
1522 (let ((input (funcall term-get-old-input))
1523 (process (get-buffer-process (current-buffer))))
1525 (error "Current buffer has no process")
1526 (goto-char (process-mark process))
1529 (defun term-skip-prompt ()
1530 "Skip past the text matching regexp term-prompt-regexp.
1531 If this takes us past the end of the current line, don't skip at all."
1532 (let ((eol (save-excursion (end-of-line) (point))))
1533 (if (and (looking-at term-prompt-regexp)
1534 (<= (match-end 0) eol))
1535 (goto-char (match-end 0)))))
1538 (defun term-after-pmark-p ()
1539 "Is point after the process output marker?"
1540 ;; Since output could come into the buffer after we looked at the point
1541 ;; but before we looked at the process marker's value, we explicitly
1542 ;; serialise. This is just because I don't know whether or not emacs
1543 ;; services input during execution of lisp commands.
1544 (let ((proc-pos (marker-position
1545 (process-mark (get-buffer-process (current-buffer))))))
1546 (<= proc-pos (point))))
1548 (defun term-simple-send (proc string)
1549 "Default function for sending to PROC input STRING.
1550 This just sends STRING plus a newline. To override this,
1551 set the hook TERM-INPUT-SENDER."
1552 (term-send-string proc string)
1553 (term-send-string proc "\n"))
1555 (defun term-bol (arg)
1556 "Goes to the beginning of line, then skips past the prompt, if any.
1557 If a prefix argument is given (\\[universal-argument]), then no prompt skip
1558 -- go straight to column 0.
1560 The prompt skip is done by skipping text matching the regular expression
1561 term-prompt-regexp, a buffer local variable."
1564 (if (null arg) (term-skip-prompt)))
1566 ;;; These two functions are for entering text you don't want echoed or
1567 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
1568 ;;; Just enter m-x term-send-invisible and type in your line.
1570 (defun term-read-noecho (prompt &optional stars)
1571 "Read a single line of text from user without echoing, and return it.
1572 Prompt with argument PROMPT, a string. Optional argument STARS causes
1573 input to be echoed with '*' characters on the prompt line. Input ends with
1574 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1575 `inhibit-quit' is set because e.g. this function was called from a process
1576 filter and C-g is pressed, this function returns nil rather than a string).
1578 Note that the keystrokes comprising the text can still be recovered
1579 \(temporarily) with \\[view-lossage]. This may be a security bug for some
1584 (cursor-in-echo-area t)
1588 (message "%s%s" prompt (make-string (length ans) ?*))
1590 (setq c (read-char))
1592 ;; This function may get called from a process filter, where
1593 ;; inhibit-quit is set. In later versions of emacs read-char
1594 ;; may clear quit-flag itself and return C-g. That would make
1595 ;; it impossible to quit this loop in a simple way, so
1596 ;; re-enable it here (for backward-compatibility the check for
1597 ;; quit-flag below would still be necessary, so this seems
1598 ;; like the simplest way to do things).
1601 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1605 ((and (/= c ?\b) (/= c ?\177))
1606 (setq ans (concat ans (char-to-string c))))
1608 (setq ans (substring ans 0 -1)))))
1610 ;; Emulate a true quit, except that we have to return a value.
1612 (setq quit-flag nil)
1618 (defun term-send-invisible (str &optional proc)
1619 "Read a string without echoing.
1620 Then send it to the process running in the current buffer. A new-line
1621 is additionally sent. String is not saved on term input history list.
1622 Security bug: your string can still be temporarily recovered with
1624 (interactive "P") ; Defeat snooping via C-x esc
1625 (if (not (stringp str))
1626 (setq str (term-read-noecho "Non-echoed text: " t)))
1628 (setq proc (get-buffer-process (current-buffer))))
1629 (if (not proc) (error "Current buffer has no process")
1630 (setq term-kill-echo-list (nconc term-kill-echo-list
1632 (term-send-string proc str)
1633 (term-send-string proc "\n")))
1636 ;;; Low-level process communication
1638 (defvar term-input-chunk-size 512
1639 "*Long inputs send to term processes are broken up into chunks of this size.
1640 If your process is choking on big inputs, try lowering the value.")
1642 (defun term-send-string (proc str)
1643 "Send PROCESS the contents of STRING as input.
1644 This is equivalent to process-send-string, except that long input strings
1645 are broken up into chunks of size term-input-chunk-size. Processes
1646 are given a chance to output between chunks. This can help prevent processes
1647 from hanging when you send them long inputs on some OS's."
1648 (let* ((len (length str))
1649 (i (min len term-input-chunk-size)))
1650 (process-send-string proc (substring str 0 i))
1652 (let ((next-i (+ i term-input-chunk-size)))
1653 (accept-process-output)
1654 (process-send-string proc (substring str i (min len next-i)))
1657 (defun term-send-region (proc start end)
1658 "Sends to PROC the region delimited by START and END.
1659 This is a replacement for process-send-region that tries to keep
1660 your process from hanging on long inputs. See term-send-string."
1661 (term-send-string proc (buffer-substring start end)))
1664 ;;; Random input hackage
1666 (defun term-kill-output ()
1667 "Kill all output from interpreter since last input."
1669 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1670 (kill-region term-last-input-end pmark)
1672 (insert "*** output flushed ***\n")
1673 (set-marker pmark (point))))
1675 (defun term-show-output ()
1676 "Display start of this batch of interpreter output at top of window.
1677 Sets mark to the value of point when this command is run."
1679 (goto-char term-last-input-end)
1682 (set-window-start (selected-window) (point))
1685 (defun term-interrupt-subjob ()
1686 "Interrupt the current subjob."
1688 (interrupt-process nil term-ptyp))
1690 (defun term-kill-subjob ()
1691 "Send kill signal to the current subjob."
1693 (kill-process nil term-ptyp))
1695 (defun term-quit-subjob ()
1696 "Send quit signal to the current subjob."
1698 (quit-process nil term-ptyp))
1700 (defun term-stop-subjob ()
1701 "Stop the current subjob.
1702 WARNING: if there is no current subjob, you can end up suspending
1703 the top-level process running in the buffer. If you accidentally do
1704 this, use \\[term-continue-subjob] to resume the process. (This
1705 is not a problem with most shells, since they ignore this signal.)"
1707 (stop-process nil term-ptyp))
1709 (defun term-continue-subjob ()
1710 "Send CONT signal to process buffer's process group.
1711 Useful if you accidentally suspend the top-level process."
1713 (continue-process nil term-ptyp))
1715 (defun term-kill-input ()
1716 "Kill all text from last stuff output by interpreter to point."
1718 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
1719 (p-pos (marker-position pmark)))
1720 (if (> (point) p-pos)
1721 (kill-region pmark (point)))))
1723 (defun term-delchar-or-maybe-eof (arg)
1724 "Delete ARG characters forward, or send an EOF to process if at end of buffer."
1730 (defun term-send-eof ()
1731 "Send an EOF to the current buffer's process."
1735 (defun term-backward-matching-input (regexp arg)
1736 "Search backward through buffer for match for REGEXP.
1737 Matches are searched for on lines that match `term-prompt-regexp'.
1738 With prefix argument N, search for Nth previous match.
1739 If N is negative, find the next or Nth next match."
1740 (interactive (term-regexp-arg "Backward input matching (regexp): "))
1741 (let* ((re (concat term-prompt-regexp ".*" regexp))
1742 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
1743 (if (re-search-backward re nil t arg)
1746 (progn (message "Not found")
1751 (defun term-forward-matching-input (regexp arg)
1752 "Search forward through buffer for match for REGEXP.
1753 Matches are searched for on lines that match `term-prompt-regexp'.
1754 With prefix argument N, search for Nth following match.
1755 If N is negative, find the previous or Nth previous match."
1756 (interactive (term-regexp-arg "Forward input matching (regexp): "))
1757 (term-backward-matching-input regexp (- arg)))
1760 (defun term-next-prompt (n)
1761 "Move to end of Nth next prompt in the buffer.
1762 See `term-prompt-regexp'."
1764 (let ((paragraph-start term-prompt-regexp))
1765 (end-of-line (if (> n 0) 1 0))
1766 (forward-paragraph n)
1767 (term-skip-prompt)))
1769 (defun term-previous-prompt (n)
1770 "Move to end of Nth previous prompt in the buffer.
1771 See `term-prompt-regexp'."
1773 (term-next-prompt (- n)))
1775 ;;; Support for source-file processing commands.
1776 ;;;============================================================================
1777 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
1778 ;;; commands that process files of source text (e.g. loading or compiling
1779 ;;; files). So the corresponding process-in-a-buffer modes have commands
1780 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
1781 ;;; for defining these commands.
1783 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
1784 ;;; and Soar, in that they don't know anything about file extensions.
1785 ;;; So the compile/load interface gets the wrong default occasionally.
1786 ;;; The load-file/compile-file default mechanism could be smarter -- it
1787 ;;; doesn't know about the relationship between filename extensions and
1788 ;;; whether the file is source or executable. If you compile foo.lisp
1789 ;;; with compile-file, then the next load-file should use foo.bin for
1790 ;;; the default, not foo.lisp. This is tricky to do right, particularly
1791 ;;; because the extension for executable files varies so much (.o, .bin,
1792 ;;; .lbin, .mo, .vo, .ao, ...).
1795 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
1798 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
1799 ;;; want to save the buffer before issuing any process requests to the command
1802 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
1803 ;;; for the file to process.
1805 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
1806 ;;;============================================================================
1807 ;;; This function computes the defaults for the load-file and compile-file
1808 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
1810 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
1811 ;;; source-file processing command. NIL if there hasn't been one yet.
1812 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
1813 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
1814 ;;; Typically, (lisp-mode) or (scheme-mode).
1816 ;;; If the command is given while the cursor is inside a string, *and*
1817 ;;; the string is an existing filename, *and* the filename is not a directory,
1818 ;;; then the string is taken as default. This allows you to just position
1819 ;;; your cursor over a string that's a filename and have it taken as default.
1821 ;;; If the command is given in a file buffer whose major mode is in
1822 ;;; SOURCE-MODES, then the the filename is the default file, and the
1823 ;;; file's directory is the default directory.
1825 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
1826 ;;; then the default directory & file are what was used in the last source-file
1827 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
1828 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
1829 ;;; is the cwd, with no default file. (\"no default file\" = nil)
1831 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
1832 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
1833 ;;; for Soar programs, etc.
1835 ;;; The function returns a pair: (default-directory . default-file).
1837 (defun term-source-default (previous-dir/file source-modes)
1838 (cond ((and buffer-file-name (memq major-mode source-modes))
1839 (cons (file-name-directory buffer-file-name)
1840 (file-name-nondirectory buffer-file-name)))
1843 (cons default-directory nil))))
1846 ;;; (TERM-CHECK-SOURCE fname)
1847 ;;;============================================================================
1848 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
1849 ;;; process-in-a-buffer modes), this function can be called on the filename.
1850 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
1851 ;;; is queried to see if he wants to save the buffer before proceeding with
1852 ;;; the load or compile.
1854 (defun term-check-source (fname)
1855 (let ((buff (get-file-buffer fname)))
1857 (buffer-modified-p buff)
1858 (y-or-n-p (format "Save buffer %s first? "
1859 (buffer-name buff))))
1861 (let ((old-buffer (current-buffer)))
1864 (set-buffer old-buffer)))))
1867 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
1868 ;;;============================================================================
1869 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
1870 ;;; commands that process source files (like loading or compiling a file).
1871 ;;; It prompts for the filename, provides a default, if there is one,
1872 ;;; and returns the result filename.
1874 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
1876 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
1877 ;;; from the last source processing command. SOURCE-MODES is a list of major
1878 ;;; modes used to determine what file buffers contain source files. (These
1879 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
1880 ;;; then the filename reader will only accept a file that exists.
1883 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
1884 ;;; '(lisp-mode) t))
1886 ;;; This is pretty stupid about strings. It decides we're in a string
1887 ;;; if there's a quote on both sides of point on the current line.
1888 (defun term-extract-string ()
1889 "Returns string around POINT that starts the current line or nil."
1891 (let* ((point (point))
1892 (bol (progn (beginning-of-line) (point)))
1893 (eol (progn (end-of-line) (point)))
1894 (start (progn (goto-char point)
1895 (and (search-backward "\"" bol t)
1897 (end (progn (goto-char point)
1898 (and (search-forward "\"" eol t)
1901 (buffer-substring start end)))))
1903 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
1904 (let* ((def (term-source-default prev-dir/file source-modes))
1905 (stringfile (term-extract-string))
1906 (sfile-p (and stringfile
1908 (file-exists-p stringfile)
1910 (not (file-directory-p stringfile))))
1911 (defdir (if sfile-p (file-name-directory stringfile)
1913 (deffile (if sfile-p (file-name-nondirectory stringfile)
1915 (ans (read-file-name (if deffile (format "%s(default %s) "
1919 (concat defdir deffile)
1921 (list (expand-file-name (substitute-in-file-name ans)))))
1923 ;;; I am somewhat divided on this string-default feature. It seems
1924 ;;; to violate the principle-of-least-astonishment, in that it makes
1925 ;;; the default harder to predict, so you actually have to look and see
1926 ;;; what the default really is before choosing it. This can trip you up.
1927 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
1932 ;;; Simple process query facility.
1933 ;;; ===========================================================================
1934 ;;; This function is for commands that want to send a query to the process
1935 ;;; and show the response to the user. For example, a command to get the
1936 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
1937 ;;; to an inferior Common Lisp process.
1939 ;;; This simple facility just sends strings to the inferior process and pops
1940 ;;; up a window for the process buffer so you can see what the process
1941 ;;; responds with. We don't do anything fancy like try to intercept what the
1942 ;;; process responds with and put it in a pop-up window or on the message
1943 ;;; line. We just display the buffer. Low tech. Simple. Works good.
1945 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
1946 ;;; a window for the inferior process so that its response can be seen.
1947 (defun term-proc-query (proc str)
1948 (let* ((proc-buf (process-buffer proc))
1949 (proc-mark (process-mark proc)))
1950 (display-buffer proc-buf)
1951 (set-buffer proc-buf) ; but it's not the selected *window*
1952 (let ((proc-win (get-buffer-window proc-buf))
1953 (proc-pt (marker-position proc-mark)))
1954 (term-send-string proc str) ; send the query
1955 (accept-process-output proc) ; wait for some output
1956 ;; Try to position the proc window so you can see the answer.
1957 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
1958 ;; I don't know why. Wizards invited to improve it.
1959 (if (not (pos-visible-in-window-p proc-pt proc-win))
1960 (let ((opoint (window-point proc-win)))
1961 (set-window-point proc-win proc-mark) (sit-for 0)
1962 (if (not (pos-visible-in-window-p opoint proc-win))
1964 (set-window-point proc-win opoint)))))))
1966 ;;; Returns the current column in the current screen line.
1967 ;;; Note: (current-column) yields column in buffer line.
1969 (defun term-horizontal-column ()
1970 (- (term-current-column) (term-start-line-column)))
1972 ;; Calls either vertical-motion or buffer-vertical-motion
1973 (defmacro term-vertical-motion (count)
1974 (list 'funcall 'term-vertical-motion count))
1976 ;; An emulation of vertical-motion that is independent of having a window.
1977 ;; Instead, it uses the term-width variable as the logical window width.
1979 (defun buffer-vertical-motion (count)
1981 (move-to-column (* term-width (/ (current-column) term-width)))
1985 (todo (+ count (/ (current-column) term-width))))
1987 ;; The loop interates over buffer lines;
1988 ;; H is the number of screen lines in the current line, i.e.
1989 ;; the ceiling of dividing the buffer line width by term-width.
1990 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
1995 (setq todo (- todo H))
1996 (forward-char) ;; Move past the ?\n
1997 (end-of-line)) ;; and on to the end of the next line.
1998 (if (and (>= todo H) (> todo 0))
1999 (+ (- count todo) H -1) ;; Hit end of buffer.
2000 (move-to-column (* todo term-width))
2002 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2005 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2009 (progn (beginning-of-line)
2011 (setq todo (- todo H))
2012 (backward-char)) ;; Move to end of previos line
2013 (if (and (>= todo H) (> todo 0))
2014 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2015 (move-to-column (* (- H todo 1) term-width))
2018 ;;; The term-start-line-column variable is used as a cache.
2019 (defun term-start-line-column ()
2020 (cond (term-start-line-column)
2021 ((let ((save-pos (point)))
2022 (term-vertical-motion 0)
2023 (setq term-start-line-column (current-column))
2024 (goto-char save-pos)
2025 term-start-line-column))))
2027 ;;; Same as (current-column), but uses term-current-column as a cache.
2028 (defun term-current-column ()
2029 (cond (term-current-column)
2030 ((setq term-current-column (current-column)))))
2032 ;;; Move DELTA column right (or left if delta < 0).
2034 (defun term-move-columns (delta)
2035 (setq term-current-column (+ (term-current-column) delta))
2036 (move-to-column term-current-column t))
2038 ;; Insert COUNT copies of CHAR in the default face.
2039 (defun term-insert-char (char count)
2040 (let ((old-point (point)))
2041 (insert-char char count)
2042 (put-text-property old-point (point) 'face 'default)))
2044 (defun term-current-row ()
2045 (cond (term-current-row)
2046 ((setq term-current-row
2049 (narrow-to-region term-home-marker (point-max))
2050 (- (term-vertical-motion -9999))))))))
2052 (defun term-adjust-current-row-cache (delta)
2053 (if term-current-row
2054 (setq term-current-row (+ term-current-row delta))))
2056 (defun term-terminal-pos ()
2057 (save-excursion ; save-restriction
2058 (let ((save-col (term-current-column))
2060 (term-vertical-motion 0)
2061 (setq x (- save-col (current-column)))
2062 (setq y (term-vertical-motion term-height))
2065 ;;; Terminal emulation
2066 ;;; This is the standard process filter for term buffers.
2067 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2069 (defun term-emulate-terminal (proc str)
2070 (let* ((previous-buffer (current-buffer))
2071 (i 0) char funny count save-point save-marker old-point temp win
2072 (selected (selected-window))
2073 (str-length (length str)))
2076 (set-buffer (process-buffer proc))
2078 (if (marker-buffer term-pending-delete-marker)
2080 ;; Delete text following term-pending-delete-marker.
2081 (delete-region term-pending-delete-marker (process-mark proc))
2082 (set-marker term-pending-delete-marker nil)))
2084 (if (eq (window-buffer) (current-buffer))
2086 (setq term-vertical-motion (symbol-function 'vertical-motion))
2087 (term-check-size proc))
2088 (setq term-vertical-motion
2089 (symbol-function 'buffer-vertical-motion)))
2091 (setq save-marker (copy-marker (process-mark proc)))
2093 (if (/= (point) (process-mark proc))
2094 (progn (setq save-point (point-marker))
2095 (goto-char (process-mark proc))))
2098 ;; If the buffer is in line mode, and there is a partial
2099 ;; input line, save the line (by narrowing to leave it
2100 ;; outside the restriction ) until we're done with output.
2101 (if (and (> (point-max) (process-mark proc))
2102 (term-in-line-mode))
2103 (narrow-to-region (point-min) (process-mark proc)))
2106 (princ str term-log-buffer))
2107 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2108 (setq str (concat term-terminal-parameter str))
2109 (setq term-terminal-parameter nil)
2110 (setq str-length (length str))
2111 (setq term-terminal-state 0)))
2113 (while (< i str-length)
2114 (setq char (aref str i))
2115 (cond ((< term-terminal-state 2)
2116 ;; Look for prefix of regular chars
2118 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2120 (if (not funny) (setq funny str-length))
2122 (cond ((eq term-terminal-state 1)
2123 (term-move-columns 1)
2124 (setq term-terminal-state 0)))
2125 (setq count (- funny i))
2126 (setq temp (- (+ (term-horizontal-column) count)
2128 (cond ((<= temp 0)) ;; All count chars fit in line.
2129 ((> count temp) ;; Some chars fit.
2130 ;; This iteration, handle only what fits.
2131 (setq count (- count temp))
2132 (setq funny (+ count i)))
2133 ((or (not (or term-pager-count
2134 term-scroll-with-delete))
2135 (> (term-handle-scroll 1) 0))
2136 (term-adjust-current-row-cache 1)
2137 (setq count (min count term-width))
2138 (setq funny (+ count i))
2139 (setq term-start-line-column
2140 term-current-column))
2141 (t ;; Doing PAGER processing.
2142 (setq count 0 funny i)
2143 (setq term-current-column nil)
2144 (setq term-start-line-column nil)))
2145 (setq old-point (point))
2146 ;; In the common case that we're at the end of
2147 ;; the buffer, we can save a little work.
2148 (cond ((/= (point) (point-max))
2149 (if term-insert-mode
2150 ;; Inserting spaces, then deleting them,
2151 ;; then inserting the actual text is
2152 ;; inefficient, but it is simple, and
2153 ;; the actual overhead is miniscule.
2154 (term-insert-spaces count))
2155 (term-move-columns count)
2156 (delete-region old-point (point)))
2157 (t (setq term-current-column (+ (term-current-column) count))))
2158 (insert (substring str i funny))
2159 (put-text-property old-point (point)
2160 'face term-current-face)
2161 ;; If the last char was written in last column,
2162 ;; back up one column, but remember we did so.
2163 ;; Thus we emulate xterm/vt100-style line-wrapping.
2165 (term-move-columns -1)
2166 (setq term-terminal-state 1)))
2167 (setq i (1- funny)))
2168 ((and (setq term-terminal-state 0)
2169 (eq char ?\^I)) ; TAB
2170 ;; FIXME: Does not handle line wrap!
2171 (setq count (term-current-column))
2172 (setq count (+ count 8 (- (mod count 8))))
2173 (if (< (move-to-column count nil) count)
2174 (term-insert-char char 1))
2175 (setq term-current-column count))
2177 ;; Optimize CRLF at end of buffer:
2178 (cond ((and (< (setq temp (1+ i)) str-length)
2179 (eq (aref str temp) ?\n)
2180 (= (point) (point-max))
2181 (not (or term-pager-count
2183 term-scroll-with-delete)))
2185 (term-adjust-current-row-cache 1)
2186 (setq term-start-line-column 0)
2187 (setq term-current-column 0)
2189 (t ;; Not followed by LF or can't optimize:
2190 (term-vertical-motion 0)
2191 (setq term-current-column 0))))
2193 (if (not (and term-kill-echo-list
2194 (term-check-kill-echo-list)))
2197 (term-move-columns -1))
2198 ((eq char ?\033) ; Escape
2199 (setq term-terminal-state 2))
2200 ((eq char 0)) ; NUL: Do nothing
2201 ((eq char ?\016)) ; Shift Out - ignored
2202 ((eq char ?\017)) ; Shift In - ignored
2206 (let ((end (string-match "\n" str i)))
2208 (progn (funcall term-command-hook
2209 (substring str (1+ i) (1- end)))
2211 (setq term-terminal-parameter
2213 (setq term-terminal-state 4)
2214 (setq i str-length))))
2215 (t ; insert char FIXME: Should never happen
2216 (term-move-columns 1)
2217 (backward-delete-char 1)
2219 ((eq term-terminal-state 2) ; Seen Esc
2220 (cond ((eq char ?\133) ;; ?\133 = ?[
2221 (make-local-variable 'term-terminal-parameter)
2222 (make-local-variable 'term-terminal-previous-parameter)
2223 (setq term-terminal-parameter 0)
2224 (setq term-terminal-previous-parameter 0)
2225 (setq term-terminal-state 3))
2226 ((eq char ?D) ;; scroll forward
2227 (term-handle-deferred-scroll)
2229 (setq term-terminal-state 0))
2230 ((eq char ?M) ;; scroll reversed
2231 (term-insert-lines 1)
2232 (setq term-terminal-state 0))
2233 ((eq char ?7) ;; Save cursor
2234 (term-handle-deferred-scroll)
2235 (setq term-saved-cursor
2236 (cons (term-current-row)
2237 (term-horizontal-column)))
2238 (setq term-terminal-state 0))
2239 ((eq char ?8) ;; Restore cursor
2240 (if term-saved-cursor
2241 (term-goto (car term-saved-cursor)
2242 (cdr term-saved-cursor)))
2243 (setq term-terminal-state 0))
2244 ((setq term-terminal-state 0))))
2245 ((eq term-terminal-state 3) ; Seen Esc [
2246 (cond ((and (>= char ?0) (<= char ?9))
2247 (setq term-terminal-parameter
2248 (+ (* 10 term-terminal-parameter) (- char ?0))))
2249 ((eq char ?\073 ) ; ?;
2250 (setq term-terminal-previous-parameter
2251 term-terminal-parameter)
2252 (setq term-terminal-parameter 0))
2253 ((eq char ??)) ; Ignore ?
2255 (term-handle-ansi-escape proc char)
2256 (setq term-terminal-state 0)))))
2257 (if (term-handling-pager)
2258 ;; Finish stuff to get ready to handle PAGER.
2260 (if (> (% (current-column) term-width) 0)
2261 (setq term-terminal-parameter
2263 ;; We're at column 0. Goto end of buffer; to compensate,
2264 ;; prepend a ?\r for later. This looks more consistent.
2266 (setq term-terminal-parameter
2267 (concat "\r" (substring str i)))
2268 (setq term-terminal-parameter (substring str (1- i)))
2269 (aset term-terminal-parameter 0 ?\r))
2270 (goto-char (point-max)))
2271 (setq term-terminal-state 4)
2272 (make-local-variable 'term-pager-old-filter)
2273 (setq term-pager-old-filter (process-filter proc))
2274 (set-process-filter proc term-pager-filter)
2275 (setq i str-length)))
2278 (if (>= (term-current-row) term-height)
2279 (term-handle-deferred-scroll))
2281 (set-marker (process-mark proc) (point))
2283 (progn (goto-char save-point)
2284 (set-marker save-point nil)))
2286 ;; Check for a pending filename-and-line number to display.
2287 ;; We do this before scrolling, because we might create a new window.
2288 (if (and term-pending-frame
2289 (eq (window-buffer selected) (current-buffer)))
2290 (progn (term-display-line (car term-pending-frame)
2291 (cdr term-pending-frame))
2292 (setq term-pending-frame nil)
2293 ;; We have created a new window, so check the window size.
2294 (term-check-size proc)))
2296 ;; Scroll each window displaying the buffer but (by default)
2297 ;; only if the point matches the process-mark we started with.
2300 (setq win (next-window win nil t))
2301 (if (eq (window-buffer win) (process-buffer proc))
2302 (let ((scroll term-scroll-to-bottom-on-output))
2304 (if (or (= (point) save-marker)
2305 (eq scroll t) (eq scroll 'all)
2306 ;; Maybe user wants point to jump to the end.
2307 (and (eq selected win)
2308 (or (eq scroll 'this) (not save-point)))
2309 (and (eq scroll 'others)
2310 (not (eq selected win))))
2312 (goto-char term-home-marker)
2314 (goto-char (process-mark proc))
2315 (if (not (pos-visible-in-window-p (point) win))
2317 ;; Optionally scroll so that the text
2318 ;; ends at the bottom of the window.
2319 (if (and term-scroll-show-maximum-output
2320 (>= (point) (process-mark proc)))
2322 (goto-char (point-max))
2324 (not (eq win selected))))
2326 (set-marker save-marker nil))
2327 ;; unwind-protect cleanup-forms follow:
2328 (set-buffer previous-buffer)
2329 (select-window selected))))
2331 (defun term-handle-deferred-scroll ()
2332 (let ((count (- (term-current-row) term-height)))
2335 (goto-char term-home-marker)
2336 (term-vertical-motion count)
2337 (set-marker term-home-marker (point))
2338 (setq term-current-row (1- term-height))))))
2340 ;;; Handle a character assuming (eq terminal-state 2) -
2341 ;;; i.e. we have previousely seen Escape followed by ?[.
2343 (defun term-handle-ansi-escape (proc char)
2345 ((eq char ?H) ; cursor motion
2346 (if (<= term-terminal-parameter 0)
2347 (setq term-terminal-parameter 1))
2348 (if (<= term-terminal-previous-parameter 0)
2349 (setq term-terminal-previous-parameter 1))
2350 (if (> term-terminal-previous-parameter term-height)
2351 (setq term-terminal-previous-parameter term-height))
2352 (if (> term-terminal-parameter term-width)
2353 (setq term-terminal-parameter term-width))
2355 (1- term-terminal-previous-parameter)
2356 (1- term-terminal-parameter)))
2359 (term-handle-deferred-scroll)
2360 (term-down (- (max 1 term-terminal-parameter)) t))
2361 ;; \E[B - cursor down
2363 (term-down (max 1 term-terminal-parameter) t))
2364 ;; \E[C - cursor right
2366 (term-move-columns (max 1 term-terminal-parameter)))
2367 ;; \E[D - cursor left
2369 (term-move-columns (- (max 1 term-terminal-parameter))))
2370 ;; \E[J - clear to end of screen
2372 (term-erase-in-display term-terminal-parameter))
2373 ;; \E[K - clear to end of line
2375 (term-erase-in-line term-terminal-parameter))
2376 ;; \E[L - insert lines
2378 (term-insert-lines (max 1 term-terminal-parameter)))
2379 ;; \E[M - delete lines
2381 (term-delete-lines (max 1 term-terminal-parameter)))
2382 ;; \E[P - delete chars
2384 (term-delete-chars (max 1 term-terminal-parameter)))
2385 ;; \E[@ - insert spaces
2387 (term-insert-spaces (max 1 term-terminal-parameter)))
2388 ;; \E[?h - DEC Private Mode Set
2390 (cond ((eq term-terminal-parameter 4)
2391 (setq term-insert-mode t))
2392 ((eq term-terminal-parameter 47)
2393 (term-switch-to-alternate-sub-buffer t))))
2394 ;; \E[?l - DEC Private Mode Reset
2396 (cond ((eq term-terminal-parameter 4)
2397 (setq term-insert-mode nil))
2398 ((eq term-terminal-parameter 47)
2399 (term-switch-to-alternate-sub-buffer nil))))
2400 ;; \E[m - Set/reset standard mode
2402 (cond ((eq term-terminal-parameter 7)
2403 (setq term-current-face 'highlight))
2404 ((eq term-terminal-parameter 4)
2405 (setq term-current-face 'term-underline-face))
2406 ((eq term-terminal-parameter 1)
2407 (setq term-current-face 'bold))
2408 (t (setq term-current-face 'default))))
2409 ;; \E[6n - Report cursor position
2411 (term-handle-deferred-scroll)
2412 (process-send-string proc
2414 (1+ (term-current-row))
2415 (1+ (term-horizontal-column)))))
2416 ;; \E[r - Set scrolling region
2419 (1- term-terminal-previous-parameter)
2420 term-terminal-parameter))
2423 (defun term-scroll-region (top bottom)
2424 "Set scrolling region.
2425 TOP is the top-most line (inclusive) of the new scrolling region,
2426 while BOTTOM is the line folling the new scrolling region (e.g. exclusive).
2427 The top-most line is line 0."
2428 (setq term-scroll-start
2429 (if (or (< top 0) (>= top term-height))
2432 (setq term-scroll-end
2433 (if (or (<= bottom term-scroll-start) (> bottom term-height))
2436 (setq term-scroll-with-delete
2437 (or (term-using-alternate-sub-buffer)
2438 (not (and (= term-scroll-start 0)
2439 (= term-scroll-end term-height))))))
2441 (defun term-switch-to-alternate-sub-buffer (set)
2442 ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
2443 ;; using it, do nothing. This test is needed for some programs (including
2444 ;; emacs) that emit the ti termcap string twice, for unknown reason.
2445 (term-handle-deferred-scroll)
2446 (if (eq set (not (term-using-alternate-sub-buffer)))
2447 (let ((row (term-current-row))
2448 (col (term-horizontal-column)))
2450 (goto-char (point-max))
2451 (if (not (eq (preceding-char) ?\n))
2452 (term-insert-char ?\n 1))
2453 (setq term-scroll-with-delete t)
2454 (setq term-saved-home-marker (copy-marker term-home-marker))
2455 (set-marker term-home-marker (point)))
2457 (setq term-scroll-with-delete
2458 (not (and (= term-scroll-start 0)
2459 (= term-scroll-end term-height))))
2460 (set-marker term-home-marker term-saved-home-marker)
2461 (set-marker term-saved-home-marker nil)
2462 (setq term-saved-home-marker nil)
2463 (goto-char term-home-marker)))
2464 (setq term-current-column nil)
2465 (setq term-current-row 0)
2466 (term-goto row col))))
2468 ;; Default value for the symbol term-command-hook.
2470 (defun term-command-hook (string)
2471 (cond ((= (aref string 0) ?\032)
2472 ;; gdb (when invoked with -fullname) prints:
2473 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
2474 (let* ((first-colon (string-match ":" string 1))
2476 (string-match ":" string (1+ first-colon)))
2477 (filename (substring string 1 first-colon))
2478 (fileline (string-to-int
2479 (substring string (1+ first-colon) second-colon))))
2480 (setq term-pending-frame (cons filename fileline))))
2481 ((= (aref string 0) ?/)
2482 (cd (substring string 1)))
2483 ;; Allowing the inferior to call functions in emacs is
2484 ;; probably too big a security hole.
2485 ;; ((= (aref string 0) ?!)
2486 ;; (eval (car (read-from-string string 1))))
2487 (t)));; Otherwise ignore it
2489 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
2490 ;; and that its line LINE is visible.
2491 ;; Put the overlay-arrow on the line LINE in that buffer.
2492 ;; This is mainly used by gdb.
2494 (defun term-display-line (true-file line)
2495 (term-display-buffer-line (find-file-noselect true-file) line))
2497 (defun term-display-buffer-line (buffer line)
2498 (let* ((window (display-buffer buffer t))
2506 (setq overlay-arrow-string "=>")
2507 (or overlay-arrow-position
2508 (setq overlay-arrow-position (make-marker)))
2509 (set-marker overlay-arrow-position (point) (current-buffer)))
2510 (cond ((or (< pos (point-min)) (> pos (point-max)))
2513 (set-window-point window overlay-arrow-position)))
2515 ;;; The buffer-local marker term-home-marker defines the "home position"
2516 ;;; (in terms of cursor motion). However, we move the term-home-marker
2517 ;;; "down" as needed so that is no more that a window-full above (point-max).
2519 (defun term-goto-home ()
2520 (term-handle-deferred-scroll)
2521 (goto-char term-home-marker)
2522 (setq term-current-row 0)
2523 (setq term-current-column (current-column))
2524 (setq term-start-line-column term-current-column))
2526 (defun term-goto (row col)
2527 (term-handle-deferred-scroll)
2528 (cond ((and term-current-row (>= row term-current-row))
2529 ;; I assume this is a worthwhile optimization.
2530 (term-vertical-motion 0)
2531 (setq term-current-column term-start-line-column)
2532 (setq row (- row term-current-row)))
2536 (term-move-columns col))
2538 ; The page is full, so enter "pager" mode, and wait for input.
2540 (defun term-process-pager ()
2541 (if (not term-pager-break-map)
2542 (let* ((map (make-keymap))
2545 ; (define-key map (make-string 1 i) 'term-send-raw)
2547 (define-key map "\e"
2548 (lookup-key (current-global-map) "\e"))
2549 (define-key map "\C-x"
2550 (lookup-key (current-global-map) "\C-x"))
2551 (define-key map "\C-u"
2552 (lookup-key (current-global-map) "\C-u"))
2553 (define-key map " " 'term-pager-page)
2554 (define-key map "\r" 'term-pager-line)
2555 (define-key map "?" 'term-pager-help)
2556 (define-key map "h" 'term-pager-help)
2557 (define-key map "b" 'term-pager-back-page)
2558 (define-key map "\177" 'term-pager-back-line)
2559 (define-key map "q" 'term-pager-discard)
2560 (define-key map "D" 'term-pager-disable)
2561 (define-key map "<" 'term-pager-bob)
2562 (define-key map ">" 'term-pager-eob)
2567 (define-key map [menu-bar terminal] term-terminal-menu)
2568 (define-key map [menu-bar signals] term-signals-menu)
2569 (setq tmp (make-sparse-keymap "More pages?"))
2570 (define-key tmp [help] '("Help" . term-pager-help))
2571 (define-key tmp [disable]
2572 '("Diable paging" . term-fake-pager-disable))
2573 (define-key tmp [discard]
2574 '("Discard remaining output" . term-pager-discard))
2575 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
2576 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
2577 (define-key tmp [line] '("1 line forwards" . term-pager-line))
2578 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
2579 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
2580 (define-key tmp [page] '("1 page forwards" . term-pager-page))
2581 (define-key map [menu-bar page] (cons "More pages?" tmp))
2584 (setq term-pager-break-map map)))
2585 ; (let ((process (get-buffer-process (current-buffer))))
2586 ; (stop-process process))
2587 (setq term-pager-old-local-map (current-local-map))
2588 (use-local-map term-pager-break-map)
2589 (make-local-variable 'term-old-mode-line-format)
2590 (setq term-old-mode-line-format mode-line-format)
2591 (setq mode-line-format
2592 (list "-- **MORE** "
2593 mode-line-buffer-identification
2594 " [Type ? for help] "
2596 (force-mode-line-update))
2598 (defun term-pager-line (lines)
2600 (let* ((moved (vertical-motion (1+ lines)))
2601 (deficit (- lines moved)))
2604 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
2605 (recenter (1- term-height)))
2606 ((term-pager-continue deficit)))))
2608 (defun term-pager-page (arg)
2609 "Proceed past the **MORE** break, allowing the next page of output to appear"
2611 (term-pager-line (* arg term-height)))
2613 ; Pager mode command to go to beginning of buffer
2614 (defun term-pager-bob ()
2616 (goto-char (point-min))
2617 (if (= (vertical-motion term-height) term-height)
2619 (recenter (1- term-height)))
2621 ; pager mode command to go to end of buffer
2622 (defun term-pager-eob ()
2624 (goto-char term-home-marker)
2626 (goto-char (process-mark (get-buffer-process (current-buffer)))))
2628 (defun term-pager-back-line (lines)
2630 (vertical-motion (- 1 lines))
2634 ;; Move cursor to end of window.
2635 (vertical-motion term-height)
2637 (recenter (1- term-height)))
2639 (defun term-pager-back-page (arg)
2641 (term-pager-back-line (* arg term-height)))
2643 (defun term-pager-discard ()
2645 (setq term-terminal-parameter "")
2646 (interrupt-process nil t)
2647 (term-pager-continue term-height))
2649 ; Disable pager processing.
2650 ; Only callable while in pager mode. (Contrast term-disable-pager.)
2651 (defun term-pager-disable ()
2653 (if (term-handling-pager)
2654 (term-pager-continue nil)
2655 (setq term-pager-count nil))
2656 (term-update-mode-line))
2658 ; Enable pager processing.
2659 (defun term-pager-enable ()
2661 (or (term-pager-enabled)
2662 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
2663 (term-update-mode-line))
2665 (defun term-pager-toggle ()
2667 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
2670 (defalias 'term-fake-pager-enable 'term-pager-toggle)
2671 (defalias 'term-fake-pager-disable 'term-pager-toggle)
2672 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
2673 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
2674 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
2675 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
2677 (defun term-pager-help ()
2678 "Provide help on commands available in a terminal-emulator **MORE** break"
2680 (message "Terminal-emulator pager break help...")
2683 (function (lambda ()
2684 (princ (substitute-command-keys
2685 "\\<term-pager-break-map>\
2686 Terminal-emulator MORE break.\n\
2687 Type one of the following keys:\n\n\
2688 \\[term-pager-page]\t\tMove forward one page.\n\
2689 \\[term-pager-line]\t\tMove forward one line.\n\
2690 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
2691 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
2692 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
2693 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
2694 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
2695 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
2696 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
2697 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
2698 \\{term-pager-break-map}\n\
2699 Any other key is passed through to the program
2700 running under the terminal emulator and disables pager processing until
2701 all pending output has been dealt with."))
2704 (defun term-pager-continue (new-count)
2705 (let ((process (get-buffer-process (current-buffer))))
2706 (use-local-map term-pager-old-local-map)
2707 (setq term-pager-old-local-map nil)
2708 (setq mode-line-format term-old-mode-line-format)
2709 (force-mode-line-update)
2710 (setq term-pager-count new-count)
2711 (set-process-filter process term-pager-old-filter)
2712 (funcall term-pager-old-filter process "")
2713 (continue-process process)))
2715 ;; Make sure there are DOWN blank lines below the current one.
2716 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
2718 (defun term-handle-scroll (down)
2719 (let ((scroll-needed
2720 (- (+ (term-current-row) down 1) term-scroll-end)))
2721 (if (> scroll-needed 0)
2722 (let ((save-point (copy-marker (point))) (save-top))
2723 (goto-char term-home-marker)
2724 (cond (term-scroll-with-delete
2725 ;; delete scroll-needed lines at term-scroll-start
2726 (term-vertical-motion term-scroll-start)
2727 (setq save-top (point))
2728 (term-vertical-motion scroll-needed)
2729 (delete-region save-top (point))
2730 (goto-char save-point)
2731 (term-vertical-motion down)
2732 (term-adjust-current-row-cache (- scroll-needed))
2733 (setq term-current-column nil)
2734 (term-insert-char ?\n scroll-needed))
2735 ((and (numberp term-pager-count)
2736 (< (setq term-pager-count (- term-pager-count down))
2739 (term-process-pager))
2741 (term-adjust-current-row-cache (- scroll-needed))
2742 (term-vertical-motion scroll-needed)
2743 (set-marker term-home-marker (point))))
2744 (goto-char save-point)
2745 (set-marker save-point nil))))
2748 (defun term-down (down &optional check-for-scroll)
2749 "Move down DOWN screen lines vertically."
2750 (let ((start-column (term-horizontal-column)))
2751 (if (and check-for-scroll (or term-scroll-with-delete term-pager-count))
2752 (setq down (term-handle-scroll down)))
2753 (term-adjust-current-row-cache down)
2754 (if (/= (point) (point-max))
2755 (setq down (- down (term-vertical-motion down))))
2756 ;; Extend buffer with extra blank lines if needed.
2758 (term-insert-char ?\n down)
2759 (setq term-current-column 0)
2760 (setq term-start-line-column 0))
2762 (setq term-current-column nil)
2763 (setq term-start-line-column (current-column))))
2765 (term-move-columns start-column))))
2767 ;; Assuming point is at the beginning of a screen line,
2768 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
2769 ;; FIXME: Probably should be called more than it is.
2770 (defun term-unwrap-line ()
2771 (if (not (bolp)) (insert-before-markers ?\n)))
2773 (defun term-erase-in-line (kind)
2774 (if (> kind 1) ;; erase left of point
2775 (let ((cols (term-horizontal-column)) (saved-point (point)))
2776 (term-vertical-motion 0)
2777 (delete-region (point) saved-point)
2778 (term-insert-char ?\n cols)))
2779 (if (not (eq kind 1)) ;; erase right of point
2780 (let ((saved-point (point))
2781 (wrapped (and (zerop (term-horizontal-column))
2782 (not (zerop (term-current-column))))))
2783 (term-vertical-motion 1)
2784 (delete-region saved-point (point))
2785 ;; wrapped is true if we're at the beginning of screen line,
2786 ;; but not a buffer line. If we delete the current screen line
2787 ;; that will make the previous line no longer wrap, and (because
2788 ;; of the way emacs display works) point will be at the end of
2789 ;; the previous screen line rather then the beginning of the
2790 ;; current one. To avoid that, we make sure that current line
2791 ;; contain a space, to force the previous line to continue to wrap.
2792 ;; We could do this always, but it seems preferable to not add the
2793 ;; extra space when wrapped is false.
2797 (put-text-property saved-point (point) 'face 'default)
2798 (goto-char saved-point))))
2800 (defun term-erase-in-display (kind)
2801 "Erases (that is blanks out) part of the window.
2802 If KIND is 0, erase from (point) to (point-max);
2803 if KIND is 1, erase from home to point; else erase from home to point-max.
2804 Should only be called when point is at the start of a screen line."
2805 (term-handle-deferred-scroll)
2806 (cond ((eq term-terminal-parameter 0)
2807 (delete-region (point) (point-max))
2809 ((let ((row (term-current-row))
2810 (col (term-horizontal-column))
2811 (start-region term-home-marker)
2812 (end-region (if (eq kind 1) (point) (point-max))))
2813 (delete-region start-region end-region)
2816 (term-insert-char ?\n row))
2817 (setq term-current-column nil)
2818 (setq term-current-row nil)
2819 (term-goto row col)))))
2821 (defun term-delete-chars (count)
2822 (let ((save-point (point)))
2823 (term-vertical-motion 1)
2825 (goto-char save-point)
2826 (move-to-column (+ (term-current-column) count) t)
2827 (delete-region save-point (point))))
2829 ;;; Insert COUNT spaces after point, but do not change any of
2830 ;;; following screen lines. Hence we may have to delete characters
2831 ;;; at teh end of this screen line to make room.
2833 (defun term-insert-spaces (count)
2834 (let ((save-point (point)) (save-eol))
2835 (term-vertical-motion 1)
2838 (setq save-eol (point))
2839 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
2840 (if (> save-eol (point))
2841 (delete-region (point) save-eol))
2842 (goto-char save-point)
2843 (term-insert-char ? count)
2844 (goto-char save-point)))
2846 (defun term-delete-lines (lines)
2847 (let ((start (point))
2848 (save-current-column term-current-column)
2849 (save-start-line-column term-start-line-column)
2850 (save-current-row (term-current-row)))
2852 (delete-region start (point))
2853 (term-down (- term-scroll-end save-current-row lines))
2854 (term-insert-char ?\n lines)
2855 (setq term-current-column save-current-column)
2856 (setq term-start-line-column save-start-line-column)
2857 (setq term-current-row save-current-row)
2860 (defun term-insert-lines (lines)
2861 (let ((start (point))
2863 (save-current-column term-current-column)
2864 (save-start-line-column term-start-line-column)
2865 (save-current-row (term-current-row)))
2866 (term-down (- term-scroll-end save-current-row lines))
2867 (setq start-deleted (point))
2869 (delete-region start-deleted (point))
2871 (setq term-current-column save-current-column)
2872 (setq term-start-line-column save-start-line-column)
2873 (setq term-current-row save-current-row)
2874 (term-insert-char ?\n lines)
2877 (defun term-set-output-log (name)
2878 "Record raw inferior process output in a buffer."
2879 (interactive (list (if term-log-buffer
2881 (read-buffer "Record output in buffer: "
2882 (format "%s output-log"
2883 (buffer-name (current-buffer)))
2885 (if (or (null name) (equal name ""))
2886 (progn (setq term-log-buffer nil)
2887 (message "Output logging off."))
2888 (if (get-buffer name)
2891 (set-buffer (get-buffer-create name))
2893 (buffer-disable-undo (current-buffer))
2895 (setq term-log-buffer (get-buffer name))
2896 (message "Recording terminal emulator output into buffer \"%s\""
2897 (buffer-name term-log-buffer))))
2899 (defun term-stop-photo ()
2900 "Discontinue raw inferior process logging."
2902 (term-set-output-log nil))
2904 (defun term-show-maximum-output ()
2905 "Put the end of the buffer at the bottom of the window."
2907 (goto-char (point-max))
2910 ;;; Do the user's customisation...
2912 (defvar term-load-hook nil
2913 "This hook is run when term is loaded in.
2914 This is a good place to put keybindings.")
2916 (run-hooks 'term-load-hook)
2919 ;;; Filename/command/history completion in a buffer
2920 ;;; ===========================================================================
2921 ;;; Useful completion functions, courtesy of the Ergo group.
2924 ;;; term-dynamic-complete Complete or expand command, filename,
2925 ;;; history at point.
2926 ;;; term-dynamic-complete-filename Complete filename at point.
2927 ;;; term-dynamic-list-filename-completions List completions in help buffer.
2928 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
2929 ;;; replace with expanded/completed name.
2930 ;;; term-dynamic-simple-complete Complete stub given candidates.
2932 ;;; These are not installed in the term-mode keymap. But they are
2933 ;;; available for people who want them. Shell-mode installs them:
2934 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
2935 ;;; (define-key shell-mode-map "\M-?"
2936 ;;; 'term-dynamic-list-filename-completions)))
2938 ;;; Commands like this are fine things to put in load hooks if you
2939 ;;; want them present in specific modes.
2941 (defvar term-completion-autolist nil
2942 "*If non-nil, automatically list possiblities on partial completion.
2943 This mirrors the optional behavior of tcsh.")
2945 (defvar term-completion-addsuffix t
2946 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2947 This mirrors the optional behavior of tcsh.")
2949 (defvar term-completion-recexact nil
2950 "*If non-nil, use shortest completion if characters cannot be added.
2951 This mirrors the optional behavior of tcsh.
2953 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
2955 (defvar term-completion-fignore nil
2956 "*List of suffixes to be disregarded during file completion.
2957 This mirrors the optional behavior of bash and tcsh.
2959 Note that this applies to `term-dynamic-complete-filename' only.")
2961 (defvar term-file-name-prefix ""
2962 "Prefix prepended to absolute file names taken from process input.
2963 This is used by term's and shell's completion functions, and by shell's
2964 directory tracking functions.")
2967 (defun term-directory (directory)
2968 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
2969 (expand-file-name (if (file-name-absolute-p directory)
2970 (concat term-file-name-prefix directory)
2974 (defun term-word (word-chars)
2975 "Return the word of WORD-CHARS at point, or nil if non is found.
2976 Word constituents are considered to be those in WORD-CHARS, which is like the
2977 inside of a \"[...]\" (see `skip-chars-forward')."
2979 (let ((limit (point))
2980 (word (concat "[" word-chars "]"))
2981 (non-word (concat "[^" word-chars "]")))
2982 (if (re-search-backward non-word nil 'move)
2984 ;; Anchor the search forwards.
2985 (if (or (eolp) (looking-at non-word))
2987 (re-search-forward (concat word "+") limit)
2988 (buffer-substring (match-beginning 0) (match-end 0))))))
2991 (defun term-match-partial-filename ()
2992 "Return the filename at point, or nil if non is found.
2993 Environment variables are substituted. See `term-word'."
2994 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
2995 (and filename (substitute-in-file-name filename))))
2998 (defun term-dynamic-complete ()
2999 "Dynamically perform completion at point.
3000 Calls the functions in `term-dynamic-complete-functions' to perform
3001 completion until a function returns non-nil, at which point completion is
3002 assumed to have occurred."
3004 (let ((functions term-dynamic-complete-functions))
3005 (while (and functions (null (funcall (car functions))))
3006 (setq functions (cdr functions)))))
3009 (defun term-dynamic-complete-filename ()
3010 "Dynamically complete the filename at point.
3011 Completes if after a filename. See `term-match-partial-filename' and
3012 `term-dynamic-complete-as-filename'.
3013 This function is similar to `term-replace-by-expanded-filename', except that
3014 it won't change parts of the filename already entered in the buffer; it just
3015 adds completion characters to the end of the filename. A completions listing
3016 may be shown in a help buffer if completion is ambiguous.
3018 Completion is dependent on the value of `term-completion-addsuffix',
3019 `term-completion-recexact' and `term-completion-fignore', and the timing of
3020 completions listing is dependent on the value of `term-completion-autolist'.
3022 Returns t if successful."
3024 (if (term-match-partial-filename)
3025 (prog2 (or (eq (selected-window) (minibuffer-window))
3026 (message "Completing file name..."))
3027 (term-dynamic-complete-as-filename))))
3029 (defun term-dynamic-complete-as-filename ()
3030 "Dynamically complete at point as a filename.
3031 See `term-dynamic-complete-filename'. Returns t if successful."
3032 (let* ((completion-ignore-case nil)
3033 (completion-ignored-extensions term-completion-fignore)
3035 (filename (or (term-match-partial-filename) ""))
3036 (pathdir (file-name-directory filename))
3037 (pathnondir (file-name-nondirectory filename))
3038 (directory (if pathdir (term-directory pathdir) default-directory))
3039 (completion (file-name-completion pathnondir directory))
3040 (mini-flag (eq (selected-window) (minibuffer-window))))
3041 (cond ((null completion)
3042 (message "No completions of %s" filename)
3044 ((eq completion t) ; Means already completed "file".
3045 (if term-completion-addsuffix (insert " "))
3046 (or mini-flag (message "Sole completion")))
3047 ((string-equal completion "") ; Means completion on "directory/".
3048 (term-dynamic-list-filename-completions))
3049 (t ; Completion string returned.
3050 (let ((file (concat (file-name-as-directory directory) completion)))
3051 (insert (substring (directory-file-name completion)
3052 (length pathnondir)))
3053 (cond ((symbolp (file-name-completion completion directory))
3054 ;; We inserted a unique completion.
3055 (if term-completion-addsuffix
3056 (insert (if (file-directory-p file) "/" " ")))
3057 (or mini-flag (message "Completed")))
3058 ((and term-completion-recexact term-completion-addsuffix
3059 (string-equal pathnondir completion)
3060 (file-exists-p file))
3061 ;; It's not unique, but user wants shortest match.
3062 (insert (if (file-directory-p file) "/" " "))
3063 (or mini-flag (message "Completed shortest")))
3064 ((or term-completion-autolist
3065 (string-equal pathnondir completion))
3066 ;; It's not unique, list possible completions.
3067 (term-dynamic-list-filename-completions))
3069 (or mini-flag (message "Partially completed")))))))
3073 (defun term-replace-by-expanded-filename ()
3074 "Dynamically expand and complete the filename at point.
3075 Replace the filename with an expanded, canonicalised and completed replacement.
3076 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
3077 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
3078 removed, and the filename is made absolute instead of relative. For expansion
3079 see `expand-file-name' and `substitute-in-file-name'. For completion see
3080 `term-dynamic-complete-filename'."
3082 (replace-match (expand-file-name (term-match-partial-filename)) t t)
3083 (term-dynamic-complete-filename))
3086 (defun term-dynamic-simple-complete (stub candidates)
3087 "Dynamically complete STUB from CANDIDATES list.
3088 This function inserts completion characters at point by completing STUB from
3089 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3090 if completion is ambiguous.
3092 Returns nil if no completion was inserted.
3093 Returns `sole' if completed with the only completion match.
3094 Returns `shortest' if completed with the shortest of the completion matches.
3095 Returns `partial' if completed as far as possible with the completion matches.
3096 Returns `listed' if a completion listing was shown.
3098 See also `term-dynamic-complete-filename'."
3099 (let* ((completion-ignore-case nil)
3100 (candidates (mapcar (function (lambda (x) (list x))) candidates))
3101 (completions (all-completions stub candidates)))
3102 (cond ((null completions)
3103 (message "No completions of %s" stub)
3105 ((= 1 (length completions)) ; Gotcha!
3106 (let ((completion (car completions)))
3107 (if (string-equal completion stub)
3108 (message "Sole completion")
3109 (insert (substring completion (length stub)))
3110 (message "Completed"))
3111 (if term-completion-addsuffix (insert " "))
3113 (t ; There's no unique completion.
3114 (let ((completion (try-completion stub candidates)))
3115 ;; Insert the longest substring.
3116 (insert (substring completion (length stub)))
3117 (cond ((and term-completion-recexact term-completion-addsuffix
3118 (string-equal stub completion)
3119 (member completion completions))
3120 ;; It's not unique, but user wants shortest match.
3122 (message "Completed shortest")
3124 ((or term-completion-autolist
3125 (string-equal stub completion))
3126 ;; It's not unique, list possible completions.
3127 (term-dynamic-list-completions completions)
3130 (message "Partially completed")
3134 (defun term-dynamic-list-filename-completions ()
3135 "List in help buffer possible completions of the filename at point."
3137 (let* ((completion-ignore-case nil)
3138 (filename (or (term-match-partial-filename) ""))
3139 (pathdir (file-name-directory filename))
3140 (pathnondir (file-name-nondirectory filename))
3141 (directory (if pathdir (term-directory pathdir) default-directory))
3142 (completions (file-name-all-completions pathnondir directory)))
3144 (term-dynamic-list-completions completions)
3145 (message "No completions of %s" filename))))
3148 (defun term-dynamic-list-completions (completions)
3149 "List in help buffer sorted COMPLETIONS.
3150 Typing SPC flushes the help buffer."
3151 (let ((conf (current-window-configuration)))
3152 (with-output-to-temp-buffer "*Completions*"
3153 (display-completion-list (sort completions 'string-lessp)))
3154 (message "Hit space to flush")
3157 (set-buffer (get-buffer "*Completions*"))
3158 (setq key (read-key-sequence nil)
3161 (eq (window-buffer (posn-window (event-start first)))
3162 (get-buffer "*Completions*"))
3163 (eq (key-binding key) 'mouse-choose-completion)))
3164 ;; If the user does mouse-choose-completion with the mouse,
3165 ;; execute the command, then delete the completion window.
3167 (mouse-choose-completion first)
3168 (set-window-configuration conf))
3170 (set-window-configuration conf)
3171 (setq unread-command-events (listify-key-sequence key)))))))
3173 ;;; Converting process modes to use term mode
3174 ;;; ===========================================================================
3175 ;;; Renaming variables
3176 ;;; Most of the work is renaming variables and functions. These are the common
3178 ;;; Local variables:
3179 ;;; last-input-start term-last-input-start
3180 ;;; last-input-end term-last-input-end
3181 ;;; shell-prompt-pattern term-prompt-regexp
3182 ;;; shell-set-directory-error-hook <no equivalent>
3184 ;;; shell-set-directory <unnecessary>
3185 ;;; shell-mode-map term-mode-map
3187 ;;; shell-send-input term-send-input
3188 ;;; shell-send-eof term-delchar-or-maybe-eof
3189 ;;; kill-shell-input term-kill-input
3190 ;;; interrupt-shell-subjob term-interrupt-subjob
3191 ;;; stop-shell-subjob term-stop-subjob
3192 ;;; quit-shell-subjob term-quit-subjob
3193 ;;; kill-shell-subjob term-kill-subjob
3194 ;;; kill-output-from-shell term-kill-output
3195 ;;; show-output-from-shell term-show-output
3196 ;;; copy-last-shell-input Use term-previous-input/term-next-input
3198 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3199 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
3200 ;;; Term mode does not provide functionality equivalent to
3201 ;;; shell-set-directory-error-hook; it is gone.
3203 ;;; term-last-input-start is provided for modes which want to munge
3204 ;;; the buffer after input is sent, perhaps because the inferior
3205 ;;; insists on echoing the input. The LAST-INPUT-START variable in
3206 ;;; the old shell package was used to implement a history mechanism,
3207 ;;; but you should think twice before using term-last-input-start
3208 ;;; for this; the input history ring often does the job better.
3210 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3211 ;;; *not* create the term-mode local variables in your foo-mode function.
3212 ;;; This is not modular. Instead, call term-mode, and let *it* create the
3213 ;;; necessary term-specific local variables. Then create the
3214 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3215 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
3216 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
3217 ;;; get-old-input) that need to be different from the defaults. Call
3218 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
3219 ;;; term-mode will take care of it. The following example, from shell.el,
3222 ;;; (defvar shell-mode-map '())
3223 ;;; (cond ((not shell-mode-map)
3224 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
3225 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3226 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3227 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3228 ;;; (define-key shell-mode-map "\M-?"
3229 ;;; 'term-dynamic-list-filename-completions)))
3231 ;;; (defun shell-mode ()
3234 ;;; (setq term-prompt-regexp shell-prompt-pattern)
3235 ;;; (setq major-mode 'shell-mode)
3236 ;;; (setq mode-name "Shell")
3237 ;;; (use-local-map shell-mode-map)
3238 ;;; (make-local-variable 'shell-directory-stack)
3239 ;;; (setq shell-directory-stack nil)
3240 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
3241 ;;; (run-hooks 'shell-mode-hook))
3244 ;;; Note that make-term is different from make-shell in that it
3245 ;;; doesn't have a default program argument. If you give make-shell
3246 ;;; a program name of NIL, it cleverly chooses one of explicit-shell-name,
3247 ;;; $ESHELL, $SHELL, or /bin/sh. If you give make-term a program argument
3248 ;;; of NIL, it barfs. Adjust your code accordingly...
3250 ;;; Completion for term-mode users
3252 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
3253 ;;; hook to add completion functions to. Functions on this list should return
3254 ;;; non-nil if completion occurs (i.e., further completion should not occur).
3255 ;;; You could use term-dynamic-simple-complete to do the bulk of the
3260 ;;; term.el ends here