1 ;;; term.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1994, 1995, 2002, 2003,
4 ;; 2004, 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Per Bothner <per@bothner.com>
7 ;; Maintainer: Dan Nicolaescu <dann@ics.uci.edu>, Per Bothner <per@bothner.com>
8 ;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
29 ;;; Fixes for CJK support by Yong Lu <lyongu@yahoo.com>.
31 ;;; Dir/Hostname tracking and ANSI colorization by
32 ;;; Marco Melgazzi <marco@techie.com>.
34 ;;; To see what I've modified and where it came from search for '-mm'
38 ;;; Speed considerations and a few caveats
39 ;;; --------------------------------------
41 ;;; While the message passing and the colorization surely introduce some
42 ;;; overhead this has became so small that IMHO is surely outweighted by
43 ;;; the benefits you get but, as usual, YMMV
45 ;;; Important caveat, when deciding the cursor/'grey keys' keycodes I had to
46 ;;; make a choice: on my Linux box this choice allows me to run all the
47 ;;; ncurses applications without problems but make these keys
48 ;;; uncomprehensible to all the cursesX programs. Your mileage may vary so
49 ;;; you may consider changing the default 'emulation'. Just search for this
50 ;;; piece of code and modify it as you like:
52 ;;; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
53 ;;; ;; For my configuration it's definitely better \eOA but YMMV. -mm
54 ;;; ;; For example: vi works with \eOA while elm wants \e[A ...
55 ;;; (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
56 ;;; (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
57 ;;; (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
58 ;;; (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
61 ;;; IMPORTANT: additions & changes
62 ;;; ------------------------------
64 ;;; With this enhanced ansi-term.el you will get a reliable mechanism of
65 ;;; directory/username/host tracking: the only drawback is that you will
66 ;;; have to modify your shell start-up script. It's worth it, believe me :).
68 ;;; When you rlogin/su/telnet and the account you access has a modified
69 ;;; startup script, you will be able to access the remote files as usual
70 ;;; with C-x C-f, if it's needed you will have to enter a password,
71 ;;; otherwise the file should get loaded straight away.
73 ;;; This is useful even if you work only on one host: it often happens that,
74 ;;; for maintenance reasons, you have to edit files 'as root': before
75 ;;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
76 ;;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
77 ;;; 'as-root'. ( If you don't want to enter the root password every time you
78 ;;; can put it in your .netrc: note that this is -not- advisable if you're
79 ;;; connected to the internet or if somebody else works on your workstation!)
81 ;;; If you use wu-ftpd you can use some of its features to avoid root ftp
82 ;;; access to the rest of the world: just put in /etc/ftphosts something like
85 ;;; allow root 127.0.0.1
87 ;;; # By default nobody can't do anything
91 ;;; ----------------------------------------
93 ;;; If, instead of 'term', you call 'ansi-term', you get multiple term
94 ;;; buffers, after every new call ansi-term opens a new *ansi-term*<xx> window,
95 ;;; where <xx> is, as usual, a number...
97 ;;; ----------------------------------------
99 ;;; With the term-buffer-maximum-size you can finally decide how many
100 ;;; scrollback lines to keep: its default is 2048 but you can change it as
103 ;;; ----------------------------------------
106 ;;; ANSI colorization should work well, I've decided to limit the interpreter
107 ;;; to five outstanding commands (like ESC [ 01;04;32;41;07m.
108 ;;; You shouldn't need more, if you do, tell me and I'll increase it. It's
109 ;;; so easy you could do it yourself...
111 ;;; Blink, is not supported. Currently it's mapped as bold.
113 ;;; Important caveat:
114 ;;; -----------------
115 ;;; if you want custom colors in term.el redefine term-default-fg-color
116 ;;; and term-default-bg-color BEFORE loading it.
118 ;;; ----------------------------------------
120 ;;; If you'd like to check out my complete configuration, you can download
121 ;;; it from http://www.polito.it/~s64912/things.html, it's ~500k in size and
122 ;;; contains my .cshrc, .emacs and my whole site-lisp subdirectory. (notice
123 ;;; that this term.el may be newer/older than the one in there, please
126 ;;; This complete configuration contains, among other things, a complete
127 ;;; rectangular marking solution (based on rect-mark.el and
128 ;;; pc-bindings.el) and should be a good example of how extensively Emacs
129 ;;; can be configured on a ppp-connected ws.
131 ;;; ----------------------------------------
135 ;;; - Add hooks to allow raw-mode keys to be configurable
136 ;;; - Which keys are better ? \eOA or \e[A ?
141 ;;; V4.0 January 1997
143 ;;; - Huge reworking of the faces code: now we only have roughly 20-30
144 ;;; faces for everything so we're even faster than the old md-term.el !
145 ;;; - Finished removing all the J-Shell code.
147 ;;; V3.0 January 1997
149 ;;; - Now all the supportable ANSI commands work well.
150 ;;; - Reworked a little the code: much less jsh-inspired stuff
154 ;;; - Now all the faces are accessed through an array: much cleaner code.
156 ;;; V2.2 November 4 1996
158 ;;; - Implemented ANSI output colorization ( a bit rough but enough for
161 ;;; - Implemented a maximum limit for the scroll buffer (stolen from
164 ;;; v2.1 October 28 1996, first public release
166 ;;; - Some new keybindings for term-char mode ( notably home/end/...)
167 ;;; - Directory, hostname and username tracking via ange-ftp
168 ;;; - Multi-term capability via the ansi-term call
170 ;;; ----------------------------------------------------------------
171 ;;; You should/could have something like this in your .emacs to take
172 ;;; full advantage of this package
174 ;;; (add-hook 'term-mode-hook
177 ;;; (setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *")
178 ;;; (make-local-variable 'mouse-yank-at-point)
179 ;;; (make-local-variable 'transient-mark-mode)
180 ;;; (setq mouse-yank-at-point t)
181 ;;; (setq transient-mark-mode nil)
182 ;;; (auto-fill-mode -1)
183 ;;; (setq tab-width 8 ))))
186 ;;; ----------------------------------------
188 ;;; If you want to use color ls the best setup is to have a different file
189 ;;; when you use eterm ( see above, mine is named .emacs_dircolors ). This
190 ;;; is necessary because some terminals, rxvt for example, need non-ansi
191 ;;; hacks to work ( for example on my rxvt white is wired to fg, and to
192 ;;; obtain normal white I have to do bold-white :)
194 ;;; ----------------------------------------
197 ;;; # Configuration file for the color ls utility
198 ;;; # This file goes in the /etc directory, and must be world readable.
199 ;;; # You can copy this file to .dir_colors in your $HOME directory to
200 ;;; # override the system defaults.
202 ;;; # COLOR needs one of these arguments: 'tty' colorizes output to ttys, but
203 ;;; # not pipes. 'all' adds color characters to all output. 'none' shuts
204 ;;; # colorization off.
208 ;;; # Below, there should be one TERM entry for each termtype that is
212 ;;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
215 ;;; # Below are the color init strings for the basic file types. A color init
216 ;;; # string consists of one or more of the following numeric codes:
217 ;;; # Attribute codes:
218 ;;; # 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
219 ;;; # Text color codes:
220 ;;; # 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
221 ;;; # Background color codes:
222 ;;; # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
223 ;;; NORMAL 00 # global default, although everything should be something.
224 ;;; FILE 00 # normal file
225 ;;; DIR 00;37 # directory
226 ;;; LINK 00;36 # symbolic link
227 ;;; FIFO 00;37 # pipe
228 ;;; SOCK 40;35 # socket
229 ;;; BLK 33;01 # block device driver
230 ;;; CHR 33;01 # character device driver
232 ;;; # This is for files with execute permission:
235 ;;; # List any file extensions like '.gz' or '.tar' that you would like ls
236 ;;; # to colorize below. Put the extension, a space, and the color init
237 ;;; # string. (and any comments you want to add after a '#')
238 ;;; .tar 01;33 # archives or compressed
247 ;;; .jpg 01;35 # image formats
254 ;;; ----------------------------------------
256 ;;; Notice: for directory/host/user tracking you need to have something
257 ;;; like this in your shell startup script ( this is for tcsh but should
258 ;;; be quite easy to port to other shells )
260 ;;; ----------------------------------------
264 ;;; set host = `hostname`
265 ;;; set date = `date`
267 ;;; # su does not change this but I'd like it to
269 ;;; set user = `whoami`
273 ;;; if ( eterm =~ $TERM ) then
275 ;;; echo --------------------------------------------------------------
277 ;;; echo Today is $date
278 ;;; echo We are on $host running $os under Emacs term mode
279 ;;; echo --------------------------------------------------------------
281 ;;; setenv EDITOR emacsclient
283 ;;; # Notice: $host and $user have been set before to 'hostname' and 'whoami'
284 ;;; # this is necessary because, f.e., certain versions of 'su' do not change
285 ;;; # $user, YMMV: if you don't want to fiddle with them define a couple
286 ;;; # of new variables and use these instead.
287 ;;; # NOTICE that there is a space between "AnSiT?" and $whatever NOTICE
289 ;;; # These are because we want the real cwd in the messages, not the login
292 ;;; set cwd_hack='$cwd'
293 ;;; set host_hack='$host'
294 ;;; set user_hack='$user'
296 ;;; # Notice that the ^[ character is an ESC, not two chars. You can
297 ;;; # get it in various ways, for example by typing
298 ;;; # echo -e '\033' > escape.file
299 ;;; # or by using your favourite editor
301 ;;; foreach temp (cd pushd)
302 ;;; alias $temp "$temp \!* ; echo '\eAnSiTc' $cwd_hack"
304 ;;; alias popd 'popd ;echo "\eAnSiTc" $cwd'
306 ;;; # Every command that can modify the user/host/directory should be aliased
307 ;;; # as follows for the tracking mechanism to work.
309 ;;; foreach temp ( rlogin telnet rsh sh ksh csh tcsh zsh bash tcl su )
310 ;;; alias $temp "$temp \!* ; echo '\eAnSiTh' $host_hack ; \
311 ;;; echo '\eAnSiTu' $user_hack ;echo '\eAnSiTc' $cwd_hack"
314 ;;; # Start up & use color ls
316 ;;; echo "\eAnSiTh" $host
317 ;;; echo "\eAnSiTu" $user
318 ;;; echo "\eAnSiTc" $cwd
320 ;;; # some housekeeping
327 ;;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
332 ;;; # Let's not clutter user space
339 ;;; Original Commentary:
340 ;;; --------------------
342 ;; The changelog is at the end of this file.
344 ;; Please send me bug reports, bug fixes, and extensions, so that I can
345 ;; merge them into the master source.
346 ;; - Per Bothner (bothner@cygnus.com)
348 ;; This file defines a general command-interpreter-in-a-buffer package
349 ;; (term mode). The idea is that you can build specific process-in-a-buffer
350 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
351 ;; This way, all these specific packages share a common base functionality,
352 ;; and a common set of bindings, which makes them easier to use (and
353 ;; saves code, implementation time, etc., etc.).
355 ;; For hints on converting existing process modes (e.g., tex-mode,
356 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
357 ;; instead of shell-mode, see the notes at the end of this file.
360 ;; Brief Command Documentation:
361 ;;============================================================================
362 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
365 ;; m-p term-previous-input Cycle backwards in input history
366 ;; m-n term-next-input Cycle forwards
367 ;; m-r term-previous-matching-input Previous input matching a regexp
368 ;; m-s comint-next-matching-input Next input that matches
369 ;; return term-send-input
370 ;; c-c c-a term-bol Beginning of line; skip prompt.
371 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
372 ;; c-c c-u term-kill-input ^u
373 ;; c-c c-w backward-kill-word ^w
374 ;; c-c c-c term-interrupt-subjob ^c
375 ;; c-c c-z term-stop-subjob ^z
376 ;; c-c c-\ term-quit-subjob ^\
377 ;; c-c c-o term-kill-output Delete last batch of process output
378 ;; c-c c-r term-show-output Show last batch of process output
379 ;; c-c c-h term-dynamic-list-input-ring List input history
381 ;; Not bound by default in term-mode
382 ;; term-send-invisible Read a line w/o echo, and send to proc
383 ;; (These are bound in shell-mode)
384 ;; term-dynamic-complete Complete filename at point.
385 ;; term-dynamic-list-completions List completions in help buffer.
386 ;; term-replace-by-expanded-filename Expand and complete filename at point;
387 ;; replace with expanded/completed name.
388 ;; term-kill-subjob No mercy.
389 ;; term-show-maximum-output Show as much output as possible.
390 ;; term-continue-subjob Send CONT signal to buffer's process
391 ;; group. Useful if you accidentally
392 ;; suspend your process (with C-c C-z).
394 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
395 ;; term-load-hook is run after loading in this package.
399 ;; This is passed to the inferior in the EMACS environment variable,
400 ;; so it is important to increase it if there are protocol-relevant changes.
401 (defconst term-protocol-version
"0.96")
409 "General command interpreter in a window."
414 ;;; Buffer Local Variables:
415 ;;;============================================================================
416 ;;; Term mode buffer local variables:
417 ;;; term-prompt-regexp - string term-bol uses to match prompt.
418 ;;; term-delimiter-argument-list - list For delimiters and arguments
419 ;;; term-last-input-start - marker Handy if inferior always echoes
420 ;;; term-last-input-end - marker For term-kill-output command
421 ;; For the input history mechanism:
422 (defvar term-input-ring-size
32 "Size of input history ring.")
423 ;;; term-input-ring-size - integer
424 ;;; term-input-ring - ring
425 ;;; term-input-ring-index - number ...
426 ;;; term-input-autoexpand - symbol ...
427 ;;; term-input-ignoredups - boolean ...
428 ;;; term-last-input-match - string ...
429 ;;; term-dynamic-complete-functions - hook For the completion mechanism
430 ;;; term-completion-fignore - list ...
431 ;;; term-get-old-input - function Hooks for specific
432 ;;; term-input-filter-functions - hook process-in-a-buffer
433 ;;; term-input-filter - function modes.
434 ;;; term-input-send - function
435 ;;; term-scroll-to-bottom-on-output - symbol ...
436 ;;; term-scroll-show-maximum-output - boolean...
437 (defvar term-height
) ;; Number of lines in window.
438 (defvar term-width
) ;; Number of columns in window.
439 (defvar term-home-marker
) ;; Marks the "home" position for cursor addressing.
440 (defvar term-saved-home-marker nil
) ;; When using alternate sub-buffer,
441 ;; contains saved term-home-marker from original sub-buffer .
442 (defvar term-start-line-column
0) ;; (current-column) at start of screen line,
443 ;; or nil if unknown.
444 (defvar term-current-column
0) ;; If non-nil, is cache for (current-column).
445 (defvar term-current-row
0) ;; Current vertical row (relative to home-marker)
446 ;; or nil if unknown.
447 (defvar term-insert-mode nil
)
448 (defvar term-vertical-motion
)
449 (defvar term-terminal-state
0) ;; State of the terminal emulator:
450 ;; state 0: Normal state
451 ;; state 1: Last character was a graphic in the last column.
452 ;; If next char is graphic, first move one column right
453 ;; (and line warp) before displaying it.
454 ;; This emulates (more or less) the behavior of xterm.
456 ;; state 3: seen ESC [ (or ESC [ ?)
457 ;; state 4: term-terminal-parameter contains pending output.
458 (defvar term-kill-echo-list nil
) ;; A queue of strings whose echo
459 ;; we want suppressed.
460 (defvar term-terminal-parameter
)
461 (defvar term-terminal-previous-parameter
)
462 (defvar term-current-face
'default
)
463 (defvar term-scroll-start
0) ;; Top-most line (inclusive) of scrolling region.
464 (defvar term-scroll-end
) ;; Number of line (zero-based) after scrolling region.
465 (defvar term-pager-count nil
) ;; If nil, paging is disabled.
466 ;; Otherwise, number of lines before we need to page.
467 (defvar term-saved-cursor nil
)
468 (defvar term-command-hook
)
469 (defvar term-log-buffer nil
)
470 (defvar term-scroll-with-delete nil
) ;; term-scroll-with-delete is t if
471 ;; forward scrolling should be implemented by delete to
472 ;; top-most line(s); and nil if scrolling should be implemented
473 ;; by moving term-home-marker. It is set to t iff there is a
474 ;; (non-default) scroll-region OR the alternate buffer is used.
475 (defvar term-pending-delete-marker
) ;; New user input in line mode needs to
476 ;; be deleted, because it gets echoed by the inferior.
477 ;; To reduce flicker, we defer the delete until the next output.
478 (defvar term-old-mode-map nil
) ;; Saves the old keymap when in char mode.
479 (defvar term-old-mode-line-format
) ;; Saves old mode-line-format while paging.
480 (defvar term-pager-old-local-map nil
) ;; Saves old keymap while paging.
481 (defvar term-pager-old-filter
) ;; Saved process-filter while paging.
483 (defcustom explicit-shell-file-name nil
484 "*If non-nil, is file name to use for explicitly requested inferior shell."
485 :type
'(choice (const nil
) file
)
488 (defvar term-prompt-regexp
"^"
489 "Regexp to recognize prompts in the inferior process.
490 Defaults to \"^\", the null string at BOL.
493 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
494 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
495 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
497 shell: \"^[^#$%>\\n]*[#$%>] *\"
500 This is a good thing to set in mode hooks.")
502 (defvar term-delimiter-argument-list
()
503 "List of characters to recognize as separate arguments in input.
504 Strings comprising a character in this list will separate the arguments
505 surrounding them, and also be regarded as arguments in their own right (unlike
506 whitespace). See `term-arguments'.
507 Defaults to the empty list.
509 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
511 This is a good thing to set in mode hooks.")
513 (defcustom term-input-autoexpand nil
514 "*If non-nil, expand input command history references on completion.
515 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
517 If the value is `input', then the expansion is seen on input.
518 If the value is `history', then the expansion is only when inserting
519 into the buffer's input ring. See also `term-magic-space' and
520 `term-dynamic-complete'.
522 This variable is buffer-local."
523 :type
'(choice (const nil
) (const t
) (const input
) (const history
))
526 (defcustom term-input-ignoredups nil
527 "*If non-nil, don't add input matching the last on the input ring.
528 This mirrors the optional behavior of bash.
530 This variable is buffer-local."
534 (defcustom term-input-ring-file-name nil
535 "*If non-nil, name of the file to read/write input history.
536 See also `term-read-input-ring' and `term-write-input-ring'.
538 This variable is buffer-local, and is a good thing to set in mode hooks."
542 (defcustom term-scroll-to-bottom-on-output nil
543 "*Controls whether interpreter output causes window to scroll.
544 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
545 If `this', scroll only the selected window.
546 If `others', scroll only those that are not the selected window.
550 See variable `term-scroll-show-maximum-output'.
551 This variable is buffer-local."
555 (defcustom term-scroll-show-maximum-output nil
556 "*Controls how interpreter output causes window to scroll.
557 If non-nil, then show the maximum output when the window is scrolled.
559 See variable `term-scroll-to-bottom-on-output'.
560 This variable is buffer-local."
564 ;; Where gud-display-frame should put the debugging arrow. This is
565 ;; set by the marker-filter, which scans the debugger's output for
566 ;; indications of the current pc.
567 (defvar term-pending-frame nil
)
569 ;;; Here are the per-interpreter hooks.
570 (defvar term-get-old-input
(function term-get-old-input-default
)
571 "Function that submits old text in term mode.
572 This function is called when return is typed while the point is in old text.
573 It returns the text to be submitted as process input. The default is
574 `term-get-old-input-default', which grabs the current line, and strips off
575 leading text matching `term-prompt-regexp'.")
577 (defvar term-dynamic-complete-functions
578 '(term-replace-by-expanded-history term-dynamic-complete-filename
)
579 "List of functions called to perform completion.
580 Functions should return non-nil if completion was performed.
581 See also `term-dynamic-complete'.
583 This is a good thing to set in mode hooks.")
585 (defvar term-input-filter
586 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
587 "Predicate for filtering additions to input history.
588 Only inputs answering true to this function are saved on the input
589 history list. Default is to save anything that isn't all whitespace.")
591 (defvar term-input-filter-functions
'()
592 "Functions to call before input is sent to the process.
593 These functions get one argument, a string containing the text to send.
595 This variable is buffer-local.")
597 (defvar term-input-sender
(function term-simple-send
)
598 "Function to actually send to PROCESS the STRING submitted by user.
599 Usually this is just `term-simple-send', but if your mode needs to
600 massage the input string, this is your hook. This is called from
601 the user command `term-send-input'. `term-simple-send' just sends
602 the string plus a newline.")
604 (defcustom term-eol-on-send t
605 "*Non-nil means go to the end of the line before sending input.
606 See `term-send-input'."
610 (defcustom term-mode-hook
'()
611 "Called upon entry into term mode.
612 This is run before the process is cranked up."
616 (defcustom term-exec-hook
'()
617 "Called each time a process is exec'd by `term-exec'.
618 This is called after the process is cranked up. It is useful for things that
619 must be done each time a process is executed in a term mode buffer (e.g.,
620 `process-kill-without-query'). In contrast, `term-mode-hook' is only
621 executed once when the buffer is created."
625 (defvar term-mode-map nil
)
626 (defvar term-raw-map nil
627 "Keyboard map for sending characters directly to the inferior process.")
628 (defvar term-escape-char nil
629 "Escape character for char sub-mode of term mode.
630 Do not change it directly; use `term-set-escape-char' instead.")
631 (defvar term-raw-escape-map nil
)
633 (defvar term-pager-break-map nil
)
636 "True if communications via pty; false if by pipe. Buffer local.
637 This is to work around a bug in Emacs process signaling.")
639 (defvar term-last-input-match
""
640 "Last string searched for by term input history search, for defaulting.
641 Buffer local variable.")
643 (defvar term-input-ring nil
)
644 (defvar term-last-input-start
)
645 (defvar term-last-input-end
)
646 (defvar term-input-ring-index nil
647 "Index of last matched history element.")
648 (defvar term-matching-input-from-input-string
""
649 "Input previously used to match input history.")
650 ; This argument to set-process-filter disables reading from the process,
651 ; assuming this is Emacs 19.20 or newer.
652 (defvar term-pager-filter t
)
654 (put 'term-replace-by-expanded-history
'menu-enable
'term-input-autoexpand
)
655 (put 'term-input-ring
'permanent-local t
)
656 (put 'term-input-ring-index
'permanent-local t
)
657 (put 'term-input-autoexpand
'permanent-local t
)
658 (put 'term-input-filter-functions
'permanent-local t
)
659 (put 'term-scroll-to-bottom-on-output
'permanent-local t
)
660 (put 'term-scroll-show-maximum-output
'permanent-local t
)
661 (put 'term-ptyp
'permanent-local t
)
663 (defmacro term-in-char-mode
() '(eq (current-local-map) term-raw-map
))
664 (defmacro term-in-line-mode
() '(not (term-in-char-mode)))
665 ;; True if currently doing PAGER handling.
666 (defmacro term-pager-enabled
() 'term-pager-count
)
667 (defmacro term-handling-pager
() 'term-pager-old-local-map
)
668 (defmacro term-using-alternate-sub-buffer
() 'term-saved-home-marker
)
670 (defvar term-signals-menu
)
671 (defvar term-terminal-menu
)
673 ;;; Let's silence the byte-compiler -mm
674 (defvar term-ansi-at-host nil
)
675 (defvar term-ansi-at-dir nil
)
676 (defvar term-ansi-at-user nil
)
677 (defvar term-ansi-at-message nil
)
678 (defvar term-ansi-at-save-user nil
)
679 (defvar term-ansi-at-save-pwd nil
)
680 (defvar term-ansi-at-save-anon nil
)
681 (defvar term-ansi-current-bold nil
)
682 (defvar term-ansi-current-color
0)
683 (defvar term-ansi-face-already-done nil
)
684 (defvar term-ansi-current-bg-color
0)
685 (defvar term-ansi-current-underline nil
)
686 (defvar term-ansi-current-reverse nil
)
687 (defvar term-ansi-current-invisible nil
)
689 ;;; Four should be enough, if you want more, just add. -mm
690 (defvar term-terminal-more-parameters
0)
691 (defvar term-terminal-previous-parameter-2 -
1)
692 (defvar term-terminal-previous-parameter-3 -
1)
693 (defvar term-terminal-previous-parameter-4 -
1)
698 (defcustom term-default-fg-color
'unspecified
699 "Default color for foreground in `term'."
703 (defcustom term-default-bg-color
'unspecified
704 "Default color for background in `term'."
708 ;;; Use the same colors that xterm uses, see `xterm-standard-colors'.
709 (defvar ansi-term-color-vector
710 [unspecified
"black" "red3" "green3" "yellow3" "blue2"
711 "magenta3" "cyan3" "white"])
713 ;;; Inspiration came from comint.el -mm
714 (defvar term-buffer-maximum-size
2048
715 "*The maximum size in lines for term buffers.
716 Term buffers are truncated from the top to be no greater than this number.
717 Notice that a setting of 0 means 'don't truncate anything'. This variable
721 (when (featurep 'xemacs
)
722 (defvar term-terminal-menu
724 [ "Character mode" term-char-mode
(term-in-line-mode)]
725 [ "Line mode" term-line-mode
(term-in-char-mode)]
726 [ "Enable paging" term-pager-toggle
(not term-pager-count
)]
727 [ "Disable paging" term-pager-toggle term-pager-count
])))
729 (unless term-mode-map
730 (setq term-mode-map
(make-sparse-keymap))
731 (define-key term-mode-map
"\ep" 'term-previous-input
)
732 (define-key term-mode-map
"\en" 'term-next-input
)
733 (define-key term-mode-map
"\er" 'term-previous-matching-input
)
734 (define-key term-mode-map
"\es" 'term-next-matching-input
)
735 (unless (featurep 'xemacs
)
736 (define-key term-mode-map
[?\A-\M-r
]
737 'term-previous-matching-input-from-input
)
738 (define-key term-mode-map
[?\A-\M-s
] 'term-next-matching-input-from-input
))
739 (define-key term-mode-map
"\e\C-l" 'term-show-output
)
740 (define-key term-mode-map
"\C-m" 'term-send-input
)
741 (define-key term-mode-map
"\C-d" 'term-delchar-or-maybe-eof
)
742 (define-key term-mode-map
"\C-c\C-a" 'term-bol
)
743 (define-key term-mode-map
"\C-c\C-u" 'term-kill-input
)
744 (define-key term-mode-map
"\C-c\C-w" 'backward-kill-word
)
745 (define-key term-mode-map
"\C-c\C-c" 'term-interrupt-subjob
)
746 (define-key term-mode-map
"\C-c\C-z" 'term-stop-subjob
)
747 (define-key term-mode-map
"\C-c\C-\\" 'term-quit-subjob
)
748 (define-key term-mode-map
"\C-c\C-m" 'term-copy-old-input
)
749 (define-key term-mode-map
"\C-c\C-o" 'term-kill-output
)
750 (define-key term-mode-map
"\C-c\C-r" 'term-show-output
)
751 (define-key term-mode-map
"\C-c\C-e" 'term-show-maximum-output
)
752 (define-key term-mode-map
"\C-c\C-l" 'term-dynamic-list-input-ring
)
753 (define-key term-mode-map
"\C-c\C-n" 'term-next-prompt
)
754 (define-key term-mode-map
"\C-c\C-p" 'term-previous-prompt
)
755 (define-key term-mode-map
"\C-c\C-d" 'term-send-eof
)
756 (define-key term-mode-map
"\C-c\C-k" 'term-char-mode
)
757 (define-key term-mode-map
"\C-c\C-j" 'term-line-mode
)
758 (define-key term-mode-map
"\C-c\C-q" 'term-pager-toggle
)
761 ; (define-key term-mode-map [menu-bar completion]
762 ; (cons "Complete" (make-sparse-keymap "Complete")))
763 ; (define-key term-mode-map [menu-bar completion complete-expand]
764 ; '("Expand File Name" . term-replace-by-expanded-filename))
765 ; (define-key term-mode-map [menu-bar completion complete-listing]
766 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
767 ; (define-key term-mode-map [menu-bar completion complete-file]
768 ; '("Complete File Name" . term-dynamic-complete-filename))
769 ; (define-key term-mode-map [menu-bar completion complete]
770 ; '("Complete Before Point" . term-dynamic-complete))
771 ; ;; Put them in the menu bar:
772 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
773 ; menu-bar-final-items))
777 (unless (featurep 'xemacs
)
780 (setq newmap
(make-sparse-keymap "Terminal"))
781 (define-key newmap
[terminal-pager-enable
]
782 '("Enable paging" . term-fake-pager-enable
))
783 (define-key newmap
[terminal-pager-disable
]
784 '("Disable paging" . term-fake-pager-disable
))
785 (define-key newmap
[terminal-char-mode
]
786 '("Character mode" . term-char-mode
))
787 (define-key newmap
[terminal-line-mode
]
788 '("Line mode" . term-line-mode
))
789 (setq term-terminal-menu
(cons "Terminal" newmap
))
791 ;; completion: (line mode only)
792 (defvar term-completion-menu
(make-sparse-keymap "Complete"))
793 (define-key term-mode-map
[menu-bar completion
]
794 (cons "Complete" term-completion-menu
))
795 (define-key term-completion-menu
[complete-expand
]
796 '("Expand File Name" . term-replace-by-expanded-filename
))
797 (define-key term-completion-menu
[complete-listing
]
798 '("File Completion Listing" . term-dynamic-list-filename-completions
))
799 (define-key term-completion-menu
[menu-bar completion complete-file
]
800 '("Complete File Name" . term-dynamic-complete-filename
))
801 (define-key term-completion-menu
[menu-bar completion complete
]
802 '("Complete Before Point" . term-dynamic-complete
))
804 ;; Input history: (line mode only)
805 (defvar term-inout-menu
(make-sparse-keymap "In/Out"))
806 (define-key term-mode-map
[menu-bar inout
]
807 (cons "In/Out" term-inout-menu
))
808 (define-key term-inout-menu
[kill-output
]
809 '("Kill Current Output Group" . term-kill-output
))
810 (define-key term-inout-menu
[next-prompt
]
811 '("Forward Output Group" . term-next-prompt
))
812 (define-key term-inout-menu
[previous-prompt
]
813 '("Backward Output Group" . term-previous-prompt
))
814 (define-key term-inout-menu
[show-maximum-output
]
815 '("Show Maximum Output" . term-show-maximum-output
))
816 (define-key term-inout-menu
[show-output
]
817 '("Show Current Output Group" . term-show-output
))
818 (define-key term-inout-menu
[kill-input
]
819 '("Kill Current Input" . term-kill-input
))
820 (define-key term-inout-menu
[copy-input
]
821 '("Copy Old Input" . term-copy-old-input
))
822 (define-key term-inout-menu
[forward-matching-history
]
823 '("Forward Matching Input..." . term-forward-matching-input
))
824 (define-key term-inout-menu
[backward-matching-history
]
825 '("Backward Matching Input..." . term-backward-matching-input
))
826 (define-key term-inout-menu
[next-matching-history
]
827 '("Next Matching Input..." . term-next-matching-input
))
828 (define-key term-inout-menu
[previous-matching-history
]
829 '("Previous Matching Input..." . term-previous-matching-input
))
830 (define-key term-inout-menu
[next-matching-history-from-input
]
831 '("Next Matching Current Input" . term-next-matching-input-from-input
))
832 (define-key term-inout-menu
[previous-matching-history-from-input
]
833 '("Previous Matching Current Input" .
834 term-previous-matching-input-from-input
))
835 (define-key term-inout-menu
[next-history
]
836 '("Next Input" . term-next-input
))
837 (define-key term-inout-menu
[previous-history
]
838 '("Previous Input" . term-previous-input
))
839 (define-key term-inout-menu
[list-history
]
840 '("List Input History" . term-dynamic-list-input-ring
))
841 (define-key term-inout-menu
[expand-history
]
842 '("Expand History Before Point" . term-replace-by-expanded-history
))
845 (setq newmap
(make-sparse-keymap "Signals"))
846 (define-key newmap
[eof] '("EOF" . term-send-eof))
847 (define-key newmap [kill] '("KILL" . term-kill-subjob))
848 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
849 (define-key newmap [cont] '("CONT" . term-continue-subjob))
850 (define-key newmap [stop] '("STOP" . term-stop-subjob))
851 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
852 (define-key term-mode-map [menu-bar signals]
853 (setq term-signals-menu (cons "Signals" newmap)))
856 ;; Set up term-raw-map, etc.
858 (defun term-set-escape-char (c)
859 "Change term-escape-char and keymaps that depend on it."
860 (when term-escape-char
861 (define-key term-raw-map term-escape-char 'term-send-raw))
862 (setq c (make-string 1 c))
863 (define-key term-raw-map c term-raw-escape-map)
864 ;; Define standard bindings in term-raw-escape-map
865 (define-key term-raw-escape-map "\C-v"
866 (lookup-key (current-global-map) "\C-v"))
867 (define-key term-raw-escape-map "\C-u"
868 (lookup-key (current-global-map) "\C-u"))
869 (define-key term-raw-escape-map c 'term-send-raw)
870 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
871 ;; The keybinding for term-char-mode is needed by the menubar code.
872 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
873 (define-key term-raw-escape-map "\C-j" 'term-line-mode)
874 ;; It's convenient to have execute-extended-command here.
875 (define-key term-raw-escape-map [?\M-x] 'execute-extended-command))
877 (let* ((map (make-keymap))
878 (esc-map (make-keymap))
881 (define-key map (make-string 1 i) 'term-send-raw)
882 ;; Avoid O and [. They are used in escape sequences for various keys.
883 (unless (or (eq i ?O) (eq i 91))
884 (define-key esc-map (make-string 1 i) 'term-send-raw-meta))
886 (define-key map "\e" esc-map)
887 (setq term-raw-map map)
888 (setq term-raw-escape-map
889 (copy-keymap (lookup-key (current-global-map) "\C-x")))
891 ;;; Added nearly all the 'grey keys' -mm
893 (if (featurep 'xemacs)
894 (define-key term-raw-map [button2] 'term-mouse-paste)
895 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
896 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
897 (define-key term-raw-map [menu-bar signals] term-signals-menu))
898 (define-key term-raw-map [up] 'term-send-up)
899 (define-key term-raw-map [down] 'term-send-down)
900 (define-key term-raw-map [right] 'term-send-right)
901 (define-key term-raw-map [left] 'term-send-left)
902 (define-key term-raw-map [delete] 'term-send-del)
903 (define-key term-raw-map [deletechar] 'term-send-del)
904 (define-key term-raw-map [backspace] 'term-send-backspace)
905 (define-key term-raw-map [home] 'term-send-home)
906 (define-key term-raw-map [end] 'term-send-end)
907 (define-key term-raw-map [insert] 'term-send-insert)
908 (define-key term-raw-map [S-prior] 'scroll-down)
909 (define-key term-raw-map [S-next] 'scroll-up)
910 (define-key term-raw-map [S-insert] 'term-paste)
911 (define-key term-raw-map [prior] 'term-send-prior)
912 (define-key term-raw-map [next] 'term-send-next))
914 (term-set-escape-char ?\C-c)
916 (defun term-window-width ()
917 (if (featurep 'xemacs)
919 (if (and window-system overflow-newline-into-fringe)
921 (1- (window-width)))))
924 (put 'term-mode 'mode-class 'special)
927 ;;; Use this variable as a display table for `term-mode'.
928 (defvar term-display-table
929 (let ((dt (or (copy-sequence standard-display-table)
930 (make-display-table)))
932 ;; avoid changing the display table for ^J
935 (aset dt i (vector i))
939 (aset dt i (vector i))
943 (aset dt i (vector i))
948 "Major mode for interacting with an inferior interpreter.
949 The interpreter name is same as buffer name, sans the asterisks.
951 There are two submodes: line mode and char mode. By default, you are
952 in char mode. In char sub-mode, each character (except
953 `term-escape-char') is sent immediately to the subprocess.
954 The escape character is equivalent to the usual meaning of C-x.
956 In line mode, you send a line of input at a time; use
957 \\[term-send-input] to send.
959 In line mode, this maintains an input history of size
960 `term-input-ring-size', and you can access it with the commands
961 \\[term-next-input], \\[term-previous-input], and
962 \\[term-dynamic-list-input-ring]. Input ring history expansion can be
963 achieved with the commands \\[term-replace-by-expanded-history] or
964 \\[term-magic-space]. Input ring expansion is controlled by the
965 variable `term-input-autoexpand', and addition is controlled by the
966 variable `term-input-ignoredups'.
968 Input to, and output from, the subprocess can cause the window to scroll to
969 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
970 and `term-scroll-to-bottom-on-output'.
972 If you accidentally suspend your process, use \\[term-continue-subjob]
975 This mode can be customized to create specific modes for running
976 particular subprocesses. This can be done by setting the hooks
977 `term-input-filter-functions', `term-input-filter',
978 `term-input-sender' and `term-get-old-input' to appropriate functions,
979 and the variable `term-prompt-regexp' to the appropriate regular
982 Commands in raw mode:
986 Commands in line mode:
990 Entry to this mode runs the hooks on `term-mode-hook'."
992 ;; Do not remove this. All major modes must do this.
993 (kill-all-local-variables)
994 (setq major-mode 'term-mode)
995 (setq mode-name "Term")
996 (use-local-map term-mode-map)
997 ;; we do not want indent to sneak in any tabs
998 (setq indent-tabs-mode nil)
999 (setq buffer-display-table term-display-table)
1000 (make-local-variable 'term-home-marker)
1001 (setq term-home-marker (copy-marker 0))
1002 (make-local-variable 'term-saved-home-marker)
1003 (make-local-variable 'term-height)
1004 (make-local-variable 'term-width)
1005 (setq term-width (term-window-width))
1006 (setq term-height (1- (window-height)))
1007 (make-local-variable 'term-terminal-parameter)
1008 (make-local-variable 'term-saved-cursor)
1009 (make-local-variable 'term-last-input-start)
1010 (setq term-last-input-start (make-marker))
1011 (make-local-variable 'term-last-input-end)
1012 (setq term-last-input-end (make-marker))
1013 (make-local-variable 'term-last-input-match)
1014 (setq term-last-input-match "")
1015 (make-local-variable 'term-prompt-regexp) ; Don't set; default
1016 (make-local-variable 'term-input-ring-size) ; ...to global val.
1017 (make-local-variable 'term-input-ring)
1018 (make-local-variable 'term-input-ring-file-name)
1019 (or (and (boundp 'term-input-ring) term-input-ring)
1020 (setq term-input-ring (make-ring term-input-ring-size)))
1021 (make-local-variable 'term-input-ring-index)
1022 (or (and (boundp 'term-input-ring-index) term-input-ring-index)
1023 (setq term-input-ring-index nil))
1025 (make-local-variable 'term-command-hook)
1026 (setq term-command-hook (symbol-function 'term-command-hook))
1028 ;;; I'm not sure these saves are necessary but, since I
1029 ;;; haven't tested the whole thing on a net connected machine with
1030 ;;; a properly configured ange-ftp, I've decided to be conservative
1031 ;;; and put them in. -mm
1033 (make-local-variable 'term-ansi-at-host)
1034 (setq term-ansi-at-host (system-name))
1036 (make-local-variable 'term-ansi-at-dir)
1037 (setq term-ansi-at-dir default-directory)
1039 (make-local-variable 'term-ansi-at-message)
1040 (setq term-ansi-at-message nil)
1042 ;;; For user tracking purposes -mm
1043 (make-local-variable 'ange-ftp-default-user)
1044 (make-local-variable 'ange-ftp-default-password)
1045 (make-local-variable 'ange-ftp-generate-anonymous-password)
1047 ;;; You may want to have different scroll-back sizes -mm
1048 (make-local-variable 'term-buffer-maximum-size)
1050 ;;; Of course these have to be buffer-local -mm
1051 (make-local-variable 'term-ansi-current-bold)
1052 (make-local-variable 'term-ansi-current-color)
1053 (make-local-variable 'term-ansi-face-already-done)
1054 (make-local-variable 'term-ansi-current-bg-color)
1055 (make-local-variable 'term-ansi-current-underline)
1056 (make-local-variable 'term-ansi-current-reverse)
1057 (make-local-variable 'term-ansi-current-invisible)
1059 (make-local-variable 'term-terminal-parameter)
1060 (make-local-variable 'term-terminal-previous-parameter)
1061 (make-local-variable 'term-terminal-previous-parameter-2)
1062 (make-local-variable 'term-terminal-previous-parameter-3)
1063 (make-local-variable 'term-terminal-previous-parameter-4)
1064 (make-local-variable 'term-terminal-more-parameters)
1066 (make-local-variable 'term-terminal-state)
1067 (make-local-variable 'term-kill-echo-list)
1068 (make-local-variable 'term-start-line-column)
1069 (make-local-variable 'term-current-column)
1070 (make-local-variable 'term-current-row)
1071 (make-local-variable 'term-log-buffer)
1072 (make-local-variable 'term-scroll-start)
1073 (make-local-variable 'term-scroll-end)
1074 (setq term-scroll-end term-height)
1075 (make-local-variable 'term-scroll-with-delete)
1076 (make-local-variable 'term-pager-count)
1077 (make-local-variable 'term-pager-old-local-map)
1078 (make-local-variable 'term-old-mode-map)
1079 (make-local-variable 'term-insert-mode)
1080 (make-local-variable 'term-dynamic-complete-functions)
1081 (make-local-variable 'term-completion-fignore)
1082 (make-local-variable 'term-get-old-input)
1083 (make-local-variable 'term-matching-input-from-input-string)
1084 (make-local-variable 'term-input-autoexpand)
1085 (make-local-variable 'term-input-ignoredups)
1086 (make-local-variable 'term-delimiter-argument-list)
1087 (make-local-variable 'term-input-filter-functions)
1088 (make-local-variable 'term-input-filter)
1089 (make-local-variable 'term-input-sender)
1090 (make-local-variable 'term-eol-on-send)
1091 (make-local-variable 'term-scroll-to-bottom-on-output)
1092 (make-local-variable 'term-scroll-show-maximum-output)
1093 (make-local-variable 'term-ptyp)
1094 (make-local-variable 'term-exec-hook)
1095 (make-local-variable 'term-vertical-motion)
1096 (make-local-variable 'term-pending-delete-marker)
1097 (setq term-pending-delete-marker (make-marker))
1098 (make-local-variable 'term-current-face)
1099 (make-local-variable 'term-pending-frame)
1100 (setq term-pending-frame nil)
1101 ;; Cua-mode's keybindings interfere with the term keybindings, disable it.
1102 (set (make-local-variable 'cua-mode) nil)
1103 (run-mode-hooks 'term-mode-hook)
1104 (when (featurep 'xemacs)
1106 (append current-menubar (list term-terminal-menu))))
1108 (setq term-input-ring (make-ring term-input-ring-size)))
1109 (term-update-mode-line))
1111 (defun term-reset-size (height width)
1112 (setq term-height height)
1113 (setq term-width width)
1114 (setq term-start-line-column nil)
1115 (setq term-current-row nil)
1116 (setq term-current-column nil)
1117 (term-set-scroll-region 0 height))
1119 ;; Recursive routine used to check if any string in term-kill-echo-list
1120 ;; matches part of the buffer before point.
1121 ;; If so, delete that matched part of the buffer - this suppresses echo.
1122 ;; Also, remove that string from the term-kill-echo-list.
1123 ;; We *also* remove any older string on the list, as a sanity measure,
1124 ;; in case something gets out of sync. (Except for type-ahead, there
1125 ;; should only be one element in the list.)
1127 (defun term-check-kill-echo-list ()
1128 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1133 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1134 (if (and (>= start (point-min))
1135 (string= str (buffer-substring start (point))))
1136 (progn (delete-backward-char len)
1137 (setq term-kill-echo-list (cdr cur))
1138 (setq term-current-column nil)
1139 (setq term-current-row nil)
1140 (setq term-start-line-column nil)
1141 (setq cur nil found t))
1142 (setq cur (cdr cur))))))
1144 (goto-char save-point)))
1147 (defun term-check-size (process)
1148 (when (or (/= term-height (1- (window-height)))
1149 (/= term-width (term-window-width)))
1150 (term-reset-size (1- (window-height)) (term-window-width))
1151 (set-process-window-size process term-height term-width)))
1153 (defun term-send-raw-string (chars)
1154 (let ((proc (get-buffer-process (current-buffer))))
1156 (error "Current buffer has no process")
1157 ;; Note that (term-current-row) must be called *after*
1158 ;; (point) has been updated to (process-mark proc).
1159 (goto-char (process-mark proc))
1160 (when (term-pager-enabled)
1161 (setq term-pager-count (term-current-row)))
1162 (process-send-string proc chars))))
1164 (defun term-send-raw ()
1165 "Send the last character typed through the terminal-emulator
1166 without any interpretation."
1168 ;; Convert `return' to C-m, etc.
1169 (when (and (symbolp last-input-char)
1170 (get last-input-char 'ascii-character))
1171 (setq last-input-char (get last-input-char 'ascii-character)))
1172 (term-send-raw-string (make-string 1 last-input-char)))
1174 (defun term-send-raw-meta ()
1176 (let ((char last-input-char))
1177 (when (symbolp last-input-char)
1178 ;; Convert `return' to C-m, etc.
1179 (let ((tmp (get char 'event-symbol-elements)))
1181 (setq char (car tmp)))
1182 (when (symbolp char)
1183 (setq tmp (get char 'ascii-character))
1186 (setq char (event-basic-type char))
1187 (term-send-raw-string (if (and (numberp char)
1190 (make-string 1 char)
1191 (format "\e%c" char)))))
1193 (defun term-mouse-paste (click arg)
1194 "Insert the last stretch of killed text at the position clicked on."
1195 (interactive "e\nP")
1196 (if (featurep 'xemacs)
1197 (term-send-raw-string
1198 (or (condition-case () (x-get-selection) (error ()))
1200 (error "No selection or cut buffer available")))
1201 ;; Give temporary modes such as isearch a chance to turn off.
1202 (run-hooks 'mouse-leave-buffer-hook)
1203 (setq this-command 'yank)
1204 (mouse-set-point click)
1205 (term-send-raw-string (current-kill (cond
1210 (defun term-paste ()
1211 "Insert the last stretch of killed text at point."
1213 (term-send-raw-string (current-kill 0)))
1215 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1216 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1217 ;; For example: vi works with \eOA while elm wants \e[A ...
1218 ;;; (terminfo: kcuu1, kcud1, kcuf1, kcub1, khome, kend, kpp, knp, kdch1, kbs)
1219 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1220 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1221 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1222 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1223 (defun term-send-home () (interactive) (term-send-raw-string "\e[1~"))
1224 (defun term-send-insert() (interactive) (term-send-raw-string "\e[2~"))
1225 (defun term-send-end () (interactive) (term-send-raw-string "\e[4~"))
1226 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1227 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1228 (defun term-send-del () (interactive) (term-send-raw-string "\e[3~"))
1229 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-?"))
1231 (defun term-char-mode ()
1232 "Switch to char (\"raw\") sub-mode of term mode.
1233 Each character you type is sent directly to the inferior without
1234 intervention from Emacs, except for the escape character (usually C-c)."
1236 ;; FIXME: Emit message? Cfr ilisp-raw-message
1237 (when (term-in-line-mode)
1238 (setq term-old-mode-map (current-local-map))
1239 (use-local-map term-raw-map)
1241 ;; Send existing partial line to inferior (without newline).
1242 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1243 (save-input-sender term-input-sender))
1244 (when (> (point) pmark)
1247 (setq term-input-sender
1248 (symbol-function 'term-send-string))
1251 (setq term-input-sender save-input-sender))))
1252 (term-update-mode-line)))
1254 (defun term-line-mode ()
1255 "Switch to line (\"cooked\") sub-mode of term mode.
1256 This means that Emacs editing commands work as normally, until
1257 you type \\[term-send-input] which sends the current line to the inferior."
1259 (when (term-in-char-mode)
1260 (use-local-map term-old-mode-map)
1261 (term-update-mode-line)))
1263 (defun term-update-mode-line ()
1264 (setq mode-line-process
1265 (if (term-in-char-mode)
1266 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
1267 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
1268 (force-mode-line-update))
1270 (defun term-check-proc (buffer)
1271 "True if there is a process associated w/buffer BUFFER, and
1272 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
1274 (let ((proc (get-buffer-process buffer)))
1275 (and proc (memq (process-status proc) '(run stop)))))
1278 (defun make-term (name program &optional startfile &rest switches)
1279 "Make a term process NAME in a buffer, running PROGRAM.
1280 The name of the buffer is made by surrounding NAME with `*'s.
1281 If there is already a running process in that buffer, it is not restarted.
1282 Optional third arg STARTFILE is the name of a file to send the contents of to
1283 the process. Any more args are arguments to PROGRAM."
1284 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1285 ;; If no process, or nuked process, crank up a new one and put buffer in
1286 ;; term mode. Otherwise, leave buffer and existing process alone.
1287 (cond ((not (term-check-proc buffer))
1290 (term-mode)) ; Install local vars, mode, keymap, ...
1291 (term-exec buffer name program startfile switches)))
1295 (defun term (program)
1296 "Start a terminal-emulator in a new buffer.
1297 The buffer is in Term mode; see `term-mode' for the
1298 commands to use in that buffer.
1300 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
1301 (interactive (list (read-from-minibuffer "Run program: "
1302 (or explicit-shell-file-name
1306 (set-buffer (make-term "terminal" program))
1309 (switch-to-buffer "*terminal*"))
1311 (defun term-exec (buffer name command startfile switches)
1312 "Start up a process in buffer for term modes.
1313 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1314 You can use this to cheaply run a series of processes in the same term
1315 buffer. The hook term-exec-hook is run after each exec."
1318 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1319 (when proc (delete-process proc)))
1320 ;; Crank up a new process
1321 (let ((proc (term-exec-1 name buffer command switches)))
1322 (make-local-variable 'term-ptyp)
1323 (setq term-ptyp process-connection-type) ; t if pty, nil if pipe.
1324 ;; Jump to the end, and set the process mark.
1325 (goto-char (point-max))
1326 (set-marker (process-mark proc) (point))
1327 (set-process-filter proc 'term-emulate-terminal)
1328 (set-process-sentinel proc 'term-sentinel)
1329 ;; Feed it the startfile.
1331 ;;This is guaranteed to wait long enough
1332 ;;but has bad results if the term does not prompt at all
1333 ;; (while (= size (buffer-size))
1335 ;;I hope 1 second is enough!
1337 (goto-char (point-max))
1338 (insert-file-contents startfile)
1339 (setq startfile (buffer-substring (point) (point-max)))
1340 (delete-region (point) (point-max))
1341 (term-send-string proc startfile)))
1342 (run-hooks 'term-exec-hook)
1345 (defun term-sentinel (proc msg)
1346 "Sentinel for term buffers.
1347 The main purpose is to get rid of the local keymap."
1348 (let ((buffer (process-buffer proc)))
1349 (when (memq (process-status proc) '(signal exit))
1350 (if (null (buffer-name buffer))
1352 (set-process-buffer proc nil)
1353 (let ((obuf (current-buffer)))
1354 ;; save-excursion isn't the right thing if
1355 ;; process-buffer is current-buffer
1358 ;; Write something in the compilation buffer
1359 ;; and hack its mode line.
1361 ;; Get rid of local keymap.
1363 (term-handle-exit (process-name proc)
1365 ;; Since the buffer and mode line will show that the
1366 ;; process is dead, we can delete it now. Otherwise it
1367 ;; will stay around until M-x list-processes.
1368 (delete-process proc))
1372 (defun term-handle-exit (process-name msg)
1373 "Write process exit (or other change) message MSG in the current buffer."
1374 (let ((buffer-read-only nil)
1377 ;; Record where we put the message, so we can ignore it
1380 (insert ?\n "Process " process-name " " msg)
1381 ;; Force mode line redisplay soon.
1382 (force-mode-line-update)
1383 (when (and opoint (< opoint omax))
1384 (goto-char opoint))))
1387 ;;; Name to use for TERM.
1388 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
1389 (defvar term-term-name "eterm-color")
1390 ; Format string, usage:
1391 ; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1392 (defvar term-termcap-format
1393 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1394 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1395 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=^J\
1396 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1397 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1398 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC\
1399 :kl=\\EOD:kd=\\EOB:kr=\\EOC:ku=\\EOA:kN=\\E[6~:kP=\\E[5~:@7=\\E[4~:kh=\\E[1~\
1400 :mk=\\E[8m:cb=\\E[1K:op=\\E[39;49m:Co#8:pa#64:AB=\\E[4%%dm:AF=\\E[3%%dm:cr=^M\
1401 :bl=^G:do=^J:le=^H:ta=^I:se=\\E[27m:ue=\\E24m\
1402 :kb=^?:kD=^[[3~:sc=\\E7:rc=\\E8:r1=\\Ec:"
1404 ;;; don't define :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1405 "termcap capabilities supported")
1407 ;;; This auxiliary function cranks up the process for term-exec in
1408 ;;; the appropriate environment.
1410 (defun term-exec-1 (name buffer command switches)
1411 ;; We need to do an extra (fork-less) exec to run stty.
1412 ;; (This would not be needed if we had suitable Emacs primitives.)
1413 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1414 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1415 ;; Thus we add an extra dummy argument "..", and then remove it.
1416 (let ((process-environment
1419 (format "TERM=%s" term-term-name)
1420 (format "TERMINFO=%s" data-directory)
1421 (format term-termcap-format "TERMCAP="
1422 term-term-name term-height term-width)
1423 ;; Breaks `./configure' of w3 and url which try to run $EMACS.
1424 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1425 (format "LINES=%d" term-height)
1426 (format "COLUMNS=%d" term-width))
1427 process-environment))
1428 (process-connection-type t)
1429 ;; We should suppress conversion of end-of-line format.
1430 (inhibit-eol-conversion t)
1431 ;; The process's output contains not just chars but also binary
1432 ;; escape codes, so we need to see the raw output. We will have to
1433 ;; do the decoding by hand on the parts that are made of chars.
1434 (coding-system-for-read 'binary))
1435 (apply 'start-process name buffer
1437 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1438 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1439 term-height term-width)
1444 ;;; Input history processing in a buffer
1445 ;;; ===========================================================================
1446 ;;; Useful input history functions, courtesy of the Ergo group.
1448 ;;; Eleven commands:
1449 ;;; term-dynamic-list-input-ring List history in help buffer.
1450 ;;; term-previous-input Previous input...
1451 ;;; term-previous-matching-input ...matching a string.
1452 ;;; term-previous-matching-input-from-input ... matching the current input.
1453 ;;; term-next-input Next input...
1454 ;;; term-next-matching-input ...matching a string.
1455 ;;; term-next-matching-input-from-input ... matching the current input.
1456 ;;; term-backward-matching-input Backwards input...
1457 ;;; term-forward-matching-input ...matching a string.
1458 ;;; term-replace-by-expanded-history Expand history at point;
1459 ;;; replace with expanded history.
1460 ;;; term-magic-space Expand history and insert space.
1462 ;;; Three functions:
1463 ;;; term-read-input-ring Read into term-input-ring...
1464 ;;; term-write-input-ring Write to term-input-ring-file-name.
1465 ;;; term-replace-by-expanded-history-before-point Workhorse function.
1467 (defun term-read-input-ring (&optional silent)
1468 "Sets the buffer's `term-input-ring' from a history file.
1469 The name of the file is given by the variable `term-input-ring-file-name'.
1470 The history ring is of size `term-input-ring-size', regardless of file size.
1471 If `term-input-ring-file-name' is nil this function does nothing.
1473 If the optional argument SILENT is non-nil, we say nothing about a
1474 failure to read the history file.
1476 This function is useful for major mode commands and mode hooks.
1478 The structure of the history file should be one input command per line,
1479 with the most recent command last.
1480 See also `term-input-ignoredups' and `term-write-input-ring'."
1481 (cond ((or (null term-input-ring-file-name)
1482 (equal term-input-ring-file-name ""))
1484 ((not (file-readable-p term-input-ring-file-name))
1486 (message "Cannot read history file %s"
1487 term-input-ring-file-name)))
1489 (let ((history-buf (get-buffer-create " *temp*"))
1490 (file term-input-ring-file-name)
1492 (ring (make-ring term-input-ring-size)))
1495 (set-buffer history-buf)
1498 (insert-file-contents file)
1499 ;; Save restriction in case file is already visited...
1500 ;; Watch for those date stamps in history files!
1501 (goto-char (point-max))
1502 (while (and (< count term-input-ring-size)
1503 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1505 (let ((history (buffer-substring (match-beginning 1)
1507 (when (or (null term-input-ignoredups)
1509 (not (string-equal (ring-ref ring 0) history)))
1510 (ring-insert-at-beginning ring history)))
1511 (setq count (1+ count))))
1512 (kill-buffer history-buf))
1513 (setq term-input-ring ring
1514 term-input-ring-index nil)))))
1516 (defun term-write-input-ring ()
1517 "Writes the buffer's `term-input-ring' to a history file.
1518 The name of the file is given by the variable `term-input-ring-file-name'.
1519 The original contents of the file are lost if `term-input-ring' is not empty.
1520 If `term-input-ring-file-name' is nil this function does nothing.
1522 Useful within process sentinels.
1524 See also `term-read-input-ring'."
1525 (cond ((or (null term-input-ring-file-name)
1526 (equal term-input-ring-file-name "")
1527 (null term-input-ring) (ring-empty-p term-input-ring))
1529 ((not (file-writable-p term-input-ring-file-name))
1530 (message "Cannot write history file %s" term-input-ring-file-name))
1532 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1533 (ring term-input-ring)
1534 (file term-input-ring-file-name)
1535 (index (ring-length ring)))
1536 ;; Write it all out into a buffer first. Much faster, but messier,
1537 ;; than writing it one line at a time.
1539 (set-buffer history-buf)
1542 (setq index (1- index))
1543 (insert (ring-ref ring index) ?\n))
1544 (write-region (buffer-string) nil file nil 'no-message)
1545 (kill-buffer nil))))))
1548 (defun term-dynamic-list-input-ring ()
1549 "List in help buffer the buffer's input history."
1551 (if (or (not (ring-p term-input-ring))
1552 (ring-empty-p term-input-ring))
1553 (message "No history")
1555 (history-buffer " *Input History*")
1556 (index (1- (ring-length term-input-ring)))
1557 (conf (current-window-configuration)))
1558 ;; We have to build up a list ourselves from the ring vector.
1560 (setq history (cons (ring-ref term-input-ring index) history)
1562 ;; Change "completion" to "history reference"
1563 ;; to make the display accurate.
1564 (with-output-to-temp-buffer history-buffer
1565 (display-completion-list history)
1566 (set-buffer history-buffer)
1568 (while (search-backward "completion" nil 'move)
1569 (replace-match "history reference")))
1571 (message "Hit space to flush")
1572 (let ((ch (read-event)))
1574 (set-window-configuration conf)
1575 (setq unread-command-events (list ch)))))))
1578 (defun term-regexp-arg (prompt)
1579 ;; Return list of regexp and prefix arg using PROMPT.
1580 (let* (;; Don't clobber this.
1581 (last-command last-command)
1582 (regexp (read-from-minibuffer prompt nil nil nil
1583 'minibuffer-history-search-history)))
1584 (list (if (string-equal regexp "")
1585 (setcar minibuffer-history-search-history
1586 (nth 1 minibuffer-history-search-history))
1588 (prefix-numeric-value current-prefix-arg))))
1590 (defun term-search-arg (arg)
1591 ;; First make sure there is a ring and that we are after the process mark
1592 (cond ((not (term-after-pmark-p))
1593 (error "Not at command line"))
1594 ((or (null term-input-ring)
1595 (ring-empty-p term-input-ring))
1596 (error "Empty input ring"))
1598 ;; arg of zero resets search from beginning, and uses arg of 1
1599 (setq term-input-ring-index nil)
1604 (defun term-search-start (arg)
1605 ;; Index to start a directional search, starting at term-input-ring-index
1606 (if term-input-ring-index
1607 ;; If a search is running, offset by 1 in direction of arg
1608 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1609 (ring-length term-input-ring))
1610 ;; For a new search, start from beginning or end, as appropriate
1612 0 ; First elt for forward search
1613 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1615 (defun term-previous-input-string (arg)
1616 "Return the string ARG places along the input ring.
1617 Moves relative to `term-input-ring-index'."
1618 (ring-ref term-input-ring (if term-input-ring-index
1619 (mod (+ arg term-input-ring-index)
1620 (ring-length term-input-ring))
1623 (defun term-previous-input (arg)
1624 "Cycle backwards through input history."
1626 (term-previous-matching-input "." arg))
1628 (defun term-next-input (arg)
1629 "Cycle forwards through input history."
1631 (term-previous-input (- arg)))
1633 (defun term-previous-matching-input-string (regexp arg)
1634 "Return the string matching REGEXP ARG places along the input ring.
1635 Moves relative to `term-input-ring-index'."
1636 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1637 (when pos (ring-ref term-input-ring pos))))
1639 (defun term-previous-matching-input-string-position
1640 (regexp arg &optional start)
1641 "Return the index matching REGEXP ARG places along the input ring.
1642 Moves relative to START, or `term-input-ring-index'."
1643 (when (or (not (ring-p term-input-ring))
1644 (ring-empty-p term-input-ring))
1645 (error "No history"))
1646 (let* ((len (ring-length term-input-ring))
1647 (motion (if (> arg 0) 1 -1))
1648 (n (mod (- (or start (term-search-start arg)) motion) len))
1649 (tried-each-ring-item nil)
1651 ;; Do the whole search as many times as the argument says.
1652 (while (and (/= arg 0) (not tried-each-ring-item))
1655 n (mod (+ n motion) len))
1656 ;; If we haven't reached a match, step some more.
1657 (while (and (< n len) (not tried-each-ring-item)
1658 (not (string-match regexp (ring-ref term-input-ring n))))
1659 (setq n (mod (+ n motion) len)
1660 ;; If we have gone all the way around in this search.
1661 tried-each-ring-item (= n prev)))
1662 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1663 ;; Now that we know which ring element to use, if we found it, return that.
1664 (when (string-match regexp (ring-ref term-input-ring n))
1667 (defun term-previous-matching-input (regexp arg)
1668 "Search backwards through input history for match for REGEXP.
1669 \(Previous history elements are earlier commands.)
1670 With prefix argument N, search for Nth previous match.
1671 If N is negative, find the next or Nth next match."
1672 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1673 (setq arg (term-search-arg arg))
1674 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1675 ;; Has a match been found?
1678 (setq term-input-ring-index pos)
1679 (message "History item: %d" (1+ pos))
1681 ;; Can't use kill-region as it sets this-command
1682 (process-mark (get-buffer-process (current-buffer))) (point))
1683 (insert (ring-ref term-input-ring pos)))))
1685 (defun term-next-matching-input (regexp arg)
1686 "Search forwards through input history for match for REGEXP.
1687 \(Later history elements are more recent commands.)
1688 With prefix argument N, search for Nth following match.
1689 If N is negative, find the previous or Nth previous match."
1690 (interactive (term-regexp-arg "Next input matching (regexp): "))
1691 (term-previous-matching-input regexp (- arg)))
1693 (defun term-previous-matching-input-from-input (arg)
1694 "Search backwards through input history for match for current input.
1695 \(Previous history elements are earlier commands.)
1696 With prefix argument N, search for Nth previous match.
1697 If N is negative, search forwards for the -Nth following match."
1699 (when (not (memq last-command '(term-previous-matching-input-from-input
1700 term-next-matching-input-from-input)))
1701 ;; Starting a new search
1702 (setq term-matching-input-from-input-string
1704 (process-mark (get-buffer-process (current-buffer)))
1706 term-input-ring-index nil))
1707 (term-previous-matching-input
1708 (concat "^" (regexp-quote term-matching-input-from-input-string))
1711 (defun term-next-matching-input-from-input (arg)
1712 "Search forwards through input history for match for current input.
1713 \(Following history elements are more recent commands.)
1714 With prefix argument N, search for Nth following match.
1715 If N is negative, search backwards for the -Nth previous match."
1717 (term-previous-matching-input-from-input (- arg)))
1720 (defun term-replace-by-expanded-history (&optional silent)
1721 "Expand input command history references before point.
1722 Expansion is dependent on the value of `term-input-autoexpand'.
1724 This function depends on the buffer's idea of the input history, which may not
1725 match the command interpreter's idea, assuming it has one.
1727 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1728 cannot know the interpreter's idea of input line numbers, assuming it has one,
1729 it cannot expand absolute input line number references.
1731 If the optional argument SILENT is non-nil, never complain
1732 even if history reference seems erroneous.
1734 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1736 Returns t if successful."
1738 (when (and term-input-autoexpand
1739 (string-match "[!^]" (funcall term-get-old-input))
1740 (save-excursion (beginning-of-line)
1741 (looking-at term-prompt-regexp)))
1742 ;; Looks like there might be history references in the command.
1743 (let ((previous-modified-tick (buffer-modified-tick)))
1744 (message "Expanding history references...")
1745 (term-replace-by-expanded-history-before-point silent)
1746 (/= previous-modified-tick (buffer-modified-tick)))))
1749 (defun term-replace-by-expanded-history-before-point (silent)
1750 "Expand directory stack reference before point.
1751 See `term-replace-by-expanded-history'. Returns t if successful."
1753 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1754 (start (progn (term-bol nil) (point))))
1756 (skip-chars-forward "^!^"
1758 (end-of-line nil) (- (point) toend)))
1761 (end-of-line nil) (- (point) toend))))
1762 ;; This seems a bit complex. We look for references such as !!, !-num,
1763 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1764 ;; If that wasn't enough, the plings can be suffixed with argument
1765 ;; range specifiers.
1766 ;; Argument ranges are complex too, so we hive off the input line,
1767 ;; referenced with plings, with the range string to `term-args'.
1768 (setq term-input-ring-index nil)
1769 (cond ((or (= (preceding-char) ?\\)
1770 (term-within-quotes start (point)))
1771 ;; The history is quoted, or we're in quotes.
1772 (goto-char (1+ (point))))
1773 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1774 ;; We cannot know the interpreter's idea of input line numbers.
1775 (goto-char (match-end 0))
1776 (message "Absolute reference cannot be expanded"))
1777 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1778 ;; Just a number of args from `number' lines backward.
1779 (let ((number (1- (string-to-number
1780 (buffer-substring (match-beginning 1)
1782 (if (<= number (ring-length term-input-ring))
1785 (term-args (term-previous-input-string number)
1786 (match-beginning 2) (match-end 2))
1788 (setq term-input-ring-index number)
1789 (message "History item: %d" (1+ number)))
1790 (goto-char (match-end 0))
1791 (message "Relative reference exceeds input history size"))))
1792 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1793 ;; Just a number of args from the previous input line.
1795 (term-args (term-previous-input-string 0)
1796 (match-beginning 1) (match-end 1))
1798 (message "History item: previous"))
1800 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1801 ;; Most recent input starting with or containing (possibly
1802 ;; protected) string, maybe just a number of args. Phew.
1803 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1804 (mb2 (match-beginning 2)) (me2 (match-end 2))
1805 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1806 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1807 (pos (save-match-data
1808 (term-previous-matching-input-string-position
1809 (concat pref (regexp-quote exp)) 1))))
1812 (goto-char (match-end 0))
1814 (progn (message "Not found")
1816 (setq term-input-ring-index pos)
1818 (term-args (ring-ref term-input-ring pos)
1819 (match-beginning 4) (match-end 4))
1821 (message "History item: %d" (1+ pos)))))
1822 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1823 ;; Quick substitution on the previous input line.
1824 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1825 (new (buffer-substring (match-beginning 2) (match-end 2)))
1827 (replace-match (term-previous-input-string 0) t t)
1829 (goto-char (match-beginning 0))
1830 (if (not (search-forward old pos t))
1832 (error "Not found"))
1833 (replace-match new t t)
1834 (message "History item: substituted"))))
1836 (goto-char (match-end 0))))))))
1839 (defun term-magic-space (arg)
1840 "Expand input history references before point and insert ARG spaces.
1841 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1843 (term-replace-by-expanded-history)
1844 (self-insert-command arg))
1846 (defun term-within-quotes (beg end)
1847 "Return t if the number of quotes between BEG and END is odd.
1848 Quotes are single and double."
1849 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1850 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1851 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1853 (defun term-how-many-region (regexp beg end)
1854 "Return number of matches for REGEXP from BEG to END."
1859 (while (re-search-forward regexp end t)
1860 (setq count (1+ count)))))
1863 (defun term-args (string begin end)
1864 ;; From STRING, return the args depending on the range specified in the text
1865 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1866 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1869 (term-arguments string 0 nil)
1870 (let* ((range (buffer-substring
1871 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1872 (nth (cond ((string-match "^[*^]" range) 1)
1873 ((string-match "^-" range) 0)
1874 ((string-equal range "$") nil)
1875 (t (string-to-number range))))
1876 (mth (cond ((string-match "[-*$]$" range) nil)
1877 ((string-match "-" range)
1878 (string-to-number (substring range (match-end 0))))
1880 (term-arguments string nth mth)))))
1882 ;; Return a list of arguments from ARG. Break it up at the
1883 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1884 (defun term-delim-arg (arg)
1885 (if (null term-delimiter-argument-list)
1891 (let ((char (aref arg pos))
1893 (if (memq char term-delimiter-argument-list)
1894 (while (and (< pos len) (eq (aref arg pos) char))
1895 (setq pos (1+ pos)))
1896 (while (and (< pos len)
1897 (not (memq (aref arg pos)
1898 term-delimiter-argument-list)))
1899 (setq pos (1+ pos))))
1900 (setq args (cons (substring arg start pos) args))))
1903 (defun term-arguments (string nth mth)
1904 "Return from STRING the NTH to MTH arguments.
1905 NTH and/or MTH can be nil, which means the last argument.
1906 Returned arguments are separated by single spaces.
1907 We assume whitespace separates arguments, except within quotes.
1908 Also, a run of one or more of a single character
1909 in `term-delimiter-argument-list' is a separate argument.
1910 Argument 0 is the command name."
1911 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1915 ;; Build a list of all the args until we have as many as we want.
1916 (while (and (or (null mth) (<= count mth))
1917 (string-match argpart string pos))
1918 (if (and beg (= pos (match-beginning 0)))
1919 ;; It's contiguous, part of the same arg.
1920 (setq pos (match-end 0)
1921 quotes (or quotes (match-beginning 1)))
1922 ;; It's a new separate arg.
1924 ;; Put the previous arg, if there was one, onto ARGS.
1925 (setq str (substring string beg pos)
1926 args (if quotes (cons str args)
1927 (nconc (term-delim-arg str) args))
1929 (setq quotes (match-beginning 1))
1930 (setq beg (match-beginning 0))
1931 (setq pos (match-end 0))))
1933 (setq str (substring string beg pos)
1934 args (if quotes (cons str args)
1935 (nconc (term-delim-arg str) args))
1937 (let ((n (or nth (1- count)))
1938 (m (if mth (1- (- count mth)) 0)))
1940 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1943 ;;; Input processing stuff [line mode]
1946 (defun term-send-input ()
1947 "Send input to process.
1948 After the process output mark, sends all text from the process mark to
1949 point as input to the process. Before the process output mark, calls value
1950 of variable term-get-old-input to retrieve old input, copies it to the
1951 process mark, and sends it. A terminal newline is also inserted into the
1952 buffer and sent to the process. The list of function names contained in the
1953 value of `term-input-filter-functions' is called on the input before sending
1954 it. The input is entered into the input history ring, if the value of variable
1955 term-input-filter returns non-nil when called on the input.
1957 Any history reference may be expanded depending on the value of the variable
1958 `term-input-autoexpand'. The list of function names contained in the value
1959 of `term-input-filter-functions' is called on the input before sending it.
1960 The input is entered into the input history ring, if the value of variable
1961 `term-input-filter' returns non-nil when called on the input.
1963 If variable `term-eol-on-send' is non-nil, then point is moved to the
1964 end of line before sending the input.
1966 The values of `term-get-old-input', `term-input-filter-functions', and
1967 `term-input-filter' are chosen according to the command interpreter running
1968 in the buffer. E.g.,
1970 If the interpreter is the csh,
1971 term-get-old-input is the default: take the current line, discard any
1972 initial string matching regexp term-prompt-regexp.
1973 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
1974 \"popd\" commands. When it sees one, it cd's the buffer.
1975 term-input-filter is the default: returns t if the input isn't all white
1978 If the term is Lucid Common Lisp,
1979 term-get-old-input snarfs the sexp ending at point.
1980 term-input-filter-functions does nothing.
1981 term-input-filter returns nil if the input matches input-filter-regexp,
1982 which matches (1) all whitespace (2) :a, :c, etc.
1984 Similarly for Soar, Scheme, etc."
1986 ;; Note that the input string does not include its terminal newline.
1987 (let ((proc (get-buffer-process (current-buffer))))
1988 (if (not proc) (error "Current buffer has no process")
1989 (let* ((pmark (process-mark proc))
1990 (pmark-val (marker-position pmark))
1991 (input-is-new (>= (point) pmark-val))
1992 (intxt (if input-is-new
1993 (progn (if term-eol-on-send (end-of-line))
1994 (buffer-substring pmark (point)))
1995 (funcall term-get-old-input)))
1996 (input (if (not (eq term-input-autoexpand 'input))
1997 ;; Just whatever's already there
1999 ;; Expand and leave it visible in buffer
2000 (term-replace-by-expanded-history t)
2001 (buffer-substring pmark (point))))
2002 (history (if (not (eq term-input-autoexpand 'history))
2004 ;; This is messy 'cos ultimately the original
2005 ;; functions used do insertion, rather than return
2006 ;; strings. We have to expand, then insert back.
2007 (term-replace-by-expanded-history t)
2008 (let ((copy (buffer-substring pmark (point))))
2009 (delete-region pmark (point))
2012 (when (term-pager-enabled)
2014 (goto-char (process-mark proc))
2015 (setq term-pager-count (term-current-row))))
2016 (when (and (funcall term-input-filter history)
2017 (or (null term-input-ignoredups)
2018 (not (ring-p term-input-ring))
2019 (ring-empty-p term-input-ring)
2020 (not (string-equal (ring-ref term-input-ring 0)
2022 (ring-insert term-input-ring history))
2023 (let ((functions term-input-filter-functions))
2025 (funcall (car functions) (concat input "\n"))
2026 (setq functions (cdr functions))))
2027 (setq term-input-ring-index nil)
2029 ;; Update the markers before we send the input
2030 ;; in case we get output amidst sending the input.
2031 (set-marker term-last-input-start pmark)
2032 (set-marker term-last-input-end (point))
2034 ;; Set up to delete, because inferior should echo.
2035 (when (marker-buffer term-pending-delete-marker)
2036 (delete-region term-pending-delete-marker pmark))
2037 (set-marker term-pending-delete-marker pmark-val)
2038 (set-marker (process-mark proc) (point)))
2040 (funcall term-input-sender proc input)))))
2042 (defun term-get-old-input-default ()
2043 "Default for term-get-old-input.
2044 Take the current line, and discard any initial text matching
2045 term-prompt-regexp."
2049 (let ((beg (point)))
2051 (buffer-substring beg (point)))))
2053 (defun term-copy-old-input ()
2054 "Insert after prompt old input at point as new input to be edited.
2055 Calls `term-get-old-input' to get old input."
2057 (let ((input (funcall term-get-old-input))
2058 (process (get-buffer-process (current-buffer))))
2060 (error "Current buffer has no process")
2061 (goto-char (process-mark process))
2064 (defun term-skip-prompt ()
2065 "Skip past the text matching regexp term-prompt-regexp.
2066 If this takes us past the end of the current line, don't skip at all."
2067 (let ((eol (save-excursion (end-of-line) (point))))
2068 (when (and (looking-at term-prompt-regexp)
2069 (<= (match-end 0) eol))
2070 (goto-char (match-end 0)))))
2073 (defun term-after-pmark-p ()
2074 "Is point after the process output marker?"
2075 ;; Since output could come into the buffer after we looked at the point
2076 ;; but before we looked at the process marker's value, we explicitly
2077 ;; serialise. This is just because I don't know whether or not Emacs
2078 ;; services input during execution of lisp commands.
2079 (let ((proc-pos (marker-position
2080 (process-mark (get-buffer-process (current-buffer))))))
2081 (<= proc-pos (point))))
2083 (defun term-simple-send (proc string)
2084 "Default function for sending to PROC input STRING.
2085 This just sends STRING plus a newline. To override this,
2086 set the hook `term-input-sender'."
2087 (term-send-string proc string)
2088 (term-send-string proc "\n"))
2090 (defun term-bol (arg)
2091 "Goes to the beginning of line, then skips past the prompt, if any.
2092 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2093 -- go straight to column 0.
2095 The prompt skip is done by skipping text matching the regular expression
2096 term-prompt-regexp, a buffer local variable."
2099 (when (null arg) (term-skip-prompt)))
2101 ;;; These two functions are for entering text you don't want echoed or
2102 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
2103 ;;; Just enter m-x term-send-invisible and type in your line.
2105 (defun term-read-noecho (prompt &optional stars)
2106 "Read a single line of text from user without echoing, and return it.
2107 Prompt with argument PROMPT, a string. Optional argument STARS causes
2108 input to be echoed with '*' characters on the prompt line. Input ends with
2109 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2110 `inhibit-quit' is set because e.g. this function was called from a process
2111 filter and C-g is pressed, this function returns nil rather than a string).
2113 Note that the keystrokes comprising the text can still be recovered
2114 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2119 (cursor-in-echo-area t)
2123 (message "%s%s" prompt (make-string (length ans) ?*))
2124 (message "%s" prompt))
2125 (setq c (read-char))
2127 ;; This function may get called from a process filter, where
2128 ;; inhibit-quit is set. In later versions of Emacs read-char
2129 ;; may clear quit-flag itself and return C-g. That would make
2130 ;; it impossible to quit this loop in a simple way, so
2131 ;; re-enable it here (for backward-compatibility the check for
2132 ;; quit-flag below would still be necessary, so this seems
2133 ;; like the simplest way to do things).
2136 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2140 ((and (/= c ?\b) (/= c ?\177))
2141 (setq ans (concat ans (char-to-string c))))
2143 (setq ans (substring ans 0 -1)))))
2145 ;; Emulate a true quit, except that we have to return a value.
2147 (setq quit-flag nil)
2153 (defun term-send-invisible (str &optional proc)
2154 "Read a string without echoing.
2155 Then send it to the process running in the current buffer. A new-line
2156 is additionally sent. String is not saved on term input history list.
2157 Security bug: your string can still be temporarily recovered with
2159 (interactive "P") ; Defeat snooping via C-x esc
2160 (when (not (stringp str))
2161 (setq str (term-read-noecho "Non-echoed text: " t)))
2163 (setq proc (get-buffer-process (current-buffer))))
2164 (if (not proc) (error "Current buffer has no process")
2165 (setq term-kill-echo-list (nconc term-kill-echo-list
2167 (term-send-string proc str)
2168 (term-send-string proc "\n")))
2171 ;;; Low-level process communication
2173 (defvar term-input-chunk-size 512
2174 "*Long inputs send to term processes are broken up into chunks of this size.
2175 If your process is choking on big inputs, try lowering the value.")
2177 (defun term-send-string (proc str)
2178 "Send to PROC the contents of STR as input.
2179 This is equivalent to process-send-string, except that long input strings
2180 are broken up into chunks of size term-input-chunk-size. Processes
2181 are given a chance to output between chunks. This can help prevent processes
2182 from hanging when you send them long inputs on some OS's."
2183 (let* ((len (length str))
2184 (i (min len term-input-chunk-size)))
2185 (process-send-string proc (substring str 0 i))
2187 (let ((next-i (+ i term-input-chunk-size)))
2188 (accept-process-output)
2189 (process-send-string proc (substring str i (min len next-i)))
2192 (defun term-send-region (proc start end)
2193 "Send to PROC the region delimited by START and END.
2194 This is a replacement for process-send-region that tries to keep
2195 your process from hanging on long inputs. See `term-send-string'."
2196 (term-send-string proc (buffer-substring start end)))
2199 ;;; Random input hackage
2201 (defun term-kill-output ()
2202 "Kill all output from interpreter since last input."
2204 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2205 (kill-region term-last-input-end pmark)
2207 (insert "*** output flushed ***\n")
2208 (set-marker pmark (point))))
2210 (defun term-show-output ()
2211 "Display start of this batch of interpreter output at top of window.
2212 Sets mark to the value of point when this command is run."
2214 (goto-char term-last-input-end)
2217 (set-window-start (selected-window) (point))
2220 (defun term-interrupt-subjob ()
2221 "Interrupt the current subjob."
2223 (interrupt-process nil term-ptyp))
2225 (defun term-kill-subjob ()
2226 "Send kill signal to the current subjob."
2228 (kill-process nil term-ptyp))
2230 (defun term-quit-subjob ()
2231 "Send quit signal to the current subjob."
2233 (quit-process nil term-ptyp))
2235 (defun term-stop-subjob ()
2236 "Stop the current subjob.
2237 WARNING: if there is no current subjob, you can end up suspending
2238 the top-level process running in the buffer. If you accidentally do
2239 this, use \\[term-continue-subjob] to resume the process. (This
2240 is not a problem with most shells, since they ignore this signal.)"
2242 (stop-process nil term-ptyp))
2244 (defun term-continue-subjob ()
2245 "Send CONT signal to process buffer's process group.
2246 Useful if you accidentally suspend the top-level process."
2248 (continue-process nil term-ptyp))
2250 (defun term-kill-input ()
2251 "Kill all text from last stuff output by interpreter to point."
2253 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2254 (p-pos (marker-position pmark)))
2255 (when (> (point) p-pos)
2256 (kill-region pmark (point)))))
2258 (defun term-delchar-or-maybe-eof (arg)
2259 "Delete ARG characters forward, or send an EOF to process if at end of
2266 (defun term-send-eof ()
2267 "Send an EOF to the current buffer's process."
2271 (defun term-backward-matching-input (regexp arg)
2272 "Search backward through buffer for match for REGEXP.
2273 Matches are searched for on lines that match `term-prompt-regexp'.
2274 With prefix argument N, search for Nth previous match.
2275 If N is negative, find the next or Nth next match."
2276 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2277 (let* ((re (concat term-prompt-regexp ".*" regexp))
2278 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2279 (when (re-search-backward re nil t arg)
2282 (progn (message "Not found")
2287 (defun term-forward-matching-input (regexp arg)
2288 "Search forward through buffer for match for REGEXP.
2289 Matches are searched for on lines that match `term-prompt-regexp'.
2290 With prefix argument N, search for Nth following match.
2291 If N is negative, find the previous or Nth previous match."
2292 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2293 (term-backward-matching-input regexp (- arg)))
2296 (defun term-next-prompt (n)
2297 "Move to end of Nth next prompt in the buffer.
2298 See `term-prompt-regexp'."
2300 (let ((paragraph-start term-prompt-regexp))
2301 (end-of-line (if (> n 0) 1 0))
2302 (forward-paragraph n)
2303 (term-skip-prompt)))
2305 (defun term-previous-prompt (n)
2306 "Move to end of Nth previous prompt in the buffer.
2307 See `term-prompt-regexp'."
2309 (term-next-prompt (- n)))
2311 ;;; Support for source-file processing commands.
2312 ;;;============================================================================
2313 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2314 ;;; commands that process files of source text (e.g. loading or compiling
2315 ;;; files). So the corresponding process-in-a-buffer modes have commands
2316 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
2317 ;;; for defining these commands.
2319 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2320 ;;; and Soar, in that they don't know anything about file extensions.
2321 ;;; So the compile/load interface gets the wrong default occasionally.
2322 ;;; The load-file/compile-file default mechanism could be smarter -- it
2323 ;;; doesn't know about the relationship between filename extensions and
2324 ;;; whether the file is source or executable. If you compile foo.lisp
2325 ;;; with compile-file, then the next load-file should use foo.bin for
2326 ;;; the default, not foo.lisp. This is tricky to do right, particularly
2327 ;;; because the extension for executable files varies so much (.o, .bin,
2328 ;;; .lbin, .mo, .vo, .ao, ...).
2331 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2334 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2335 ;;; want to save the buffer before issuing any process requests to the command
2338 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2339 ;;; for the file to process.
2341 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2342 ;;;============================================================================
2343 ;;; This function computes the defaults for the load-file and compile-file
2344 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
2346 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2347 ;;; source-file processing command, or nil if there hasn't been one yet.
2348 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
2349 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2350 ;;; Typically, (lisp-mode) or (scheme-mode).
2352 ;;; If the command is given while the cursor is inside a string, *and*
2353 ;;; the string is an existing filename, *and* the filename is not a directory,
2354 ;;; then the string is taken as default. This allows you to just position
2355 ;;; your cursor over a string that's a filename and have it taken as default.
2357 ;;; If the command is given in a file buffer whose major mode is in
2358 ;;; SOURCE-MODES, then the filename is the default file, and the
2359 ;;; file's directory is the default directory.
2361 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2362 ;;; then the default directory & file are what was used in the last source-file
2363 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2364 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2365 ;;; is the cwd, with no default file. (\"no default file\" = nil)
2367 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2368 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2369 ;;; for Soar programs, etc.
2371 ;;; The function returns a pair: (default-directory . default-file).
2373 (defun term-source-default (previous-dir/file source-modes)
2374 (cond ((and buffer-file-name (memq major-mode source-modes))
2375 (cons (file-name-directory buffer-file-name)
2376 (file-name-nondirectory buffer-file-name)))
2379 (cons default-directory nil))))
2382 ;;; (TERM-CHECK-SOURCE fname)
2383 ;;;============================================================================
2384 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2385 ;;; process-in-a-buffer modes), this function can be called on the filename.
2386 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
2387 ;;; is queried to see if he wants to save the buffer before proceeding with
2388 ;;; the load or compile.
2390 (defun term-check-source (fname)
2391 (let ((buff (get-file-buffer fname)))
2393 (buffer-modified-p buff)
2394 (y-or-n-p (format "Save buffer %s first? "
2395 (buffer-name buff))))
2397 (let ((old-buffer (current-buffer)))
2400 (set-buffer old-buffer)))))
2403 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2404 ;;;============================================================================
2405 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2406 ;;; commands that process source files (like loading or compiling a file).
2407 ;;; It prompts for the filename, provides a default, if there is one,
2408 ;;; and returns the result filename.
2410 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2412 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2413 ;;; from the last source processing command. SOURCE-MODES is a list of major
2414 ;;; modes used to determine what file buffers contain source files. (These
2415 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2416 ;;; then the filename reader will only accept a file that exists.
2419 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2420 ;;; '(lisp-mode) t))
2422 ;;; This is pretty stupid about strings. It decides we're in a string
2423 ;;; if there's a quote on both sides of point on the current line.
2424 (defun term-extract-string ()
2425 "Return string around `point' that starts the current line or nil."
2427 (let* ((point (point))
2428 (bol (progn (beginning-of-line) (point)))
2429 (eol (progn (end-of-line) (point)))
2430 (start (progn (goto-char point)
2431 (and (search-backward "\"" bol t)
2433 (end (progn (goto-char point)
2434 (and (search-forward "\"" eol t)
2437 (buffer-substring start end)))))
2439 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2440 (let* ((def (term-source-default prev-dir/file source-modes))
2441 (stringfile (term-extract-string))
2442 (sfile-p (and stringfile
2444 (file-exists-p stringfile)
2446 (not (file-directory-p stringfile))))
2447 (defdir (if sfile-p (file-name-directory stringfile)
2449 (deffile (if sfile-p (file-name-nondirectory stringfile)
2451 (ans (read-file-name (if deffile (format "%s(default %s) "
2455 (concat defdir deffile)
2457 (list (expand-file-name (substitute-in-file-name ans)))))
2459 ;;; I am somewhat divided on this string-default feature. It seems
2460 ;;; to violate the principle-of-least-astonishment, in that it makes
2461 ;;; the default harder to predict, so you actually have to look and see
2462 ;;; what the default really is before choosing it. This can trip you up.
2463 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
2468 ;;; Simple process query facility.
2469 ;;; ===========================================================================
2470 ;;; This function is for commands that want to send a query to the process
2471 ;;; and show the response to the user. For example, a command to get the
2472 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2473 ;;; to an inferior Common Lisp process.
2475 ;;; This simple facility just sends strings to the inferior process and pops
2476 ;;; up a window for the process buffer so you can see what the process
2477 ;;; responds with. We don't do anything fancy like try to intercept what the
2478 ;;; process responds with and put it in a pop-up window or on the message
2479 ;;; line. We just display the buffer. Low tech. Simple. Works good.
2481 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
2482 ;;; a window for the inferior process so that its response can be seen.
2483 (defun term-proc-query (proc str)
2484 (let* ((proc-buf (process-buffer proc))
2485 (proc-mark (process-mark proc)))
2486 (display-buffer proc-buf)
2487 (set-buffer proc-buf) ; but it's not the selected *window*
2488 (let ((proc-win (get-buffer-window proc-buf))
2489 (proc-pt (marker-position proc-mark)))
2490 (term-send-string proc str) ; send the query
2491 (accept-process-output proc) ; wait for some output
2492 ;; Try to position the proc window so you can see the answer.
2493 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2494 ;; I don't know why. Wizards invited to improve it.
2495 (when (not (pos-visible-in-window-p proc-pt proc-win))
2496 (let ((opoint (window-point proc-win)))
2497 (set-window-point proc-win proc-mark) (sit-for 0)
2498 (if (not (pos-visible-in-window-p opoint proc-win))
2500 (set-window-point proc-win opoint)))))))
2502 ;;; Returns the current column in the current screen line.
2503 ;;; Note: (current-column) yields column in buffer line.
2505 (defun term-horizontal-column ()
2506 (- (term-current-column) (term-start-line-column)))
2508 ;; Calls either vertical-motion or term-buffer-vertical-motion
2509 (defmacro term-vertical-motion (count)
2510 (list 'funcall 'term-vertical-motion count))
2512 ;; An emulation of vertical-motion that is independent of having a window.
2513 ;; Instead, it uses the term-width variable as the logical window width.
2515 (defun term-buffer-vertical-motion (count)
2517 (move-to-column (* term-width (/ (current-column) term-width)))
2521 (todo (+ count (/ (current-column) term-width))))
2523 ;; The loop iterates over buffer lines;
2524 ;; H is the number of screen lines in the current line, i.e.
2525 ;; the ceiling of dividing the buffer line width by term-width.
2526 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2531 (setq todo (- todo H))
2532 (forward-char) ;; Move past the ?\n
2533 (end-of-line)) ;; and on to the end of the next line.
2534 (if (and (>= todo H) (> todo 0))
2535 (+ (- count todo) H -1) ;; Hit end of buffer.
2536 (move-to-column (* todo term-width))
2538 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2541 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2545 (progn (beginning-of-line)
2547 (setq todo (- todo H))
2548 (backward-char)) ;; Move to end of previous line.
2549 (if (and (>= todo H) (> todo 0))
2550 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2551 (move-to-column (* (- H todo 1) term-width))
2554 ;;; The term-start-line-column variable is used as a cache.
2555 (defun term-start-line-column ()
2556 (cond (term-start-line-column)
2557 ((let ((save-pos (point)))
2558 (term-vertical-motion 0)
2559 (setq term-start-line-column (current-column))
2560 (goto-char save-pos)
2561 term-start-line-column))))
2563 ;;; Same as (current-column), but uses term-current-column as a cache.
2564 (defun term-current-column ()
2565 (cond (term-current-column)
2566 ((setq term-current-column (current-column)))))
2568 ;;; Move DELTA column right (or left if delta < 0 limiting at column 0).
2570 (defun term-move-columns (delta)
2571 (setq term-current-column (max 0 (+ (term-current-column) delta)))
2575 (setq point-at-eol (point)))
2576 (move-to-column term-current-column t)
2577 ;; If move-to-column extends the current line it will use the face
2578 ;; from the last character on the line, set the face for the chars
2580 (when (> (point) point-at-eol)
2581 (put-text-property point-at-eol (point) 'face 'default))))
2583 ;; Insert COUNT copies of CHAR in the default face.
2584 (defun term-insert-char (char count)
2585 (let ((old-point (point)))
2586 (insert-char char count)
2587 (put-text-property old-point (point) 'face 'default)))
2589 (defun term-current-row ()
2590 (cond (term-current-row)
2591 ((setq term-current-row
2594 (narrow-to-region term-home-marker (point-max))
2595 (- (term-vertical-motion -9999))))))))
2597 (defun term-adjust-current-row-cache (delta)
2598 (when term-current-row
2599 (setq term-current-row
2600 (max 0 (+ term-current-row delta)))))
2602 (defun term-terminal-pos ()
2603 (save-excursion ; save-restriction
2604 (let ((save-col (term-current-column))
2606 (term-vertical-motion 0)
2607 (setq x (- save-col (current-column)))
2608 (setq y (term-vertical-motion term-height))
2611 ;;;Function that handles term messages: code by rms ( and you can see the
2612 ;;;difference ;-) -mm
2614 (defun term-handle-ansi-terminal-messages (message)
2615 ;; Is there a command here?
2616 (while (string-match "\eAnSiT.+\n" message)
2617 ;; Extract the command code and the argument.
2618 (let* ((start (match-beginning 0))
2620 (command-code (aref message (+ start 6)))
2625 (string-match "\r?\n" message
2628 ;; Delete this command from MESSAGE.
2629 (setq message (replace-match "" t t message))
2631 ;; If we recognize the type of command, set the appropriate variable.
2632 (cond ((= command-code ?c)
2633 (setq term-ansi-at-dir argument))
2634 ((= command-code ?h)
2635 (setq term-ansi-at-host argument))
2636 ((= command-code ?u)
2637 (setq term-ansi-at-user argument))
2638 ;; Otherwise ignore this one.
2642 ;; Update default-directory based on the changes this command made.
2645 (setq default-directory
2646 (file-name-as-directory
2647 (if (and (string= term-ansi-at-host (system-name))
2648 (string= term-ansi-at-user (user-real-login-name)))
2649 (expand-file-name term-ansi-at-dir)
2650 (if (string= term-ansi-at-user (user-real-login-name))
2651 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2652 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2653 term-ansi-at-dir)))))
2655 ;; I'm not sure this is necessary,
2656 ;; but it's best to be on the safe side.
2657 (if (string= term-ansi-at-host (system-name))
2659 (setq ange-ftp-default-user term-ansi-at-save-user)
2660 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2661 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2662 (setq term-ansi-at-save-user ange-ftp-default-user)
2663 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2664 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2665 (setq ange-ftp-default-user nil)
2666 (setq ange-ftp-default-password nil)
2667 (setq ange-ftp-generate-anonymous-password nil)))))
2671 ;;; Terminal emulation
2672 ;;; This is the standard process filter for term buffers.
2673 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2675 (defun term-emulate-terminal (proc str)
2676 (with-current-buffer (process-buffer proc)
2677 (let* ((i 0) char funny count save-point save-marker old-point temp win
2678 (buffer-undo-list t)
2679 (selected (selected-window))
2681 handled-ansi-message
2682 (str-length (length str)))
2683 (save-selected-window
2685 ;; Let's handle the messages. -mm
2687 (let* ((newstr (term-handle-ansi-terminal-messages str)))
2688 (when (not (eq str newstr))
2689 (setq handled-ansi-message t
2691 (setq str-length (length str))
2693 (when (marker-buffer term-pending-delete-marker)
2694 ;; Delete text following term-pending-delete-marker.
2695 (delete-region term-pending-delete-marker (process-mark proc))
2696 (set-marker term-pending-delete-marker nil))
2698 (if (eq (window-buffer) (current-buffer))
2700 (setq term-vertical-motion (symbol-function 'vertical-motion))
2701 (term-check-size proc))
2702 (setq term-vertical-motion
2703 (symbol-function 'term-buffer-vertical-motion)))
2705 (setq save-marker (copy-marker (process-mark proc)))
2707 (when (/= (point) (process-mark proc))
2708 (setq save-point (point-marker))
2709 (goto-char (process-mark proc)))
2712 ;; If the buffer is in line mode, and there is a partial
2713 ;; input line, save the line (by narrowing to leave it
2714 ;; outside the restriction ) until we're done with output.
2715 (when (and (> (point-max) (process-mark proc))
2716 (term-in-line-mode))
2717 (narrow-to-region (point-min) (process-mark proc)))
2719 (when term-log-buffer
2720 (princ str term-log-buffer))
2721 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2722 (setq str (concat term-terminal-parameter str))
2723 (setq term-terminal-parameter nil)
2724 (setq str-length (length str))
2725 (setq term-terminal-state 0)))
2727 (while (< i str-length)
2728 (setq char (aref str i))
2729 (cond ((< term-terminal-state 2)
2730 ;; Look for prefix of regular chars
2732 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2734 (when (not funny) (setq funny str-length))
2736 (cond ((eq term-terminal-state 1)
2737 ;; We are in state 1, we need to wrap
2738 ;; around. Go to the beginning of
2739 ;; the next line and switch to state
2742 (term-move-columns (- (term-current-column)))
2743 (setq term-terminal-state 0)))
2744 (setq count (- funny i))
2745 (setq temp (- (+ (term-horizontal-column) count)
2747 (cond ((<= temp 0)) ;; All count chars fit in line.
2748 ((> count temp) ;; Some chars fit.
2749 ;; This iteration, handle only what fits.
2750 (setq count (- count temp))
2752 (setq funny (+ count i)))
2753 ((or (not (or term-pager-count
2754 term-scroll-with-delete))
2755 (> (term-handle-scroll 1) 0))
2756 (term-adjust-current-row-cache 1)
2757 (setq count (min count term-width))
2758 (setq funny (+ count i))
2759 (setq term-start-line-column
2760 term-current-column))
2761 (t ;; Doing PAGER processing.
2762 (setq count 0 funny i)
2763 (setq term-current-column nil)
2764 (setq term-start-line-column nil)))
2765 (setq old-point (point))
2767 ;; Insert a string, check how many columns
2768 ;; we moved, then delete that many columns
2769 ;; following point if not eob nor insert-mode.
2770 (let ((old-column (current-column))
2772 (insert (decode-coding-string (substring str i funny) locale-coding-system))
2773 (setq term-current-column (current-column)
2774 columns (- term-current-column old-column))
2775 (when (not (or (eobp) term-insert-mode))
2777 (term-move-columns columns)
2778 (delete-region pos (point)))
2779 ;; In insert mode if the current line
2780 ;; has become too long it needs to be
2782 (when term-insert-mode
2785 (when (> (current-column) term-width)
2786 (delete-region (- (point) (- (current-column) term-width))
2789 (setq term-current-column nil)
2791 (put-text-property old-point (point)
2792 'face term-current-face)
2793 ;; If the last char was written in last column,
2794 ;; back up one column, but remember we did so.
2795 ;; Thus we emulate xterm/vt100-style line-wrapping.
2797 (term-move-columns -1)
2798 (setq term-terminal-state 1)))
2799 (setq i (1- funny)))
2800 ((and (setq term-terminal-state 0)
2801 (eq char ?\^I)) ; TAB (terminfo: ht)
2802 (setq count (term-current-column))
2803 ;; The line cannot exceed term-width. TAB at
2804 ;; the end of a line should not cause wrapping.
2805 (setq count (min term-width
2806 (+ count 8 (- (mod count 8)))))
2807 (if (> term-width count)
2810 (- count (term-current-column)))
2811 (setq term-current-column count))
2812 (when (> term-width (term-current-column))
2814 (1- (- term-width (term-current-column)))))
2815 (when (= term-width (term-current-column))
2816 (term-move-columns -1))))
2817 ((eq char ?\r) ;; (terminfo: cr)
2818 (term-vertical-motion 0)
2819 (setq term-current-column term-start-line-column))
2820 ((eq char ?\n) ;; (terminfo: cud1, ind)
2821 (unless (and term-kill-echo-list
2822 (term-check-kill-echo-list))
2824 ((eq char ?\b) ;; (terminfo: cub1)
2825 (term-move-columns -1))
2826 ((eq char ?\033) ; Escape
2827 (setq term-terminal-state 2))
2828 ((eq char 0)) ; NUL: Do nothing
2829 ((eq char ?\016)) ; Shift Out - ignored
2830 ((eq char ?\017)) ; Shift In - ignored
2831 ((eq char ?\^G) ;; (terminfo: bel)
2833 ((and (eq char ?\032)
2834 (not handled-ansi-message))
2835 (let ((end (string-match "\r?$" str i)))
2837 (funcall term-command-hook
2838 (prog1 (substring str (1+ i) end)
2839 (setq i (match-end 0))))
2840 (setq term-terminal-parameter (substring str i))
2841 (setq term-terminal-state 4)
2842 (setq i str-length))))
2843 (t ; insert char FIXME: Should never happen
2844 (term-move-columns 1)
2845 (backward-delete-char 1)
2847 ((eq term-terminal-state 2) ; Seen Esc
2848 (cond ((eq char ?\133) ;; ?\133 = ?[
2850 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2851 ;;; Note that now the init value of term-terminal-previous-parameter has
2852 ;;; been changed to -1
2854 (setq term-terminal-parameter 0)
2855 (setq term-terminal-previous-parameter -1)
2856 (setq term-terminal-previous-parameter-2 -1)
2857 (setq term-terminal-previous-parameter-3 -1)
2858 (setq term-terminal-previous-parameter-4 -1)
2859 (setq term-terminal-more-parameters 0)
2860 (setq term-terminal-state 3))
2861 ((eq char ?D) ;; scroll forward
2862 (term-handle-deferred-scroll)
2864 (setq term-terminal-state 0))
2865 ;; ((eq char ?E) ;; (terminfo: nw), not used for
2866 ;; ;; now, but this is a working
2867 ;; ;; implementation
2869 ;; (term-goto term-current-row 0)
2870 ;; (setq term-terminal-state 0))
2871 ((eq char ?M) ;; scroll reversed (terminfo: ri)
2872 (if (or (< (term-current-row) term-scroll-start)
2873 (>= (1- (term-current-row))
2875 ;; Scrolling up will not move outside
2876 ;; the scroll region.
2878 ;; Scrolling the scroll region is needed.
2880 (setq term-terminal-state 0))
2881 ((eq char ?7) ;; Save cursor (terminfo: sc)
2882 (term-handle-deferred-scroll)
2883 (setq term-saved-cursor
2884 (list (term-current-row)
2885 (term-horizontal-column)
2886 term-ansi-current-bg-color
2887 term-ansi-current-bold
2888 term-ansi-current-color
2889 term-ansi-current-invisible
2890 term-ansi-current-reverse
2891 term-ansi-current-underline
2894 (setq term-terminal-state 0))
2895 ((eq char ?8) ;; Restore cursor (terminfo: rc)
2896 (when term-saved-cursor
2897 (term-goto (nth 0 term-saved-cursor)
2898 (nth 1 term-saved-cursor))
2899 (setq term-ansi-current-bg-color
2900 (nth 2 term-saved-cursor)
2901 term-ansi-current-bold
2902 (nth 3 term-saved-cursor)
2903 term-ansi-current-color
2904 (nth 4 term-saved-cursor)
2905 term-ansi-current-invisible
2906 (nth 5 term-saved-cursor)
2907 term-ansi-current-reverse
2908 (nth 6 term-saved-cursor)
2909 term-ansi-current-underline
2910 (nth 7 term-saved-cursor)
2912 (nth 8 term-saved-cursor)))
2913 (setq term-terminal-state 0))
2914 ((eq char ?c) ;; \Ec - Reset (terminfo: rs1)
2915 ;; This is used by the "clear" program.
2916 (setq term-terminal-state 0)
2917 (term-reset-terminal))
2918 ;; The \E#8 reset sequence for xterm. We
2919 ;; probably don't need to handle it, but this
2920 ;; is the code to parse it.
2922 ;; (when (eq (aref str (1+ i)) ?8)
2924 ;; (setq term-scroll-start 0)
2925 ;; (setq term-scroll-end term-height)
2926 ;; (setq term-terminal-state 0)))
2927 ((setq term-terminal-state 0))))
2928 ((eq term-terminal-state 3) ; Seen Esc [
2929 (cond ((and (>= char ?0) (<= char ?9))
2930 (setq term-terminal-parameter
2931 (+ (* 10 term-terminal-parameter) (- char ?0))))
2933 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2934 (setq term-terminal-more-parameters 1)
2935 (setq term-terminal-previous-parameter-4
2936 term-terminal-previous-parameter-3)
2937 (setq term-terminal-previous-parameter-3
2938 term-terminal-previous-parameter-2)
2939 (setq term-terminal-previous-parameter-2
2940 term-terminal-previous-parameter)
2941 (setq term-terminal-previous-parameter
2942 term-terminal-parameter)
2943 (setq term-terminal-parameter 0))
2944 ((eq char ??)) ; Ignore ?
2946 (term-handle-ansi-escape proc char)
2947 (setq term-terminal-more-parameters 0)
2948 (setq term-terminal-previous-parameter-4 -1)
2949 (setq term-terminal-previous-parameter-3 -1)
2950 (setq term-terminal-previous-parameter-2 -1)
2951 (setq term-terminal-previous-parameter -1)
2952 (setq term-terminal-state 0)))))
2953 (when (term-handling-pager)
2954 ;; Finish stuff to get ready to handle PAGER.
2955 (if (> (% (current-column) term-width) 0)
2956 (setq term-terminal-parameter
2958 ;; We're at column 0. Goto end of buffer; to compensate,
2959 ;; prepend a ?\r for later. This looks more consistent.
2961 (setq term-terminal-parameter
2962 (concat "\r" (substring str i)))
2963 (setq term-terminal-parameter (substring str (1- i)))
2964 (aset term-terminal-parameter 0 ?\r))
2965 (goto-char (point-max)))
2966 (setq term-terminal-state 4)
2967 (make-local-variable 'term-pager-old-filter)
2968 (setq term-pager-old-filter (process-filter proc))
2969 (set-process-filter proc term-pager-filter)
2970 (setq i str-length))
2973 (when (>= (term-current-row) term-height)
2974 (term-handle-deferred-scroll))
2976 (set-marker (process-mark proc) (point))
2978 (goto-char save-point)
2979 (set-marker save-point nil))
2981 ;; Check for a pending filename-and-line number to display.
2982 ;; We do this before scrolling, because we might create a new window.
2983 (when (and term-pending-frame
2984 (eq (window-buffer selected) (current-buffer)))
2985 (term-display-line (car term-pending-frame)
2986 (cdr term-pending-frame))
2987 (setq term-pending-frame nil)
2988 ;; We have created a new window, so check the window size.
2989 (term-check-size proc))
2991 ;; Scroll each window displaying the buffer but (by default)
2992 ;; only if the point matches the process-mark we started with.
2994 ;; Avoid infinite loop in strange case where minibuffer window
2995 ;; is selected but not active.
2996 (while (window-minibuffer-p win)
2997 (setq win (next-window win nil t)))
3000 (setq win (next-window win nil t))
3001 (when (eq (window-buffer win) (process-buffer proc))
3002 (let ((scroll term-scroll-to-bottom-on-output))
3004 (when (or (= (point) save-marker)
3005 (eq scroll t) (eq scroll 'all)
3006 ;; Maybe user wants point to jump to the end.
3007 (and (eq selected win)
3008 (or (eq scroll 'this) (not save-point)))
3009 (and (eq scroll 'others)
3010 (not (eq selected win))))
3011 (goto-char term-home-marker)
3013 (goto-char (process-mark proc))
3014 (if (not (pos-visible-in-window-p (point) win))
3016 ;; Optionally scroll so that the text
3017 ;; ends at the bottom of the window.
3018 (when (and term-scroll-show-maximum-output
3019 (>= (point) (process-mark proc)))
3021 (goto-char (point-max))
3023 (not (eq win last-win))))
3025 ;;; Stolen from comint.el and adapted -mm
3026 (when (> term-buffer-maximum-size 0)
3028 (goto-char (process-mark (get-buffer-process (current-buffer))))
3029 (forward-line (- term-buffer-maximum-size))
3031 (delete-region (point-min) (point))))
3032 (set-marker save-marker nil)))))
3034 (defun term-handle-deferred-scroll ()
3035 (let ((count (- (term-current-row) term-height)))
3038 (goto-char term-home-marker)
3039 (term-vertical-motion (1+ count))
3040 (set-marker term-home-marker (point))
3041 (setq term-current-row (1- term-height))))))
3043 ;;; Reset the terminal, delete all the content and set the face to the
3045 (defun term-reset-terminal ()
3047 (setq term-current-row 0)
3048 (setq term-current-column 1)
3049 (setq term-scroll-start 0)
3050 (setq term-scroll-end term-height)
3051 (setq term-insert-mode nil)
3052 (setq term-current-face nil)
3053 (setq term-ansi-current-underline nil)
3054 (setq term-ansi-current-bold nil)
3055 (setq term-ansi-current-reverse nil)
3056 (setq term-ansi-current-color 0)
3057 (setq term-ansi-current-invisible nil)
3058 (setq term-ansi-face-already-done nil)
3059 (setq term-ansi-current-bg-color 0))
3061 ;;; New function to deal with ansi colorized output, as you can see you can
3062 ;;; have any bold/underline/fg/bg/reverse combination. -mm
3064 (defun term-handle-colors-array (parameter)
3067 ;;; Bold (terminfo: bold)
3069 (setq term-ansi-current-bold t))
3073 (setq term-ansi-current-underline t))
3075 ;;; Blink (unsupported by Emacs), will be translated to bold.
3076 ;;; This may change in the future though.
3078 (setq term-ansi-current-bold t))
3080 ;;; Reverse (terminfo: smso)
3082 (setq term-ansi-current-reverse t))
3086 (setq term-ansi-current-invisible t))
3088 ;;; Reset underline (terminfo: rmul)
3090 (setq term-ansi-current-underline nil))
3092 ;;; Reset reverse (terminfo: rmso)
3094 (setq term-ansi-current-reverse nil))
3097 ((and (>= parameter 30) (<= parameter 37))
3098 (setq term-ansi-current-color (- parameter 29)))
3100 ;;; Reset foreground
3102 (setq term-ansi-current-color 0))
3105 ((and (>= parameter 40) (<= parameter 47))
3106 (setq term-ansi-current-bg-color (- parameter 39)))
3108 ;;; Reset background
3110 (setq term-ansi-current-bg-color 0))
3112 ;;; 0 (Reset) or unknown (reset anyway)
3114 (setq term-current-face nil)
3115 (setq term-ansi-current-underline nil)
3116 (setq term-ansi-current-bold nil)
3117 (setq term-ansi-current-reverse nil)
3118 (setq term-ansi-current-color 0)
3119 (setq term-ansi-current-invisible nil)
3120 (setq term-ansi-face-already-done t)
3121 (setq term-ansi-current-bg-color 0)))
3123 ; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3124 ; term-ansi-current-underline
3125 ; term-ansi-current-reverse
3126 ; term-ansi-current-bold
3127 ; term-ansi-current-invisible
3128 ; term-ansi-face-already-done
3129 ; term-ansi-current-color
3130 ; term-ansi-current-bg-color)
3133 (unless term-ansi-face-already-done
3134 (if term-ansi-current-reverse
3135 (if term-ansi-current-invisible
3136 (setq term-current-face
3137 (if (= term-ansi-current-color 0)
3139 term-default-fg-color
3141 term-default-fg-color)
3143 (elt ansi-term-color-vector term-ansi-current-color)
3145 (elt ansi-term-color-vector term-ansi-current-color)))
3146 ;; No need to bother with anything else if it's invisible
3148 (setq term-current-face
3150 (if (= term-ansi-current-color 0)
3151 (face-foreground 'default)
3152 (elt ansi-term-color-vector term-ansi-current-color))
3154 (if (= term-ansi-current-bg-color 0)
3155 (face-background 'default)
3156 (elt ansi-term-color-vector term-ansi-current-bg-color))))
3157 (when term-ansi-current-bold
3158 (setq term-current-face
3159 (append '(:weight bold) term-current-face)))
3160 (when term-ansi-current-underline
3161 (setq term-current-face
3162 (append '(:underline t) term-current-face))))
3163 (if term-ansi-current-invisible
3164 (setq term-current-face
3165 (if (= term-ansi-current-bg-color 0)
3167 term-default-bg-color
3169 term-default-bg-color)
3171 (elt ansi-term-color-vector term-ansi-current-bg-color)
3173 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3174 ;; No need to bother with anything else if it's invisible
3176 (setq term-current-face
3178 (elt ansi-term-color-vector term-ansi-current-color)
3180 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3181 (when term-ansi-current-bold
3182 (setq term-current-face
3183 (append '(:weight bold) term-current-face)))
3184 (when term-ansi-current-underline
3185 (setq term-current-face
3186 (append '(:underline t) term-current-face))))))
3188 ;;; (message "Debug %S" term-current-face)
3189 (setq term-ansi-face-already-done nil))
3192 ;;; Handle a character assuming (eq terminal-state 2) -
3193 ;;; i.e. we have previously seen Escape followed by ?[.
3195 (defun term-handle-ansi-escape (proc char)
3197 ((or (eq char ?H) ;; cursor motion (terminfo: cup,home)
3198 ;; (eq char ?f) ;; xterm seems to handle this sequence too, not
3201 (when (<= term-terminal-parameter 0)
3202 (setq term-terminal-parameter 1))
3203 (when (<= term-terminal-previous-parameter 0)
3204 (setq term-terminal-previous-parameter 1))
3205 (when (> term-terminal-previous-parameter term-height)
3206 (setq term-terminal-previous-parameter term-height))
3207 (when (> term-terminal-parameter term-width)
3208 (setq term-terminal-parameter term-width))
3210 (1- term-terminal-previous-parameter)
3211 (1- term-terminal-parameter)))
3212 ;; \E[A - cursor up (terminfo: cuu, cuu1)
3214 (term-handle-deferred-scroll)
3215 (let ((tcr (term-current-row)))
3217 (if (< (- tcr term-terminal-parameter) term-scroll-start)
3218 ;; If the amount to move is before scroll start, move
3220 (- term-scroll-start tcr)
3221 (if (>= term-terminal-parameter tcr)
3223 (- (max 1 term-terminal-parameter)))) t)))
3224 ;; \E[B - cursor down (terminfo: cud)
3226 (let ((tcr (term-current-row)))
3227 (unless (= tcr (1- term-scroll-end))
3229 (if (> (+ tcr term-terminal-parameter) term-scroll-end)
3230 (- term-scroll-end 1 tcr)
3231 (max 1 term-terminal-parameter)) t))))
3232 ;; \E[C - cursor right (terminfo: cuf, cuf1)
3236 (if (>= (+ term-terminal-parameter (term-current-column)) term-width)
3237 (- term-width (term-current-column) 1)
3238 term-terminal-parameter))))
3239 ;; \E[D - cursor left (terminfo: cub)
3241 (term-move-columns (- (max 1 term-terminal-parameter))))
3242 ;; \E[J - clear to end of screen (terminfo: ed, clear)
3244 (term-erase-in-display term-terminal-parameter))
3245 ;; \E[K - clear to end of line (terminfo: el, el1)
3247 (term-erase-in-line term-terminal-parameter))
3248 ;; \E[L - insert lines (terminfo: il, il1)
3250 (term-insert-lines (max 1 term-terminal-parameter)))
3251 ;; \E[M - delete lines (terminfo: dl, dl1)
3253 (term-delete-lines (max 1 term-terminal-parameter)))
3254 ;; \E[P - delete chars (terminfo: dch, dch1)
3256 (term-delete-chars (max 1 term-terminal-parameter)))
3257 ;; \E[@ - insert spaces (terminfo: ich)
3259 (term-insert-spaces (max 1 term-terminal-parameter)))
3260 ;; \E[?h - DEC Private Mode Set
3262 (cond ((eq term-terminal-parameter 4) ;; (terminfo: smir)
3263 (setq term-insert-mode t))
3264 ;; ((eq term-terminal-parameter 47) ;; (terminfo: smcup)
3265 ;; (term-switch-to-alternate-sub-buffer t))
3267 ;; \E[?l - DEC Private Mode Reset
3269 (cond ((eq term-terminal-parameter 4) ;; (terminfo: rmir)
3270 (setq term-insert-mode nil))
3271 ;; ((eq term-terminal-parameter 47) ;; (terminfo: rmcup)
3272 ;; (term-switch-to-alternate-sub-buffer nil))
3275 ;;; Modified to allow ansi coloring -mm
3276 ;; \E[m - Set/reset modes, set bg/fg
3277 ;;(terminfo: smso,rmso,smul,rmul,rev,bold,sgr0,invis,op,setab,setaf)
3279 (when (= term-terminal-more-parameters 1)
3280 (when (>= term-terminal-previous-parameter-4 0)
3281 (term-handle-colors-array term-terminal-previous-parameter-4))
3282 (when (>= term-terminal-previous-parameter-3 0)
3283 (term-handle-colors-array term-terminal-previous-parameter-3))
3284 (when (>= term-terminal-previous-parameter-2 0)
3285 (term-handle-colors-array term-terminal-previous-parameter-2))
3286 (term-handle-colors-array term-terminal-previous-parameter))
3287 (term-handle-colors-array term-terminal-parameter))
3289 ;; \E[6n - Report cursor position
3291 (term-handle-deferred-scroll)
3292 (process-send-string proc
3294 (1+ (term-current-row))
3295 (1+ (term-horizontal-column)))))
3296 ;; \E[r - Set scrolling region (terminfo: csr)
3298 (term-set-scroll-region
3299 (1- term-terminal-previous-parameter)
3300 (1- term-terminal-parameter)))
3303 (defun term-set-scroll-region (top bottom)
3304 "Set scrolling region.
3305 TOP is the top-most line (inclusive) of the new scrolling region,
3306 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3307 The top-most line is line 0."
3308 (setq term-scroll-start
3309 (if (or (< top 0) (>= top term-height))
3312 (setq term-scroll-end
3313 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3316 (setq term-scroll-with-delete
3317 (or (term-using-alternate-sub-buffer)
3318 (not (and (= term-scroll-start 0)
3319 (= term-scroll-end term-height)))))
3320 (term-move-columns (- (term-current-column)))
3323 ;; (defun term-switch-to-alternate-sub-buffer (set)
3324 ;; ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3325 ;; ;; using it, do nothing. This test is needed for some programs (including
3326 ;; ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3327 ;; (term-handle-deferred-scroll)
3328 ;; (if (eq set (not (term-using-alternate-sub-buffer)))
3329 ;; (let ((row (term-current-row))
3330 ;; (col (term-horizontal-column)))
3332 ;; (goto-char (point-max))
3333 ;; (if (not (eq (preceding-char) ?\n))
3334 ;; (term-insert-char ?\n 1))
3335 ;; (setq term-scroll-with-delete t)
3336 ;; (setq term-saved-home-marker (copy-marker term-home-marker))
3337 ;; (set-marker term-home-marker (point)))
3339 ;; (setq term-scroll-with-delete
3340 ;; (not (and (= term-scroll-start 0)
3341 ;; (= term-scroll-end term-height))))
3342 ;; (set-marker term-home-marker term-saved-home-marker)
3343 ;; (set-marker term-saved-home-marker nil)
3344 ;; (setq term-saved-home-marker nil)
3345 ;; (goto-char term-home-marker)))
3346 ;; (setq term-current-column nil)
3347 ;; (setq term-current-row 0)
3348 ;; (term-goto row col))))
3350 ;; Default value for the symbol term-command-hook.
3352 (defun term-command-hook (string)
3353 (cond ((equal string "")
3355 ((= (aref string 0) ?\032)
3356 ;; gdb (when invoked with -fullname) prints:
3357 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3358 (let* ((first-colon (string-match ":" string 1))
3360 (string-match ":" string (1+ first-colon)))
3361 (filename (substring string 1 first-colon))
3362 (fileline (string-to-number
3363 (substring string (1+ first-colon) second-colon))))
3364 (setq term-pending-frame (cons filename fileline))))
3365 ((= (aref string 0) ?/)
3366 (cd (substring string 1)))
3367 ;; Allowing the inferior to call functions in Emacs is
3368 ;; probably too big a security hole.
3369 ;; ((= (aref string 0) ?!)
3370 ;; (eval (car (read-from-string string 1))))
3371 (t)));; Otherwise ignore it
3373 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3374 ;; and that its line LINE is visible.
3375 ;; Put the overlay-arrow on the line LINE in that buffer.
3376 ;; This is mainly used by gdb.
3378 (defun term-display-line (true-file line)
3379 (term-display-buffer-line (find-file-noselect true-file) line))
3381 (defun term-display-buffer-line (buffer line)
3382 (let* ((window (display-buffer buffer t))
3390 (setq overlay-arrow-string "=>")
3391 (or overlay-arrow-position
3392 (setq overlay-arrow-position (make-marker)))
3393 (set-marker overlay-arrow-position (point) (current-buffer)))
3394 (cond ((or (< pos (point-min)) (> pos (point-max)))
3397 (set-window-point window overlay-arrow-position)))
3399 ;;; The buffer-local marker term-home-marker defines the "home position"
3400 ;;; (in terms of cursor motion). However, we move the term-home-marker
3401 ;;; "down" as needed so that is no more that a window-full above (point-max).
3403 (defun term-goto-home ()
3404 (term-handle-deferred-scroll)
3405 (goto-char term-home-marker)
3406 (setq term-current-row 0)
3407 (setq term-current-column (current-column))
3408 (setq term-start-line-column term-current-column))
3410 (defun term-goto (row col)
3411 (term-handle-deferred-scroll)
3412 (cond ((and term-current-row (>= row term-current-row))
3413 ;; I assume this is a worthwhile optimization.
3414 (term-vertical-motion 0)
3415 (setq term-current-column term-start-line-column)
3416 (setq row (- row term-current-row)))
3420 (term-move-columns col))
3422 ; The page is full, so enter "pager" mode, and wait for input.
3424 (defun term-process-pager ()
3425 (when (not term-pager-break-map)
3426 (let* ((map (make-keymap))
3429 ; (define-key map (make-string 1 i) 'term-send-raw)
3431 (define-key map "\e"
3432 (lookup-key (current-global-map) "\e"))
3433 (define-key map "\C-x"
3434 (lookup-key (current-global-map) "\C-x"))
3435 (define-key map "\C-u"
3436 (lookup-key (current-global-map) "\C-u"))
3437 (define-key map " " 'term-pager-page)
3438 (define-key map "\r" 'term-pager-line)
3439 (define-key map "?" 'term-pager-help)
3440 (define-key map "h" 'term-pager-help)
3441 (define-key map "b" 'term-pager-back-page)
3442 (define-key map "\177" 'term-pager-back-line)
3443 (define-key map "q" 'term-pager-discard)
3444 (define-key map "D" 'term-pager-disable)
3445 (define-key map "<" 'term-pager-bob)
3446 (define-key map ">" 'term-pager-eob)
3449 (unless (featurep 'xemacs)
3450 (define-key map [menu-bar terminal] term-terminal-menu)
3451 (define-key map [menu-bar signals] term-signals-menu)
3452 (setq tmp (make-sparse-keymap "More pages?"))
3453 (define-key tmp [help] '("Help" . term-pager-help))
3454 (define-key tmp [disable]
3455 '("Disable paging" . term-fake-pager-disable))
3456 (define-key tmp [discard]
3457 '("Discard remaining output" . term-pager-discard))
3458 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3459 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3460 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3461 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3462 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3463 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3464 (define-key map [menu-bar page] (cons "More pages?" tmp))
3467 (setq term-pager-break-map map)))
3468 ; (let ((process (get-buffer-process (current-buffer))))
3469 ; (stop-process process))
3470 (setq term-pager-old-local-map (current-local-map))
3471 (use-local-map term-pager-break-map)
3472 (make-local-variable 'term-old-mode-line-format)
3473 (setq term-old-mode-line-format mode-line-format)
3474 (setq mode-line-format
3475 (list "-- **MORE** "
3476 mode-line-buffer-identification
3477 " [Type ? for help] "
3479 (force-mode-line-update))
3481 (defun term-pager-line (lines)
3483 (let* ((moved (vertical-motion (1+ lines)))
3484 (deficit (- lines moved)))
3485 (when (> moved lines)
3487 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3488 (recenter (1- term-height)))
3489 ((term-pager-continue deficit)))))
3491 (defun term-pager-page (arg)
3492 "Proceed past the **MORE** break, allowing the next page of output to appear"
3494 (term-pager-line (* arg term-height)))
3496 ; Pager mode command to go to beginning of buffer
3497 (defun term-pager-bob ()
3499 (goto-char (point-min))
3500 (when (= (vertical-motion term-height) term-height)
3502 (recenter (1- term-height)))
3504 ; pager mode command to go to end of buffer
3505 (defun term-pager-eob ()
3507 (goto-char term-home-marker)
3509 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3511 (defun term-pager-back-line (lines)
3513 (vertical-motion (- 1 lines))
3517 ;; Move cursor to end of window.
3518 (vertical-motion term-height)
3520 (recenter (1- term-height)))
3522 (defun term-pager-back-page (arg)
3524 (term-pager-back-line (* arg term-height)))
3526 (defun term-pager-discard ()
3528 (setq term-terminal-parameter "")
3529 (interrupt-process nil t)
3530 (term-pager-continue term-height))
3532 ; Disable pager processing.
3533 ; Only callable while in pager mode. (Contrast term-disable-pager.)
3534 (defun term-pager-disable ()
3536 (if (term-handling-pager)
3537 (term-pager-continue nil)
3538 (setq term-pager-count nil))
3539 (term-update-mode-line))
3541 ; Enable pager processing.
3542 (defun term-pager-enable ()
3544 (or (term-pager-enabled)
3545 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3546 (term-update-mode-line))
3548 (defun term-pager-toggle ()
3550 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3552 (unless (featurep 'xemacs)
3553 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3554 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3555 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3556 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3557 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3558 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3560 (defun term-pager-help ()
3561 "Provide help on commands available in a terminal-emulator **MORE** break"
3563 (message "Terminal-emulator pager break help...")
3566 (function (lambda ()
3567 (princ (substitute-command-keys
3568 "\\<term-pager-break-map>\
3569 Terminal-emulator MORE break.\n\
3570 Type one of the following keys:\n\n\
3571 \\[term-pager-page]\t\tMove forward one page.\n\
3572 \\[term-pager-line]\t\tMove forward one line.\n\
3573 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3574 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3575 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3576 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3577 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3578 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3579 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3580 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3581 \\{term-pager-break-map}\n\
3582 Any other key is passed through to the program
3583 running under the terminal emulator and disables pager processing until
3584 all pending output has been dealt with."))
3587 (defun term-pager-continue (new-count)
3588 (let ((process (get-buffer-process (current-buffer))))
3589 (use-local-map term-pager-old-local-map)
3590 (setq term-pager-old-local-map nil)
3591 (setq mode-line-format term-old-mode-line-format)
3592 (force-mode-line-update)
3593 (setq term-pager-count new-count)
3594 (set-process-filter process term-pager-old-filter)
3595 (funcall term-pager-old-filter process "")
3596 (continue-process process)))
3598 ;; Make sure there are DOWN blank lines below the current one.
3599 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3601 (defun term-handle-scroll (down)
3602 (let ((scroll-needed
3603 (- (+ (term-current-row) down)
3604 (if (< down 0) term-scroll-start term-scroll-end))))
3605 (when (or (and (< down 0) (< scroll-needed 0))
3606 (and (> down 0) (> scroll-needed 0)))
3607 (let ((save-point (copy-marker (point))) (save-top))
3608 (goto-char term-home-marker)
3609 (cond (term-scroll-with-delete
3612 ;; Delete scroll-needed lines at term-scroll-end,
3613 ;; then insert scroll-needed lines.
3614 (term-vertical-motion term-scroll-end)
3616 (setq save-top (point))
3617 (term-vertical-motion scroll-needed)
3619 (delete-region save-top (point))
3620 (goto-char save-point)
3621 (setq down (- scroll-needed down))
3622 (term-vertical-motion down))
3623 ;; Delete scroll-needed lines at term-scroll-start.
3624 (term-vertical-motion term-scroll-start)
3625 (setq save-top (point))
3626 (term-vertical-motion scroll-needed)
3627 (delete-region save-top (point))
3628 (goto-char save-point)
3629 (term-vertical-motion down)
3630 (term-adjust-current-row-cache (- scroll-needed)))
3631 (setq term-current-column nil)
3632 (term-insert-char ?\n (abs scroll-needed)))
3633 ((and (numberp term-pager-count)
3634 (< (setq term-pager-count (- term-pager-count down))
3637 (term-process-pager))
3639 (term-adjust-current-row-cache (- scroll-needed))
3640 (term-vertical-motion scroll-needed)
3641 (set-marker term-home-marker (point))))
3642 (goto-char save-point)
3643 (set-marker save-point nil))))
3646 (defun term-down (down &optional check-for-scroll)
3647 "Move down DOWN screen lines vertically."
3648 (let ((start-column (term-horizontal-column)))
3649 (when (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3650 (setq down (term-handle-scroll down)))
3651 (unless (and (= term-current-row 0) (< down 0))
3652 (term-adjust-current-row-cache down)
3653 (when (or (/= (point) (point-max)) (< down 0))
3654 (setq down (- down (term-vertical-motion down)))))
3656 ;; Extend buffer with extra blank lines if needed.
3657 (term-insert-char ?\n down)
3658 (setq term-current-column 0)
3659 (setq term-start-line-column 0))
3661 (when (= term-current-row 0)
3662 ;; Insert lines if at the beginning.
3663 (save-excursion (term-insert-char ?\n (- down)))
3666 ;; Delete lines from the end.
3667 (forward-line term-height)
3669 (forward-line (- down))
3670 (delete-region p (point)))))
3671 (setq term-current-column 0)
3672 (setq term-start-line-column (current-column))))
3674 (term-move-columns start-column))))
3676 ;; Assuming point is at the beginning of a screen line,
3677 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3678 ;; FIXME: Probably should be called more than it is.
3679 (defun term-unwrap-line ()
3680 (when (not (bolp)) (insert-before-markers ?\n)))
3682 (defun term-erase-in-line (kind)
3683 (when (= kind 1) ;; erase left of point
3684 (let ((cols (term-horizontal-column)) (saved-point (point)))
3685 (term-vertical-motion 0)
3686 (delete-region (point) saved-point)
3687 (term-insert-char ? cols)))
3688 (when (not (eq kind 1)) ;; erase right of point
3689 (let ((saved-point (point))
3690 (wrapped (and (zerop (term-horizontal-column))
3691 (not (zerop (term-current-column))))))
3692 (term-vertical-motion 1)
3693 (delete-region saved-point (point))
3694 ;; wrapped is true if we're at the beginning of screen line,
3695 ;; but not a buffer line. If we delete the current screen line
3696 ;; that will make the previous line no longer wrap, and (because
3697 ;; of the way Emacs display works) point will be at the end of
3698 ;; the previous screen line rather then the beginning of the
3699 ;; current one. To avoid that, we make sure that current line
3700 ;; contain a space, to force the previous line to continue to wrap.
3701 ;; We could do this always, but it seems preferable to not add the
3702 ;; extra space when wrapped is false.
3706 (put-text-property saved-point (point) 'face 'default)
3707 (goto-char saved-point))))
3709 (defun term-erase-in-display (kind)
3710 "Erases (that is blanks out) part of the window.
3711 If KIND is 0, erase from (point) to (point-max);
3712 if KIND is 1, erase from home to point; else erase from home to point-max.
3713 Should only be called when point is at the start of a screen line."
3714 (term-handle-deferred-scroll)
3715 (cond ((eq term-terminal-parameter 0)
3716 (delete-region (point) (point-max))
3718 ((let ((row (term-current-row))
3719 (col (term-horizontal-column))
3720 (start-region term-home-marker)
3721 (end-region (if (eq kind 1) (point) (point-max))))
3722 (delete-region start-region end-region)
3725 (term-insert-char ?\n row))
3726 (setq term-current-column nil)
3727 (setq term-current-row nil)
3728 (term-goto row col)))))
3730 (defun term-delete-chars (count)
3731 (let ((save-point (point)))
3732 (term-vertical-motion 1)
3734 (goto-char save-point)
3735 (move-to-column (+ (term-current-column) count) t)
3736 (delete-region save-point (point))))
3738 ;;; Insert COUNT spaces after point, but do not change any of
3739 ;;; following screen lines. Hence we may have to delete characters
3740 ;;; at the end of this screen line to make room.
3742 (defun term-insert-spaces (count)
3743 (let ((save-point (point)) (save-eol) (pnt-at-eol))
3744 (term-vertical-motion 1)
3747 (setq save-eol (point))
3750 (setq pnt-at-eol (point)))
3751 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3752 ;; If move-to-column extends the current line it will use the face
3753 ;; from the last character on the line, set the face for the chars
3755 (when (>= (point) pnt-at-eol)
3756 (put-text-property pnt-at-eol (point) 'face 'default))
3757 (when (> save-eol (point))
3758 (delete-region (point) save-eol))
3759 (goto-char save-point)
3760 (term-insert-char ? count)
3761 (goto-char save-point)))
3763 (defun term-delete-lines (lines)
3764 (let ((start (point))
3765 (save-current-column term-current-column)
3766 (save-start-line-column term-start-line-column)
3767 (save-current-row (term-current-row)))
3768 ;; The number of inserted lines shouldn't exceed the scroll region end.
3769 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3770 (setq lines (- lines (- (+ save-current-row lines) (1+ term-scroll-end)))))
3772 (delete-region start (point))
3773 (term-down (- (1+ term-scroll-end) save-current-row lines))
3774 (term-insert-char ?\n lines)
3775 (setq term-current-column save-current-column)
3776 (setq term-start-line-column save-start-line-column)
3777 (setq term-current-row save-current-row)
3780 (defun term-insert-lines (lines)
3781 (let ((start (point))
3783 (save-current-column term-current-column)
3784 (save-start-line-column term-start-line-column)
3785 (save-current-row (term-current-row)))
3786 ;; Inserting lines should take into account the scroll region.
3787 (if (< save-current-row term-scroll-start)
3788 ;; If point is before scroll start,
3790 (setq lines (- lines (- term-scroll-start save-current-row)))
3791 (term-down (- term-scroll-start save-current-row))
3792 (setq start (point)))
3793 ;; The number of inserted lines shouldn't exceed the scroll region end.
3794 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3795 (setq lines (- lines (- (+ save-current-row lines)(1+ term-scroll-end)))))
3796 (term-down (- (1+ term-scroll-end) save-current-row lines)))
3797 (setq start-deleted (point))
3799 (delete-region start-deleted (point))
3801 (setq term-current-column save-current-column)
3802 (setq term-start-line-column save-start-line-column)
3803 (setq term-current-row save-current-row)
3804 (term-insert-char ?\n lines)
3807 (defun term-start-output-log (name)
3808 "Record raw inferior process output in a buffer."
3809 (interactive (list (if term-log-buffer
3811 (read-buffer "Record output in buffer: "
3812 (format "%s output-log"
3813 (buffer-name (current-buffer)))
3815 (if (or (null name) (equal name ""))
3816 (progn (setq term-log-buffer nil)
3817 (message "Output logging off."))
3818 (if (get-buffer name)
3821 (set-buffer (get-buffer-create name))
3823 (buffer-disable-undo (current-buffer))
3825 (setq term-log-buffer (get-buffer name))
3826 (message "Recording terminal emulator output into buffer \"%s\""
3827 (buffer-name term-log-buffer))))
3829 (defun term-stop-output-log ()
3830 "Discontinue raw inferior process logging."
3832 (term-start-output-log nil))
3834 (defun term-show-maximum-output ()
3835 "Put the end of the buffer at the bottom of the window."
3837 (goto-char (point-max))
3840 ;;; Do the user's customisation...
3842 (defvar term-load-hook nil
3843 "This hook is run when term is loaded in.
3844 This is a good place to put keybindings.")
3846 (run-hooks 'term-load-hook)
3849 ;;; Filename/command/history completion in a buffer
3850 ;;; ===========================================================================
3851 ;;; Useful completion functions, courtesy of the Ergo group.
3854 ;;; term-dynamic-complete Complete or expand command, filename,
3855 ;;; history at point.
3856 ;;; term-dynamic-complete-filename Complete filename at point.
3857 ;;; term-dynamic-list-filename-completions List completions in help buffer.
3858 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
3859 ;;; replace with expanded/completed name.
3860 ;;; term-dynamic-simple-complete Complete stub given candidates.
3862 ;;; These are not installed in the term-mode keymap. But they are
3863 ;;; available for people who want them. Shell-mode installs them:
3864 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3865 ;;; (define-key shell-mode-map "\M-?"
3866 ;;; 'term-dynamic-list-filename-completions)))
3868 ;;; Commands like this are fine things to put in load hooks if you
3869 ;;; want them present in specific modes.
3871 (defvar term-completion-autolist nil
3872 "*If non-nil, automatically list possibilities on partial completion.
3873 This mirrors the optional behavior of tcsh.")
3875 (defvar term-completion-addsuffix t
3876 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3877 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3878 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3879 completion. This mirrors the optional behavior of tcsh.")
3881 (defvar term-completion-recexact nil
3882 "*If non-nil, use shortest completion if characters cannot be added.
3883 This mirrors the optional behavior of tcsh.
3885 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3887 (defvar term-completion-fignore nil
3888 "*List of suffixes to be disregarded during file completion.
3889 This mirrors the optional behavior of bash and tcsh.
3891 Note that this applies to `term-dynamic-complete-filename' only.")
3893 (defvar term-file-name-prefix ""
3894 "Prefix prepended to absolute file names taken from process input.
3895 This is used by term's and shell's completion functions, and by shell's
3896 directory tracking functions.")
3899 (defun term-directory (directory)
3900 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3901 (expand-file-name (if (file-name-absolute-p directory)
3902 (concat term-file-name-prefix directory)
3906 (defun term-word (word-chars)
3907 "Return the word of WORD-CHARS at point, or nil if none is found.
3908 Word constituents are considered to be those in WORD-CHARS, which is like the
3909 inside of a \"[...]\" (see `skip-chars-forward')."
3911 (let ((limit (point))
3912 (word (concat "[" word-chars "]"))
3913 (non-word (concat "[^" word-chars "]")))
3914 (when (re-search-backward non-word nil 'move)
3916 ;; Anchor the search forwards.
3917 (if (or (eolp) (looking-at non-word))
3919 (re-search-forward (concat word "+") limit)
3920 (buffer-substring (match-beginning 0) (match-end 0))))))
3923 (defun term-match-partial-filename ()
3924 "Return the filename at point, or nil if none is found.
3925 Environment variables are substituted. See `term-word'."
3926 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3927 (and filename (substitute-in-file-name filename))))
3930 (defun term-dynamic-complete ()
3931 "Dynamically perform completion at point.
3932 Calls the functions in `term-dynamic-complete-functions' to perform
3933 completion until a function returns non-nil, at which point completion is
3934 assumed to have occurred."
3936 (let ((functions term-dynamic-complete-functions))
3937 (while (and functions (null (funcall (car functions))))
3938 (setq functions (cdr functions)))))
3941 (defun term-dynamic-complete-filename ()
3942 "Dynamically complete the filename at point.
3943 Completes if after a filename. See `term-match-partial-filename' and
3944 `term-dynamic-complete-as-filename'.
3945 This function is similar to `term-replace-by-expanded-filename', except that
3946 it won't change parts of the filename already entered in the buffer; it just
3947 adds completion characters to the end of the filename. A completions listing
3948 may be shown in a help buffer if completion is ambiguous.
3950 Completion is dependent on the value of `term-completion-addsuffix',
3951 `term-completion-recexact' and `term-completion-fignore', and the timing of
3952 completions listing is dependent on the value of `term-completion-autolist'.
3954 Returns t if successful."
3956 (when (term-match-partial-filename)
3957 (prog2 (or (eq (selected-window) (minibuffer-window))
3958 (message "Completing file name..."))
3959 (term-dynamic-complete-as-filename))))
3961 (defun term-dynamic-complete-as-filename ()
3962 "Dynamically complete at point as a filename.
3963 See `term-dynamic-complete-filename'. Returns t if successful."
3964 (let* ((completion-ignore-case nil)
3965 (completion-ignored-extensions term-completion-fignore)
3967 (dirsuffix (cond ((not term-completion-addsuffix) "")
3968 ((not (consp term-completion-addsuffix)) "/")
3969 (t (car term-completion-addsuffix))))
3970 (filesuffix (cond ((not term-completion-addsuffix) "")
3971 ((not (consp term-completion-addsuffix)) " ")
3972 (t (cdr term-completion-addsuffix))))
3973 (filename (or (term-match-partial-filename) ""))
3974 (pathdir (file-name-directory filename))
3975 (pathnondir (file-name-nondirectory filename))
3976 (directory (if pathdir (term-directory pathdir) default-directory))
3977 (completion (file-name-completion pathnondir directory))
3978 (mini-flag (eq (selected-window) (minibuffer-window))))
3979 (cond ((null completion)
3980 (message "No completions of %s" filename)
3982 ((eq completion t) ; Means already completed "file".
3983 (when term-completion-addsuffix (insert " "))
3984 (or mini-flag (message "Sole completion")))
3985 ((string-equal completion "") ; Means completion on "directory/".
3986 (term-dynamic-list-filename-completions))
3987 (t ; Completion string returned.
3988 (let ((file (concat (file-name-as-directory directory) completion)))
3989 (insert (substring (directory-file-name completion)
3990 (length pathnondir)))
3991 (cond ((symbolp (file-name-completion completion directory))
3992 ;; We inserted a unique completion.
3993 (insert (if (file-directory-p file) dirsuffix filesuffix))
3994 (or mini-flag (message "Completed")))
3995 ((and term-completion-recexact term-completion-addsuffix
3996 (string-equal pathnondir completion)
3997 (file-exists-p file))
3998 ;; It's not unique, but user wants shortest match.
3999 (insert (if (file-directory-p file) dirsuffix filesuffix))
4000 (or mini-flag (message "Completed shortest")))
4001 ((or term-completion-autolist
4002 (string-equal pathnondir completion))
4003 ;; It's not unique, list possible completions.
4004 (term-dynamic-list-filename-completions))
4006 (or mini-flag (message "Partially completed")))))))
4010 (defun term-replace-by-expanded-filename ()
4011 "Dynamically expand and complete the filename at point.
4012 Replace the filename with an expanded, canonicalized and completed replacement.
4013 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
4014 with the corresponding directories. \"Canonicalized\" means `..' and `.' are
4015 removed, and the filename is made absolute instead of relative. For expansion
4016 see `expand-file-name' and `substitute-in-file-name'. For completion see
4017 `term-dynamic-complete-filename'."
4019 (replace-match (expand-file-name (term-match-partial-filename)) t t)
4020 (term-dynamic-complete-filename))
4023 (defun term-dynamic-simple-complete (stub candidates)
4024 "Dynamically complete STUB from CANDIDATES list.
4025 This function inserts completion characters at point by completing STUB from
4026 the strings in CANDIDATES. A completions listing may be shown in a help buffer
4027 if completion is ambiguous.
4029 Returns nil if no completion was inserted.
4030 Returns `sole' if completed with the only completion match.
4031 Returns `shortest' if completed with the shortest of the completion matches.
4032 Returns `partial' if completed as far as possible with the completion matches.
4033 Returns `listed' if a completion listing was shown.
4035 See also `term-dynamic-complete-filename'."
4036 (let* ((completion-ignore-case nil)
4037 (candidates (mapcar (function (lambda (x) (list x))) candidates))
4038 (completions (all-completions stub candidates)))
4039 (cond ((null completions)
4040 (message "No completions of %s" stub)
4042 ((= 1 (length completions)) ; Gotcha!
4043 (let ((completion (car completions)))
4044 (if (string-equal completion stub)
4045 (message "Sole completion")
4046 (insert (substring completion (length stub)))
4047 (message "Completed"))
4048 (when term-completion-addsuffix (insert " "))
4050 (t ; There's no unique completion.
4051 (let ((completion (try-completion stub candidates)))
4052 ;; Insert the longest substring.
4053 (insert (substring completion (length stub)))
4054 (cond ((and term-completion-recexact term-completion-addsuffix
4055 (string-equal stub completion)
4056 (member completion completions))
4057 ;; It's not unique, but user wants shortest match.
4059 (message "Completed shortest")
4061 ((or term-completion-autolist
4062 (string-equal stub completion))
4063 ;; It's not unique, list possible completions.
4064 (term-dynamic-list-completions completions)
4067 (message "Partially completed")
4071 (defun term-dynamic-list-filename-completions ()
4072 "List in help buffer possible completions of the filename at point."
4074 (let* ((completion-ignore-case nil)
4075 (filename (or (term-match-partial-filename) ""))
4076 (pathdir (file-name-directory filename))
4077 (pathnondir (file-name-nondirectory filename))
4078 (directory (if pathdir (term-directory pathdir) default-directory))
4079 (completions (file-name-all-completions pathnondir directory)))
4081 (term-dynamic-list-completions completions)
4082 (message "No completions of %s" filename))))
4085 (defun term-dynamic-list-completions (completions)
4086 "List in help buffer sorted COMPLETIONS.
4087 Typing SPC flushes the help buffer."
4088 (let ((conf (current-window-configuration)))
4089 (with-output-to-temp-buffer "*Completions*"
4090 (display-completion-list (sort completions 'string-lessp)))
4091 (message "Hit space to flush")
4094 (set-buffer (get-buffer "*Completions*"))
4095 (setq key (read-key-sequence nil)
4098 (eq (window-buffer (posn-window (event-start first)))
4099 (get-buffer "*Completions*"))
4100 (eq (key-binding key) 'mouse-choose-completion)))
4101 ;; If the user does mouse-choose-completion with the mouse,
4102 ;; execute the command, then delete the completion window.
4104 (mouse-choose-completion first)
4105 (set-window-configuration conf))
4107 (set-window-configuration conf)
4108 (setq unread-command-events (listify-key-sequence key)))))))
4110 ;;; I need a make-term that doesn't surround with *s -mm
4111 (defun term-ansi-make-term (name program &optional startfile &rest switches)
4112 "Make a term process NAME in a buffer, running PROGRAM.
4113 The name of the buffer is NAME.
4114 If there is already a running process in that buffer, it is not restarted.
4115 Optional third arg STARTFILE is the name of a file to send the contents of to
4116 the process. Any more args are arguments to PROGRAM."
4117 (let ((buffer (get-buffer-create name )))
4118 ;; If no process, or nuked process, crank up a new one and put buffer in
4119 ;; term mode. Otherwise, leave buffer and existing process alone.
4120 (cond ((not (term-check-proc buffer))
4123 (term-mode)) ; Install local vars, mode, keymap, ...
4124 (term-exec buffer name program startfile switches)))
4127 (defvar term-ansi-buffer-name nil)
4128 (defvar term-ansi-default-program nil)
4129 (defvar term-ansi-buffer-base-name nil)
4132 (defun ansi-term (program &optional new-buffer-name)
4133 "Start a terminal-emulator in a new buffer."
4134 (interactive (list (read-from-minibuffer "Run program: "
4135 (or explicit-shell-file-name
4140 ;; Pick the name of the new buffer.
4141 (setq term-ansi-buffer-name
4144 (if term-ansi-buffer-base-name
4145 (if (eq term-ansi-buffer-base-name t)
4146 (file-name-nondirectory program)
4147 term-ansi-buffer-base-name)
4150 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
4152 ;; In order to have more than one term active at a time
4153 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
4154 ;; for now they have the *term-ansi-term*<?> form but we'll see...
4156 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
4157 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
4159 (set-buffer term-ansi-buffer-name)
4163 ;; I wanna have find-file on C-x C-f -mm
4164 ;; your mileage may definitely vary, maybe it's better to put this in your
4167 (term-set-escape-char ?\C-x)
4169 (switch-to-buffer term-ansi-buffer-name))
4172 ;;; Converting process modes to use term mode
4173 ;;; ===========================================================================
4174 ;;; Renaming variables
4175 ;;; Most of the work is renaming variables and functions. These are the common
4177 ;;; Local variables:
4178 ;;; last-input-start term-last-input-start
4179 ;;; last-input-end term-last-input-end
4180 ;;; shell-prompt-pattern term-prompt-regexp
4181 ;;; shell-set-directory-error-hook <no equivalent>
4183 ;;; shell-set-directory <unnecessary>
4184 ;;; shell-mode-map term-mode-map
4186 ;;; shell-send-input term-send-input
4187 ;;; shell-send-eof term-delchar-or-maybe-eof
4188 ;;; kill-shell-input term-kill-input
4189 ;;; interrupt-shell-subjob term-interrupt-subjob
4190 ;;; stop-shell-subjob term-stop-subjob
4191 ;;; quit-shell-subjob term-quit-subjob
4192 ;;; kill-shell-subjob term-kill-subjob
4193 ;;; kill-output-from-shell term-kill-output
4194 ;;; show-output-from-shell term-show-output
4195 ;;; copy-last-shell-input Use term-previous-input/term-next-input
4197 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4198 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4199 ;;; Term mode does not provide functionality equivalent to
4200 ;;; shell-set-directory-error-hook; it is gone.
4202 ;;; term-last-input-start is provided for modes which want to munge
4203 ;;; the buffer after input is sent, perhaps because the inferior
4204 ;;; insists on echoing the input. The LAST-INPUT-START variable in
4205 ;;; the old shell package was used to implement a history mechanism,
4206 ;;; but you should think twice before using term-last-input-start
4207 ;;; for this; the input history ring often does the job better.
4209 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4210 ;;; *not* create the term-mode local variables in your foo-mode function.
4211 ;;; This is not modular. Instead, call term-mode, and let *it* create the
4212 ;;; necessary term-specific local variables. Then create the
4213 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4214 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4215 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
4216 ;;; get-old-input) that need to be different from the defaults. Call
4217 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4218 ;;; term-mode will take care of it. The following example, from shell.el,
4221 ;;; (defvar shell-mode-map '())
4222 ;;; (cond ((not shell-mode-map)
4223 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
4224 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4225 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4226 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4227 ;;; (define-key shell-mode-map "\M-?"
4228 ;;; 'term-dynamic-list-filename-completions)))
4230 ;;; (defun shell-mode ()
4233 ;;; (setq term-prompt-regexp shell-prompt-pattern)
4234 ;;; (setq major-mode 'shell-mode)
4235 ;;; (setq mode-name "Shell")
4236 ;;; (use-local-map shell-mode-map)
4237 ;;; (make-local-variable 'shell-directory-stack)
4238 ;;; (setq shell-directory-stack nil)
4239 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4240 ;;; (run-mode-hooks 'shell-mode-hook))
4243 ;;; Completion for term-mode users
4245 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
4246 ;;; hook to add completion functions to. Functions on this list should return
4247 ;;; non-nil if completion occurs (i.e., further completion should not occur).
4248 ;;; You could use term-dynamic-simple-complete to do the bulk of the
4253 ;;; arch-tag: eee16bc8-2cd7-4147-9534-a5694752f716
4254 ;;; term.el ends here