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 ;;; Dir/Hostname tracking and ANSI colorization by
10 ;;; Marco Melgazzi <marco@techie.com>.
12 ;;; To see what I've modified and where it came from search for '-mm'
14 ;;; Speed considerations and a few caveats
15 ;;; --------------------------------------
17 ;;; While the message passing and the colorization surely introduce some
18 ;;; overhead this has became so small that IMHO is surely outweighted by
19 ;;; the benefits you get but, as usual, YMMV
21 ;;; Important caveat, when deciding the cursor/'grey keys' keycodes I had to
22 ;;; make a choice: on my Linux box this choice allows me to run all the
23 ;;; ncurses applications without problems but make these keys
24 ;;; uncomprehensible to all the cursesX programs. Your mileage may vary so
25 ;;; you may consider changing the default 'emulation'. Just search for this
26 ;;; piece of code and modify it as you like:
28 ;;; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
29 ;;; ;; For my configuration it's definitely better \eOA but YMMV. -mm
30 ;;; ;; For example: vi works with \eOA while elm wants \e[A ...
31 ;;; (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
32 ;;; (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
33 ;;; (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
34 ;;; (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
37 ;;; IMPORTANT: additions & changes
38 ;;; ------------------------------
40 ;;; With this enhanced ansi-term.el you will get a reliable mechanism of
41 ;;; directory/username/host tracking: the only drawback is that you will
42 ;;; have to modify your shell start-up script. It's worth it, believe me :).
44 ;;; When you rlogin/su/telnet and the account you access has a modified
45 ;;; startup script, you will be able to access the remote files as usual
46 ;;; with C-x C-f, if it's needed you will have to enter a password,
47 ;;; otherwise the file should get loaded straight away.
49 ;;; This is useful even if you work only on one host: it often happens that,
50 ;;; for maintenance reasons, you have to edit files 'as root': before
51 ;;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
52 ;;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
53 ;;; 'as-root'. ( If you don't want to enter the root password every time you
54 ;;; can put it in your .netrc: note that this is -not- advisable if you're
55 ;;; connected to the internet or if somebody else works on your workstation!)
57 ;;; If you use wu-ftpd you can use some of its features to avoid root ftp
58 ;;; access to the rest of the world: just put in /etc/ftphosts something like
61 ;;; allow root 127.0.0.1
63 ;;; # By default nobody can't do anything
67 ;;; ----------------------------------------
69 ;;; If, instead of 'term', you call 'ansi-term', you get multiple term
70 ;;; buffers, after every new call ansi-term opens a new *ansi-term*<xx> window,
71 ;;; where <xx> is, as usual, a number...
73 ;;; ----------------------------------------
75 ;;; With the term-buffer-maximum-size you can finally decide how many
76 ;;; scrollback lines to keep: its default is 2048 but you can change it as
79 ;;; ----------------------------------------
82 ;;; ANSI colorization should work well, I've decided to limit the interpreter
83 ;;; to five outstanding commands (like ESC [ 01;04;32;41;07m.
84 ;;; You shouldn't need more, if you do, tell me and I'll increase it. It's
85 ;;; so easy you could do it yourself...
87 ;;; Blink, is not supported. Currently it's mapped as bold.
91 ;;; if you want custom colors in term.el redefine term-default-fg-color
92 ;;; and term-default-bg-color BEFORE loading it.
94 ;;; ----------------------------------------
96 ;;; If you'd like to check out my complete configuration, you can download
97 ;;; it from http://www.polito.it/~s64912/things.html, it's ~500k in size and
98 ;;; contains my .cshrc, .emacs and my whole site-lisp subdirectory. (notice
99 ;;; that this term.el may be newer/older than the one in there, please
102 ;;; This complete configuration contains, among other things, a complete
103 ;;; rectangular marking solution (based on rect-mark.el and
104 ;;; pc-bindings.el) and should be a good example of how extensively Emacs
105 ;;; can be configured on a ppp-connected ws.
107 ;;; ----------------------------------------
111 ;;; - Add hooks to allow raw-mode keys to be configurable
112 ;;; - Which keys are better ? \eOA or \e[A ?
117 ;;; V4.0 January 1997
119 ;;; - Huge reworking of the faces code: now we only have roughly 20-30
120 ;;; faces for everything so we're even faster than the old md-term.el !
121 ;;; - Finished removing all the J-Shell code.
123 ;;; V3.0 January 1997
125 ;;; - Now all the supportable ANSI commands work well.
126 ;;; - Reworked a little the code: much less jsh-inspired stuff
130 ;;; - Now all the faces are accessed through an array: much cleaner code.
132 ;;; V2.2 November 4 1996
134 ;;; - Implemented ANSI output colorization ( a bit rough but enough for
137 ;;; - Implemented a maximum limit for the scroll buffer (stolen from
140 ;;; v2.1 October 28 1996, first public release
142 ;;; - Some new keybindings for term-char mode ( notably home/end/...)
143 ;;; - Directory, hostname and username tracking via ange-ftp
144 ;;; - Multi-term capability via the ansi-term call
146 ;;; ----------------------------------------------------------------
147 ;;; You should/could have something like this in your .emacs to take
148 ;;; full advantage of this package
150 ;;; (add-hook 'term-mode-hook
153 ;;; (setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *")
154 ;;; (make-local-variable 'mouse-yank-at-point)
155 ;;; (make-local-variable 'transient-mark-mode)
156 ;;; (setq mouse-yank-at-point t)
157 ;;; (setq transient-mark-mode nil)
158 ;;; (auto-fill-mode -1)
159 ;;; (setq tab-width 8 ))))
162 ;;; ----------------------------------------
164 ;;; If you want to use color ls the best setup is to have a different file
165 ;;; when you use eterm ( see above, mine is named .emacs_dircolors ). This
166 ;;; is necessary because some terminals, rxvt for example, need non-ansi
167 ;;; hacks to work ( for example on my rxvt white is wired to fg, and to
168 ;;; obtain normal white I have to do bold-white :)
170 ;;; ----------------------------------------
173 ;;; # Configuration file for the color ls utility
174 ;;; # This file goes in the /etc directory, and must be world readable.
175 ;;; # You can copy this file to .dir_colors in your $HOME directory to
176 ;;; # override the system defaults.
178 ;;; # COLOR needs one of these arguments: 'tty' colorizes output to ttys, but
179 ;;; # not pipes. 'all' adds color characters to all output. 'none' shuts
180 ;;; # colorization off.
184 ;;; # Below, there should be one TERM entry for each termtype that is
188 ;;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
191 ;;; # Below are the color init strings for the basic file types. A color init
192 ;;; # string consists of one or more of the following numeric codes:
193 ;;; # Attribute codes:
194 ;;; # 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
195 ;;; # Text color codes:
196 ;;; # 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
197 ;;; # Background color codes:
198 ;;; # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
199 ;;; NORMAL 00 # global default, although everything should be something.
200 ;;; FILE 00 # normal file
201 ;;; DIR 00;37 # directory
202 ;;; LINK 00;36 # symbolic link
203 ;;; FIFO 00;37 # pipe
204 ;;; SOCK 40;35 # socket
205 ;;; BLK 33;01 # block device driver
206 ;;; CHR 33;01 # character device driver
208 ;;; # This is for files with execute permission:
211 ;;; # List any file extensions like '.gz' or '.tar' that you would like ls
212 ;;; # to colorize below. Put the extension, a space, and the color init
213 ;;; # string. (and any comments you want to add after a '#')
214 ;;; .tar 01;33 # archives or compressed
223 ;;; .jpg 01;35 # image formats
230 ;;; ----------------------------------------
232 ;;; Notice: for directory/host/user tracking you need to have something
233 ;;; like this in your shell startup script ( this is for tcsh but should
234 ;;; be quite easy to port to other shells )
236 ;;; ----------------------------------------
240 ;;; set host = `hostname`
241 ;;; set date = `date`
243 ;;; # su does not change this but I'd like it to
245 ;;; set user = `whoami`
249 ;;; if ( eterm =~ $TERM ) then
251 ;;; echo --------------------------------------------------------------
253 ;;; echo Today is $date
254 ;;; echo We are on $host running $os under Emacs term mode
255 ;;; echo --------------------------------------------------------------
257 ;;; setenv EDITOR emacsclient
259 ;;; # Notice: $host and $user have been set before to 'hostname' and 'whoami'
260 ;;; # this is necessary because, f.e., certain versions of 'su' do not change
261 ;;; # $user, YMMV: if you don't want to fiddle with them define a couple
262 ;;; # of new variables and use these instead.
263 ;;; # NOTICE that there is a space between "AnSiT?" and $whatever NOTICE
265 ;;; # These are because we want the real cwd in the messages, not the login
268 ;;; set cwd_hack='$cwd'
269 ;;; set host_hack='$host'
270 ;;; set user_hack='$user'
272 ;;; # Notice that the ^[ character is an ESC, not two chars. You can
273 ;;; # get it in various ways, for example by typing
274 ;;; # echo -e '\033' > escape.file
275 ;;; # or by using your favourite editor
277 ;;; foreach temp (cd pushd)
278 ;;; alias $temp "$temp \!* ; echo '
\eAnSiTc' $cwd_hack"
280 ;;; alias popd 'popd ;echo "
\eAnSiTc" $cwd'
282 ;;; # Every command that can modify the user/host/directory should be aliased
283 ;;; # as follows for the tracking mechanism to work.
285 ;;; foreach temp ( rlogin telnet rsh sh ksh csh tcsh zsh bash tcl su )
286 ;;; alias $temp "$temp \!* ; echo '
\eAnSiTh' $host_hack ; \
287 ;;; echo '
\eAnSiTu' $user_hack ;echo '
\eAnSiTc' $cwd_hack"
290 ;;; # Start up & use color ls
292 ;;; echo "
\eAnSiTh" $host
293 ;;; echo "
\eAnSiTu" $user
294 ;;; echo "
\eAnSiTc" $cwd
296 ;;; # some housekeeping
303 ;;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
308 ;;; # Let's not clutter user space
315 ;;; Original Commentary:
316 ;;; --------------------
318 ;; The changelog is at the end of this file.
320 ;; Please send me bug reports, bug fixes, and extensions, so that I can
321 ;; merge them into the master source.
322 ;; - Per Bothner (bothner@cygnus.com)
324 ;; This file defines a general command-interpreter-in-a-buffer package
325 ;; (term mode). The idea is that you can build specific process-in-a-buffer
326 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
327 ;; This way, all these specific packages share a common base functionality,
328 ;; and a common set of bindings, which makes them easier to use (and
329 ;; saves code, implementation time, etc., etc.).
331 ;; For hints on converting existing process modes (e.g., tex-mode,
332 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
333 ;; instead of shell-mode, see the notes at the end of this file.
336 ;; Brief Command Documentation:
337 ;;============================================================================
338 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
341 ;; m-p term-previous-input Cycle backwards in input history
342 ;; m-n term-next-input Cycle forwards
343 ;; m-r term-previous-matching-input Previous input matching a regexp
344 ;; m-s comint-next-matching-input Next input that matches
345 ;; return term-send-input
346 ;; c-c c-a term-bol Beginning of line; skip prompt.
347 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
348 ;; c-c c-u term-kill-input ^u
349 ;; c-c c-w backward-kill-word ^w
350 ;; c-c c-c term-interrupt-subjob ^c
351 ;; c-c c-z term-stop-subjob ^z
352 ;; c-c c-\ term-quit-subjob ^\
353 ;; c-c c-o term-kill-output Delete last batch of process output
354 ;; c-c c-r term-show-output Show last batch of process output
355 ;; c-c c-h term-dynamic-list-input-ring List input history
357 ;; Not bound by default in term-mode
358 ;; term-send-invisible Read a line w/o echo, and send to proc
359 ;; (These are bound in shell-mode)
360 ;; term-dynamic-complete Complete filename at point.
361 ;; term-dynamic-list-completions List completions in help buffer.
362 ;; term-replace-by-expanded-filename Expand and complete filename at point;
363 ;; replace with expanded/completed name.
364 ;; term-kill-subjob No mercy.
365 ;; term-show-maximum-output Show as much output as possible.
366 ;; term-continue-subjob Send CONT signal to buffer's process
367 ;; group. Useful if you accidentally
368 ;; suspend your process (with C-c C-z).
370 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
371 ;; term-load-hook is run after loading in this package.
375 ;; This is passed to the inferior in the EMACS environment variable,
376 ;; so it is important to increase it if there are protocol-relevant changes.
377 (defconst term-protocol-version "0.95")
383 "General command interpreter in a window"
388 ;;; Buffer Local Variables:
389 ;;;============================================================================
390 ;;; Term mode buffer local variables:
391 ;;; term-prompt-regexp - string term-bol uses to match prompt.
392 ;;; term-delimiter-argument-list - list For delimiters and arguments
393 ;;; term-last-input-start - marker Handy if inferior always echoes
394 ;;; term-last-input-end - marker For term-kill-output command
395 ;; For the input history mechanism:
396 (defvar term-input-ring-size 32 "Size of input history ring.")
397 ;;; term-input-ring-size - integer
398 ;;; term-input-ring - ring
399 ;;; term-input-ring-index - number ...
400 ;;; term-input-autoexpand - symbol ...
401 ;;; term-input-ignoredups - boolean ...
402 ;;; term-last-input-match - string ...
403 ;;; term-dynamic-complete-functions - hook For the completion mechanism
404 ;;; term-completion-fignore - list ...
405 ;;; term-get-old-input - function Hooks for specific
406 ;;; term-input-filter-functions - hook process-in-a-buffer
407 ;;; term-input-filter - function modes.
408 ;;; term-input-send - function
409 ;;; term-scroll-to-bottom-on-output - symbol ...
410 ;;; term-scroll-show-maximum-output - boolean...
411 (defvar term-height) ;; Number of lines in window.
412 (defvar term-width) ;; Number of columns in window.
413 (defvar term-home-marker) ;; Marks the "home" position for cursor addressing.
414 (defvar term-saved-home-marker nil) ;; When using alternate sub-buffer,
415 ;; contains saved term-home-marker from original sub-buffer .
416 (defvar term-start-line-column 0) ;; (current-column) at start of screen line,
417 ;; or nil if unknown.
418 (defvar term-current-column 0) ;; If non-nil, is cache for (current-column).
419 (defvar term-current-row 0) ;; Current vertical row (relative to home-marker)
420 ;; or nil if unknown.
421 (defvar term-insert-mode nil)
422 (defvar term-vertical-motion)
423 (defvar term-terminal-state 0) ;; State of the terminal emulator:
424 ;; state 0: Normal state
425 ;; state 1: Last character was a graphic in the last column.
426 ;; If next char is graphic, first move one column right
427 ;; (and line warp) before displaying it.
428 ;; This emulates (more or less) the behavior of xterm.
430 ;; state 3: seen ESC [ (or ESC [ ?)
431 ;; state 4: term-terminal-parameter contains pending output.
432 (defvar term-kill-echo-list nil) ;; A queue of strings whose echo
433 ;; we want suppressed.
434 (defvar term-terminal-parameter)
435 (defvar term-terminal-previous-parameter)
436 (defvar term-current-face 'term-default)
437 (defvar term-scroll-start 0) ;; Top-most line (inclusive) of scrolling region.
438 (defvar term-scroll-end) ;; Number of line (zero-based) after scrolling region.
439 (defvar term-pager-count nil) ;; If nil, paging is disabled.
440 ;; Otherwise, number of lines before we need to page.
441 (defvar term-saved-cursor nil)
442 (defvar term-command-hook)
443 (defvar term-log-buffer nil)
444 (defvar term-scroll-with-delete nil) ;; term-scroll-with-delete is t if
445 ;; forward scrolling should be implemented by delete to
446 ;; top-most line(s); and nil if scrolling should be implemented
447 ;; by moving term-home-marker. It is set to t iff there is a
448 ;; (non-default) scroll-region OR the alternate buffer is used.
449 (defvar term-pending-delete-marker) ;; New user input in line mode needs to
450 ;; be deleted, because it gets echoed by the inferior.
451 ;; To reduce flicker, we defer the delete until the next output.
452 (defvar term-old-mode-map nil) ;; Saves the old keymap when in char mode.
453 (defvar term-old-mode-line-format) ;; Saves old mode-line-format while paging.
454 (defvar term-pager-old-local-map nil) ;; Saves old keymap while paging.
455 (defvar term-pager-old-filter) ;; Saved process-filter while paging.
457 (defcustom explicit-shell-file-name nil
458 "*If non-nil, is file name to use for explicitly requested inferior shell."
459 :type '(choice (const nil) file)
462 (defvar term-prompt-regexp "^"
463 "Regexp to recognise prompts in the inferior process.
464 Defaults to \"^\", the null string at BOL.
467 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
468 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
469 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
471 shell: \"^[^#$%>\\n]*[#$%>] *\"
474 This is a good thing to set in mode hooks.")
476 (defvar term-delimiter-argument-list ()
477 "List of characters to recognise as separate arguments in input.
478 Strings comprising a character in this list will separate the arguments
479 surrounding them, and also be regarded as arguments in their own right (unlike
480 whitespace). See `term-arguments'.
481 Defaults to the empty list.
483 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
485 This is a good thing to set in mode hooks.")
487 (defcustom term-input-autoexpand nil
488 "*If non-nil, expand input command history references on completion.
489 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
491 If the value is `input', then the expansion is seen on input.
492 If the value is `history', then the expansion is only when inserting
493 into the buffer's input ring. See also `term-magic-space' and
494 `term-dynamic-complete'.
496 This variable is buffer-local."
497 :type '(choice (const nil) (const t) (const input) (const history))
500 (defcustom term-input-ignoredups nil
501 "*If non-nil, don't add input matching the last on the input ring.
502 This mirrors the optional behavior of bash.
504 This variable is buffer-local."
508 (defcustom term-input-ring-file-name nil
509 "*If non-nil, name of the file to read/write input history.
510 See also `term-read-input-ring' and `term-write-input-ring'.
512 This variable is buffer-local, and is a good thing to set in mode hooks."
516 (defcustom term-scroll-to-bottom-on-output nil
517 "*Controls whether interpreter output causes window to scroll.
518 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
519 If `this', scroll only the selected window.
520 If `others', scroll only those that are not the selected window.
524 See variable `term-scroll-show-maximum-output'.
525 This variable is buffer-local."
529 (defcustom term-scroll-show-maximum-output nil
530 "*Controls how interpreter output causes window to scroll.
531 If non-nil, then show the maximum output when the window is scrolled.
533 See variable `term-scroll-to-bottom-on-output'.
534 This variable is buffer-local."
538 ;; Where gud-display-frame should put the debugging arrow. This is
539 ;; set by the marker-filter, which scans the debugger's output for
540 ;; indications of the current pc.
541 (defvar term-pending-frame nil)
543 ;;; Here are the per-interpreter hooks.
544 (defvar term-get-old-input (function term-get-old-input-default)
545 "Function that submits old text in term mode.
546 This function is called when return is typed while the point is in old text.
547 It returns the text to be submitted as process input. The default is
548 term-get-old-input-default, which grabs the current line, and strips off
549 leading text matching term-prompt-regexp")
551 (defvar term-dynamic-complete-functions
552 '(term-replace-by-expanded-history term-dynamic-complete-filename)
553 "List of functions called to perform completion.
554 Functions should return non-nil if completion was performed.
555 See also `term-dynamic-complete'.
557 This is a good thing to set in mode hooks.")
559 (defvar term-input-filter
560 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
561 "Predicate for filtering additions to input history.
562 Only inputs answering true to this function are saved on the input
563 history list. Default is to save anything that isn't all whitespace")
565 (defvar term-input-filter-functions '()
566 "Functions to call before input is sent to the process.
567 These functions get one argument, a string containing the text to send.
569 This variable is buffer-local.")
571 (defvar term-input-sender (function term-simple-send)
572 "Function to actually send to PROCESS the STRING submitted by user.
573 Usually this is just 'term-simple-send, but if your mode needs to
574 massage the input string, this is your hook. This is called from
575 the user command term-send-input. term-simple-send just sends
576 the string plus a newline.")
578 (defcustom term-eol-on-send t
579 "*Non-nil means go to the end of the line before sending input.
580 See `term-send-input'."
584 (defcustom term-mode-hook '()
585 "Called upon entry into term-mode
586 This is run before the process is cranked up."
590 (defcustom term-exec-hook '()
591 "Called each time a process is exec'd by term-exec.
592 This is called after the process is cranked up. It is useful for things that
593 must be done each time a process is executed in a term-mode buffer (e.g.,
594 \(process-kill-without-query)). In contrast, the term-mode-hook is only
595 executed once when the buffer is created."
599 (defvar term-mode-map nil)
600 (defvar term-raw-map nil
601 "Keyboard map for sending characters directly to the inferior process.")
602 (defvar term-escape-char nil
603 "Escape character for char-sub-mode of term mode.
604 Do not change it directly; use term-set-escape-char instead.")
605 (defvar term-raw-escape-map nil)
607 (defvar term-pager-break-map nil)
610 "True if communications via pty; false if by pipe. Buffer local.
611 This is to work around a bug in Emacs process signaling.")
613 (defvar term-last-input-match ""
614 "Last string searched for by term input history search, for defaulting.
615 Buffer local variable.")
617 (defvar term-input-ring nil)
618 (defvar term-last-input-start)
619 (defvar term-last-input-end)
620 (defvar term-input-ring-index nil
621 "Index of last matched history element.")
622 (defvar term-matching-input-from-input-string ""
623 "Input previously used to match input history.")
624 ; This argument to set-process-filter disables reading from the process,
625 ; assuming this is Emacs 19.20 or newer.
626 (defvar term-pager-filter t)
628 (put 'term-replace-by-expanded-history 'menu-enable 'term-input-autoexpand)
629 (put 'term-input-ring 'permanent-local t)
630 (put 'term-input-ring-index 'permanent-local t)
631 (put 'term-input-autoexpand 'permanent-local t)
632 (put 'term-input-filter-functions 'permanent-local t)
633 (put 'term-scroll-to-bottom-on-output 'permanent-local t)
634 (put 'term-scroll-show-maximum-output 'permanent-local t)
635 (put 'term-ptyp 'permanent-local t)
637 ;; Do FORMS if running under Emacs-19.
638 (defmacro term-if-emacs19 (&rest forms)
639 (if (string-match "^19" emacs-version) (cons 'progn forms)))
640 ;; True if running under XEmacs (previously Lucid Emacs).
641 (defmacro term-is-xemacs () '(string-match "Lucid" emacs-version))
642 ;; Do FORM if running under XEmacs (previously Lucid Emacs).
643 (defmacro term-if-xemacs (&rest forms)
644 (if (term-is-xemacs) (cons 'progn forms)))
645 ;; Do FORM if NOT running under XEmacs (previously Lucid Emacs).
646 (defmacro term-ifnot-xemacs (&rest forms)
647 (if (not (term-is-xemacs)) (cons 'progn forms)))
649 (defmacro term-in-char-mode () '(eq (current-local-map) term-raw-map))
650 (defmacro term-in-line-mode () '(not (term-in-char-mode)))
651 ;; True if currently doing PAGER handling.
652 (defmacro term-pager-enabled () 'term-pager-count)
653 (defmacro term-handling-pager () 'term-pager-old-local-map)
654 (defmacro term-using-alternate-sub-buffer () 'term-saved-home-marker)
656 (defvar term-signals-menu)
657 (defvar term-terminal-menu)
659 ;;; Let's silence the byte-compiler -mm
660 (defvar term-ansi-at-eval-string nil)
661 (defvar term-ansi-at-host nil)
662 (defvar term-ansi-at-dir nil)
663 (defvar term-ansi-at-user nil)
664 (defvar term-ansi-at-message nil)
665 (defvar term-ansi-at-save-user nil)
666 (defvar term-ansi-at-save-pwd nil)
667 (defvar term-ansi-at-save-anon nil)
668 (defvar term-ansi-current-bold 0)
669 (defvar term-ansi-current-color 0)
670 (defvar term-ansi-face-alredy-done 0)
671 (defvar term-ansi-current-bg-color 0)
672 (defvar term-ansi-current-underline 0)
673 (defvar term-ansi-current-highlight 0)
674 (defvar term-ansi-current-reverse 0)
675 (defvar term-ansi-current-invisible 0)
676 (defvar term-ansi-default-fg 0)
677 (defvar term-ansi-default-bg 0)
678 (defvar term-ansi-current-temp 0)
679 (defvar term-ansi-fg-faces-vector nil)
680 (defvar term-ansi-bg-faces-vector nil)
681 (defvar term-ansi-inv-fg-faces-vector nil)
682 (defvar term-ansi-inv-bg-faces-vector nil)
683 (defvar term-ansi-reverse-faces-vector nil)
685 ;;; Four should be enough, if you want more, just add. -mm
686 (defvar term-terminal-more-parameters 0)
687 (defvar term-terminal-previous-parameter-2 -1)
688 (defvar term-terminal-previous-parameter-3 -1)
689 (defvar term-terminal-previous-parameter-4 -1)
695 (defvar term-default-fg-color "azure3")
696 (defvar term-default-bg-color "SkyBlue4")
698 ;;; --- Simple faces ---
699 (make-face 'term-default-fg)
700 (make-face 'term-default-bg)
701 (make-face 'term-default-fg-inv)
702 (make-face 'term-default-bg-inv)
703 (make-face 'term-bold)
704 (make-face 'term-underline)
705 (make-face 'term-invisible)
706 (make-face 'term-invisible-inv)
708 (copy-face 'default 'term-default-fg)
709 (copy-face 'default 'term-default-bg)
710 (set-face-foreground 'term-default-fg term-default-fg-color)
711 (set-face-background 'term-default-bg term-default-bg-color)
713 (copy-face 'default 'term-default-fg-inv)
714 (copy-face 'default 'term-default-bg-inv)
715 (set-face-foreground 'term-default-fg-inv term-default-bg-color)
716 (set-face-background 'term-default-bg-inv term-default-fg-color)
718 (copy-face 'default 'term-invisible)
719 (set-face-background 'term-invisible term-default-bg-color)
720 (set-face-background 'term-invisible term-default-bg-color)
722 (copy-face 'default 'term-invisible-inv)
723 (set-face-background 'term-invisible-inv term-default-fg-color)
724 (set-face-background 'term-invisible-inv term-default-fg-color)
726 (copy-face 'default 'term-bold)
727 (make-face-bold 'term-bold)
729 (copy-face 'default 'term-underline)
730 (set-face-underline-p 'term-underline t)
733 (make-face 'term-black)
734 (make-face 'term-red)
735 (make-face 'term-green)
736 (make-face 'term-yellow)
737 (make-face 'term-blue)
738 (make-face 'term-magenta)
739 (make-face 'term-cyan)
740 (make-face 'term-white)
742 (copy-face 'default 'term-black)
743 (set-face-foreground 'term-black "black")
744 (copy-face 'default 'term-red)
745 (set-face-foreground 'term-red "red")
746 (copy-face 'default 'term-green)
747 (set-face-foreground 'term-green "green")
748 (copy-face 'default 'term-yellow)
749 (set-face-foreground 'term-yellow "yellow")
750 (copy-face 'default 'term-blue)
751 (set-face-foreground 'term-blue "blue")
752 (copy-face 'default 'term-magenta)
753 (set-face-foreground 'term-magenta "magenta")
754 (copy-face 'default 'term-cyan)
755 (set-face-foreground 'term-cyan "cyan")
756 (copy-face 'default 'term-white)
757 (set-face-foreground 'term-white "white")
760 (make-face 'term-blackbg)
761 (make-face 'term-redbg)
762 (make-face 'term-greenbg)
763 (make-face 'term-yellowbg)
764 (make-face 'term-bluebg)
765 (make-face 'term-magentabg)
766 (make-face 'term-cyanbg)
767 (make-face 'term-whitebg)
769 (copy-face 'default 'term-blackbg)
770 (set-face-background 'term-blackbg "black")
771 (copy-face 'default 'term-redbg)
772 (set-face-background 'term-redbg "red")
773 (copy-face 'default 'term-greenbg)
774 (set-face-background 'term-greenbg "green")
775 (copy-face 'default 'term-yellowbg)
776 (set-face-background 'term-yellowbg "yellow")
777 (copy-face 'default 'term-bluebg)
778 (set-face-background 'term-bluebg "blue")
779 (copy-face 'default 'term-magentabg)
780 (set-face-background 'term-magentabg "magenta")
781 (copy-face 'default 'term-cyanbg)
782 (set-face-background 'term-cyanbg "cyan")
783 (copy-face 'default 'term-whitebg)
784 (set-face-background 'term-whitebg "white")
786 (setq ansi-term-fg-faces-vector
787 [term-default-fg term-black term-red term-green term-yellow term-blue
788 term-magenta term-cyan term-white])
790 (setq ansi-term-bg-faces-vector
791 [term-default-bg term-blackbg term-redbg term-greenbg term-yellowbg
792 term-bluebg term-magentabg term-cyanbg term-whitebg])
794 (setq ansi-term-inv-bg-faces-vector
795 [term-default-fg-inv term-black term-red term-green term-yellow term-blue
796 term-magenta term-cyan term-white])
798 (setq ansi-term-inv-fg-faces-vector
799 [term-default-bg-inv term-blackbg term-redbg term-greenbg term-yellowbg
800 term-bluebg term-magentabg term-cyanbg term-whitebg])
802 ;;; Inspiration came from comint.el -mm
803 (defvar term-buffer-maximum-size 2048
804 "*The maximum size in lines for term buffers.
805 Term buffers are truncated from the top to be no greater than this number.
806 Notice that a setting of 0 means 'don't truncate anything'. This variable
811 (defvar term-terminal-menu
813 [ "Character mode" term-char-mode (term-in-line-mode)]
814 [ "Line mode" term-line-mode (term-in-char-mode)]
815 [ "Enable paging" term-pager-toggle (not term-pager-count)]
816 [ "Disable paging" term-pager-toggle term-pager-count])))
819 "Major mode for interacting with an inferior interpreter.
820 Interpreter name is same as buffer name, sans the asterisks.
821 In line sub-mode, return at end of buffer sends line as input,
822 while return not at end copies rest of line to end and sends it.
823 In char sub-mode, each character (except `term-escape-char`) is
826 This mode is typically customised to create inferior-lisp-mode,
827 shell-mode, etc.. This can be done by setting the hooks
828 term-input-filter-functions, term-input-filter, term-input-sender and
829 term-get-old-input to appropriate functions, and the variable
830 term-prompt-regexp to the appropriate regular expression.
832 An input history is maintained of size `term-input-ring-size', and
833 can be accessed with the commands \\[term-next-input],
834 \\[term-previous-input], and \\[term-dynamic-list-input-ring].
835 Input ring history expansion can be achieved with the commands
836 \\[term-replace-by-expanded-history] or \\[term-magic-space].
837 Input ring expansion is controlled by the variable `term-input-autoexpand',
838 and addition is controlled by the variable `term-input-ignoredups'.
840 Input to, and output from, the subprocess can cause the window to scroll to
841 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
842 and `term-scroll-to-bottom-on-output'.
844 If you accidentally suspend your process, use \\[term-continue-subjob]
849 Entry to this mode runs the hooks on term-mode-hook"
851 ;; Do not remove this. All major modes must do this.
852 (kill-all-local-variables)
853 (setq major-mode 'term-mode)
854 (setq mode-name "Term")
855 (use-local-map term-mode-map)
856 (make-local-variable 'term-home-marker)
857 (setq term-home-marker (copy-marker 0))
858 (make-local-variable 'term-saved-home-marker)
859 (make-local-variable 'term-height)
860 (make-local-variable 'term-width)
861 (setq term-width (1- (window-width)))
862 (setq term-height (1- (window-height)))
863 (make-local-variable 'term-terminal-parameter)
864 (make-local-variable 'term-saved-cursor)
865 (make-local-variable 'term-last-input-start)
866 (setq term-last-input-start (make-marker))
867 (make-local-variable 'term-last-input-end)
868 (setq term-last-input-end (make-marker))
869 (make-local-variable 'term-last-input-match)
870 (setq term-last-input-match "")
871 (make-local-variable 'term-prompt-regexp) ; Don't set; default
872 (make-local-variable 'term-input-ring-size) ; ...to global val.
873 (make-local-variable 'term-input-ring)
874 (make-local-variable 'term-input-ring-file-name)
875 (or (and (boundp 'term-input-ring) term-input-ring)
876 (setq term-input-ring (make-ring term-input-ring-size)))
877 (make-local-variable 'term-input-ring-index)
878 (or (and (boundp 'term-input-ring-index) term-input-ring-index)
879 (setq term-input-ring-index nil))
881 (make-local-variable 'term-command-hook)
882 (setq term-command-hook (symbol-function 'term-command-hook))
884 ;;; I'm not sure these saves are necessary but, since I
885 ;;; haven't tested the whole thing on a net connected machine with
886 ;;; a properly configured ange-ftp, I've decided to be conservative
887 ;;; and put them in. -mm
889 (make-local-variable 'term-ansi-at-host)
890 (setq term-ansi-at-host (system-name))
892 (make-local-variable 'term-ansi-at-dir)
893 (setq term-ansi-at-dir default-directory)
895 (make-local-variable 'term-ansi-at-message)
896 (setq term-ansi-at-message nil)
898 ;;; For user tracking purposes -mm
899 (make-local-variable 'ange-ftp-default-user)
900 (make-local-variable 'ange-ftp-default-password)
901 (make-local-variable 'ange-ftp-generate-anonymous-password)
903 ;;; You may want to have different scroll-back sizes -mm
904 (make-local-variable 'term-buffer-maximum-size)
906 ;;; Of course these have to be buffer-local -mm
907 (make-local-variable 'term-ansi-current-bold)
908 (make-local-variable 'term-ansi-current-color)
909 (make-local-variable 'term-ansi-face-alredy-done)
910 (make-local-variable 'term-ansi-current-bg-color)
911 (make-local-variable 'term-ansi-current-underline)
912 (make-local-variable 'term-ansi-current-highlight)
913 (make-local-variable 'term-ansi-current-reverse)
914 (make-local-variable 'term-ansi-current-invisible)
916 (make-local-variable 'term-terminal-state)
917 (make-local-variable 'term-kill-echo-list)
918 (make-local-variable 'term-start-line-column)
919 (make-local-variable 'term-current-column)
920 (make-local-variable 'term-current-row)
921 (make-local-variable 'term-log-buffer)
922 (make-local-variable 'term-scroll-start)
923 (make-local-variable 'term-scroll-end)
924 (setq term-scroll-end term-height)
925 (make-local-variable 'term-scroll-with-delete)
926 (make-local-variable 'term-pager-count)
927 (make-local-variable 'term-pager-old-local-map)
928 (make-local-variable 'term-old-mode-map)
929 (make-local-variable 'term-insert-mode)
930 (make-local-variable 'term-dynamic-complete-functions)
931 (make-local-variable 'term-completion-fignore)
932 (make-local-variable 'term-get-old-input)
933 (make-local-variable 'term-matching-input-from-input-string)
934 (make-local-variable 'term-input-autoexpand)
935 (make-local-variable 'term-input-ignoredups)
936 (make-local-variable 'term-delimiter-argument-list)
937 (make-local-variable 'term-input-filter-functions)
938 (make-local-variable 'term-input-filter)
939 (make-local-variable 'term-input-sender)
940 (make-local-variable 'term-eol-on-send)
941 (make-local-variable 'term-scroll-to-bottom-on-output)
942 (make-local-variable 'term-scroll-show-maximum-output)
943 (make-local-variable 'term-ptyp)
944 (make-local-variable 'term-exec-hook)
945 (make-local-variable 'term-vertical-motion)
946 (make-local-variable 'term-pending-delete-marker)
947 (setq term-pending-delete-marker (make-marker))
948 (make-local-variable 'term-current-face)
949 (make-local-variable 'term-pending-frame)
950 (setq term-pending-frame nil)
951 (run-hooks 'term-mode-hook)
954 (append current-menubar (list term-terminal-menu))))
956 (setq term-input-ring (make-ring term-input-ring-size)))
957 (term-update-mode-line))
961 (setq term-mode-map (make-sparse-keymap))
962 (define-key term-mode-map "\ep" 'term-previous-input)
963 (define-key term-mode-map "\en" 'term-next-input)
964 (define-key term-mode-map "\er" 'term-previous-matching-input)
965 (define-key term-mode-map "\es" 'term-next-matching-input)
967 (define-key term-mode-map [?\A-\M-r]
968 'term-previous-matching-input-from-input)
969 (define-key term-mode-map [?\A-\M-s] 'term-next-matching-input-from-input))
970 (define-key term-mode-map "\e\C-l" 'term-show-output)
971 (define-key term-mode-map "\C-m" 'term-send-input)
972 (define-key term-mode-map "\C-d" 'term-delchar-or-maybe-eof)
973 (define-key term-mode-map "\C-c\C-a" 'term-bol)
974 (define-key term-mode-map "\C-c\C-u" 'term-kill-input)
975 (define-key term-mode-map "\C-c\C-w" 'backward-kill-word)
976 (define-key term-mode-map "\C-c\C-c" 'term-interrupt-subjob)
977 (define-key term-mode-map "\C-c\C-z" 'term-stop-subjob)
978 (define-key term-mode-map "\C-c\C-\\" 'term-quit-subjob)
979 (define-key term-mode-map "\C-c\C-m" 'term-copy-old-input)
980 (define-key term-mode-map "\C-c\C-o" 'term-kill-output)
981 (define-key term-mode-map "\C-c\C-r" 'term-show-output)
982 (define-key term-mode-map "\C-c\C-e" 'term-show-maximum-output)
983 (define-key term-mode-map "\C-c\C-l" 'term-dynamic-list-input-ring)
984 (define-key term-mode-map "\C-c\C-n" 'term-next-prompt)
985 (define-key term-mode-map "\C-c\C-p" 'term-previous-prompt)
986 (define-key term-mode-map "\C-c\C-d" 'term-send-eof)
987 (define-key term-mode-map "\C-c\C-k" 'term-char-mode)
988 (define-key term-mode-map "\C-c\C-j" 'term-line-mode)
989 (define-key term-mode-map "\C-c\C-q" 'term-pager-toggle)
993 ; (define-key term-mode-map [menu-bar completion]
994 ; (cons "Complete" (make-sparse-keymap "Complete")))
995 ; (define-key term-mode-map [menu-bar completion complete-expand]
996 ; '("Expand File Name" . term-replace-by-expanded-filename))
997 ; (define-key term-mode-map [menu-bar completion complete-listing]
998 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
999 ; (define-key term-mode-map [menu-bar completion complete-file]
1000 ; '("Complete File Name" . term-dynamic-complete-filename))
1001 ; (define-key term-mode-map [menu-bar completion complete]
1002 ; '("Complete Before Point" . term-dynamic-complete))
1003 ; ;; Put them in the menu bar:
1004 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
1005 ; menu-bar-final-items))
1014 (setq newmap (make-sparse-keymap "Terminal"))
1015 (define-key newmap [terminal-pager-enable]
1016 '("Enable paging" . term-fake-pager-enable))
1017 (define-key newmap [terminal-pager-disable]
1018 '("Disable paging" . term-fake-pager-disable))
1019 (define-key newmap [terminal-char-mode]
1020 '("Character mode" . term-char-mode))
1021 (define-key newmap [terminal-line-mode]
1022 '("Line mode" . term-line-mode))
1023 (setq term-terminal-menu (cons "Terminal" newmap))
1025 ;; completion: (line mode only)
1026 (defvar term-completion-menu (make-sparse-keymap "Complete"))
1027 (define-key term-mode-map [menu-bar completion]
1028 (cons "Complete" term-completion-menu))
1029 (define-key term-completion-menu [complete-expand]
1030 '("Expand File Name" . term-replace-by-expanded-filename))
1031 (define-key term-completion-menu [complete-listing]
1032 '("File Completion Listing" . term-dynamic-list-filename-completions))
1033 (define-key term-completion-menu [menu-bar completion complete-file]
1034 '("Complete File Name" . term-dynamic-complete-filename))
1035 (define-key term-completion-menu [menu-bar completion complete]
1036 '("Complete Before Point" . term-dynamic-complete))
1038 ;; Input history: (line mode only)
1039 (defvar term-inout-menu (make-sparse-keymap "In/Out"))
1040 (define-key term-mode-map [menu-bar inout]
1041 (cons "In/Out" term-inout-menu))
1042 (define-key term-inout-menu [kill-output]
1043 '("Kill Current Output Group" . term-kill-output))
1044 (define-key term-inout-menu [next-prompt]
1045 '("Forward Output Group" . term-next-prompt))
1046 (define-key term-inout-menu [previous-prompt]
1047 '("Backward Output Group" . term-previous-prompt))
1048 (define-key term-inout-menu [show-maximum-output]
1049 '("Show Maximum Output" . term-show-maximum-output))
1050 (define-key term-inout-menu [show-output]
1051 '("Show Current Output Group" . term-show-output))
1052 (define-key term-inout-menu [kill-input]
1053 '("Kill Current Input" . term-kill-input))
1054 (define-key term-inout-menu [copy-input]
1055 '("Copy Old Input" . term-copy-old-input))
1056 (define-key term-inout-menu [forward-matching-history]
1057 '("Forward Matching Input..." . term-forward-matching-input))
1058 (define-key term-inout-menu [backward-matching-history]
1059 '("Backward Matching Input..." . term-backward-matching-input))
1060 (define-key term-inout-menu [next-matching-history]
1061 '("Next Matching Input..." . term-next-matching-input))
1062 (define-key term-inout-menu [previous-matching-history]
1063 '("Previous Matching Input..." . term-previous-matching-input))
1064 (define-key term-inout-menu [next-matching-history-from-input]
1065 '("Next Matching Current Input" . term-next-matching-input-from-input))
1066 (define-key term-inout-menu [previous-matching-history-from-input]
1067 '("Previous Matching Current Input" .
1068 term-previous-matching-input-from-input))
1069 (define-key term-inout-menu [next-history]
1070 '("Next Input" . term-next-input))
1071 (define-key term-inout-menu [previous-history]
1072 '("Previous Input" . term-previous-input))
1073 (define-key term-inout-menu [list-history]
1074 '("List Input History" . term-dynamic-list-input-ring))
1075 (define-key term-inout-menu [expand-history]
1076 '("Expand History Before Point" . term-replace-by-expanded-history))
1079 (setq newmap (make-sparse-keymap "Signals"))
1080 (define-key newmap [eof] '("EOF" . term-send-eof))
1081 (define-key newmap [kill] '("KILL" . term-kill-subjob))
1082 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
1083 (define-key newmap [cont] '("CONT" . term-continue-subjob))
1084 (define-key newmap [stop] '("STOP" . term-stop-subjob))
1085 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
1086 (define-key term-mode-map [menu-bar signals]
1087 (setq term-signals-menu (cons "Signals" newmap)))
1090 (defun term-reset-size (height width)
1091 (setq term-height height)
1092 (setq term-width width)
1093 (setq term-start-line-column nil)
1094 (setq term-current-row nil)
1095 (setq term-current-column nil)
1096 (term-scroll-region 0 height))
1098 ;; Recursive routine used to check if any string in term-kill-echo-list
1099 ;; matches part of the buffer before point.
1100 ;; If so, delete that matched part of the buffer - this suppresses echo.
1101 ;; Also, remove that string from the term-kill-echo-list.
1102 ;; We *also* remove any older string on the list, as a sanity measure,
1103 ;; in case something gets out of sync. (Except for type-ahead, there
1104 ;; should only be one element in the list.)
1106 (defun term-check-kill-echo-list ()
1107 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1112 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1113 (if (and (>= start (point-min))
1114 (string= str (buffer-substring start (point))))
1115 (progn (delete-backward-char len)
1116 (setq term-kill-echo-list (cdr cur))
1117 (setq term-current-column nil)
1118 (setq term-current-row nil)
1119 (setq term-start-line-column nil)
1120 (setq cur nil found t))
1121 (setq cur (cdr cur))))))
1123 (goto-char save-point)))
1126 (defun term-check-size (process)
1127 (if (or (/= term-height (1- (window-height)))
1128 (/= term-width (1- (window-width))))
1130 (term-reset-size (1- (window-height)) (1- (window-width)))
1131 (set-process-window-size process term-height term-width))))
1133 (defun term-send-raw-string (chars)
1134 (let ((proc (get-buffer-process (current-buffer))))
1136 (error "Current buffer has no process")
1137 ;; Note that (term-current-row) must be called *after*
1138 ;; (point) has been updated to (process-mark proc).
1139 (goto-char (process-mark proc))
1140 (if (term-pager-enabled)
1141 (setq term-pager-count (term-current-row)))
1142 (process-send-string proc chars))))
1144 (defun term-send-raw ()
1145 "Send the last character typed through the terminal-emulator
1146 without any interpretation."
1148 ;; Convert `return' to C-m, etc.
1149 (if (and (symbolp last-input-char)
1150 (get last-input-char 'ascii-character))
1151 (setq last-input-char (get last-input-char 'ascii-character)))
1152 (term-send-raw-string (make-string 1 last-input-char)))
1154 (defun term-send-raw-meta ()
1156 (if (symbolp last-input-char)
1157 ;; Convert `return' to C-m, etc.
1158 (let ((tmp (get last-input-char 'event-symbol-elements)))
1160 (setq last-input-char (car tmp)))
1161 (if (symbolp last-input-char)
1163 (setq tmp (get last-input-char 'ascii-character))
1164 (if tmp (setq last-input-char tmp))))))
1165 (term-send-raw-string (if (and (numberp last-input-char)
1166 (> last-input-char 127)
1167 (< last-input-char 256))
1168 (make-string 1 last-input-char)
1169 (format "\e%c" last-input-char))))
1171 (defun term-mouse-paste (click arg)
1172 "Insert the last stretch of killed text at the position clicked on."
1173 (interactive "e\nP")
1175 (term-send-raw-string (or (condition-case () (x-get-selection) (error ()))
1177 (error "No selection or cut buffer available"))))
1179 ;; Give temporary modes such as isearch a chance to turn off.
1180 (run-hooks 'mouse-leave-buffer-hook)
1181 (setq this-command 'yank)
1182 (term-send-raw-string (current-kill (cond
1187 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1188 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1189 ;; For example: vi works with \eOA while elm wants \e[A ...
1190 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1191 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1192 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1193 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1194 (defun term-send-home () (interactive) (term-send-raw-string "\e[H"))
1195 (defun term-send-end () (interactive) (term-send-raw-string "\eOw"))
1196 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1197 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1198 (defun term-send-del () (interactive) (term-send-raw-string "\C-?"))
1199 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-H"))
1201 (defun term-set-escape-char (c)
1202 "Change term-escape-char and keymaps that depend on it."
1203 (if term-escape-char
1204 (define-key term-raw-map term-escape-char 'term-send-raw))
1205 (setq c (make-string 1 c))
1206 (define-key term-raw-map c term-raw-escape-map)
1207 ;; Define standard bindings in term-raw-escape-map
1208 (define-key term-raw-escape-map "\C-x"
1209 (lookup-key (current-global-map) "\C-x"))
1210 (define-key term-raw-escape-map "\C-v"
1211 (lookup-key (current-global-map) "\C-v"))
1212 (define-key term-raw-escape-map "\C-u"
1213 (lookup-key (current-global-map) "\C-u"))
1214 (define-key term-raw-escape-map c 'term-send-raw)
1215 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
1216 ;; The keybinding for term-char-mode is needed by the menubar code.
1217 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
1218 (define-key term-raw-escape-map "\C-j" 'term-line-mode))
1220 (defun term-char-mode ()
1221 "Switch to char (\"raw\") sub-mode of term mode.
1222 Each character you type is sent directly to the inferior without
1223 intervention from Emacs, except for the escape character (usually C-c)."
1225 (if (not term-raw-map)
1226 (let* ((map (make-keymap))
1227 (esc-map (make-keymap))
1230 (define-key map (make-string 1 i) 'term-send-raw)
1231 (define-key esc-map (make-string 1 i) 'term-send-raw-meta)
1233 (define-key map "\e" esc-map)
1234 (setq term-raw-map map)
1235 (setq term-raw-escape-map
1236 (copy-keymap (lookup-key (current-global-map) "\C-x")))
1238 ;;; Added nearly all the 'grey keys' -mm
1242 (define-key term-raw-map [button2] 'term-mouse-paste))
1244 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
1245 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
1246 (define-key term-raw-map [menu-bar signals] term-signals-menu))
1247 (define-key term-raw-map [up] 'term-send-up)
1248 (define-key term-raw-map [down] 'term-send-down)
1249 (define-key term-raw-map [right] 'term-send-right)
1250 (define-key term-raw-map [left] 'term-send-left)
1251 (define-key term-raw-map [delete] 'term-send-del)
1252 (define-key term-raw-map [backspace] 'term-send-backspace)
1253 (define-key term-raw-map [home] 'term-send-home)
1254 (define-key term-raw-map [end] 'term-send-end)
1255 (define-key term-raw-map [prior] 'term-send-prior)
1256 (define-key term-raw-map [next] 'term-send-next))
1259 (term-set-escape-char ?\C-c)))
1260 ;; FIXME: Emit message? Cfr ilisp-raw-message
1261 (if (term-in-line-mode)
1263 (setq term-old-mode-map (current-local-map))
1264 (use-local-map term-raw-map)
1266 ;; Send existing partial line to inferior (without newline).
1267 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1268 (save-input-sender term-input-sender))
1269 (if (> (point) pmark)
1272 (setq term-input-sender
1273 (symbol-function 'term-send-string))
1276 (setq term-input-sender save-input-sender))))
1277 (term-update-mode-line))))
1279 (defun term-line-mode ()
1280 "Switch to line (\"cooked\") sub-mode of term mode.
1281 This means that Emacs editing commands work as normally, until
1282 you type \\[term-send-input] which sends the current line to the inferior."
1284 (if (term-in-char-mode)
1286 (use-local-map term-old-mode-map)
1287 (term-update-mode-line))))
1289 (defun term-update-mode-line ()
1290 (setq mode-line-process
1291 (if (term-in-char-mode)
1292 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
1293 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
1294 (force-mode-line-update))
1296 (defun term-check-proc (buffer)
1297 "True if there is a process associated w/buffer BUFFER, and
1298 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
1300 (let ((proc (get-buffer-process buffer)))
1301 (and proc (memq (process-status proc) '(run stop)))))
1304 (defun make-term (name program &optional startfile &rest switches)
1305 "Make a term process NAME in a buffer, running PROGRAM.
1306 The name of the buffer is made by surrounding NAME with `*'s.
1307 If there is already a running process in that buffer, it is not restarted.
1308 Optional third arg STARTFILE is the name of a file to send the contents of to
1309 the process. Any more args are arguments to PROGRAM."
1310 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1311 ;; If no process, or nuked process, crank up a new one and put buffer in
1312 ;; term mode. Otherwise, leave buffer and existing process alone.
1313 (cond ((not (term-check-proc buffer))
1316 (term-mode)) ; Install local vars, mode, keymap, ...
1317 (term-exec buffer name program startfile switches)))
1321 (defun term (program)
1322 "Start a terminal-emulator in a new buffer."
1323 (interactive (list (read-from-minibuffer "Run program: "
1324 (or explicit-shell-file-name
1328 (set-buffer (make-term "terminal" program))
1331 (switch-to-buffer "*terminal*"))
1333 (defun term-exec (buffer name command startfile switches)
1334 "Start up a process in buffer for term modes.
1335 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1336 You can use this to cheaply run a series of processes in the same term
1337 buffer. The hook term-exec-hook is run after each exec."
1340 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1341 (if proc (delete-process proc)))
1342 ;; Crank up a new process
1343 (let ((proc (term-exec-1 name buffer command switches)))
1344 (make-local-variable 'term-ptyp)
1345 (setq term-ptyp process-connection-type) ; T if pty, NIL if pipe.
1346 ;; Jump to the end, and set the process mark.
1347 (goto-char (point-max))
1348 (set-marker (process-mark proc) (point))
1349 (set-process-filter proc 'term-emulate-terminal)
1350 ;; Feed it the startfile.
1352 ;;This is guaranteed to wait long enough
1353 ;;but has bad results if the term does not prompt at all
1354 ;; (while (= size (buffer-size))
1356 ;;I hope 1 second is enough!
1358 (goto-char (point-max))
1359 (insert-file-contents startfile)
1360 (setq startfile (buffer-substring (point) (point-max)))
1361 (delete-region (point) (point-max))
1362 (term-send-string proc startfile)))
1363 (run-hooks 'term-exec-hook)
1366 ;;; Name to use for TERM.
1367 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
1368 (defvar term-term-name "eterm")
1369 ; Format string, usage:
1370 ; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1371 (defvar term-termcap-format
1372 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1373 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1374 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=\\n\
1375 :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1376 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1377 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1378 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC"
1380 "termcap capabilities supported")
1382 ;;; This auxiliary function cranks up the process for term-exec in
1383 ;;; the appropriate environment.
1385 (defun term-exec-1 (name buffer command switches)
1386 ;; We need to do an extra (fork-less) exec to run stty.
1387 ;; (This would not be needed if we had suitable Emacs primitives.)
1388 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1389 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1390 ;; Thus we add an extra dummy argument "..", and then remove it.
1391 (let ((process-environment
1394 (format "TERM=%s" term-term-name)
1395 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
1396 (format "TERMINFO=%s" data-directory)
1397 (format term-termcap-format "TERMCAP="
1398 term-term-name term-height term-width))
1399 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1400 (format "LINES=%d" term-height)
1401 (format "COLUMNS=%d" term-width))
1402 process-environment))
1403 (process-connection-type t))
1404 (apply 'start-process name buffer
1406 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1407 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1408 term-height term-width)
1412 ;;; This should be in Emacs, but it isn't.
1413 (defun term-mem (item list &optional elt=)
1414 "Test to see if ITEM is equal to an item in LIST.
1415 Option comparison function ELT= defaults to equal."
1416 (let ((elt= (or elt= (function equal)))
1418 (while (and list (not done))
1419 (if (funcall elt= item (car list))
1421 (setq list (cdr list))))
1425 ;;; Input history processing in a buffer
1426 ;;; ===========================================================================
1427 ;;; Useful input history functions, courtesy of the Ergo group.
1429 ;;; Eleven commands:
1430 ;;; term-dynamic-list-input-ring List history in help buffer.
1431 ;;; term-previous-input Previous input...
1432 ;;; term-previous-matching-input ...matching a string.
1433 ;;; term-previous-matching-input-from-input ... matching the current input.
1434 ;;; term-next-input Next input...
1435 ;;; term-next-matching-input ...matching a string.
1436 ;;; term-next-matching-input-from-input ... matching the current input.
1437 ;;; term-backward-matching-input Backwards input...
1438 ;;; term-forward-matching-input ...matching a string.
1439 ;;; term-replace-by-expanded-history Expand history at point;
1440 ;;; replace with expanded history.
1441 ;;; term-magic-space Expand history and insert space.
1443 ;;; Three functions:
1444 ;;; term-read-input-ring Read into term-input-ring...
1445 ;;; term-write-input-ring Write to term-input-ring-file-name.
1446 ;;; term-replace-by-expanded-history-before-point Workhorse function.
1448 (defun term-read-input-ring (&optional silent)
1449 "Sets the buffer's `term-input-ring' from a history file.
1450 The name of the file is given by the variable `term-input-ring-file-name'.
1451 The history ring is of size `term-input-ring-size', regardless of file size.
1452 If `term-input-ring-file-name' is nil this function does nothing.
1454 If the optional argument SILENT is non-nil, we say nothing about a
1455 failure to read the history file.
1457 This function is useful for major mode commands and mode hooks.
1459 The structure of the history file should be one input command per line,
1460 with the most recent command last.
1461 See also `term-input-ignoredups' and `term-write-input-ring'."
1462 (cond ((or (null term-input-ring-file-name)
1463 (equal term-input-ring-file-name ""))
1465 ((not (file-readable-p term-input-ring-file-name))
1467 (message "Cannot read history file %s"
1468 term-input-ring-file-name)))
1470 (let ((history-buf (get-buffer-create " *temp*"))
1471 (file term-input-ring-file-name)
1473 (ring (make-ring term-input-ring-size)))
1476 (set-buffer history-buf)
1479 (insert-file-contents file)
1480 ;; Save restriction in case file is already visited...
1481 ;; Watch for those date stamps in history files!
1482 (goto-char (point-max))
1483 (while (and (< count term-input-ring-size)
1484 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1486 (let ((history (buffer-substring (match-beginning 1)
1488 (if (or (null term-input-ignoredups)
1490 (not (string-equal (ring-ref ring 0) history)))
1491 (ring-insert-at-beginning ring history)))
1492 (setq count (1+ count))))
1493 (kill-buffer history-buf))
1494 (setq term-input-ring ring
1495 term-input-ring-index nil)))))
1497 (defun term-write-input-ring ()
1498 "Writes the buffer's `term-input-ring' to a history file.
1499 The name of the file is given by the variable `term-input-ring-file-name'.
1500 The original contents of the file are lost if `term-input-ring' is not empty.
1501 If `term-input-ring-file-name' is nil this function does nothing.
1503 Useful within process sentinels.
1505 See also `term-read-input-ring'."
1506 (cond ((or (null term-input-ring-file-name)
1507 (equal term-input-ring-file-name "")
1508 (null term-input-ring) (ring-empty-p term-input-ring))
1510 ((not (file-writable-p term-input-ring-file-name))
1511 (message "Cannot write history file %s" term-input-ring-file-name))
1513 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1514 (ring term-input-ring)
1515 (file term-input-ring-file-name)
1516 (index (ring-length ring)))
1517 ;; Write it all out into a buffer first. Much faster, but messier,
1518 ;; than writing it one line at a time.
1520 (set-buffer history-buf)
1523 (setq index (1- index))
1524 (insert (ring-ref ring index) ?\n))
1525 (write-region (buffer-string) nil file nil 'no-message)
1526 (kill-buffer nil))))))
1529 (defun term-dynamic-list-input-ring ()
1530 "List in help buffer the buffer's input history."
1532 (if (or (not (ring-p term-input-ring))
1533 (ring-empty-p term-input-ring))
1534 (message "No history")
1536 (history-buffer " *Input History*")
1537 (index (1- (ring-length term-input-ring)))
1538 (conf (current-window-configuration)))
1539 ;; We have to build up a list ourselves from the ring vector.
1541 (setq history (cons (ring-ref term-input-ring index) history)
1543 ;; Change "completion" to "history reference"
1544 ;; to make the display accurate.
1545 (with-output-to-temp-buffer history-buffer
1546 (display-completion-list history)
1547 (set-buffer history-buffer)
1549 (while (search-backward "completion" nil 'move)
1550 (replace-match "history reference")))
1552 (message "Hit space to flush")
1553 (let ((ch (read-event)))
1555 (set-window-configuration conf)
1556 (setq unread-command-events (list ch)))))))
1559 (defun term-regexp-arg (prompt)
1560 ;; Return list of regexp and prefix arg using PROMPT.
1561 (let* ((minibuffer-history-sexp-flag nil)
1562 ;; Don't clobber this.
1563 (last-command last-command)
1564 (regexp (read-from-minibuffer prompt nil nil nil
1565 'minibuffer-history-search-history)))
1566 (list (if (string-equal regexp "")
1567 (setcar minibuffer-history-search-history
1568 (nth 1 minibuffer-history-search-history))
1570 (prefix-numeric-value current-prefix-arg))))
1572 (defun term-search-arg (arg)
1573 ;; First make sure there is a ring and that we are after the process mark
1574 (cond ((not (term-after-pmark-p))
1575 (error "Not at command line"))
1576 ((or (null term-input-ring)
1577 (ring-empty-p term-input-ring))
1578 (error "Empty input ring"))
1580 ;; arg of zero resets search from beginning, and uses arg of 1
1581 (setq term-input-ring-index nil)
1586 (defun term-search-start (arg)
1587 ;; Index to start a directional search, starting at term-input-ring-index
1588 (if term-input-ring-index
1589 ;; If a search is running, offset by 1 in direction of arg
1590 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1591 (ring-length term-input-ring))
1592 ;; For a new search, start from beginning or end, as appropriate
1594 0 ; First elt for forward search
1595 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1597 (defun term-previous-input-string (arg)
1598 "Return the string ARG places along the input ring.
1599 Moves relative to `term-input-ring-index'."
1600 (ring-ref term-input-ring (if term-input-ring-index
1601 (mod (+ arg term-input-ring-index)
1602 (ring-length term-input-ring))
1605 (defun term-previous-input (arg)
1606 "Cycle backwards through input history."
1608 (term-previous-matching-input "." arg))
1610 (defun term-next-input (arg)
1611 "Cycle forwards through input history."
1613 (term-previous-input (- arg)))
1615 (defun term-previous-matching-input-string (regexp arg)
1616 "Return the string matching REGEXP ARG places along the input ring.
1617 Moves relative to `term-input-ring-index'."
1618 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1619 (if pos (ring-ref term-input-ring pos))))
1621 (defun term-previous-matching-input-string-position
1622 (regexp arg &optional start)
1623 "Return the index matching REGEXP ARG places along the input ring.
1624 Moves relative to START, or `term-input-ring-index'."
1625 (if (or (not (ring-p term-input-ring))
1626 (ring-empty-p term-input-ring))
1627 (error "No history"))
1628 (let* ((len (ring-length term-input-ring))
1629 (motion (if (> arg 0) 1 -1))
1630 (n (mod (- (or start (term-search-start arg)) motion) len))
1631 (tried-each-ring-item nil)
1633 ;; Do the whole search as many times as the argument says.
1634 (while (and (/= arg 0) (not tried-each-ring-item))
1637 n (mod (+ n motion) len))
1638 ;; If we haven't reached a match, step some more.
1639 (while (and (< n len) (not tried-each-ring-item)
1640 (not (string-match regexp (ring-ref term-input-ring n))))
1641 (setq n (mod (+ n motion) len)
1642 ;; If we have gone all the way around in this search.
1643 tried-each-ring-item (= n prev)))
1644 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1645 ;; Now that we know which ring element to use, if we found it, return that.
1646 (if (string-match regexp (ring-ref term-input-ring n))
1649 (defun term-previous-matching-input (regexp arg)
1650 "Search backwards through input history for match for REGEXP.
1651 \(Previous history elements are earlier commands.)
1652 With prefix argument N, search for Nth previous match.
1653 If N is negative, find the next or Nth next match."
1654 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1655 (setq arg (term-search-arg arg))
1656 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1657 ;; Has a match been found?
1660 (setq term-input-ring-index pos)
1661 (message "History item: %d" (1+ pos))
1663 ;; Can't use kill-region as it sets this-command
1664 (process-mark (get-buffer-process (current-buffer))) (point))
1665 (insert (ring-ref term-input-ring pos)))))
1667 (defun term-next-matching-input (regexp arg)
1668 "Search forwards through input history for match for REGEXP.
1669 \(Later history elements are more recent commands.)
1670 With prefix argument N, search for Nth following match.
1671 If N is negative, find the previous or Nth previous match."
1672 (interactive (term-regexp-arg "Next input matching (regexp): "))
1673 (term-previous-matching-input regexp (- arg)))
1675 (defun term-previous-matching-input-from-input (arg)
1676 "Search backwards through input history for match for current input.
1677 \(Previous history elements are earlier commands.)
1678 With prefix argument N, search for Nth previous match.
1679 If N is negative, search forwards for the -Nth following match."
1681 (if (not (memq last-command '(term-previous-matching-input-from-input
1682 term-next-matching-input-from-input)))
1683 ;; Starting a new search
1684 (setq term-matching-input-from-input-string
1686 (process-mark (get-buffer-process (current-buffer)))
1688 term-input-ring-index nil))
1689 (term-previous-matching-input
1690 (concat "^" (regexp-quote term-matching-input-from-input-string))
1693 (defun term-next-matching-input-from-input (arg)
1694 "Search forwards through input history for match for current input.
1695 \(Following history elements are more recent commands.)
1696 With prefix argument N, search for Nth following match.
1697 If N is negative, search backwards for the -Nth previous match."
1699 (term-previous-matching-input-from-input (- arg)))
1702 (defun term-replace-by-expanded-history (&optional silent)
1703 "Expand input command history references before point.
1704 Expansion is dependent on the value of `term-input-autoexpand'.
1706 This function depends on the buffer's idea of the input history, which may not
1707 match the command interpreter's idea, assuming it has one.
1709 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1710 cannot know the interpreter's idea of input line numbers, assuming it has one,
1711 it cannot expand absolute input line number references.
1713 If the optional argument SILENT is non-nil, never complain
1714 even if history reference seems erroneous.
1716 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1718 Returns t if successful."
1720 (if (and term-input-autoexpand
1721 (string-match "[!^]" (funcall term-get-old-input))
1722 (save-excursion (beginning-of-line)
1723 (looking-at term-prompt-regexp)))
1724 ;; Looks like there might be history references in the command.
1725 (let ((previous-modified-tick (buffer-modified-tick)))
1726 (message "Expanding history references...")
1727 (term-replace-by-expanded-history-before-point silent)
1728 (/= previous-modified-tick (buffer-modified-tick)))))
1731 (defun term-replace-by-expanded-history-before-point (silent)
1732 "Expand directory stack reference before point.
1733 See `term-replace-by-expanded-history'. Returns t if successful."
1735 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1736 (start (progn (term-bol nil) (point))))
1738 (skip-chars-forward "^!^"
1740 (end-of-line nil) (- (point) toend)))
1743 (end-of-line nil) (- (point) toend))))
1744 ;; This seems a bit complex. We look for references such as !!, !-num,
1745 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1746 ;; If that wasn't enough, the plings can be suffixed with argument
1747 ;; range specifiers.
1748 ;; Argument ranges are complex too, so we hive off the input line,
1749 ;; referenced with plings, with the range string to `term-args'.
1750 (setq term-input-ring-index nil)
1751 (cond ((or (= (preceding-char) ?\\)
1752 (term-within-quotes start (point)))
1753 ;; The history is quoted, or we're in quotes.
1754 (goto-char (1+ (point))))
1755 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1756 ;; We cannot know the interpreter's idea of input line numbers.
1757 (goto-char (match-end 0))
1758 (message "Absolute reference cannot be expanded"))
1759 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1760 ;; Just a number of args from `number' lines backward.
1761 (let ((number (1- (string-to-number
1762 (buffer-substring (match-beginning 1)
1764 (if (<= number (ring-length term-input-ring))
1767 (term-args (term-previous-input-string number)
1768 (match-beginning 2) (match-end 2))
1770 (setq term-input-ring-index number)
1771 (message "History item: %d" (1+ number)))
1772 (goto-char (match-end 0))
1773 (message "Relative reference exceeds input history size"))))
1774 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1775 ;; Just a number of args from the previous input line.
1777 (term-args (term-previous-input-string 0)
1778 (match-beginning 1) (match-end 1))
1780 (message "History item: previous"))
1782 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1783 ;; Most recent input starting with or containing (possibly
1784 ;; protected) string, maybe just a number of args. Phew.
1785 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1786 (mb2 (match-beginning 2)) (me2 (match-end 2))
1787 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1788 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1789 (pos (save-match-data
1790 (term-previous-matching-input-string-position
1791 (concat pref (regexp-quote exp)) 1))))
1794 (goto-char (match-end 0))
1796 (progn (message "Not found")
1798 (setq term-input-ring-index pos)
1800 (term-args (ring-ref term-input-ring pos)
1801 (match-beginning 4) (match-end 4))
1803 (message "History item: %d" (1+ pos)))))
1804 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1805 ;; Quick substitution on the previous input line.
1806 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1807 (new (buffer-substring (match-beginning 2) (match-end 2)))
1809 (replace-match (term-previous-input-string 0) t t)
1811 (goto-char (match-beginning 0))
1812 (if (not (search-forward old pos t))
1814 (error "Not found"))
1815 (replace-match new t t)
1816 (message "History item: substituted"))))
1818 (goto-char (match-end 0))))))))
1821 (defun term-magic-space (arg)
1822 "Expand input history references before point and insert ARG spaces.
1823 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1825 (term-replace-by-expanded-history)
1826 (self-insert-command arg))
1828 (defun term-within-quotes (beg end)
1829 "Return t if the number of quotes between BEG and END is odd.
1830 Quotes are single and double."
1831 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1832 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1833 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1835 (defun term-how-many-region (regexp beg end)
1836 "Return number of matches for REGEXP from BEG to END."
1841 (while (re-search-forward regexp end t)
1842 (setq count (1+ count)))))
1845 (defun term-args (string begin end)
1846 ;; From STRING, return the args depending on the range specified in the text
1847 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1848 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1851 (term-arguments string 0 nil)
1852 (let* ((range (buffer-substring
1853 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1854 (nth (cond ((string-match "^[*^]" range) 1)
1855 ((string-match "^-" range) 0)
1856 ((string-equal range "$") nil)
1857 (t (string-to-number range))))
1858 (mth (cond ((string-match "[-*$]$" range) nil)
1859 ((string-match "-" range)
1860 (string-to-number (substring range (match-end 0))))
1862 (term-arguments string nth mth)))))
1864 ;; Return a list of arguments from ARG. Break it up at the
1865 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1866 (defun term-delim-arg (arg)
1867 (if (null term-delimiter-argument-list)
1873 (let ((char (aref arg pos))
1875 (if (memq char term-delimiter-argument-list)
1876 (while (and (< pos len) (eq (aref arg pos) char))
1877 (setq pos (1+ pos)))
1878 (while (and (< pos len)
1879 (not (memq (aref arg pos)
1880 term-delimiter-argument-list)))
1881 (setq pos (1+ pos))))
1882 (setq args (cons (substring arg start pos) args))))
1885 (defun term-arguments (string nth mth)
1886 "Return from STRING the NTH to MTH arguments.
1887 NTH and/or MTH can be nil, which means the last argument.
1888 Returned arguments are separated by single spaces.
1889 We assume whitespace separates arguments, except within quotes.
1890 Also, a run of one or more of a single character
1891 in `term-delimiter-argument-list' is a separate argument.
1892 Argument 0 is the command name."
1893 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1897 ;; Build a list of all the args until we have as many as we want.
1898 (while (and (or (null mth) (<= count mth))
1899 (string-match argpart string pos))
1900 (if (and beg (= pos (match-beginning 0)))
1901 ;; It's contiguous, part of the same arg.
1902 (setq pos (match-end 0)
1903 quotes (or quotes (match-beginning 1)))
1904 ;; It's a new separate arg.
1906 ;; Put the previous arg, if there was one, onto ARGS.
1907 (setq str (substring string beg pos)
1908 args (if quotes (cons str args)
1909 (nconc (term-delim-arg str) args))
1911 (setq quotes (match-beginning 1))
1912 (setq beg (match-beginning 0))
1913 (setq pos (match-end 0))))
1915 (setq str (substring string beg pos)
1916 args (if quotes (cons str args)
1917 (nconc (term-delim-arg str) args))
1919 (let ((n (or nth (1- count)))
1920 (m (if mth (1- (- count mth)) 0)))
1922 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1925 ;;; Input processing stuff [line mode]
1928 (defun term-send-input ()
1929 "Send input to process.
1930 After the process output mark, sends all text from the process mark to
1931 point as input to the process. Before the process output mark, calls value
1932 of variable term-get-old-input to retrieve old input, copies it to the
1933 process mark, and sends it. A terminal newline is also inserted into the
1934 buffer and sent to the process. The list of function names contained in the
1935 value of `term-input-filter-functions' is called on the input before sending
1936 it. The input is entered into the input history ring, if the value of variable
1937 term-input-filter returns non-nil when called on the input.
1939 Any history reference may be expanded depending on the value of the variable
1940 `term-input-autoexpand'. The list of function names contained in the value
1941 of `term-input-filter-functions' is called on the input before sending it.
1942 The input is entered into the input history ring, if the value of variable
1943 `term-input-filter' returns non-nil when called on the input.
1945 If variable `term-eol-on-send' is non-nil, then point is moved to the
1946 end of line before sending the input.
1948 The values of `term-get-old-input', `term-input-filter-functions', and
1949 `term-input-filter' are chosen according to the command interpreter running
1950 in the buffer. E.g.,
1952 If the interpreter is the csh,
1953 term-get-old-input is the default: take the current line, discard any
1954 initial string matching regexp term-prompt-regexp.
1955 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
1956 \"popd\" commands. When it sees one, it cd's the buffer.
1957 term-input-filter is the default: returns T if the input isn't all white
1960 If the term is Lucid Common Lisp,
1961 term-get-old-input snarfs the sexp ending at point.
1962 term-input-filter-functions does nothing.
1963 term-input-filter returns NIL if the input matches input-filter-regexp,
1964 which matches (1) all whitespace (2) :a, :c, etc.
1966 Similarly for Soar, Scheme, etc."
1968 ;; Note that the input string does not include its terminal newline.
1969 (let ((proc (get-buffer-process (current-buffer))))
1970 (if (not proc) (error "Current buffer has no process")
1971 (let* ((pmark (process-mark proc))
1972 (pmark-val (marker-position pmark))
1973 (input-is-new (>= (point) pmark-val))
1974 (intxt (if input-is-new
1975 (progn (if term-eol-on-send (end-of-line))
1976 (buffer-substring pmark (point)))
1977 (funcall term-get-old-input)))
1978 (input (if (not (eq term-input-autoexpand 'input))
1979 ;; Just whatever's already there
1981 ;; Expand and leave it visible in buffer
1982 (term-replace-by-expanded-history t)
1983 (buffer-substring pmark (point))))
1984 (history (if (not (eq term-input-autoexpand 'history))
1986 ;; This is messy 'cos ultimately the original
1987 ;; functions used do insertion, rather than return
1988 ;; strings. We have to expand, then insert back.
1989 (term-replace-by-expanded-history t)
1990 (let ((copy (buffer-substring pmark (point))))
1991 (delete-region pmark (point))
1994 (if (term-pager-enabled)
1996 (goto-char (process-mark proc))
1997 (setq term-pager-count (term-current-row))))
1998 (if (and (funcall term-input-filter history)
1999 (or (null term-input-ignoredups)
2000 (not (ring-p term-input-ring))
2001 (ring-empty-p term-input-ring)
2002 (not (string-equal (ring-ref term-input-ring 0)
2004 (ring-insert term-input-ring history))
2005 (let ((functions term-input-filter-functions))
2007 (funcall (car functions) (concat input "\n"))
2008 (setq functions (cdr functions))))
2009 (setq term-input-ring-index nil)
2011 ;; Update the markers before we send the input
2012 ;; in case we get output amidst sending the input.
2013 (set-marker term-last-input-start pmark)
2014 (set-marker term-last-input-end (point))
2017 ;; Set up to delete, because inferior should echo.
2018 (if (marker-buffer term-pending-delete-marker)
2019 (delete-region term-pending-delete-marker pmark))
2020 (set-marker term-pending-delete-marker pmark-val)
2021 (set-marker (process-mark proc) (point))))
2023 (funcall term-input-sender proc input)))))
2025 (defun term-get-old-input-default ()
2026 "Default for term-get-old-input.
2027 Take the current line, and discard any initial text matching
2028 term-prompt-regexp."
2032 (let ((beg (point)))
2034 (buffer-substring beg (point)))))
2036 (defun term-copy-old-input ()
2037 "Insert after prompt old input at point as new input to be edited.
2038 Calls `term-get-old-input' to get old input."
2040 (let ((input (funcall term-get-old-input))
2041 (process (get-buffer-process (current-buffer))))
2043 (error "Current buffer has no process")
2044 (goto-char (process-mark process))
2047 (defun term-skip-prompt ()
2048 "Skip past the text matching regexp term-prompt-regexp.
2049 If this takes us past the end of the current line, don't skip at all."
2050 (let ((eol (save-excursion (end-of-line) (point))))
2051 (if (and (looking-at term-prompt-regexp)
2052 (<= (match-end 0) eol))
2053 (goto-char (match-end 0)))))
2056 (defun term-after-pmark-p ()
2057 "Is point after the process output marker?"
2058 ;; Since output could come into the buffer after we looked at the point
2059 ;; but before we looked at the process marker's value, we explicitly
2060 ;; serialise. This is just because I don't know whether or not Emacs
2061 ;; services input during execution of lisp commands.
2062 (let ((proc-pos (marker-position
2063 (process-mark (get-buffer-process (current-buffer))))))
2064 (<= proc-pos (point))))
2066 (defun term-simple-send (proc string)
2067 "Default function for sending to PROC input STRING.
2068 This just sends STRING plus a newline. To override this,
2069 set the hook TERM-INPUT-SENDER."
2070 (term-send-string proc string)
2071 (term-send-string proc "\n"))
2073 (defun term-bol (arg)
2074 "Goes to the beginning of line, then skips past the prompt, if any.
2075 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2076 -- go straight to column 0.
2078 The prompt skip is done by skipping text matching the regular expression
2079 term-prompt-regexp, a buffer local variable."
2082 (if (null arg) (term-skip-prompt)))
2084 ;;; These two functions are for entering text you don't want echoed or
2085 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
2086 ;;; Just enter m-x term-send-invisible and type in your line.
2088 (defun term-read-noecho (prompt &optional stars)
2089 "Read a single line of text from user without echoing, and return it.
2090 Prompt with argument PROMPT, a string. Optional argument STARS causes
2091 input to be echoed with '*' characters on the prompt line. Input ends with
2092 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2093 `inhibit-quit' is set because e.g. this function was called from a process
2094 filter and C-g is pressed, this function returns nil rather than a string).
2096 Note that the keystrokes comprising the text can still be recovered
2097 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2102 (cursor-in-echo-area t)
2106 (message "%s%s" prompt (make-string (length ans) ?*))
2107 (message "%s" prompt))
2108 (setq c (read-char))
2110 ;; This function may get called from a process filter, where
2111 ;; inhibit-quit is set. In later versions of Emacs read-char
2112 ;; may clear quit-flag itself and return C-g. That would make
2113 ;; it impossible to quit this loop in a simple way, so
2114 ;; re-enable it here (for backward-compatibility the check for
2115 ;; quit-flag below would still be necessary, so this seems
2116 ;; like the simplest way to do things).
2119 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2123 ((and (/= c ?\b) (/= c ?\177))
2124 (setq ans (concat ans (char-to-string c))))
2126 (setq ans (substring ans 0 -1)))))
2128 ;; Emulate a true quit, except that we have to return a value.
2130 (setq quit-flag nil)
2136 (defun term-send-invisible (str &optional proc)
2137 "Read a string without echoing.
2138 Then send it to the process running in the current buffer. A new-line
2139 is additionally sent. String is not saved on term input history list.
2140 Security bug: your string can still be temporarily recovered with
2142 (interactive "P") ; Defeat snooping via C-x esc
2143 (if (not (stringp str))
2144 (setq str (term-read-noecho "Non-echoed text: " t)))
2146 (setq proc (get-buffer-process (current-buffer))))
2147 (if (not proc) (error "Current buffer has no process")
2148 (setq term-kill-echo-list (nconc term-kill-echo-list
2150 (term-send-string proc str)
2151 (term-send-string proc "\n")))
2154 ;;; Low-level process communication
2156 (defvar term-input-chunk-size 512
2157 "*Long inputs send to term processes are broken up into chunks of this size.
2158 If your process is choking on big inputs, try lowering the value.")
2160 (defun term-send-string (proc str)
2161 "Send PROCESS the contents of STRING as input.
2162 This is equivalent to process-send-string, except that long input strings
2163 are broken up into chunks of size term-input-chunk-size. Processes
2164 are given a chance to output between chunks. This can help prevent processes
2165 from hanging when you send them long inputs on some OS's."
2166 (let* ((len (length str))
2167 (i (min len term-input-chunk-size)))
2168 (process-send-string proc (substring str 0 i))
2170 (let ((next-i (+ i term-input-chunk-size)))
2171 (accept-process-output)
2172 (process-send-string proc (substring str i (min len next-i)))
2175 (defun term-send-region (proc start end)
2176 "Sends to PROC the region delimited by START and END.
2177 This is a replacement for process-send-region that tries to keep
2178 your process from hanging on long inputs. See term-send-string."
2179 (term-send-string proc (buffer-substring start end)))
2182 ;;; Random input hackage
2184 (defun term-kill-output ()
2185 "Kill all output from interpreter since last input."
2187 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2188 (kill-region term-last-input-end pmark)
2190 (insert "*** output flushed ***\n")
2191 (set-marker pmark (point))))
2193 (defun term-show-output ()
2194 "Display start of this batch of interpreter output at top of window.
2195 Sets mark to the value of point when this command is run."
2197 (goto-char term-last-input-end)
2200 (set-window-start (selected-window) (point))
2203 (defun term-interrupt-subjob ()
2204 "Interrupt the current subjob."
2206 (interrupt-process nil term-ptyp))
2208 (defun term-kill-subjob ()
2209 "Send kill signal to the current subjob."
2211 (kill-process nil term-ptyp))
2213 (defun term-quit-subjob ()
2214 "Send quit signal to the current subjob."
2216 (quit-process nil term-ptyp))
2218 (defun term-stop-subjob ()
2219 "Stop the current subjob.
2220 WARNING: if there is no current subjob, you can end up suspending
2221 the top-level process running in the buffer. If you accidentally do
2222 this, use \\[term-continue-subjob] to resume the process. (This
2223 is not a problem with most shells, since they ignore this signal.)"
2225 (stop-process nil term-ptyp))
2227 (defun term-continue-subjob ()
2228 "Send CONT signal to process buffer's process group.
2229 Useful if you accidentally suspend the top-level process."
2231 (continue-process nil term-ptyp))
2233 (defun term-kill-input ()
2234 "Kill all text from last stuff output by interpreter to point."
2236 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2237 (p-pos (marker-position pmark)))
2238 (if (> (point) p-pos)
2239 (kill-region pmark (point)))))
2241 (defun term-delchar-or-maybe-eof (arg)
2242 "Delete ARG characters forward, or send an EOF to process if at end of
2249 (defun term-send-eof ()
2250 "Send an EOF to the current buffer's process."
2254 (defun term-backward-matching-input (regexp arg)
2255 "Search backward through buffer for match for REGEXP.
2256 Matches are searched for on lines that match `term-prompt-regexp'.
2257 With prefix argument N, search for Nth previous match.
2258 If N is negative, find the next or Nth next match."
2259 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2260 (let* ((re (concat term-prompt-regexp ".*" regexp))
2261 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2262 (if (re-search-backward re nil t arg)
2265 (progn (message "Not found")
2270 (defun term-forward-matching-input (regexp arg)
2271 "Search forward through buffer for match for REGEXP.
2272 Matches are searched for on lines that match `term-prompt-regexp'.
2273 With prefix argument N, search for Nth following match.
2274 If N is negative, find the previous or Nth previous match."
2275 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2276 (term-backward-matching-input regexp (- arg)))
2279 (defun term-next-prompt (n)
2280 "Move to end of Nth next prompt in the buffer.
2281 See `term-prompt-regexp'."
2283 (let ((paragraph-start term-prompt-regexp))
2284 (end-of-line (if (> n 0) 1 0))
2285 (forward-paragraph n)
2286 (term-skip-prompt)))
2288 (defun term-previous-prompt (n)
2289 "Move to end of Nth previous prompt in the buffer.
2290 See `term-prompt-regexp'."
2292 (term-next-prompt (- n)))
2294 ;;; Support for source-file processing commands.
2295 ;;;============================================================================
2296 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2297 ;;; commands that process files of source text (e.g. loading or compiling
2298 ;;; files). So the corresponding process-in-a-buffer modes have commands
2299 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
2300 ;;; for defining these commands.
2302 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2303 ;;; and Soar, in that they don't know anything about file extensions.
2304 ;;; So the compile/load interface gets the wrong default occasionally.
2305 ;;; The load-file/compile-file default mechanism could be smarter -- it
2306 ;;; doesn't know about the relationship between filename extensions and
2307 ;;; whether the file is source or executable. If you compile foo.lisp
2308 ;;; with compile-file, then the next load-file should use foo.bin for
2309 ;;; the default, not foo.lisp. This is tricky to do right, particularly
2310 ;;; because the extension for executable files varies so much (.o, .bin,
2311 ;;; .lbin, .mo, .vo, .ao, ...).
2314 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2317 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2318 ;;; want to save the buffer before issuing any process requests to the command
2321 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2322 ;;; for the file to process.
2324 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2325 ;;;============================================================================
2326 ;;; This function computes the defaults for the load-file and compile-file
2327 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
2329 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2330 ;;; source-file processing command, or nil if there hasn't been one yet.
2331 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
2332 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2333 ;;; Typically, (lisp-mode) or (scheme-mode).
2335 ;;; If the command is given while the cursor is inside a string, *and*
2336 ;;; the string is an existing filename, *and* the filename is not a directory,
2337 ;;; then the string is taken as default. This allows you to just position
2338 ;;; your cursor over a string that's a filename and have it taken as default.
2340 ;;; If the command is given in a file buffer whose major mode is in
2341 ;;; SOURCE-MODES, then the the filename is the default file, and the
2342 ;;; file's directory is the default directory.
2344 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2345 ;;; then the default directory & file are what was used in the last source-file
2346 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2347 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2348 ;;; is the cwd, with no default file. (\"no default file\" = nil)
2350 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2351 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2352 ;;; for Soar programs, etc.
2354 ;;; The function returns a pair: (default-directory . default-file).
2356 (defun term-source-default (previous-dir/file source-modes)
2357 (cond ((and buffer-file-name (memq major-mode source-modes))
2358 (cons (file-name-directory buffer-file-name)
2359 (file-name-nondirectory buffer-file-name)))
2362 (cons default-directory nil))))
2365 ;;; (TERM-CHECK-SOURCE fname)
2366 ;;;============================================================================
2367 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2368 ;;; process-in-a-buffer modes), this function can be called on the filename.
2369 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
2370 ;;; is queried to see if he wants to save the buffer before proceeding with
2371 ;;; the load or compile.
2373 (defun term-check-source (fname)
2374 (let ((buff (get-file-buffer fname)))
2376 (buffer-modified-p buff)
2377 (y-or-n-p (format "Save buffer %s first? "
2378 (buffer-name buff))))
2380 (let ((old-buffer (current-buffer)))
2383 (set-buffer old-buffer)))))
2386 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2387 ;;;============================================================================
2388 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2389 ;;; commands that process source files (like loading or compiling a file).
2390 ;;; It prompts for the filename, provides a default, if there is one,
2391 ;;; and returns the result filename.
2393 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2395 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2396 ;;; from the last source processing command. SOURCE-MODES is a list of major
2397 ;;; modes used to determine what file buffers contain source files. (These
2398 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2399 ;;; then the filename reader will only accept a file that exists.
2402 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2403 ;;; '(lisp-mode) t))
2405 ;;; This is pretty stupid about strings. It decides we're in a string
2406 ;;; if there's a quote on both sides of point on the current line.
2407 (defun term-extract-string ()
2408 "Returns string around POINT that starts the current line or nil."
2410 (let* ((point (point))
2411 (bol (progn (beginning-of-line) (point)))
2412 (eol (progn (end-of-line) (point)))
2413 (start (progn (goto-char point)
2414 (and (search-backward "\"" bol t)
2416 (end (progn (goto-char point)
2417 (and (search-forward "\"" eol t)
2420 (buffer-substring start end)))))
2422 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2423 (let* ((def (term-source-default prev-dir/file source-modes))
2424 (stringfile (term-extract-string))
2425 (sfile-p (and stringfile
2427 (file-exists-p stringfile)
2429 (not (file-directory-p stringfile))))
2430 (defdir (if sfile-p (file-name-directory stringfile)
2432 (deffile (if sfile-p (file-name-nondirectory stringfile)
2434 (ans (read-file-name (if deffile (format "%s(default %s) "
2438 (concat defdir deffile)
2440 (list (expand-file-name (substitute-in-file-name ans)))))
2442 ;;; I am somewhat divided on this string-default feature. It seems
2443 ;;; to violate the principle-of-least-astonishment, in that it makes
2444 ;;; the default harder to predict, so you actually have to look and see
2445 ;;; what the default really is before choosing it. This can trip you up.
2446 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
2451 ;;; Simple process query facility.
2452 ;;; ===========================================================================
2453 ;;; This function is for commands that want to send a query to the process
2454 ;;; and show the response to the user. For example, a command to get the
2455 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2456 ;;; to an inferior Common Lisp process.
2458 ;;; This simple facility just sends strings to the inferior process and pops
2459 ;;; up a window for the process buffer so you can see what the process
2460 ;;; responds with. We don't do anything fancy like try to intercept what the
2461 ;;; process responds with and put it in a pop-up window or on the message
2462 ;;; line. We just display the buffer. Low tech. Simple. Works good.
2464 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
2465 ;;; a window for the inferior process so that its response can be seen.
2466 (defun term-proc-query (proc str)
2467 (let* ((proc-buf (process-buffer proc))
2468 (proc-mark (process-mark proc)))
2469 (display-buffer proc-buf)
2470 (set-buffer proc-buf) ; but it's not the selected *window*
2471 (let ((proc-win (get-buffer-window proc-buf))
2472 (proc-pt (marker-position proc-mark)))
2473 (term-send-string proc str) ; send the query
2474 (accept-process-output proc) ; wait for some output
2475 ;; Try to position the proc window so you can see the answer.
2476 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2477 ;; I don't know why. Wizards invited to improve it.
2478 (if (not (pos-visible-in-window-p proc-pt proc-win))
2479 (let ((opoint (window-point proc-win)))
2480 (set-window-point proc-win proc-mark) (sit-for 0)
2481 (if (not (pos-visible-in-window-p opoint proc-win))
2483 (set-window-point proc-win opoint)))))))
2485 ;;; Returns the current column in the current screen line.
2486 ;;; Note: (current-column) yields column in buffer line.
2488 (defun term-horizontal-column ()
2489 (- (term-current-column) (term-start-line-column)))
2491 ;; Calls either vertical-motion or buffer-vertical-motion
2492 (defmacro term-vertical-motion (count)
2493 (list 'funcall 'term-vertical-motion count))
2495 ;; An emulation of vertical-motion that is independent of having a window.
2496 ;; Instead, it uses the term-width variable as the logical window width.
2498 (defun buffer-vertical-motion (count)
2500 (move-to-column (* term-width (/ (current-column) term-width)))
2504 (todo (+ count (/ (current-column) term-width))))
2506 ;; The loop iterates over buffer lines;
2507 ;; H is the number of screen lines in the current line, i.e.
2508 ;; the ceiling of dividing the buffer line width by term-width.
2509 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2514 (setq todo (- todo H))
2515 (forward-char) ;; Move past the ?\n
2516 (end-of-line)) ;; and on to the end of the next line.
2517 (if (and (>= todo H) (> todo 0))
2518 (+ (- count todo) H -1) ;; Hit end of buffer.
2519 (move-to-column (* todo term-width))
2521 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2524 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2528 (progn (beginning-of-line)
2530 (setq todo (- todo H))
2531 (backward-char)) ;; Move to end of previous line.
2532 (if (and (>= todo H) (> todo 0))
2533 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2534 (move-to-column (* (- H todo 1) term-width))
2537 ;;; The term-start-line-column variable is used as a cache.
2538 (defun term-start-line-column ()
2539 (cond (term-start-line-column)
2540 ((let ((save-pos (point)))
2541 (term-vertical-motion 0)
2542 (setq term-start-line-column (current-column))
2543 (goto-char save-pos)
2544 term-start-line-column))))
2546 ;;; Same as (current-column), but uses term-current-column as a cache.
2547 (defun term-current-column ()
2548 (cond (term-current-column)
2549 ((setq term-current-column (current-column)))))
2551 ;;; Move DELTA column right (or left if delta < 0).
2553 (defun term-move-columns (delta)
2554 (setq term-current-column (+ (term-current-column) delta))
2555 (move-to-column term-current-column t))
2557 ;; Insert COUNT copies of CHAR in the default face.
2558 (defun term-insert-char (char count)
2559 (let ((old-point (point)))
2560 (insert-char char count)
2561 (put-text-property old-point (point) 'face 'default)))
2563 (defun term-current-row ()
2564 (cond (term-current-row)
2565 ((setq term-current-row
2568 (narrow-to-region term-home-marker (point-max))
2569 (- (term-vertical-motion -9999))))))))
2571 (defun term-adjust-current-row-cache (delta)
2572 (if term-current-row
2573 (setq term-current-row (+ term-current-row delta))))
2575 (defun term-terminal-pos ()
2576 (save-excursion ; save-restriction
2577 (let ((save-col (term-current-column))
2579 (term-vertical-motion 0)
2580 (setq x (- save-col (current-column)))
2581 (setq y (term-vertical-motion term-height))
2584 ;;;Function that handles term messages: code by rms ( and you can see the
2585 ;;;difference ;-) -mm
2587 (defun term-handle-ansi-terminal-messages (message)
2588 ;; Is there a command here?
2589 (while (string-match "\eAnSiT.+\n" message)
2590 ;; Extract the command code and the argument.
2591 (let* ((start (match-beginning 0))
2593 (command-code (aref message (+ start 6)))
2598 (string-match "\r?\n" message
2601 ;; Delete this command from MESSAGE.
2602 (setq message (replace-match "" t t message))
2604 ;; If we recognize the type of command, set the appropriate variable.
2605 (cond ((= command-code ?c)
2606 (setq term-ansi-at-dir argument))
2607 ((= command-code ?h)
2608 (setq term-ansi-at-host argument))
2609 ((= command-code ?u)
2610 (setq term-ansi-at-user argument))
2611 ;; Otherwise ignore this one.
2615 ;; Update default-directory based on the changes this command made.
2618 (setq default-directory
2619 (file-name-as-directory
2620 (if (and (string= term-ansi-at-host (system-name))
2621 (string= term-ansi-at-user (user-real-login-name)))
2622 (expand-file-name term-ansi-at-dir)
2623 (if (string= term-ansi-at-user (user-real-login-name))
2624 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2625 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2626 term-ansi-at-dir)))))
2628 ;; I'm not sure this is necessary,
2629 ;; but it's best to be on the safe side.
2630 (if (string= term-ansi-at-host (system-name))
2632 (setq ange-ftp-default-user term-ansi-at-save-user)
2633 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2634 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2635 (setq term-ansi-at-save-user ange-ftp-default-user)
2636 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2637 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2638 (setq ange-ftp-default-user nil)
2639 (setq ange-ftp-default-password nil)
2640 (setq ange-ftp-generate-anonymous-password nil)))))
2644 ;;; Terminal emulation
2645 ;;; This is the standard process filter for term buffers.
2646 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2648 (defun term-emulate-terminal (proc str)
2649 (let* ((previous-buffer (current-buffer))
2650 (i 0) char funny count save-point save-marker old-point temp win
2651 (selected (selected-window))
2652 (str-length (length str)))
2655 (set-buffer (process-buffer proc))
2657 ;;; Let's handle the messages. -mm
2659 (setq str (term-handle-ansi-terminal-messages str))
2660 (setq str-length (length str))
2662 (if (marker-buffer term-pending-delete-marker)
2664 ;; Delete text following term-pending-delete-marker.
2665 (delete-region term-pending-delete-marker (process-mark proc))
2666 (set-marker term-pending-delete-marker nil)))
2668 (if (eq (window-buffer) (current-buffer))
2670 (setq term-vertical-motion (symbol-function 'vertical-motion))
2671 (term-check-size proc))
2672 (setq term-vertical-motion
2673 (symbol-function 'buffer-vertical-motion)))
2675 (setq save-marker (copy-marker (process-mark proc)))
2677 (if (/= (point) (process-mark proc))
2678 (progn (setq save-point (point-marker))
2679 (goto-char (process-mark proc))))
2682 ;; If the buffer is in line mode, and there is a partial
2683 ;; input line, save the line (by narrowing to leave it
2684 ;; outside the restriction ) until we're done with output.
2685 (if (and (> (point-max) (process-mark proc))
2686 (term-in-line-mode))
2687 (narrow-to-region (point-min) (process-mark proc)))
2690 (princ str term-log-buffer))
2691 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2692 (setq str (concat term-terminal-parameter str))
2693 (setq term-terminal-parameter nil)
2694 (setq str-length (length str))
2695 (setq term-terminal-state 0)))
2697 (while (< i str-length)
2698 (setq char (aref str i))
2699 (cond ((< term-terminal-state 2)
2700 ;; Look for prefix of regular chars
2702 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2704 (if (not funny) (setq funny str-length))
2706 (cond ((eq term-terminal-state 1)
2707 (term-move-columns 1)
2708 (setq term-terminal-state 0)))
2709 (setq count (- funny i))
2710 (setq temp (- (+ (term-horizontal-column) count)
2712 (cond ((<= temp 0)) ;; All count chars fit in line.
2713 ((> count temp) ;; Some chars fit.
2714 ;; This iteration, handle only what fits.
2715 (setq count (- count temp))
2716 (setq funny (+ count i)))
2717 ((or (not (or term-pager-count
2718 term-scroll-with-delete))
2719 (> (term-handle-scroll 1) 0))
2720 (term-adjust-current-row-cache 1)
2721 (setq count (min count term-width))
2722 (setq funny (+ count i))
2723 (setq term-start-line-column
2724 term-current-column))
2725 (t ;; Doing PAGER processing.
2726 (setq count 0 funny i)
2727 (setq term-current-column nil)
2728 (setq term-start-line-column nil)))
2729 (setq old-point (point))
2730 ;; In the common case that we're at the end of
2731 ;; the buffer, we can save a little work.
2732 (cond ((/= (point) (point-max))
2733 (if term-insert-mode
2734 ;; Inserting spaces, then deleting them,
2735 ;; then inserting the actual text is
2736 ;; inefficient, but it is simple, and
2737 ;; the actual overhead is miniscule.
2738 (term-insert-spaces count))
2739 (term-move-columns count)
2740 (delete-region old-point (point)))
2741 (t (setq term-current-column (+ (term-current-column) count))))
2742 (insert (substring str i funny))
2743 (put-text-property old-point (point)
2744 'face term-current-face)
2745 ;; If the last char was written in last column,
2746 ;; back up one column, but remember we did so.
2747 ;; Thus we emulate xterm/vt100-style line-wrapping.
2749 (term-move-columns -1)
2750 (setq term-terminal-state 1)))
2751 (setq i (1- funny)))
2752 ((and (setq term-terminal-state 0)
2753 (eq char ?\^I)) ; TAB
2754 ;; FIXME: Does not handle line wrap!
2755 (setq count (term-current-column))
2756 (setq count (+ count 8 (- (mod count 8))))
2757 (if (< (move-to-column count nil) count)
2758 (term-insert-char char 1))
2759 (setq term-current-column count))
2761 ;; Optimize CRLF at end of buffer:
2762 (cond ((and (< (setq temp (1+ i)) str-length)
2763 (eq (aref str temp) ?\n)
2764 (= (point) (point-max))
2765 (not (or term-pager-count
2767 term-scroll-with-delete)))
2769 (term-adjust-current-row-cache 1)
2770 (setq term-start-line-column 0)
2771 (setq term-current-column 0)
2773 (t ;; Not followed by LF or can't optimize:
2774 (term-vertical-motion 0)
2775 (setq term-current-column term-start-line-column))))
2777 (if (not (and term-kill-echo-list
2778 (term-check-kill-echo-list)))
2781 (term-move-columns -1))
2782 ((eq char ?\033) ; Escape
2783 (setq term-terminal-state 2))
2784 ((eq char 0)) ; NUL: Do nothing
2785 ((eq char ?\016)) ; Shift Out - ignored
2786 ((eq char ?\017)) ; Shift In - ignored
2790 (let ((end (string-match "\n" str i)))
2792 (progn (funcall term-command-hook
2793 (substring str (1+ i) (1- end)))
2795 (setq term-terminal-parameter
2797 (setq term-terminal-state 4)
2798 (setq i str-length))))
2799 (t ; insert char FIXME: Should never happen
2800 (term-move-columns 1)
2801 (backward-delete-char 1)
2803 ((eq term-terminal-state 2) ; Seen Esc
2804 (cond ((eq char ?\133) ;; ?\133 = ?[
2806 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2807 ;;; Note that now the init value of term-terminal-previous-parameter has
2808 ;;; been changed to -1
2810 (make-local-variable 'term-terminal-parameter)
2811 (make-local-variable 'term-terminal-previous-parameter)
2812 (make-local-variable 'term-terminal-previous-parameter-2)
2813 (make-local-variable 'term-terminal-previous-parameter-3)
2814 (make-local-variable 'term-terminal-previous-parameter-4)
2815 (make-local-variable 'term-terminal-more-parameters)
2816 (setq term-terminal-parameter 0)
2817 (setq term-terminal-previous-parameter -1)
2818 (setq term-terminal-previous-parameter-2 -1)
2819 (setq term-terminal-previous-parameter-3 -1)
2820 (setq term-terminal-previous-parameter-4 -1)
2821 (setq term-terminal-more-parameters 0)
2822 (setq term-terminal-state 3))
2823 ((eq char ?D) ;; scroll forward
2824 (term-handle-deferred-scroll)
2826 (setq term-terminal-state 0))
2827 ((eq char ?M) ;; scroll reversed
2828 (term-insert-lines 1)
2829 (setq term-terminal-state 0))
2830 ((eq char ?7) ;; Save cursor
2831 (term-handle-deferred-scroll)
2832 (setq term-saved-cursor
2833 (cons (term-current-row)
2834 (term-horizontal-column)))
2835 (setq term-terminal-state 0))
2836 ((eq char ?8) ;; Restore cursor
2837 (if term-saved-cursor
2838 (term-goto (car term-saved-cursor)
2839 (cdr term-saved-cursor)))
2840 (setq term-terminal-state 0))
2841 ((setq term-terminal-state 0))))
2842 ((eq term-terminal-state 3) ; Seen Esc [
2843 (cond ((and (>= char ?0) (<= char ?9))
2844 (setq term-terminal-parameter
2845 (+ (* 10 term-terminal-parameter) (- char ?0))))
2846 ((eq char ?\073 ) ; ?;
2847 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2848 (setq term-terminal-more-parameters 1)
2849 (setq term-terminal-previous-parameter-4
2850 term-terminal-previous-parameter-3)
2851 (setq term-terminal-previous-parameter-3
2852 term-terminal-previous-parameter-2)
2853 (setq term-terminal-previous-parameter-2
2854 term-terminal-previous-parameter)
2855 (setq term-terminal-previous-parameter
2856 term-terminal-parameter)
2857 (setq term-terminal-parameter 0))
2858 ((eq char ??)) ; Ignore ?
2860 (term-handle-ansi-escape proc char)
2861 (setq term-terminal-more-parameters 0)
2862 (setq term-terminal-previous-parameter-4 -1)
2863 (setq term-terminal-previous-parameter-3 -1)
2864 (setq term-terminal-previous-parameter-2 -1)
2865 (setq term-terminal-previous-parameter -1)
2866 (setq term-terminal-state 0)))))
2867 (if (term-handling-pager)
2868 ;; Finish stuff to get ready to handle PAGER.
2870 (if (> (% (current-column) term-width) 0)
2871 (setq term-terminal-parameter
2873 ;; We're at column 0. Goto end of buffer; to compensate,
2874 ;; prepend a ?\r for later. This looks more consistent.
2876 (setq term-terminal-parameter
2877 (concat "\r" (substring str i)))
2878 (setq term-terminal-parameter (substring str (1- i)))
2879 (aset term-terminal-parameter 0 ?\r))
2880 (goto-char (point-max)))
2881 (setq term-terminal-state 4)
2882 (make-local-variable 'term-pager-old-filter)
2883 (setq term-pager-old-filter (process-filter proc))
2884 (set-process-filter proc term-pager-filter)
2885 (setq i str-length)))
2888 (if (>= (term-current-row) term-height)
2889 (term-handle-deferred-scroll))
2891 (set-marker (process-mark proc) (point))
2893 (progn (goto-char save-point)
2894 (set-marker save-point nil)))
2896 ;; Check for a pending filename-and-line number to display.
2897 ;; We do this before scrolling, because we might create a new window.
2898 (if (and term-pending-frame
2899 (eq (window-buffer selected) (current-buffer)))
2900 (progn (term-display-line (car term-pending-frame)
2901 (cdr term-pending-frame))
2902 (setq term-pending-frame nil)
2903 ;; We have created a new window, so check the window size.
2904 (term-check-size proc)))
2906 ;; Scroll each window displaying the buffer but (by default)
2907 ;; only if the point matches the process-mark we started with.
2910 (setq win (next-window win nil t))
2911 (if (eq (window-buffer win) (process-buffer proc))
2912 (let ((scroll term-scroll-to-bottom-on-output))
2914 (if (or (= (point) save-marker)
2915 (eq scroll t) (eq scroll 'all)
2916 ;; Maybe user wants point to jump to the end.
2917 (and (eq selected win)
2918 (or (eq scroll 'this) (not save-point)))
2919 (and (eq scroll 'others)
2920 (not (eq selected win))))
2922 (goto-char term-home-marker)
2924 (goto-char (process-mark proc))
2925 (if (not (pos-visible-in-window-p (point) win))
2927 ;; Optionally scroll so that the text
2928 ;; ends at the bottom of the window.
2929 (if (and term-scroll-show-maximum-output
2930 (>= (point) (process-mark proc)))
2932 (goto-char (point-max))
2934 (not (eq win selected))))
2936 ;;; Stolen from comint.el and adapted -mm
2937 (if (> term-buffer-maximum-size 0)
2939 (goto-char (process-mark (get-buffer-process (current-buffer))))
2940 (forward-line (- term-buffer-maximum-size))
2942 (delete-region (point-min) (point))))
2945 (set-marker save-marker nil))
2946 ;; unwind-protect cleanup-forms follow:
2947 (set-buffer previous-buffer)
2948 (select-window selected))))
2950 (defun term-handle-deferred-scroll ()
2951 (let ((count (- (term-current-row) term-height)))
2954 (goto-char term-home-marker)
2955 (term-vertical-motion (1+ count))
2956 (set-marker term-home-marker (point))
2957 (setq term-current-row (1- term-height))))))
2959 ;;; New function to deal with ansi colorized output, as you can see you can
2960 ;;; have any bold/underline/fg/bg/reverse combination. -mm
2962 (defun term-handle-colors-array (parameter)
2967 (setq term-ansi-current-bold 1))
2971 (setq term-ansi-current-underline 1))
2973 ;;; Blink (unsupported by Emacs), will be translated to bold.
2974 ;;; This may change in the future though.
2976 (setq term-ansi-current-bold 1))
2980 (setq term-ansi-current-reverse 1))
2984 (setq term-ansi-current-invisible 1))
2986 ((and (>= parameter 30) (<= parameter 37))
2987 (setq term-ansi-current-color (- parameter 29)))
2989 ((and (>= parameter 40) (<= parameter 47))
2990 (setq term-ansi-current-bg-color (- parameter 39)))
2992 ;;; 0 (Reset) or unknown (reset anyway)
2994 (setq term-current-face
2995 (list 'term-default-fg 'term-default-bg))
2996 (setq term-ansi-current-underline 0)
2997 (setq term-ansi-current-bold 0)
2998 (setq term-ansi-current-reverse 0)
2999 (setq term-ansi-current-color 0)
3000 (setq term-ansi-current-invisible 0)
3001 (setq term-ansi-face-alredy-done 1)
3002 (setq term-ansi-current-bg-color 0)))
3004 ; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3005 ; term-ansi-current-underline
3006 ; term-ansi-current-reverse
3007 ; term-ansi-current-bold
3008 ; term-ansi-current-invisible
3009 ; term-ansi-face-alredy-done
3010 ; term-ansi-current-color
3011 ; term-ansi-current-bg-color)
3014 (if (= term-ansi-face-alredy-done 0)
3015 (if (= term-ansi-current-reverse 1)
3017 (if (= term-ansi-current-invisible 1)
3018 (if (= term-ansi-current-color 0)
3019 (setq term-current-face
3020 '(term-default-bg-inv term-default-fg))
3021 (setq term-current-face
3022 (list (elt ansi-term-inv-fg-faces-vector term-ansi-current-color)
3023 (elt ansi-term-inv-bg-faces-vector term-ansi-current-color))))
3024 ;; No need to bother with anything else if it's invisible
3026 (setq term-current-face
3027 (list (elt ansi-term-inv-fg-faces-vector term-ansi-current-color)
3028 (elt ansi-term-inv-bg-faces-vector term-ansi-current-bg-color)))
3029 (if (= term-ansi-current-bold 1)
3030 (setq term-current-face
3031 (append '(term-bold) term-current-face)))
3032 (if (= term-ansi-current-underline 1)
3033 (setq term-current-face
3034 (append '(term-underline) term-current-face))))))
3036 (if (= term-ansi-current-invisible 1)
3037 (if (= term-ansi-current-bg-color 0)
3038 (setq term-current-face
3039 '(term-default-fg-inv term-default-bg))
3040 (setq term-current-face
3041 (list (elt ansi-term-fg-faces-vector term-ansi-current-bg-color)
3042 (elt ansi-term-bg-faces-vector term-ansi-current-bg-color))))
3043 ;; No need to bother with anything else if it's invisible
3045 (setq term-current-face
3046 (list (elt ansi-term-fg-faces-vector term-ansi-current-color)
3047 (elt ansi-term-bg-faces-vector term-ansi-current-bg-color)))
3048 (if (= term-ansi-current-bold 1)
3049 (setq term-current-face
3050 (append '(term-bold) term-current-face)))
3051 (if (= term-ansi-current-underline 1)
3052 (setq term-current-face
3053 (append '(term-underline) term-current-face))))))))
3055 ; (message "Debug %S" term-current-face)
3057 (setq term-ansi-face-alredy-done 0))
3060 ;;; Handle a character assuming (eq terminal-state 2) -
3061 ;;; i.e. we have previously seen Escape followed by ?[.
3063 (defun term-handle-ansi-escape (proc char)
3065 ((eq char ?H) ; cursor motion
3066 (if (<= term-terminal-parameter 0)
3067 (setq term-terminal-parameter 1))
3068 (if (<= term-terminal-previous-parameter 0)
3069 (setq term-terminal-previous-parameter 1))
3070 (if (> term-terminal-previous-parameter term-height)
3071 (setq term-terminal-previous-parameter term-height))
3072 (if (> term-terminal-parameter term-width)
3073 (setq term-terminal-parameter term-width))
3075 (1- term-terminal-previous-parameter)
3076 (1- term-terminal-parameter)))
3079 (term-handle-deferred-scroll)
3080 (term-down (- (max 1 term-terminal-parameter)) t))
3081 ;; \E[B - cursor down
3083 (term-down (max 1 term-terminal-parameter) t))
3084 ;; \E[C - cursor right
3086 (term-move-columns (max 1 term-terminal-parameter)))
3087 ;; \E[D - cursor left
3089 (term-move-columns (- (max 1 term-terminal-parameter))))
3090 ;; \E[J - clear to end of screen
3092 (term-erase-in-display term-terminal-parameter))
3093 ;; \E[K - clear to end of line
3095 (term-erase-in-line term-terminal-parameter))
3096 ;; \E[L - insert lines
3098 (term-insert-lines (max 1 term-terminal-parameter)))
3099 ;; \E[M - delete lines
3101 (term-delete-lines (max 1 term-terminal-parameter)))
3102 ;; \E[P - delete chars
3104 (term-delete-chars (max 1 term-terminal-parameter)))
3105 ;; \E[@ - insert spaces
3107 (term-insert-spaces (max 1 term-terminal-parameter)))
3108 ;; \E[?h - DEC Private Mode Set
3110 (cond ((eq term-terminal-parameter 4)
3111 (setq term-insert-mode t))
3112 ((eq term-terminal-parameter 47)
3113 (term-switch-to-alternate-sub-buffer t))))
3114 ;; \E[?l - DEC Private Mode Reset
3116 (cond ((eq term-terminal-parameter 4)
3117 (setq term-insert-mode nil))
3118 ((eq term-terminal-parameter 47)
3119 (term-switch-to-alternate-sub-buffer nil))))
3121 ;;; Modified to allow ansi coloring -mm
3122 ;; \E[m - Set/reset standard mode
3125 ; (message "Debug: Current param stack 4)%d 3)%d 2)%d 1)%d 0)%d"
3126 ; term-terminal-previous-parameter-4
3127 ; term-terminal-previous-parameter-3
3128 ; term-terminal-previous-parameter-2
3129 ; term-terminal-previous-parameter
3130 ; term-terminal-parameter)
3132 (if (= term-terminal-more-parameters 1)
3133 (progn (if (>= term-terminal-previous-parameter-4 0)
3134 (term-handle-colors-array term-terminal-previous-parameter-4))
3135 (if (>= term-terminal-previous-parameter-3 0)
3136 (term-handle-colors-array term-terminal-previous-parameter-3))
3137 (if (>= term-terminal-previous-parameter-2 0)
3138 (term-handle-colors-array term-terminal-previous-parameter-2))
3139 (term-handle-colors-array term-terminal-previous-parameter)))
3140 (term-handle-colors-array term-terminal-parameter)))
3144 ;; \E[6n - Report cursor position
3146 (term-handle-deferred-scroll)
3147 (process-send-string proc
3149 (1+ (term-current-row))
3150 (1+ (term-horizontal-column)))))
3151 ;; \E[r - Set scrolling region
3154 (1- term-terminal-previous-parameter)
3155 term-terminal-parameter))
3158 (defun term-scroll-region (top bottom)
3159 "Set scrolling region.
3160 TOP is the top-most line (inclusive) of the new scrolling region,
3161 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3162 The top-most line is line 0."
3163 (setq term-scroll-start
3164 (if (or (< top 0) (>= top term-height))
3167 (setq term-scroll-end
3168 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3171 (setq term-scroll-with-delete
3172 (or (term-using-alternate-sub-buffer)
3173 (not (and (= term-scroll-start 0)
3174 (= term-scroll-end term-height))))))
3176 (defun term-switch-to-alternate-sub-buffer (set)
3177 ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3178 ;; using it, do nothing. This test is needed for some programs (including
3179 ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3180 (term-handle-deferred-scroll)
3181 (if (eq set (not (term-using-alternate-sub-buffer)))
3182 (let ((row (term-current-row))
3183 (col (term-horizontal-column)))
3185 (goto-char (point-max))
3186 (if (not (eq (preceding-char) ?\n))
3187 (term-insert-char ?\n 1))
3188 (setq term-scroll-with-delete t)
3189 (setq term-saved-home-marker (copy-marker term-home-marker))
3190 (set-marker term-home-marker (point)))
3192 (setq term-scroll-with-delete
3193 (not (and (= term-scroll-start 0)
3194 (= term-scroll-end term-height))))
3195 (set-marker term-home-marker term-saved-home-marker)
3196 (set-marker term-saved-home-marker nil)
3197 (setq term-saved-home-marker nil)
3198 (goto-char term-home-marker)))
3199 (setq term-current-column nil)
3200 (setq term-current-row 0)
3201 (term-goto row col))))
3203 ;; Default value for the symbol term-command-hook.
3205 (defun term-command-hook (string)
3206 (cond ((= (aref string 0) ?\032)
3207 ;; gdb (when invoked with -fullname) prints:
3208 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3209 (let* ((first-colon (string-match ":" string 1))
3211 (string-match ":" string (1+ first-colon)))
3212 (filename (substring string 1 first-colon))
3213 (fileline (string-to-int
3214 (substring string (1+ first-colon) second-colon))))
3215 (setq term-pending-frame (cons filename fileline))))
3216 ((= (aref string 0) ?/)
3217 (cd (substring string 1)))
3218 ;; Allowing the inferior to call functions in Emacs is
3219 ;; probably too big a security hole.
3220 ;; ((= (aref string 0) ?!)
3221 ;; (eval (car (read-from-string string 1))))
3222 (t)));; Otherwise ignore it
3224 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3225 ;; and that its line LINE is visible.
3226 ;; Put the overlay-arrow on the line LINE in that buffer.
3227 ;; This is mainly used by gdb.
3229 (defun term-display-line (true-file line)
3230 (term-display-buffer-line (find-file-noselect true-file) line))
3232 (defun term-display-buffer-line (buffer line)
3233 (let* ((window (display-buffer buffer t))
3241 (setq overlay-arrow-string "=>")
3242 (or overlay-arrow-position
3243 (setq overlay-arrow-position (make-marker)))
3244 (set-marker overlay-arrow-position (point) (current-buffer)))
3245 (cond ((or (< pos (point-min)) (> pos (point-max)))
3248 (set-window-point window overlay-arrow-position)))
3250 ;;; The buffer-local marker term-home-marker defines the "home position"
3251 ;;; (in terms of cursor motion). However, we move the term-home-marker
3252 ;;; "down" as needed so that is no more that a window-full above (point-max).
3254 (defun term-goto-home ()
3255 (term-handle-deferred-scroll)
3256 (goto-char term-home-marker)
3257 (setq term-current-row 0)
3258 (setq term-current-column (current-column))
3259 (setq term-start-line-column term-current-column))
3261 (defun term-goto (row col)
3262 (term-handle-deferred-scroll)
3263 (cond ((and term-current-row (>= row term-current-row))
3264 ;; I assume this is a worthwhile optimization.
3265 (term-vertical-motion 0)
3266 (setq term-current-column term-start-line-column)
3267 (setq row (- row term-current-row)))
3271 (term-move-columns col))
3273 ; The page is full, so enter "pager" mode, and wait for input.
3275 (defun term-process-pager ()
3276 (if (not term-pager-break-map)
3277 (let* ((map (make-keymap))
3280 ; (define-key map (make-string 1 i) 'term-send-raw)
3282 (define-key map "\e"
3283 (lookup-key (current-global-map) "\e"))
3284 (define-key map "\C-x"
3285 (lookup-key (current-global-map) "\C-x"))
3286 (define-key map "\C-u"
3287 (lookup-key (current-global-map) "\C-u"))
3288 (define-key map " " 'term-pager-page)
3289 (define-key map "\r" 'term-pager-line)
3290 (define-key map "?" 'term-pager-help)
3291 (define-key map "h" 'term-pager-help)
3292 (define-key map "b" 'term-pager-back-page)
3293 (define-key map "\177" 'term-pager-back-line)
3294 (define-key map "q" 'term-pager-discard)
3295 (define-key map "D" 'term-pager-disable)
3296 (define-key map "<" 'term-pager-bob)
3297 (define-key map ">" 'term-pager-eob)
3302 (define-key map [menu-bar terminal] term-terminal-menu)
3303 (define-key map [menu-bar signals] term-signals-menu)
3304 (setq tmp (make-sparse-keymap "More pages?"))
3305 (define-key tmp [help] '("Help" . term-pager-help))
3306 (define-key tmp [disable]
3307 '("Disable paging" . term-fake-pager-disable))
3308 (define-key tmp [discard]
3309 '("Discard remaining output" . term-pager-discard))
3310 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3311 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3312 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3313 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3314 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3315 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3316 (define-key map [menu-bar page] (cons "More pages?" tmp))
3319 (setq term-pager-break-map map)))
3320 ; (let ((process (get-buffer-process (current-buffer))))
3321 ; (stop-process process))
3322 (setq term-pager-old-local-map (current-local-map))
3323 (use-local-map term-pager-break-map)
3324 (make-local-variable 'term-old-mode-line-format)
3325 (setq term-old-mode-line-format mode-line-format)
3326 (setq mode-line-format
3327 (list "-- **MORE** "
3328 mode-line-buffer-identification
3329 " [Type ? for help] "
3331 (force-mode-line-update))
3333 (defun term-pager-line (lines)
3335 (let* ((moved (vertical-motion (1+ lines)))
3336 (deficit (- lines moved)))
3339 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3340 (recenter (1- term-height)))
3341 ((term-pager-continue deficit)))))
3343 (defun term-pager-page (arg)
3344 "Proceed past the **MORE** break, allowing the next page of output to appear"
3346 (term-pager-line (* arg term-height)))
3348 ; Pager mode command to go to beginning of buffer
3349 (defun term-pager-bob ()
3351 (goto-char (point-min))
3352 (if (= (vertical-motion term-height) term-height)
3354 (recenter (1- term-height)))
3356 ; pager mode command to go to end of buffer
3357 (defun term-pager-eob ()
3359 (goto-char term-home-marker)
3361 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3363 (defun term-pager-back-line (lines)
3365 (vertical-motion (- 1 lines))
3369 ;; Move cursor to end of window.
3370 (vertical-motion term-height)
3372 (recenter (1- term-height)))
3374 (defun term-pager-back-page (arg)
3376 (term-pager-back-line (* arg term-height)))
3378 (defun term-pager-discard ()
3380 (setq term-terminal-parameter "")
3381 (interrupt-process nil t)
3382 (term-pager-continue term-height))
3384 ; Disable pager processing.
3385 ; Only callable while in pager mode. (Contrast term-disable-pager.)
3386 (defun term-pager-disable ()
3388 (if (term-handling-pager)
3389 (term-pager-continue nil)
3390 (setq term-pager-count nil))
3391 (term-update-mode-line))
3393 ; Enable pager processing.
3394 (defun term-pager-enable ()
3396 (or (term-pager-enabled)
3397 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3398 (term-update-mode-line))
3400 (defun term-pager-toggle ()
3402 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3405 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3406 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3407 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3408 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3409 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3410 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3412 (defun term-pager-help ()
3413 "Provide help on commands available in a terminal-emulator **MORE** break"
3415 (message "Terminal-emulator pager break help...")
3418 (function (lambda ()
3419 (princ (substitute-command-keys
3420 "\\<term-pager-break-map>\
3421 Terminal-emulator MORE break.\n\
3422 Type one of the following keys:\n\n\
3423 \\[term-pager-page]\t\tMove forward one page.\n\
3424 \\[term-pager-line]\t\tMove forward one line.\n\
3425 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3426 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3427 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3428 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3429 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3430 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3431 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3432 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3433 \\{term-pager-break-map}\n\
3434 Any other key is passed through to the program
3435 running under the terminal emulator and disables pager processing until
3436 all pending output has been dealt with."))
3439 (defun term-pager-continue (new-count)
3440 (let ((process (get-buffer-process (current-buffer))))
3441 (use-local-map term-pager-old-local-map)
3442 (setq term-pager-old-local-map nil)
3443 (setq mode-line-format term-old-mode-line-format)
3444 (force-mode-line-update)
3445 (setq term-pager-count new-count)
3446 (set-process-filter process term-pager-old-filter)
3447 (funcall term-pager-old-filter process "")
3448 (continue-process process)))
3450 ;; Make sure there are DOWN blank lines below the current one.
3451 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3453 (defun term-handle-scroll (down)
3454 (let ((scroll-needed
3455 (- (+ (term-current-row) down 1) term-scroll-end)))
3456 (if (> scroll-needed 0)
3457 (let ((save-point (copy-marker (point))) (save-top))
3458 (goto-char term-home-marker)
3459 (cond (term-scroll-with-delete
3460 ;; delete scroll-needed lines at term-scroll-start
3461 (term-vertical-motion term-scroll-start)
3462 (setq save-top (point))
3463 (term-vertical-motion scroll-needed)
3464 (delete-region save-top (point))
3465 (goto-char save-point)
3466 (term-vertical-motion down)
3467 (term-adjust-current-row-cache (- scroll-needed))
3468 (setq term-current-column nil)
3469 (term-insert-char ?\n scroll-needed))
3470 ((and (numberp term-pager-count)
3471 (< (setq term-pager-count (- term-pager-count down))
3474 (term-process-pager))
3476 (term-adjust-current-row-cache (- scroll-needed))
3477 (term-vertical-motion scroll-needed)
3478 (set-marker term-home-marker (point))))
3479 (goto-char save-point)
3480 (set-marker save-point nil))))
3483 (defun term-down (down &optional check-for-scroll)
3484 "Move down DOWN screen lines vertically."
3485 (let ((start-column (term-horizontal-column)))
3486 (if (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3487 (setq down (term-handle-scroll down)))
3488 (term-adjust-current-row-cache down)
3489 (if (/= (point) (point-max))
3490 (setq down (- down (term-vertical-motion down))))
3491 ;; Extend buffer with extra blank lines if needed.
3493 (term-insert-char ?\n down)
3494 (setq term-current-column 0)
3495 (setq term-start-line-column 0))
3497 (setq term-current-column nil)
3498 (setq term-start-line-column (current-column))))
3500 (term-move-columns start-column))))
3502 ;; Assuming point is at the beginning of a screen line,
3503 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3504 ;; FIXME: Probably should be called more than it is.
3505 (defun term-unwrap-line ()
3506 (if (not (bolp)) (insert-before-markers ?\n)))
3508 (defun term-erase-in-line (kind)
3509 (if (> kind 1) ;; erase left of point
3510 (let ((cols (term-horizontal-column)) (saved-point (point)))
3511 (term-vertical-motion 0)
3512 (delete-region (point) saved-point)
3513 (term-insert-char ?\n cols)))
3514 (if (not (eq kind 1)) ;; erase right of point
3515 (let ((saved-point (point))
3516 (wrapped (and (zerop (term-horizontal-column))
3517 (not (zerop (term-current-column))))))
3518 (term-vertical-motion 1)
3519 (delete-region saved-point (point))
3520 ;; wrapped is true if we're at the beginning of screen line,
3521 ;; but not a buffer line. If we delete the current screen line
3522 ;; that will make the previous line no longer wrap, and (because
3523 ;; of the way Emacs display works) point will be at the end of
3524 ;; the previous screen line rather then the beginning of the
3525 ;; current one. To avoid that, we make sure that current line
3526 ;; contain a space, to force the previous line to continue to wrap.
3527 ;; We could do this always, but it seems preferable to not add the
3528 ;; extra space when wrapped is false.
3532 (put-text-property saved-point (point) 'face 'default)
3533 (goto-char saved-point))))
3535 (defun term-erase-in-display (kind)
3536 "Erases (that is blanks out) part of the window.
3537 If KIND is 0, erase from (point) to (point-max);
3538 if KIND is 1, erase from home to point; else erase from home to point-max.
3539 Should only be called when point is at the start of a screen line."
3540 (term-handle-deferred-scroll)
3541 (cond ((eq term-terminal-parameter 0)
3542 (delete-region (point) (point-max))
3544 ((let ((row (term-current-row))
3545 (col (term-horizontal-column))
3546 (start-region term-home-marker)
3547 (end-region (if (eq kind 1) (point) (point-max))))
3548 (delete-region start-region end-region)
3551 (term-insert-char ?\n row))
3552 (setq term-current-column nil)
3553 (setq term-current-row nil)
3554 (term-goto row col)))))
3556 (defun term-delete-chars (count)
3557 (let ((save-point (point)))
3558 (term-vertical-motion 1)
3560 (goto-char save-point)
3561 (move-to-column (+ (term-current-column) count) t)
3562 (delete-region save-point (point))))
3564 ;;; Insert COUNT spaces after point, but do not change any of
3565 ;;; following screen lines. Hence we may have to delete characters
3566 ;;; at teh end of this screen line to make room.
3568 (defun term-insert-spaces (count)
3569 (let ((save-point (point)) (save-eol))
3570 (term-vertical-motion 1)
3573 (setq save-eol (point))
3574 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3575 (if (> save-eol (point))
3576 (delete-region (point) save-eol))
3577 (goto-char save-point)
3578 (term-insert-char ? count)
3579 (goto-char save-point)))
3581 (defun term-delete-lines (lines)
3582 (let ((start (point))
3583 (save-current-column term-current-column)
3584 (save-start-line-column term-start-line-column)
3585 (save-current-row (term-current-row)))
3587 (delete-region start (point))
3588 (term-down (- term-scroll-end save-current-row lines))
3589 (term-insert-char ?\n lines)
3590 (setq term-current-column save-current-column)
3591 (setq term-start-line-column save-start-line-column)
3592 (setq term-current-row save-current-row)
3595 (defun term-insert-lines (lines)
3596 (let ((start (point))
3598 (save-current-column term-current-column)
3599 (save-start-line-column term-start-line-column)
3600 (save-current-row (term-current-row)))
3601 (term-down (- term-scroll-end save-current-row lines))
3602 (setq start-deleted (point))
3604 (delete-region start-deleted (point))
3606 (setq term-current-column save-current-column)
3607 (setq term-start-line-column save-start-line-column)
3608 (setq term-current-row save-current-row)
3609 (term-insert-char ?\n lines)
3612 (defun term-set-output-log (name)
3613 "Record raw inferior process output in a buffer."
3614 (interactive (list (if term-log-buffer
3616 (read-buffer "Record output in buffer: "
3617 (format "%s output-log"
3618 (buffer-name (current-buffer)))
3620 (if (or (null name) (equal name ""))
3621 (progn (setq term-log-buffer nil)
3622 (message "Output logging off."))
3623 (if (get-buffer name)
3626 (set-buffer (get-buffer-create name))
3628 (buffer-disable-undo (current-buffer))
3630 (setq term-log-buffer (get-buffer name))
3631 (message "Recording terminal emulator output into buffer \"%s\""
3632 (buffer-name term-log-buffer))))
3634 (defun term-stop-photo ()
3635 "Discontinue raw inferior process logging."
3637 (term-set-output-log nil))
3639 (defun term-show-maximum-output ()
3640 "Put the end of the buffer at the bottom of the window."
3642 (goto-char (point-max))
3645 ;;; Do the user's customisation...
3647 (defvar term-load-hook nil
3648 "This hook is run when term is loaded in.
3649 This is a good place to put keybindings.")
3651 (run-hooks 'term-load-hook)
3654 ;;; Filename/command/history completion in a buffer
3655 ;;; ===========================================================================
3656 ;;; Useful completion functions, courtesy of the Ergo group.
3659 ;;; term-dynamic-complete Complete or expand command, filename,
3660 ;;; history at point.
3661 ;;; term-dynamic-complete-filename Complete filename at point.
3662 ;;; term-dynamic-list-filename-completions List completions in help buffer.
3663 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
3664 ;;; replace with expanded/completed name.
3665 ;;; term-dynamic-simple-complete Complete stub given candidates.
3667 ;;; These are not installed in the term-mode keymap. But they are
3668 ;;; available for people who want them. Shell-mode installs them:
3669 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3670 ;;; (define-key shell-mode-map "\M-?"
3671 ;;; 'term-dynamic-list-filename-completions)))
3673 ;;; Commands like this are fine things to put in load hooks if you
3674 ;;; want them present in specific modes.
3676 (defvar term-completion-autolist nil
3677 "*If non-nil, automatically list possibilities on partial completion.
3678 This mirrors the optional behavior of tcsh.")
3680 (defvar term-completion-addsuffix t
3681 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3682 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3683 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3684 completion. This mirrors the optional behavior of tcsh.")
3686 (defvar term-completion-recexact nil
3687 "*If non-nil, use shortest completion if characters cannot be added.
3688 This mirrors the optional behavior of tcsh.
3690 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3692 (defvar term-completion-fignore nil
3693 "*List of suffixes to be disregarded during file completion.
3694 This mirrors the optional behavior of bash and tcsh.
3696 Note that this applies to `term-dynamic-complete-filename' only.")
3698 (defvar term-file-name-prefix ""
3699 "Prefix prepended to absolute file names taken from process input.
3700 This is used by term's and shell's completion functions, and by shell's
3701 directory tracking functions.")
3704 (defun term-directory (directory)
3705 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3706 (expand-file-name (if (file-name-absolute-p directory)
3707 (concat term-file-name-prefix directory)
3711 (defun term-word (word-chars)
3712 "Return the word of WORD-CHARS at point, or nil if non is found.
3713 Word constituents are considered to be those in WORD-CHARS, which is like the
3714 inside of a \"[...]\" (see `skip-chars-forward')."
3716 (let ((limit (point))
3717 (word (concat "[" word-chars "]"))
3718 (non-word (concat "[^" word-chars "]")))
3719 (if (re-search-backward non-word nil 'move)
3721 ;; Anchor the search forwards.
3722 (if (or (eolp) (looking-at non-word))
3724 (re-search-forward (concat word "+") limit)
3725 (buffer-substring (match-beginning 0) (match-end 0))))))
3728 (defun term-match-partial-filename ()
3729 "Return the filename at point, or nil if non is found.
3730 Environment variables are substituted. See `term-word'."
3731 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3732 (and filename (substitute-in-file-name filename))))
3735 (defun term-dynamic-complete ()
3736 "Dynamically perform completion at point.
3737 Calls the functions in `term-dynamic-complete-functions' to perform
3738 completion until a function returns non-nil, at which point completion is
3739 assumed to have occurred."
3741 (let ((functions term-dynamic-complete-functions))
3742 (while (and functions (null (funcall (car functions))))
3743 (setq functions (cdr functions)))))
3746 (defun term-dynamic-complete-filename ()
3747 "Dynamically complete the filename at point.
3748 Completes if after a filename. See `term-match-partial-filename' and
3749 `term-dynamic-complete-as-filename'.
3750 This function is similar to `term-replace-by-expanded-filename', except that
3751 it won't change parts of the filename already entered in the buffer; it just
3752 adds completion characters to the end of the filename. A completions listing
3753 may be shown in a help buffer if completion is ambiguous.
3755 Completion is dependent on the value of `term-completion-addsuffix',
3756 `term-completion-recexact' and `term-completion-fignore', and the timing of
3757 completions listing is dependent on the value of `term-completion-autolist'.
3759 Returns t if successful."
3761 (if (term-match-partial-filename)
3762 (prog2 (or (eq (selected-window) (minibuffer-window))
3763 (message "Completing file name..."))
3764 (term-dynamic-complete-as-filename))))
3766 (defun term-dynamic-complete-as-filename ()
3767 "Dynamically complete at point as a filename.
3768 See `term-dynamic-complete-filename'. Returns t if successful."
3769 (let* ((completion-ignore-case nil)
3770 (completion-ignored-extensions term-completion-fignore)
3772 (dirsuffix (cond ((not term-completion-addsuffix) "")
3773 ((not (consp term-completion-addsuffix)) "/")
3774 (t (car term-completion-addsuffix))))
3775 (filesuffix (cond ((not term-completion-addsuffix) "")
3776 ((not (consp term-completion-addsuffix)) " ")
3777 (t (cdr term-completion-addsuffix))))
3778 (filename (or (term-match-partial-filename) ""))
3779 (pathdir (file-name-directory filename))
3780 (pathnondir (file-name-nondirectory filename))
3781 (directory (if pathdir (term-directory pathdir) default-directory))
3782 (completion (file-name-completion pathnondir directory))
3783 (mini-flag (eq (selected-window) (minibuffer-window))))
3784 (cond ((null completion)
3785 (message "No completions of %s" filename)
3787 ((eq completion t) ; Means already completed "file".
3788 (if term-completion-addsuffix (insert " "))
3789 (or mini-flag (message "Sole completion")))
3790 ((string-equal completion "") ; Means completion on "directory/".
3791 (term-dynamic-list-filename-completions))
3792 (t ; Completion string returned.
3793 (let ((file (concat (file-name-as-directory directory) completion)))
3794 (insert (substring (directory-file-name completion)
3795 (length pathnondir)))
3796 (cond ((symbolp (file-name-completion completion directory))
3797 ;; We inserted a unique completion.
3798 (insert (if (file-directory-p file) dirsuffix filesuffix))
3799 (or mini-flag (message "Completed")))
3800 ((and term-completion-recexact term-completion-addsuffix
3801 (string-equal pathnondir completion)
3802 (file-exists-p file))
3803 ;; It's not unique, but user wants shortest match.
3804 (insert (if (file-directory-p file) dirsuffix filesuffix))
3805 (or mini-flag (message "Completed shortest")))
3806 ((or term-completion-autolist
3807 (string-equal pathnondir completion))
3808 ;; It's not unique, list possible completions.
3809 (term-dynamic-list-filename-completions))
3811 (or mini-flag (message "Partially completed")))))))
3815 (defun term-replace-by-expanded-filename ()
3816 "Dynamically expand and complete the filename at point.
3817 Replace the filename with an expanded, canonicalised and completed replacement.
3818 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
3819 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
3820 removed, and the filename is made absolute instead of relative. For expansion
3821 see `expand-file-name' and `substitute-in-file-name'. For completion see
3822 `term-dynamic-complete-filename'."
3824 (replace-match (expand-file-name (term-match-partial-filename)) t t)
3825 (term-dynamic-complete-filename))
3828 (defun term-dynamic-simple-complete (stub candidates)
3829 "Dynamically complete STUB from CANDIDATES list.
3830 This function inserts completion characters at point by completing STUB from
3831 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3832 if completion is ambiguous.
3834 Returns nil if no completion was inserted.
3835 Returns `sole' if completed with the only completion match.
3836 Returns `shortest' if completed with the shortest of the completion matches.
3837 Returns `partial' if completed as far as possible with the completion matches.
3838 Returns `listed' if a completion listing was shown.
3840 See also `term-dynamic-complete-filename'."
3841 (let* ((completion-ignore-case nil)
3842 (candidates (mapcar (function (lambda (x) (list x))) candidates))
3843 (completions (all-completions stub candidates)))
3844 (cond ((null completions)
3845 (message "No completions of %s" stub)
3847 ((= 1 (length completions)) ; Gotcha!
3848 (let ((completion (car completions)))
3849 (if (string-equal completion stub)
3850 (message "Sole completion")
3851 (insert (substring completion (length stub)))
3852 (message "Completed"))
3853 (if term-completion-addsuffix (insert " "))
3855 (t ; There's no unique completion.
3856 (let ((completion (try-completion stub candidates)))
3857 ;; Insert the longest substring.
3858 (insert (substring completion (length stub)))
3859 (cond ((and term-completion-recexact term-completion-addsuffix
3860 (string-equal stub completion)
3861 (member completion completions))
3862 ;; It's not unique, but user wants shortest match.
3864 (message "Completed shortest")
3866 ((or term-completion-autolist
3867 (string-equal stub completion))
3868 ;; It's not unique, list possible completions.
3869 (term-dynamic-list-completions completions)
3872 (message "Partially completed")
3876 (defun term-dynamic-list-filename-completions ()
3877 "List in help buffer possible completions of the filename at point."
3879 (let* ((completion-ignore-case nil)
3880 (filename (or (term-match-partial-filename) ""))
3881 (pathdir (file-name-directory filename))
3882 (pathnondir (file-name-nondirectory filename))
3883 (directory (if pathdir (term-directory pathdir) default-directory))
3884 (completions (file-name-all-completions pathnondir directory)))
3886 (term-dynamic-list-completions completions)
3887 (message "No completions of %s" filename))))
3890 (defun term-dynamic-list-completions (completions)
3891 "List in help buffer sorted COMPLETIONS.
3892 Typing SPC flushes the help buffer."
3893 (let ((conf (current-window-configuration)))
3894 (with-output-to-temp-buffer "*Completions*"
3895 (display-completion-list (sort completions 'string-lessp)))
3896 (message "Hit space to flush")
3899 (set-buffer (get-buffer "*Completions*"))
3900 (setq key (read-key-sequence nil)
3903 (eq (window-buffer (posn-window (event-start first)))
3904 (get-buffer "*Completions*"))
3905 (eq (key-binding key) 'mouse-choose-completion)))
3906 ;; If the user does mouse-choose-completion with the mouse,
3907 ;; execute the command, then delete the completion window.
3909 (mouse-choose-completion first)
3910 (set-window-configuration conf))
3912 (set-window-configuration conf)
3913 (setq unread-command-events (listify-key-sequence key)))))))
3915 ;;; I need a make-term that doesn't surround with *s -mm
3916 (defun term-ansi-make-term (name program &optional startfile &rest switches)
3917 "Make a term process NAME in a buffer, running PROGRAM.
3918 The name of the buffer is NAME.
3919 If there is already a running process in that buffer, it is not restarted.
3920 Optional third arg STARTFILE is the name of a file to send the contents of to
3921 the process. Any more args are arguments to PROGRAM."
3922 (let ((buffer (get-buffer-create name )))
3923 ;; If no process, or nuked process, crank up a new one and put buffer in
3924 ;; term mode. Otherwise, leave buffer and existing process alone.
3925 (cond ((not (term-check-proc buffer))
3928 (term-mode)) ; Install local vars, mode, keymap, ...
3929 (term-exec buffer name program startfile switches)))
3932 (defvar term-ansi-buffer-name nil)
3933 (defvar term-ansi-default-program nil)
3934 (defvar term-ansi-buffer-base-name nil)
3937 (defun ansi-term (program &optional new-buffer-name)
3938 "Start a terminal-emulator in a new buffer."
3939 (interactive (list (read-from-minibuffer "Run program: "
3940 (or explicit-shell-file-name
3945 ;; Pick the name of the new buffer.
3946 (setq term-ansi-buffer-name
3949 (if term-ansi-buffer-base-name
3950 (if (eq term-ansi-buffer-base-name t)
3951 (file-name-nondirectory program)
3952 term-ansi-buffer-base-name)
3955 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
3957 ;; In order to have more than one term active at a time
3958 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
3959 ;; for now they have the *term-ansi-term*<?> form but we'll see...
3961 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
3962 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
3964 (set-buffer term-ansi-buffer-name)
3968 ;; I wanna have find-file on C-x C-f -mm
3969 ;; your mileage may definitely vary, maybe it's better to put this in your
3972 (term-set-escape-char ?\C-x)
3974 (switch-to-buffer term-ansi-buffer-name))
3977 ;;; Converting process modes to use term mode
3978 ;;; ===========================================================================
3979 ;;; Renaming variables
3980 ;;; Most of the work is renaming variables and functions. These are the common
3982 ;;; Local variables:
3983 ;;; last-input-start term-last-input-start
3984 ;;; last-input-end term-last-input-end
3985 ;;; shell-prompt-pattern term-prompt-regexp
3986 ;;; shell-set-directory-error-hook <no equivalent>
3988 ;;; shell-set-directory <unnecessary>
3989 ;;; shell-mode-map term-mode-map
3991 ;;; shell-send-input term-send-input
3992 ;;; shell-send-eof term-delchar-or-maybe-eof
3993 ;;; kill-shell-input term-kill-input
3994 ;;; interrupt-shell-subjob term-interrupt-subjob
3995 ;;; stop-shell-subjob term-stop-subjob
3996 ;;; quit-shell-subjob term-quit-subjob
3997 ;;; kill-shell-subjob term-kill-subjob
3998 ;;; kill-output-from-shell term-kill-output
3999 ;;; show-output-from-shell term-show-output
4000 ;;; copy-last-shell-input Use term-previous-input/term-next-input
4002 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4003 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4004 ;;; Term mode does not provide functionality equivalent to
4005 ;;; shell-set-directory-error-hook; it is gone.
4007 ;;; term-last-input-start is provided for modes which want to munge
4008 ;;; the buffer after input is sent, perhaps because the inferior
4009 ;;; insists on echoing the input. The LAST-INPUT-START variable in
4010 ;;; the old shell package was used to implement a history mechanism,
4011 ;;; but you should think twice before using term-last-input-start
4012 ;;; for this; the input history ring often does the job better.
4014 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4015 ;;; *not* create the term-mode local variables in your foo-mode function.
4016 ;;; This is not modular. Instead, call term-mode, and let *it* create the
4017 ;;; necessary term-specific local variables. Then create the
4018 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4019 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4020 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
4021 ;;; get-old-input) that need to be different from the defaults. Call
4022 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4023 ;;; term-mode will take care of it. The following example, from shell.el,
4026 ;;; (defvar shell-mode-map '())
4027 ;;; (cond ((not shell-mode-map)
4028 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
4029 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4030 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4031 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4032 ;;; (define-key shell-mode-map "\M-?"
4033 ;;; 'term-dynamic-list-filename-completions)))
4035 ;;; (defun shell-mode ()
4038 ;;; (setq term-prompt-regexp shell-prompt-pattern)
4039 ;;; (setq major-mode 'shell-mode)
4040 ;;; (setq mode-name "Shell")
4041 ;;; (use-local-map shell-mode-map)
4042 ;;; (make-local-variable 'shell-directory-stack)
4043 ;;; (setq shell-directory-stack nil)
4044 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4045 ;;; (run-hooks 'shell-mode-hook))
4048 ;;; Completion for term-mode users
4050 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
4051 ;;; hook to add completion functions to. Functions on this list should return
4052 ;;; non-nil if completion occurs (i.e., further completion should not occur).
4053 ;;; You could use term-dynamic-simple-complete to do the bulk of the
4058 ;;; term.el ends here