1 ;;; term.el --- general command interpreter in a window stuff
3 ;;; Copyright (C) 1988, 1990, 1992, 1994, 1995 Free Software Foundation, Inc.
5 ;;; Author: Per Bothner <bothner@cygnus.com>
6 ;;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
7 ;;; Keywords: processes
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Dir/Hostname tracking and ANSI colorization by
27 ;;; Marco Melgazzi <marco@techie.com>.
29 ;;; To see what I've modified and where it came from search for '-mm'
31 ;;; Speed considerations and a few caveats
32 ;;; --------------------------------------
34 ;;; While the message passing and the colorization surely introduce some
35 ;;; overhead this has became so small that IMHO is surely outweighted by
36 ;;; the benefits you get but, as usual, YMMV
38 ;;; Important caveat, when deciding the cursor/'grey keys' keycodes I had to
39 ;;; make a choice: on my Linux box this choice allows me to run all the
40 ;;; ncurses applications without problems but make these keys
41 ;;; uncomprehensible to all the cursesX programs. Your mileage may vary so
42 ;;; you may consider changing the default 'emulation'. Just search for this
43 ;;; piece of code and modify it as you like:
45 ;;; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
46 ;;; ;; For my configuration it's definitely better \eOA but YMMV. -mm
47 ;;; ;; For example: vi works with \eOA while elm wants \e[A ...
48 ;;; (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
49 ;;; (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
50 ;;; (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
51 ;;; (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
54 ;;; IMPORTANT: additions & changes
55 ;;; ------------------------------
57 ;;; With this enhanced ansi-term.el you will get a reliable mechanism of
58 ;;; directory/username/host tracking: the only drawback is that you will
59 ;;; have to modify your shell start-up script. It's worth it, believe me :).
61 ;;; When you rlogin/su/telnet and the account you access has a modified
62 ;;; startup script, you will be able to access the remote files as usual
63 ;;; with C-x C-f, if it's needed you will have to enter a password,
64 ;;; otherwise the file should get loaded straight away.
66 ;;; This is useful even if you work only on one host: it often happens that,
67 ;;; for maintenance reasons, you have to edit files 'as root': before
68 ;;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
69 ;;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
70 ;;; 'as-root'. ( If you don't want to enter the root password every time you
71 ;;; can put it in your .netrc: note that this is -not- advisable if you're
72 ;;; connected to the internet or if somebody else works on your workstation!)
74 ;;; If you use wu-ftpd you can use some of its features to avoid root ftp
75 ;;; access to the rest of the world: just put in /etc/ftphosts something like
78 ;;; allow root 127.0.0.1
80 ;;; # By default nobody can't do anything
84 ;;; ----------------------------------------
86 ;;; If, instead of 'term', you call 'ansi-term', you get multiple term
87 ;;; buffers, after every new call ansi-term opens a new *ansi-term*<xx> window,
88 ;;; where <xx> is, as usual, a number...
90 ;;; ----------------------------------------
92 ;;; With the term-buffer-maximum-size you can finally decide how many
93 ;;; scrollback lines to keep: its default is 2048 but you can change it as
96 ;;; ----------------------------------------
99 ;;; ANSI colorization should work well, I've decided to limit the interpreter
100 ;;; to five outstanding commands (like ESC [ 01;04;32;41;07m.
101 ;;; You shouldn't need more, if you do, tell me and I'll increase it. It's
102 ;;; so easy you could do it yourself...
104 ;;; Blink, is not supported. Currently it's mapped as bold.
106 ;;; Important caveat:
107 ;;; -----------------
108 ;;; if you want custom colors in term.el redefine term-default-fg-color
109 ;;; and term-default-bg-color BEFORE loading it.
111 ;;; ----------------------------------------
113 ;;; If you'd like to check out my complete configuration, you can download
114 ;;; it from http://www.polito.it/~s64912/things.html, it's ~500k in size and
115 ;;; contains my .cshrc, .emacs and my whole site-lisp subdirectory. (notice
116 ;;; that this term.el may be newer/older than the one in there, please
119 ;;; This complete configuration contains, among other things, a complete
120 ;;; rectangular marking solution (based on rect-mark.el and
121 ;;; pc-bindings.el) and should be a good example of how extensively Emacs
122 ;;; can be configured on a ppp-connected ws.
124 ;;; ----------------------------------------
128 ;;; - Add hooks to allow raw-mode keys to be configurable
129 ;;; - Which keys are better ? \eOA or \e[A ?
134 ;;; V4.0 January 1997
136 ;;; - Huge reworking of the faces code: now we only have roughly 20-30
137 ;;; faces for everything so we're even faster than the old md-term.el !
138 ;;; - Finished removing all the J-Shell code.
140 ;;; V3.0 January 1997
142 ;;; - Now all the supportable ANSI commands work well.
143 ;;; - Reworked a little the code: much less jsh-inspired stuff
147 ;;; - Now all the faces are accessed through an array: much cleaner code.
149 ;;; V2.2 November 4 1996
151 ;;; - Implemented ANSI output colorization ( a bit rough but enough for
154 ;;; - Implemented a maximum limit for the scroll buffer (stolen from
157 ;;; v2.1 October 28 1996, first public release
159 ;;; - Some new keybindings for term-char mode ( notably home/end/...)
160 ;;; - Directory, hostname and username tracking via ange-ftp
161 ;;; - Multi-term capability via the ansi-term call
163 ;;; ----------------------------------------------------------------
164 ;;; You should/could have something like this in your .emacs to take
165 ;;; full advantage of this package
167 ;;; (add-hook 'term-mode-hook
170 ;;; (setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *")
171 ;;; (make-local-variable 'mouse-yank-at-point)
172 ;;; (make-local-variable 'transient-mark-mode)
173 ;;; (setq mouse-yank-at-point t)
174 ;;; (setq transient-mark-mode nil)
175 ;;; (auto-fill-mode -1)
176 ;;; (setq tab-width 8 ))))
179 ;;; ----------------------------------------
181 ;;; If you want to use color ls the best setup is to have a different file
182 ;;; when you use eterm ( see above, mine is named .emacs_dircolors ). This
183 ;;; is necessary because some terminals, rxvt for example, need non-ansi
184 ;;; hacks to work ( for example on my rxvt white is wired to fg, and to
185 ;;; obtain normal white I have to do bold-white :)
187 ;;; ----------------------------------------
190 ;;; # Configuration file for the color ls utility
191 ;;; # This file goes in the /etc directory, and must be world readable.
192 ;;; # You can copy this file to .dir_colors in your $HOME directory to
193 ;;; # override the system defaults.
195 ;;; # COLOR needs one of these arguments: 'tty' colorizes output to ttys, but
196 ;;; # not pipes. 'all' adds color characters to all output. 'none' shuts
197 ;;; # colorization off.
201 ;;; # Below, there should be one TERM entry for each termtype that is
205 ;;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
208 ;;; # Below are the color init strings for the basic file types. A color init
209 ;;; # string consists of one or more of the following numeric codes:
210 ;;; # Attribute codes:
211 ;;; # 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
212 ;;; # Text color codes:
213 ;;; # 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
214 ;;; # Background color codes:
215 ;;; # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
216 ;;; NORMAL 00 # global default, although everything should be something.
217 ;;; FILE 00 # normal file
218 ;;; DIR 00;37 # directory
219 ;;; LINK 00;36 # symbolic link
220 ;;; FIFO 00;37 # pipe
221 ;;; SOCK 40;35 # socket
222 ;;; BLK 33;01 # block device driver
223 ;;; CHR 33;01 # character device driver
225 ;;; # This is for files with execute permission:
228 ;;; # List any file extensions like '.gz' or '.tar' that you would like ls
229 ;;; # to colorize below. Put the extension, a space, and the color init
230 ;;; # string. (and any comments you want to add after a '#')
231 ;;; .tar 01;33 # archives or compressed
240 ;;; .jpg 01;35 # image formats
247 ;;; ----------------------------------------
249 ;;; Notice: for directory/host/user tracking you need to have something
250 ;;; like this in your shell startup script ( this is for tcsh but should
251 ;;; be quite easy to port to other shells )
253 ;;; ----------------------------------------
257 ;;; set host = `hostname`
258 ;;; set date = `date`
260 ;;; # su does not change this but I'd like it to
262 ;;; set user = `whoami`
266 ;;; if ( eterm =~ $TERM ) then
268 ;;; echo --------------------------------------------------------------
270 ;;; echo Today is $date
271 ;;; echo We are on $host running $os under Emacs term mode
272 ;;; echo --------------------------------------------------------------
274 ;;; setenv EDITOR emacsclient
276 ;;; # Notice: $host and $user have been set before to 'hostname' and 'whoami'
277 ;;; # this is necessary because, f.e., certain versions of 'su' do not change
278 ;;; # $user, YMMV: if you don't want to fiddle with them define a couple
279 ;;; # of new variables and use these instead.
280 ;;; # NOTICE that there is a space between "AnSiT?" and $whatever NOTICE
282 ;;; # These are because we want the real cwd in the messages, not the login
285 ;;; set cwd_hack='$cwd'
286 ;;; set host_hack='$host'
287 ;;; set user_hack='$user'
289 ;;; # Notice that the ^[ character is an ESC, not two chars. You can
290 ;;; # get it in various ways, for example by typing
291 ;;; # echo -e '\033' > escape.file
292 ;;; # or by using your favourite editor
294 ;;; foreach temp (cd pushd)
295 ;;; alias $temp "$temp \!* ; echo '\eAnSiTc' $cwd_hack"
297 ;;; alias popd 'popd ;echo "\eAnSiTc" $cwd'
299 ;;; # Every command that can modify the user/host/directory should be aliased
300 ;;; # as follows for the tracking mechanism to work.
302 ;;; foreach temp ( rlogin telnet rsh sh ksh csh tcsh zsh bash tcl su )
303 ;;; alias $temp "$temp \!* ; echo '\eAnSiTh' $host_hack ; \
304 ;;; echo '\eAnSiTu' $user_hack ;echo '\eAnSiTc' $cwd_hack"
307 ;;; # Start up & use color ls
309 ;;; echo "\eAnSiTh" $host
310 ;;; echo "\eAnSiTu" $user
311 ;;; echo "\eAnSiTc" $cwd
313 ;;; # some housekeeping
320 ;;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
325 ;;; # Let's not clutter user space
332 ;;; Original Commentary:
333 ;;; --------------------
335 ;; The changelog is at the end of this file.
337 ;; Please send me bug reports, bug fixes, and extensions, so that I can
338 ;; merge them into the master source.
339 ;; - Per Bothner (bothner@cygnus.com)
341 ;; This file defines a general command-interpreter-in-a-buffer package
342 ;; (term mode). The idea is that you can build specific process-in-a-buffer
343 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
344 ;; This way, all these specific packages share a common base functionality,
345 ;; and a common set of bindings, which makes them easier to use (and
346 ;; saves code, implementation time, etc., etc.).
348 ;; For hints on converting existing process modes (e.g., tex-mode,
349 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
350 ;; instead of shell-mode, see the notes at the end of this file.
353 ;; Brief Command Documentation:
354 ;;============================================================================
355 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
358 ;; m-p term-previous-input Cycle backwards in input history
359 ;; m-n term-next-input Cycle forwards
360 ;; m-r term-previous-matching-input Previous input matching a regexp
361 ;; m-s comint-next-matching-input Next input that matches
362 ;; return term-send-input
363 ;; c-c c-a term-bol Beginning of line; skip prompt.
364 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
365 ;; c-c c-u term-kill-input ^u
366 ;; c-c c-w backward-kill-word ^w
367 ;; c-c c-c term-interrupt-subjob ^c
368 ;; c-c c-z term-stop-subjob ^z
369 ;; c-c c-\ term-quit-subjob ^\
370 ;; c-c c-o term-kill-output Delete last batch of process output
371 ;; c-c c-r term-show-output Show last batch of process output
372 ;; c-c c-h term-dynamic-list-input-ring List input history
374 ;; Not bound by default in term-mode
375 ;; term-send-invisible Read a line w/o echo, and send to proc
376 ;; (These are bound in shell-mode)
377 ;; term-dynamic-complete Complete filename at point.
378 ;; term-dynamic-list-completions List completions in help buffer.
379 ;; term-replace-by-expanded-filename Expand and complete filename at point;
380 ;; replace with expanded/completed name.
381 ;; term-kill-subjob No mercy.
382 ;; term-show-maximum-output Show as much output as possible.
383 ;; term-continue-subjob Send CONT signal to buffer's process
384 ;; group. Useful if you accidentally
385 ;; suspend your process (with C-c C-z).
387 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
388 ;; term-load-hook is run after loading in this package.
392 ;; This is passed to the inferior in the EMACS environment variable,
393 ;; so it is important to increase it if there are protocol-relevant changes.
394 (defconst term-protocol-version
"0.95")
402 "General command interpreter in a window"
407 ;;; Buffer Local Variables:
408 ;;;============================================================================
409 ;;; Term mode buffer local variables:
410 ;;; term-prompt-regexp - string term-bol uses to match prompt.
411 ;;; term-delimiter-argument-list - list For delimiters and arguments
412 ;;; term-last-input-start - marker Handy if inferior always echoes
413 ;;; term-last-input-end - marker For term-kill-output command
414 ;; For the input history mechanism:
415 (defvar term-input-ring-size
32 "Size of input history ring.")
416 ;;; term-input-ring-size - integer
417 ;;; term-input-ring - ring
418 ;;; term-input-ring-index - number ...
419 ;;; term-input-autoexpand - symbol ...
420 ;;; term-input-ignoredups - boolean ...
421 ;;; term-last-input-match - string ...
422 ;;; term-dynamic-complete-functions - hook For the completion mechanism
423 ;;; term-completion-fignore - list ...
424 ;;; term-get-old-input - function Hooks for specific
425 ;;; term-input-filter-functions - hook process-in-a-buffer
426 ;;; term-input-filter - function modes.
427 ;;; term-input-send - function
428 ;;; term-scroll-to-bottom-on-output - symbol ...
429 ;;; term-scroll-show-maximum-output - boolean...
430 (defvar term-height
) ;; Number of lines in window.
431 (defvar term-width
) ;; Number of columns in window.
432 (defvar term-home-marker
) ;; Marks the "home" position for cursor addressing.
433 (defvar term-saved-home-marker nil
) ;; When using alternate sub-buffer,
434 ;; contains saved term-home-marker from original sub-buffer .
435 (defvar term-start-line-column
0) ;; (current-column) at start of screen line,
436 ;; or nil if unknown.
437 (defvar term-current-column
0) ;; If non-nil, is cache for (current-column).
438 (defvar term-current-row
0) ;; Current vertical row (relative to home-marker)
439 ;; or nil if unknown.
440 (defvar term-insert-mode nil
)
441 (defvar term-vertical-motion
)
442 (defvar term-terminal-state
0) ;; State of the terminal emulator:
443 ;; state 0: Normal state
444 ;; state 1: Last character was a graphic in the last column.
445 ;; If next char is graphic, first move one column right
446 ;; (and line warp) before displaying it.
447 ;; This emulates (more or less) the behavior of xterm.
449 ;; state 3: seen ESC [ (or ESC [ ?)
450 ;; state 4: term-terminal-parameter contains pending output.
451 (defvar term-kill-echo-list nil
) ;; A queue of strings whose echo
452 ;; we want suppressed.
453 (defvar term-terminal-parameter
)
454 (defvar term-terminal-previous-parameter
)
455 (defvar term-current-face
'term-default
)
456 (defvar term-scroll-start
0) ;; Top-most line (inclusive) of scrolling region.
457 (defvar term-scroll-end
) ;; Number of line (zero-based) after scrolling region.
458 (defvar term-pager-count nil
) ;; If nil, paging is disabled.
459 ;; Otherwise, number of lines before we need to page.
460 (defvar term-saved-cursor nil
)
461 (defvar term-command-hook
)
462 (defvar term-log-buffer nil
)
463 (defvar term-scroll-with-delete nil
) ;; term-scroll-with-delete is t if
464 ;; forward scrolling should be implemented by delete to
465 ;; top-most line(s); and nil if scrolling should be implemented
466 ;; by moving term-home-marker. It is set to t iff there is a
467 ;; (non-default) scroll-region OR the alternate buffer is used.
468 (defvar term-pending-delete-marker
) ;; New user input in line mode needs to
469 ;; be deleted, because it gets echoed by the inferior.
470 ;; To reduce flicker, we defer the delete until the next output.
471 (defvar term-old-mode-map nil
) ;; Saves the old keymap when in char mode.
472 (defvar term-old-mode-line-format
) ;; Saves old mode-line-format while paging.
473 (defvar term-pager-old-local-map nil
) ;; Saves old keymap while paging.
474 (defvar term-pager-old-filter
) ;; Saved process-filter while paging.
476 (defcustom explicit-shell-file-name nil
477 "*If non-nil, is file name to use for explicitly requested inferior shell."
478 :type
'(choice (const nil
) file
)
481 (defvar term-prompt-regexp
"^"
482 "Regexp to recognise prompts in the inferior process.
483 Defaults to \"^\", the null string at BOL.
486 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
487 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
488 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
490 shell: \"^[^#$%>\\n]*[#$%>] *\"
493 This is a good thing to set in mode hooks.")
495 (defvar term-delimiter-argument-list
()
496 "List of characters to recognise as separate arguments in input.
497 Strings comprising a character in this list will separate the arguments
498 surrounding them, and also be regarded as arguments in their own right (unlike
499 whitespace). See `term-arguments'.
500 Defaults to the empty list.
502 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
504 This is a good thing to set in mode hooks.")
506 (defcustom term-input-autoexpand nil
507 "*If non-nil, expand input command history references on completion.
508 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
510 If the value is `input', then the expansion is seen on input.
511 If the value is `history', then the expansion is only when inserting
512 into the buffer's input ring. See also `term-magic-space' and
513 `term-dynamic-complete'.
515 This variable is buffer-local."
516 :type
'(choice (const nil
) (const t
) (const input
) (const history
))
519 (defcustom term-input-ignoredups nil
520 "*If non-nil, don't add input matching the last on the input ring.
521 This mirrors the optional behavior of bash.
523 This variable is buffer-local."
527 (defcustom term-input-ring-file-name nil
528 "*If non-nil, name of the file to read/write input history.
529 See also `term-read-input-ring' and `term-write-input-ring'.
531 This variable is buffer-local, and is a good thing to set in mode hooks."
535 (defcustom term-scroll-to-bottom-on-output nil
536 "*Controls whether interpreter output causes window to scroll.
537 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
538 If `this', scroll only the selected window.
539 If `others', scroll only those that are not the selected window.
543 See variable `term-scroll-show-maximum-output'.
544 This variable is buffer-local."
548 (defcustom term-scroll-show-maximum-output nil
549 "*Controls how interpreter output causes window to scroll.
550 If non-nil, then show the maximum output when the window is scrolled.
552 See variable `term-scroll-to-bottom-on-output'.
553 This variable is buffer-local."
557 ;; Where gud-display-frame should put the debugging arrow. This is
558 ;; set by the marker-filter, which scans the debugger's output for
559 ;; indications of the current pc.
560 (defvar term-pending-frame nil
)
562 ;;; Here are the per-interpreter hooks.
563 (defvar term-get-old-input
(function term-get-old-input-default
)
564 "Function that submits old text in term mode.
565 This function is called when return is typed while the point is in old text.
566 It returns the text to be submitted as process input. The default is
567 term-get-old-input-default, which grabs the current line, and strips off
568 leading text matching term-prompt-regexp")
570 (defvar term-dynamic-complete-functions
571 '(term-replace-by-expanded-history term-dynamic-complete-filename
)
572 "List of functions called to perform completion.
573 Functions should return non-nil if completion was performed.
574 See also `term-dynamic-complete'.
576 This is a good thing to set in mode hooks.")
578 (defvar term-input-filter
579 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
580 "Predicate for filtering additions to input history.
581 Only inputs answering true to this function are saved on the input
582 history list. Default is to save anything that isn't all whitespace")
584 (defvar term-input-filter-functions
'()
585 "Functions to call before input is sent to the process.
586 These functions get one argument, a string containing the text to send.
588 This variable is buffer-local.")
590 (defvar term-input-sender
(function term-simple-send
)
591 "Function to actually send to PROCESS the STRING submitted by user.
592 Usually this is just 'term-simple-send, but if your mode needs to
593 massage the input string, this is your hook. This is called from
594 the user command term-send-input. term-simple-send just sends
595 the string plus a newline.")
597 (defcustom term-eol-on-send t
598 "*Non-nil means go to the end of the line before sending input.
599 See `term-send-input'."
603 (defcustom term-mode-hook
'()
604 "Called upon entry into term-mode
605 This is run before the process is cranked up."
609 (defcustom term-exec-hook
'()
610 "Called each time a process is exec'd by term-exec.
611 This is called after the process is cranked up. It is useful for things that
612 must be done each time a process is executed in a term-mode buffer (e.g.,
613 \(process-kill-without-query)). In contrast, the term-mode-hook is only
614 executed once when the buffer is created."
618 (defvar term-mode-map nil
)
619 (defvar term-raw-map nil
620 "Keyboard map for sending characters directly to the inferior process.")
621 (defvar term-escape-char nil
622 "Escape character for char-sub-mode of term mode.
623 Do not change it directly; use term-set-escape-char instead.")
624 (defvar term-raw-escape-map nil
)
626 (defvar term-pager-break-map nil
)
629 "True if communications via pty; false if by pipe. Buffer local.
630 This is to work around a bug in Emacs process signaling.")
632 (defvar term-last-input-match
""
633 "Last string searched for by term input history search, for defaulting.
634 Buffer local variable.")
636 (defvar term-input-ring nil
)
637 (defvar term-last-input-start
)
638 (defvar term-last-input-end
)
639 (defvar term-input-ring-index nil
640 "Index of last matched history element.")
641 (defvar term-matching-input-from-input-string
""
642 "Input previously used to match input history.")
643 ; This argument to set-process-filter disables reading from the process,
644 ; assuming this is Emacs 19.20 or newer.
645 (defvar term-pager-filter t
)
647 (put 'term-replace-by-expanded-history
'menu-enable
'term-input-autoexpand
)
648 (put 'term-input-ring
'permanent-local t
)
649 (put 'term-input-ring-index
'permanent-local t
)
650 (put 'term-input-autoexpand
'permanent-local t
)
651 (put 'term-input-filter-functions
'permanent-local t
)
652 (put 'term-scroll-to-bottom-on-output
'permanent-local t
)
653 (put 'term-scroll-show-maximum-output
'permanent-local t
)
654 (put 'term-ptyp
'permanent-local t
)
656 ;; Do FORMS if running under Emacs 19 or later.
657 (defmacro term-if-emacs19
(&rest forms
)
658 (if (string-match "^\\(19\\|[2-9][0-9]\\)" emacs-version
)
659 (cons 'progn forms
)))
660 ;; True if running under XEmacs (previously Lucid Emacs).
661 (defmacro term-is-xemacs
() '(string-match "Lucid" emacs-version
))
662 ;; Do FORM if running under XEmacs (previously Lucid Emacs).
663 (defmacro term-if-xemacs
(&rest forms
)
664 (if (term-is-xemacs) (cons 'progn forms
)))
665 ;; Do FORM if NOT running under XEmacs (previously Lucid Emacs).
666 (defmacro term-ifnot-xemacs
(&rest forms
)
667 (if (not (term-is-xemacs)) (cons 'progn forms
)))
669 (defmacro term-in-char-mode
() '(eq (current-local-map) term-raw-map
))
670 (defmacro term-in-line-mode
() '(not (term-in-char-mode)))
671 ;; True if currently doing PAGER handling.
672 (defmacro term-pager-enabled
() 'term-pager-count
)
673 (defmacro term-handling-pager
() 'term-pager-old-local-map
)
674 (defmacro term-using-alternate-sub-buffer
() 'term-saved-home-marker
)
676 (defvar term-signals-menu
)
677 (defvar term-terminal-menu
)
679 ;;; Let's silence the byte-compiler -mm
680 (defvar term-ansi-at-eval-string nil
)
681 (defvar term-ansi-at-host nil
)
682 (defvar term-ansi-at-dir nil
)
683 (defvar term-ansi-at-user nil
)
684 (defvar term-ansi-at-message nil
)
685 (defvar term-ansi-at-save-user nil
)
686 (defvar term-ansi-at-save-pwd nil
)
687 (defvar term-ansi-at-save-anon nil
)
688 (defvar term-ansi-current-bold
0)
689 (defvar term-ansi-current-color
0)
690 (defvar term-ansi-face-alredy-done
0)
691 (defvar term-ansi-current-bg-color
0)
692 (defvar term-ansi-current-underline
0)
693 (defvar term-ansi-current-highlight
0)
694 (defvar term-ansi-current-reverse
0)
695 (defvar term-ansi-current-invisible
0)
696 (defvar term-ansi-default-fg
0)
697 (defvar term-ansi-default-bg
0)
698 (defvar term-ansi-current-temp
0)
699 (defvar term-ansi-fg-faces-vector nil
)
700 (defvar term-ansi-bg-faces-vector nil
)
701 (defvar term-ansi-inv-fg-faces-vector nil
)
702 (defvar term-ansi-inv-bg-faces-vector nil
)
703 (defvar term-ansi-reverse-faces-vector nil
)
705 ;;; Four should be enough, if you want more, just add. -mm
706 (defvar term-terminal-more-parameters
0)
707 (defvar term-terminal-previous-parameter-2 -
1)
708 (defvar term-terminal-previous-parameter-3 -
1)
709 (defvar term-terminal-previous-parameter-4 -
1)
714 (defmacro term-ignore-error
(&rest body
)
719 (defvar term-default-fg-color nil
)
720 (defvar term-default-bg-color nil
)
722 (when (fboundp 'make-face
)
723 ;;; --- Simple faces ---
724 (copy-face 'default
'term-default
)
725 (make-face 'term-default-fg
)
726 (make-face 'term-default-bg
)
727 (make-face 'term-default-fg-inv
)
728 (make-face 'term-default-bg-inv
)
729 (make-face 'term-bold
)
730 (make-face 'term-underline
)
731 (make-face 'term-invisible
)
732 (make-face 'term-invisible-inv
)
734 (copy-face 'default
'term-default-fg
)
735 (copy-face 'default
'term-default-bg
)
737 (set-face-foreground 'term-default-fg term-default-fg-color
))
739 (set-face-background 'term-default-bg term-default-bg-color
))
741 (copy-face 'default
'term-default-fg-inv
)
742 (copy-face 'default
'term-default-bg-inv
)
744 (set-face-foreground 'term-default-fg-inv term-default-bg-color
))
746 (set-face-background 'term-default-bg-inv term-default-fg-color
))
748 (copy-face 'default
'term-invisible
)
750 (set-face-background 'term-invisible term-default-bg-color
))
752 (copy-face 'default
'term-invisible-inv
)
754 (set-face-background 'term-invisible-inv term-default-fg-color
))
756 (copy-face 'default
'term-bold
)
757 (copy-face 'default
'term-underline
)
759 ;; Set the colors of the new faces.
761 (make-face-bold 'term-bold
))
764 (set-face-underline-p 'term-underline t
))
767 (make-face 'term-black
)
768 (make-face 'term-red
)
769 (make-face 'term-green
)
770 (make-face 'term-yellow
)
771 (make-face 'term-blue
)
772 (make-face 'term-magenta
)
773 (make-face 'term-cyan
)
774 (make-face 'term-white
)
776 (copy-face 'default
'term-black
)
778 (set-face-foreground 'term-black
"black"))
779 (copy-face 'default
'term-red
)
781 (set-face-foreground 'term-red
"red"))
782 (copy-face 'default
'term-green
)
784 (set-face-foreground 'term-green
"green"))
785 (copy-face 'default
'term-yellow
)
787 (set-face-foreground 'term-yellow
"yellow"))
788 (copy-face 'default
'term-blue
)
790 (set-face-foreground 'term-blue
"blue"))
791 (copy-face 'default
'term-magenta
)
793 (set-face-foreground 'term-magenta
"magenta"))
794 (copy-face 'default
'term-cyan
)
796 (set-face-foreground 'term-cyan
"cyan"))
797 (copy-face 'default
'term-white
)
799 (set-face-foreground 'term-white
"white"))
802 (make-face 'term-blackbg
)
803 (make-face 'term-redbg
)
804 (make-face 'term-greenbg
)
805 (make-face 'term-yellowbg
)
806 (make-face 'term-bluebg
)
807 (make-face 'term-magentabg
)
808 (make-face 'term-cyanbg
)
809 (make-face 'term-whitebg
)
811 (copy-face 'default
'term-blackbg
)
813 (set-face-background 'term-blackbg
"black"))
814 (copy-face 'default
'term-redbg
)
816 (set-face-background 'term-redbg
"red"))
817 (copy-face 'default
'term-greenbg
)
819 (set-face-background 'term-greenbg
"green"))
820 (copy-face 'default
'term-yellowbg
)
822 (set-face-background 'term-yellowbg
"yellow"))
823 (copy-face 'default
'term-bluebg
)
825 (set-face-background 'term-bluebg
"blue"))
826 (copy-face 'default
'term-magentabg
)
828 (set-face-background 'term-magentabg
"magenta"))
829 (copy-face 'default
'term-cyanbg
)
831 (set-face-background 'term-cyanbg
"cyan"))
832 (copy-face 'default
'term-whitebg
)
834 (set-face-background 'term-whitebg
"white")))
836 (defvar ansi-term-fg-faces-vector
837 [term-default-fg term-black term-red term-green term-yellow term-blue
838 term-magenta term-cyan term-white
])
840 (defvar ansi-term-bg-faces-vector
841 [term-default-bg term-blackbg term-redbg term-greenbg term-yellowbg
842 term-bluebg term-magentabg term-cyanbg term-whitebg
])
844 (defvar ansi-term-inv-bg-faces-vector
845 [term-default-fg-inv term-black term-red term-green term-yellow term-blue
846 term-magenta term-cyan term-white
])
848 (defvar ansi-term-inv-fg-faces-vector
849 [term-default-bg-inv term-blackbg term-redbg term-greenbg term-yellowbg
850 term-bluebg term-magentabg term-cyanbg term-whitebg
])
852 ;;; Inspiration came from comint.el -mm
853 (defvar term-buffer-maximum-size
2048
854 "*The maximum size in lines for term buffers.
855 Term buffers are truncated from the top to be no greater than this number.
856 Notice that a setting of 0 means 'don't truncate anything'. This variable
861 (defvar term-terminal-menu
863 [ "Character mode" term-char-mode
(term-in-line-mode)]
864 [ "Line mode" term-line-mode
(term-in-char-mode)]
865 [ "Enable paging" term-pager-toggle
(not term-pager-count
)]
866 [ "Disable paging" term-pager-toggle term-pager-count
])))
868 (put 'term-mode
'mode-class
'special
)
871 "Major mode for interacting with an inferior interpreter.
872 Interpreter name is same as buffer name, sans the asterisks.
873 In line sub-mode, return at end of buffer sends line as input,
874 while return not at end copies rest of line to end and sends it.
875 In char sub-mode, each character (except `term-escape-char`) is
878 This mode is typically customised to create inferior-lisp-mode,
879 shell-mode, etc.. This can be done by setting the hooks
880 term-input-filter-functions, term-input-filter, term-input-sender and
881 term-get-old-input to appropriate functions, and the variable
882 term-prompt-regexp to the appropriate regular expression.
884 An input history is maintained of size `term-input-ring-size', and
885 can be accessed with the commands \\[term-next-input],
886 \\[term-previous-input], and \\[term-dynamic-list-input-ring].
887 Input ring history expansion can be achieved with the commands
888 \\[term-replace-by-expanded-history] or \\[term-magic-space].
889 Input ring expansion is controlled by the variable `term-input-autoexpand',
890 and addition is controlled by the variable `term-input-ignoredups'.
892 Input to, and output from, the subprocess can cause the window to scroll to
893 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
894 and `term-scroll-to-bottom-on-output'.
896 If you accidentally suspend your process, use \\[term-continue-subjob]
901 Entry to this mode runs the hooks on term-mode-hook"
903 ;; Do not remove this. All major modes must do this.
904 (kill-all-local-variables)
905 (setq major-mode
'term-mode
)
906 (setq mode-name
"Term")
907 (use-local-map term-mode-map
)
908 (make-local-variable 'term-home-marker
)
909 (setq term-home-marker
(copy-marker 0))
910 (make-local-variable 'term-saved-home-marker
)
911 (make-local-variable 'term-height
)
912 (make-local-variable 'term-width
)
913 (setq term-width
(1- (window-width)))
914 (setq term-height
(1- (window-height)))
915 (make-local-variable 'term-terminal-parameter
)
916 (make-local-variable 'term-saved-cursor
)
917 (make-local-variable 'term-last-input-start
)
918 (setq term-last-input-start
(make-marker))
919 (make-local-variable 'term-last-input-end
)
920 (setq term-last-input-end
(make-marker))
921 (make-local-variable 'term-last-input-match
)
922 (setq term-last-input-match
"")
923 (make-local-variable 'term-prompt-regexp
) ; Don't set; default
924 (make-local-variable 'term-input-ring-size
) ; ...to global val.
925 (make-local-variable 'term-input-ring
)
926 (make-local-variable 'term-input-ring-file-name
)
927 (or (and (boundp 'term-input-ring
) term-input-ring
)
928 (setq term-input-ring
(make-ring term-input-ring-size
)))
929 (make-local-variable 'term-input-ring-index
)
930 (or (and (boundp 'term-input-ring-index
) term-input-ring-index
)
931 (setq term-input-ring-index nil
))
933 (make-local-variable 'term-command-hook
)
934 (setq term-command-hook
(symbol-function 'term-command-hook
))
936 ;;; I'm not sure these saves are necessary but, since I
937 ;;; haven't tested the whole thing on a net connected machine with
938 ;;; a properly configured ange-ftp, I've decided to be conservative
939 ;;; and put them in. -mm
941 (make-local-variable 'term-ansi-at-host
)
942 (setq term-ansi-at-host
(system-name))
944 (make-local-variable 'term-ansi-at-dir
)
945 (setq term-ansi-at-dir default-directory
)
947 (make-local-variable 'term-ansi-at-message
)
948 (setq term-ansi-at-message nil
)
950 ;;; For user tracking purposes -mm
951 (make-local-variable 'ange-ftp-default-user
)
952 (make-local-variable 'ange-ftp-default-password
)
953 (make-local-variable 'ange-ftp-generate-anonymous-password
)
955 ;;; You may want to have different scroll-back sizes -mm
956 (make-local-variable 'term-buffer-maximum-size
)
958 ;;; Of course these have to be buffer-local -mm
959 (make-local-variable 'term-ansi-current-bold
)
960 (make-local-variable 'term-ansi-current-color
)
961 (make-local-variable 'term-ansi-face-alredy-done
)
962 (make-local-variable 'term-ansi-current-bg-color
)
963 (make-local-variable 'term-ansi-current-underline
)
964 (make-local-variable 'term-ansi-current-highlight
)
965 (make-local-variable 'term-ansi-current-reverse
)
966 (make-local-variable 'term-ansi-current-invisible
)
968 (make-local-variable 'term-terminal-state
)
969 (make-local-variable 'term-kill-echo-list
)
970 (make-local-variable 'term-start-line-column
)
971 (make-local-variable 'term-current-column
)
972 (make-local-variable 'term-current-row
)
973 (make-local-variable 'term-log-buffer
)
974 (make-local-variable 'term-scroll-start
)
975 (make-local-variable 'term-scroll-end
)
976 (setq term-scroll-end term-height
)
977 (make-local-variable 'term-scroll-with-delete
)
978 (make-local-variable 'term-pager-count
)
979 (make-local-variable 'term-pager-old-local-map
)
980 (make-local-variable 'term-old-mode-map
)
981 (make-local-variable 'term-insert-mode
)
982 (make-local-variable 'term-dynamic-complete-functions
)
983 (make-local-variable 'term-completion-fignore
)
984 (make-local-variable 'term-get-old-input
)
985 (make-local-variable 'term-matching-input-from-input-string
)
986 (make-local-variable 'term-input-autoexpand
)
987 (make-local-variable 'term-input-ignoredups
)
988 (make-local-variable 'term-delimiter-argument-list
)
989 (make-local-variable 'term-input-filter-functions
)
990 (make-local-variable 'term-input-filter
)
991 (make-local-variable 'term-input-sender
)
992 (make-local-variable 'term-eol-on-send
)
993 (make-local-variable 'term-scroll-to-bottom-on-output
)
994 (make-local-variable 'term-scroll-show-maximum-output
)
995 (make-local-variable 'term-ptyp
)
996 (make-local-variable 'term-exec-hook
)
997 (make-local-variable 'term-vertical-motion
)
998 (make-local-variable 'term-pending-delete-marker
)
999 (setq term-pending-delete-marker
(make-marker))
1000 (make-local-variable 'term-current-face
)
1001 (make-local-variable 'term-pending-frame
)
1002 (setq term-pending-frame nil
)
1003 (run-hooks 'term-mode-hook
)
1006 (append current-menubar
(list term-terminal-menu
))))
1008 (setq term-input-ring
(make-ring term-input-ring-size
)))
1009 (term-update-mode-line))
1013 (setq term-mode-map
(make-sparse-keymap))
1014 (define-key term-mode-map
"\ep" 'term-previous-input
)
1015 (define-key term-mode-map
"\en" 'term-next-input
)
1016 (define-key term-mode-map
"\er" 'term-previous-matching-input
)
1017 (define-key term-mode-map
"\es" 'term-next-matching-input
)
1019 (define-key term-mode-map
[?\A-\M-r
]
1020 'term-previous-matching-input-from-input
)
1021 (define-key term-mode-map
[?\A-\M-s
] 'term-next-matching-input-from-input
))
1022 (define-key term-mode-map
"\e\C-l" 'term-show-output
)
1023 (define-key term-mode-map
"\C-m" 'term-send-input
)
1024 (define-key term-mode-map
"\C-d" 'term-delchar-or-maybe-eof
)
1025 (define-key term-mode-map
"\C-c\C-a" 'term-bol
)
1026 (define-key term-mode-map
"\C-c\C-u" 'term-kill-input
)
1027 (define-key term-mode-map
"\C-c\C-w" 'backward-kill-word
)
1028 (define-key term-mode-map
"\C-c\C-c" 'term-interrupt-subjob
)
1029 (define-key term-mode-map
"\C-c\C-z" 'term-stop-subjob
)
1030 (define-key term-mode-map
"\C-c\C-\\" 'term-quit-subjob
)
1031 (define-key term-mode-map
"\C-c\C-m" 'term-copy-old-input
)
1032 (define-key term-mode-map
"\C-c\C-o" 'term-kill-output
)
1033 (define-key term-mode-map
"\C-c\C-r" 'term-show-output
)
1034 (define-key term-mode-map
"\C-c\C-e" 'term-show-maximum-output
)
1035 (define-key term-mode-map
"\C-c\C-l" 'term-dynamic-list-input-ring
)
1036 (define-key term-mode-map
"\C-c\C-n" 'term-next-prompt
)
1037 (define-key term-mode-map
"\C-c\C-p" 'term-previous-prompt
)
1038 (define-key term-mode-map
"\C-c\C-d" 'term-send-eof
)
1039 (define-key term-mode-map
"\C-c\C-k" 'term-char-mode
)
1040 (define-key term-mode-map
"\C-c\C-j" 'term-line-mode
)
1041 (define-key term-mode-map
"\C-c\C-q" 'term-pager-toggle
)
1045 ; (define-key term-mode-map [menu-bar completion]
1046 ; (cons "Complete" (make-sparse-keymap "Complete")))
1047 ; (define-key term-mode-map [menu-bar completion complete-expand]
1048 ; '("Expand File Name" . term-replace-by-expanded-filename))
1049 ; (define-key term-mode-map [menu-bar completion complete-listing]
1050 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
1051 ; (define-key term-mode-map [menu-bar completion complete-file]
1052 ; '("Complete File Name" . term-dynamic-complete-filename))
1053 ; (define-key term-mode-map [menu-bar completion complete]
1054 ; '("Complete Before Point" . term-dynamic-complete))
1055 ; ;; Put them in the menu bar:
1056 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
1057 ; menu-bar-final-items))
1066 (setq newmap
(make-sparse-keymap "Terminal"))
1067 (define-key newmap
[terminal-pager-enable
]
1068 '("Enable paging" . term-fake-pager-enable
))
1069 (define-key newmap
[terminal-pager-disable
]
1070 '("Disable paging" . term-fake-pager-disable
))
1071 (define-key newmap
[terminal-char-mode
]
1072 '("Character mode" . term-char-mode
))
1073 (define-key newmap
[terminal-line-mode
]
1074 '("Line mode" . term-line-mode
))
1075 (setq term-terminal-menu
(cons "Terminal" newmap
))
1077 ;; completion: (line mode only)
1078 (defvar term-completion-menu
(make-sparse-keymap "Complete"))
1079 (define-key term-mode-map
[menu-bar completion
]
1080 (cons "Complete" term-completion-menu
))
1081 (define-key term-completion-menu
[complete-expand
]
1082 '("Expand File Name" . term-replace-by-expanded-filename
))
1083 (define-key term-completion-menu
[complete-listing
]
1084 '("File Completion Listing" . term-dynamic-list-filename-completions
))
1085 (define-key term-completion-menu
[menu-bar completion complete-file
]
1086 '("Complete File Name" . term-dynamic-complete-filename
))
1087 (define-key term-completion-menu
[menu-bar completion complete
]
1088 '("Complete Before Point" . term-dynamic-complete
))
1090 ;; Input history: (line mode only)
1091 (defvar term-inout-menu
(make-sparse-keymap "In/Out"))
1092 (define-key term-mode-map
[menu-bar inout
]
1093 (cons "In/Out" term-inout-menu
))
1094 (define-key term-inout-menu
[kill-output
]
1095 '("Kill Current Output Group" . term-kill-output
))
1096 (define-key term-inout-menu
[next-prompt
]
1097 '("Forward Output Group" . term-next-prompt
))
1098 (define-key term-inout-menu
[previous-prompt
]
1099 '("Backward Output Group" . term-previous-prompt
))
1100 (define-key term-inout-menu
[show-maximum-output
]
1101 '("Show Maximum Output" . term-show-maximum-output
))
1102 (define-key term-inout-menu
[show-output
]
1103 '("Show Current Output Group" . term-show-output
))
1104 (define-key term-inout-menu
[kill-input
]
1105 '("Kill Current Input" . term-kill-input
))
1106 (define-key term-inout-menu
[copy-input
]
1107 '("Copy Old Input" . term-copy-old-input
))
1108 (define-key term-inout-menu
[forward-matching-history
]
1109 '("Forward Matching Input..." . term-forward-matching-input
))
1110 (define-key term-inout-menu
[backward-matching-history
]
1111 '("Backward Matching Input..." . term-backward-matching-input
))
1112 (define-key term-inout-menu
[next-matching-history
]
1113 '("Next Matching Input..." . term-next-matching-input
))
1114 (define-key term-inout-menu
[previous-matching-history
]
1115 '("Previous Matching Input..." . term-previous-matching-input
))
1116 (define-key term-inout-menu
[next-matching-history-from-input
]
1117 '("Next Matching Current Input" . term-next-matching-input-from-input
))
1118 (define-key term-inout-menu
[previous-matching-history-from-input
]
1119 '("Previous Matching Current Input" .
1120 term-previous-matching-input-from-input
))
1121 (define-key term-inout-menu
[next-history
]
1122 '("Next Input" . term-next-input
))
1123 (define-key term-inout-menu
[previous-history
]
1124 '("Previous Input" . term-previous-input
))
1125 (define-key term-inout-menu
[list-history
]
1126 '("List Input History" . term-dynamic-list-input-ring
))
1127 (define-key term-inout-menu
[expand-history
]
1128 '("Expand History Before Point" . term-replace-by-expanded-history
))
1131 (setq newmap
(make-sparse-keymap "Signals"))
1132 (define-key newmap
[eof] '("EOF" . term-send-eof))
1133 (define-key newmap [kill] '("KILL" . term-kill-subjob))
1134 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
1135 (define-key newmap [cont] '("CONT" . term-continue-subjob))
1136 (define-key newmap [stop] '("STOP" . term-stop-subjob))
1137 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
1138 (define-key term-mode-map [menu-bar signals]
1139 (setq term-signals-menu (cons "Signals" newmap)))
1142 (defun term-reset-size (height width)
1143 (setq term-height height)
1144 (setq term-width width)
1145 (setq term-start-line-column nil)
1146 (setq term-current-row nil)
1147 (setq term-current-column nil)
1148 (term-scroll-region 0 height))
1150 ;; Recursive routine used to check if any string in term-kill-echo-list
1151 ;; matches part of the buffer before point.
1152 ;; If so, delete that matched part of the buffer - this suppresses echo.
1153 ;; Also, remove that string from the term-kill-echo-list.
1154 ;; We *also* remove any older string on the list, as a sanity measure,
1155 ;; in case something gets out of sync. (Except for type-ahead, there
1156 ;; should only be one element in the list.)
1158 (defun term-check-kill-echo-list ()
1159 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1164 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1165 (if (and (>= start (point-min))
1166 (string= str (buffer-substring start (point))))
1167 (progn (delete-backward-char len)
1168 (setq term-kill-echo-list (cdr cur))
1169 (setq term-current-column nil)
1170 (setq term-current-row nil)
1171 (setq term-start-line-column nil)
1172 (setq cur nil found t))
1173 (setq cur (cdr cur))))))
1175 (goto-char save-point)))
1178 (defun term-check-size (process)
1179 (if (or (/= term-height (1- (window-height)))
1180 (/= term-width (1- (window-width))))
1182 (term-reset-size (1- (window-height)) (1- (window-width)))
1183 (set-process-window-size process term-height term-width))))
1185 (defun term-send-raw-string (chars)
1186 (let ((proc (get-buffer-process (current-buffer))))
1188 (error "Current buffer has no process")
1189 ;; Note that (term-current-row) must be called *after*
1190 ;; (point) has been updated to (process-mark proc).
1191 (goto-char (process-mark proc))
1192 (if (term-pager-enabled)
1193 (setq term-pager-count (term-current-row)))
1194 (process-send-string proc chars))))
1196 (defun term-send-raw ()
1197 "Send the last character typed through the terminal-emulator
1198 without any interpretation."
1200 ;; Convert `return' to C-m, etc.
1201 (if (and (symbolp last-input-char)
1202 (get last-input-char 'ascii-character))
1203 (setq last-input-char (get last-input-char 'ascii-character)))
1204 (term-send-raw-string (make-string 1 last-input-char)))
1206 (defun term-send-raw-meta ()
1208 (let ((char last-input-char))
1209 (when (symbolp last-input-char)
1210 ;; Convert `return' to C-m, etc.
1211 (let ((tmp (get char 'event-symbol-elements)))
1213 (setq char (car tmp)))
1214 (when (symbolp char)
1215 (setq tmp (get char 'ascii-character))
1218 (setq char (event-basic-type char))
1219 (term-send-raw-string (if (and (numberp char)
1222 (make-string 1 char)
1223 (format "\e%c" char)))))
1225 (defun term-mouse-paste (click arg)
1226 "Insert the last stretch of killed text at the position clicked on."
1227 (interactive "e\nP")
1229 (term-send-raw-string (or (condition-case () (x-get-selection) (error ()))
1231 (error "No selection or cut buffer available"))))
1233 ;; Give temporary modes such as isearch a chance to turn off.
1234 (run-hooks 'mouse-leave-buffer-hook)
1235 (setq this-command 'yank)
1236 (term-send-raw-string (current-kill (cond
1241 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1242 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1243 ;; For example: vi works with \eOA while elm wants \e[A ...
1244 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1245 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1246 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1247 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1248 (defun term-send-home () (interactive) (term-send-raw-string "\e[1~"))
1249 (defun term-send-end () (interactive) (term-send-raw-string "\e[4~"))
1250 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1251 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1252 (defun term-send-del () (interactive) (term-send-raw-string "\C-?"))
1253 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-H"))
1255 (defun term-set-escape-char (c)
1256 "Change term-escape-char and keymaps that depend on it."
1257 (if term-escape-char
1258 (define-key term-raw-map term-escape-char 'term-send-raw))
1259 (setq c (make-string 1 c))
1260 (define-key term-raw-map c term-raw-escape-map)
1261 ;; Define standard bindings in term-raw-escape-map
1262 (define-key term-raw-escape-map "\C-x"
1263 (lookup-key (current-global-map) "\C-x"))
1264 (define-key term-raw-escape-map "\C-v"
1265 (lookup-key (current-global-map) "\C-v"))
1266 (define-key term-raw-escape-map "\C-u"
1267 (lookup-key (current-global-map) "\C-u"))
1268 (define-key term-raw-escape-map c 'term-send-raw)
1269 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
1270 ;; The keybinding for term-char-mode is needed by the menubar code.
1271 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
1272 (define-key term-raw-escape-map "\C-j" 'term-line-mode))
1274 (defun term-char-mode ()
1275 "Switch to char (\"raw\") sub-mode of term mode.
1276 Each character you type is sent directly to the inferior without
1277 intervention from Emacs, except for the escape character (usually C-c)."
1279 (if (not term-raw-map)
1280 (let* ((map (make-keymap))
1281 (esc-map (make-keymap))
1284 (define-key map (make-string 1 i) 'term-send-raw)
1285 (define-key esc-map (make-string 1 i) 'term-send-raw-meta)
1287 (define-key map "\e" esc-map)
1288 (setq term-raw-map map)
1289 (setq term-raw-escape-map
1290 (copy-keymap (lookup-key (current-global-map) "\C-x")))
1292 ;;; Added nearly all the 'grey keys' -mm
1296 (define-key term-raw-map [button2] 'term-mouse-paste))
1298 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
1299 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
1300 (define-key term-raw-map [menu-bar signals] term-signals-menu))
1301 (define-key term-raw-map [up] 'term-send-up)
1302 (define-key term-raw-map [down] 'term-send-down)
1303 (define-key term-raw-map [right] 'term-send-right)
1304 (define-key term-raw-map [left] 'term-send-left)
1305 (define-key term-raw-map [delete] 'term-send-del)
1306 (define-key term-raw-map [backspace] 'term-send-backspace)
1307 (define-key term-raw-map [home] 'term-send-home)
1308 (define-key term-raw-map [end] 'term-send-end)
1309 (define-key term-raw-map [prior] 'term-send-prior)
1310 (define-key term-raw-map [next] 'term-send-next))
1313 (term-set-escape-char ?\C-c)))
1314 ;; FIXME: Emit message? Cfr ilisp-raw-message
1315 (if (term-in-line-mode)
1317 (setq term-old-mode-map (current-local-map))
1318 (use-local-map term-raw-map)
1320 ;; Send existing partial line to inferior (without newline).
1321 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1322 (save-input-sender term-input-sender))
1323 (if (> (point) pmark)
1326 (setq term-input-sender
1327 (symbol-function 'term-send-string))
1330 (setq term-input-sender save-input-sender))))
1331 (term-update-mode-line))))
1333 (defun term-line-mode ()
1334 "Switch to line (\"cooked\") sub-mode of term mode.
1335 This means that Emacs editing commands work as normally, until
1336 you type \\[term-send-input] which sends the current line to the inferior."
1338 (if (term-in-char-mode)
1340 (use-local-map term-old-mode-map)
1341 (term-update-mode-line))))
1343 (defun term-update-mode-line ()
1344 (setq mode-line-process
1345 (if (term-in-char-mode)
1346 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
1347 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
1348 (force-mode-line-update))
1350 (defun term-check-proc (buffer)
1351 "True if there is a process associated w/buffer BUFFER, and
1352 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
1354 (let ((proc (get-buffer-process buffer)))
1355 (and proc (memq (process-status proc) '(run stop)))))
1358 (defun make-term (name program &optional startfile &rest switches)
1359 "Make a term process NAME in a buffer, running PROGRAM.
1360 The name of the buffer is made by surrounding NAME with `*'s.
1361 If there is already a running process in that buffer, it is not restarted.
1362 Optional third arg STARTFILE is the name of a file to send the contents of to
1363 the process. Any more args are arguments to PROGRAM."
1364 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1365 ;; If no process, or nuked process, crank up a new one and put buffer in
1366 ;; term mode. Otherwise, leave buffer and existing process alone.
1367 (cond ((not (term-check-proc buffer))
1370 (term-mode)) ; Install local vars, mode, keymap, ...
1371 (term-exec buffer name program startfile switches)))
1375 (defun term (program)
1376 "Start a terminal-emulator in a new buffer."
1377 (interactive (list (read-from-minibuffer "Run program: "
1378 (or explicit-shell-file-name
1382 (set-buffer (make-term "terminal" program))
1385 (switch-to-buffer "*terminal*"))
1387 (defun term-exec (buffer name command startfile switches)
1388 "Start up a process in buffer for term modes.
1389 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1390 You can use this to cheaply run a series of processes in the same term
1391 buffer. The hook term-exec-hook is run after each exec."
1394 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1395 (if proc (delete-process proc)))
1396 ;; Crank up a new process
1397 (let ((proc (term-exec-1 name buffer command switches)))
1398 (make-local-variable 'term-ptyp)
1399 (setq term-ptyp process-connection-type) ; T if pty, NIL if pipe.
1400 ;; Jump to the end, and set the process mark.
1401 (goto-char (point-max))
1402 (set-marker (process-mark proc) (point))
1403 (set-process-filter proc 'term-emulate-terminal)
1404 ;; Feed it the startfile.
1406 ;;This is guaranteed to wait long enough
1407 ;;but has bad results if the term does not prompt at all
1408 ;; (while (= size (buffer-size))
1410 ;;I hope 1 second is enough!
1412 (goto-char (point-max))
1413 (insert-file-contents startfile)
1414 (setq startfile (buffer-substring (point) (point-max)))
1415 (delete-region (point) (point-max))
1416 (term-send-string proc startfile)))
1417 (run-hooks 'term-exec-hook)
1420 ;;; Name to use for TERM.
1421 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
1422 (defvar term-term-name "eterm")
1423 ; Format string, usage:
1424 ; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1425 (defvar term-termcap-format
1426 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1427 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1428 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=\\n\
1429 :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1430 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1431 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1432 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC"
1434 "termcap capabilities supported")
1436 ;;; This auxiliary function cranks up the process for term-exec in
1437 ;;; the appropriate environment.
1439 (defun term-exec-1 (name buffer command switches)
1440 ;; We need to do an extra (fork-less) exec to run stty.
1441 ;; (This would not be needed if we had suitable Emacs primitives.)
1442 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1443 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1444 ;; Thus we add an extra dummy argument "..", and then remove it.
1445 (let ((process-environment
1448 (format "TERM=%s" term-term-name)
1449 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
1450 (format "TERMINFO=%s" data-directory)
1451 (format term-termcap-format "TERMCAP="
1452 term-term-name term-height term-width))
1453 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1454 (format "LINES=%d" term-height)
1455 (format "COLUMNS=%d" term-width))
1456 process-environment))
1457 (process-connection-type t)
1458 ;; We should suppress conversion of end-of-line format.
1459 (inhibit-eol-conversion t)
1461 (apply 'start-process name buffer
1463 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1464 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1465 term-height term-width)
1469 ;;; This should be in Emacs, but it isn't.
1470 (defun term-mem (item list &optional elt=)
1471 "Test to see if ITEM is equal to an item in LIST.
1472 Option comparison function ELT= defaults to equal."
1473 (let ((elt= (or elt= (function equal)))
1475 (while (and list (not done))
1476 (if (funcall elt= item (car list))
1478 (setq list (cdr list))))
1482 ;;; Input history processing in a buffer
1483 ;;; ===========================================================================
1484 ;;; Useful input history functions, courtesy of the Ergo group.
1486 ;;; Eleven commands:
1487 ;;; term-dynamic-list-input-ring List history in help buffer.
1488 ;;; term-previous-input Previous input...
1489 ;;; term-previous-matching-input ...matching a string.
1490 ;;; term-previous-matching-input-from-input ... matching the current input.
1491 ;;; term-next-input Next input...
1492 ;;; term-next-matching-input ...matching a string.
1493 ;;; term-next-matching-input-from-input ... matching the current input.
1494 ;;; term-backward-matching-input Backwards input...
1495 ;;; term-forward-matching-input ...matching a string.
1496 ;;; term-replace-by-expanded-history Expand history at point;
1497 ;;; replace with expanded history.
1498 ;;; term-magic-space Expand history and insert space.
1500 ;;; Three functions:
1501 ;;; term-read-input-ring Read into term-input-ring...
1502 ;;; term-write-input-ring Write to term-input-ring-file-name.
1503 ;;; term-replace-by-expanded-history-before-point Workhorse function.
1505 (defun term-read-input-ring (&optional silent)
1506 "Sets the buffer's `term-input-ring' from a history file.
1507 The name of the file is given by the variable `term-input-ring-file-name'.
1508 The history ring is of size `term-input-ring-size', regardless of file size.
1509 If `term-input-ring-file-name' is nil this function does nothing.
1511 If the optional argument SILENT is non-nil, we say nothing about a
1512 failure to read the history file.
1514 This function is useful for major mode commands and mode hooks.
1516 The structure of the history file should be one input command per line,
1517 with the most recent command last.
1518 See also `term-input-ignoredups' and `term-write-input-ring'."
1519 (cond ((or (null term-input-ring-file-name)
1520 (equal term-input-ring-file-name ""))
1522 ((not (file-readable-p term-input-ring-file-name))
1524 (message "Cannot read history file %s"
1525 term-input-ring-file-name)))
1527 (let ((history-buf (get-buffer-create " *temp*"))
1528 (file term-input-ring-file-name)
1530 (ring (make-ring term-input-ring-size)))
1533 (set-buffer history-buf)
1536 (insert-file-contents file)
1537 ;; Save restriction in case file is already visited...
1538 ;; Watch for those date stamps in history files!
1539 (goto-char (point-max))
1540 (while (and (< count term-input-ring-size)
1541 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1543 (let ((history (buffer-substring (match-beginning 1)
1545 (if (or (null term-input-ignoredups)
1547 (not (string-equal (ring-ref ring 0) history)))
1548 (ring-insert-at-beginning ring history)))
1549 (setq count (1+ count))))
1550 (kill-buffer history-buf))
1551 (setq term-input-ring ring
1552 term-input-ring-index nil)))))
1554 (defun term-write-input-ring ()
1555 "Writes the buffer's `term-input-ring' to a history file.
1556 The name of the file is given by the variable `term-input-ring-file-name'.
1557 The original contents of the file are lost if `term-input-ring' is not empty.
1558 If `term-input-ring-file-name' is nil this function does nothing.
1560 Useful within process sentinels.
1562 See also `term-read-input-ring'."
1563 (cond ((or (null term-input-ring-file-name)
1564 (equal term-input-ring-file-name "")
1565 (null term-input-ring) (ring-empty-p term-input-ring))
1567 ((not (file-writable-p term-input-ring-file-name))
1568 (message "Cannot write history file %s" term-input-ring-file-name))
1570 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1571 (ring term-input-ring)
1572 (file term-input-ring-file-name)
1573 (index (ring-length ring)))
1574 ;; Write it all out into a buffer first. Much faster, but messier,
1575 ;; than writing it one line at a time.
1577 (set-buffer history-buf)
1580 (setq index (1- index))
1581 (insert (ring-ref ring index) ?\n))
1582 (write-region (buffer-string) nil file nil 'no-message)
1583 (kill-buffer nil))))))
1586 (defun term-dynamic-list-input-ring ()
1587 "List in help buffer the buffer's input history."
1589 (if (or (not (ring-p term-input-ring))
1590 (ring-empty-p term-input-ring))
1591 (message "No history")
1593 (history-buffer " *Input History*")
1594 (index (1- (ring-length term-input-ring)))
1595 (conf (current-window-configuration)))
1596 ;; We have to build up a list ourselves from the ring vector.
1598 (setq history (cons (ring-ref term-input-ring index) history)
1600 ;; Change "completion" to "history reference"
1601 ;; to make the display accurate.
1602 (with-output-to-temp-buffer history-buffer
1603 (display-completion-list history)
1604 (set-buffer history-buffer)
1606 (while (search-backward "completion" nil 'move)
1607 (replace-match "history reference")))
1609 (message "Hit space to flush")
1610 (let ((ch (read-event)))
1612 (set-window-configuration conf)
1613 (setq unread-command-events (list ch)))))))
1616 (defun term-regexp-arg (prompt)
1617 ;; Return list of regexp and prefix arg using PROMPT.
1618 (let* (;; Don't clobber this.
1619 (last-command last-command)
1620 (regexp (read-from-minibuffer prompt nil nil nil
1621 'minibuffer-history-search-history)))
1622 (list (if (string-equal regexp "")
1623 (setcar minibuffer-history-search-history
1624 (nth 1 minibuffer-history-search-history))
1626 (prefix-numeric-value current-prefix-arg))))
1628 (defun term-search-arg (arg)
1629 ;; First make sure there is a ring and that we are after the process mark
1630 (cond ((not (term-after-pmark-p))
1631 (error "Not at command line"))
1632 ((or (null term-input-ring)
1633 (ring-empty-p term-input-ring))
1634 (error "Empty input ring"))
1636 ;; arg of zero resets search from beginning, and uses arg of 1
1637 (setq term-input-ring-index nil)
1642 (defun term-search-start (arg)
1643 ;; Index to start a directional search, starting at term-input-ring-index
1644 (if term-input-ring-index
1645 ;; If a search is running, offset by 1 in direction of arg
1646 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1647 (ring-length term-input-ring))
1648 ;; For a new search, start from beginning or end, as appropriate
1650 0 ; First elt for forward search
1651 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1653 (defun term-previous-input-string (arg)
1654 "Return the string ARG places along the input ring.
1655 Moves relative to `term-input-ring-index'."
1656 (ring-ref term-input-ring (if term-input-ring-index
1657 (mod (+ arg term-input-ring-index)
1658 (ring-length term-input-ring))
1661 (defun term-previous-input (arg)
1662 "Cycle backwards through input history."
1664 (term-previous-matching-input "." arg))
1666 (defun term-next-input (arg)
1667 "Cycle forwards through input history."
1669 (term-previous-input (- arg)))
1671 (defun term-previous-matching-input-string (regexp arg)
1672 "Return the string matching REGEXP ARG places along the input ring.
1673 Moves relative to `term-input-ring-index'."
1674 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1675 (if pos (ring-ref term-input-ring pos))))
1677 (defun term-previous-matching-input-string-position
1678 (regexp arg &optional start)
1679 "Return the index matching REGEXP ARG places along the input ring.
1680 Moves relative to START, or `term-input-ring-index'."
1681 (if (or (not (ring-p term-input-ring))
1682 (ring-empty-p term-input-ring))
1683 (error "No history"))
1684 (let* ((len (ring-length term-input-ring))
1685 (motion (if (> arg 0) 1 -1))
1686 (n (mod (- (or start (term-search-start arg)) motion) len))
1687 (tried-each-ring-item nil)
1689 ;; Do the whole search as many times as the argument says.
1690 (while (and (/= arg 0) (not tried-each-ring-item))
1693 n (mod (+ n motion) len))
1694 ;; If we haven't reached a match, step some more.
1695 (while (and (< n len) (not tried-each-ring-item)
1696 (not (string-match regexp (ring-ref term-input-ring n))))
1697 (setq n (mod (+ n motion) len)
1698 ;; If we have gone all the way around in this search.
1699 tried-each-ring-item (= n prev)))
1700 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1701 ;; Now that we know which ring element to use, if we found it, return that.
1702 (if (string-match regexp (ring-ref term-input-ring n))
1705 (defun term-previous-matching-input (regexp arg)
1706 "Search backwards through input history for match for REGEXP.
1707 \(Previous history elements are earlier commands.)
1708 With prefix argument N, search for Nth previous match.
1709 If N is negative, find the next or Nth next match."
1710 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1711 (setq arg (term-search-arg arg))
1712 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1713 ;; Has a match been found?
1716 (setq term-input-ring-index pos)
1717 (message "History item: %d" (1+ pos))
1719 ;; Can't use kill-region as it sets this-command
1720 (process-mark (get-buffer-process (current-buffer))) (point))
1721 (insert (ring-ref term-input-ring pos)))))
1723 (defun term-next-matching-input (regexp arg)
1724 "Search forwards through input history for match for REGEXP.
1725 \(Later history elements are more recent commands.)
1726 With prefix argument N, search for Nth following match.
1727 If N is negative, find the previous or Nth previous match."
1728 (interactive (term-regexp-arg "Next input matching (regexp): "))
1729 (term-previous-matching-input regexp (- arg)))
1731 (defun term-previous-matching-input-from-input (arg)
1732 "Search backwards through input history for match for current input.
1733 \(Previous history elements are earlier commands.)
1734 With prefix argument N, search for Nth previous match.
1735 If N is negative, search forwards for the -Nth following match."
1737 (if (not (memq last-command '(term-previous-matching-input-from-input
1738 term-next-matching-input-from-input)))
1739 ;; Starting a new search
1740 (setq term-matching-input-from-input-string
1742 (process-mark (get-buffer-process (current-buffer)))
1744 term-input-ring-index nil))
1745 (term-previous-matching-input
1746 (concat "^" (regexp-quote term-matching-input-from-input-string))
1749 (defun term-next-matching-input-from-input (arg)
1750 "Search forwards through input history for match for current input.
1751 \(Following history elements are more recent commands.)
1752 With prefix argument N, search for Nth following match.
1753 If N is negative, search backwards for the -Nth previous match."
1755 (term-previous-matching-input-from-input (- arg)))
1758 (defun term-replace-by-expanded-history (&optional silent)
1759 "Expand input command history references before point.
1760 Expansion is dependent on the value of `term-input-autoexpand'.
1762 This function depends on the buffer's idea of the input history, which may not
1763 match the command interpreter's idea, assuming it has one.
1765 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1766 cannot know the interpreter's idea of input line numbers, assuming it has one,
1767 it cannot expand absolute input line number references.
1769 If the optional argument SILENT is non-nil, never complain
1770 even if history reference seems erroneous.
1772 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1774 Returns t if successful."
1776 (if (and term-input-autoexpand
1777 (string-match "[!^]" (funcall term-get-old-input))
1778 (save-excursion (beginning-of-line)
1779 (looking-at term-prompt-regexp)))
1780 ;; Looks like there might be history references in the command.
1781 (let ((previous-modified-tick (buffer-modified-tick)))
1782 (message "Expanding history references...")
1783 (term-replace-by-expanded-history-before-point silent)
1784 (/= previous-modified-tick (buffer-modified-tick)))))
1787 (defun term-replace-by-expanded-history-before-point (silent)
1788 "Expand directory stack reference before point.
1789 See `term-replace-by-expanded-history'. Returns t if successful."
1791 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1792 (start (progn (term-bol nil) (point))))
1794 (skip-chars-forward "^!^"
1796 (end-of-line nil) (- (point) toend)))
1799 (end-of-line nil) (- (point) toend))))
1800 ;; This seems a bit complex. We look for references such as !!, !-num,
1801 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1802 ;; If that wasn't enough, the plings can be suffixed with argument
1803 ;; range specifiers.
1804 ;; Argument ranges are complex too, so we hive off the input line,
1805 ;; referenced with plings, with the range string to `term-args'.
1806 (setq term-input-ring-index nil)
1807 (cond ((or (= (preceding-char) ?\\)
1808 (term-within-quotes start (point)))
1809 ;; The history is quoted, or we're in quotes.
1810 (goto-char (1+ (point))))
1811 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1812 ;; We cannot know the interpreter's idea of input line numbers.
1813 (goto-char (match-end 0))
1814 (message "Absolute reference cannot be expanded"))
1815 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1816 ;; Just a number of args from `number' lines backward.
1817 (let ((number (1- (string-to-number
1818 (buffer-substring (match-beginning 1)
1820 (if (<= number (ring-length term-input-ring))
1823 (term-args (term-previous-input-string number)
1824 (match-beginning 2) (match-end 2))
1826 (setq term-input-ring-index number)
1827 (message "History item: %d" (1+ number)))
1828 (goto-char (match-end 0))
1829 (message "Relative reference exceeds input history size"))))
1830 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1831 ;; Just a number of args from the previous input line.
1833 (term-args (term-previous-input-string 0)
1834 (match-beginning 1) (match-end 1))
1836 (message "History item: previous"))
1838 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1839 ;; Most recent input starting with or containing (possibly
1840 ;; protected) string, maybe just a number of args. Phew.
1841 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1842 (mb2 (match-beginning 2)) (me2 (match-end 2))
1843 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1844 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1845 (pos (save-match-data
1846 (term-previous-matching-input-string-position
1847 (concat pref (regexp-quote exp)) 1))))
1850 (goto-char (match-end 0))
1852 (progn (message "Not found")
1854 (setq term-input-ring-index pos)
1856 (term-args (ring-ref term-input-ring pos)
1857 (match-beginning 4) (match-end 4))
1859 (message "History item: %d" (1+ pos)))))
1860 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1861 ;; Quick substitution on the previous input line.
1862 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1863 (new (buffer-substring (match-beginning 2) (match-end 2)))
1865 (replace-match (term-previous-input-string 0) t t)
1867 (goto-char (match-beginning 0))
1868 (if (not (search-forward old pos t))
1870 (error "Not found"))
1871 (replace-match new t t)
1872 (message "History item: substituted"))))
1874 (goto-char (match-end 0))))))))
1877 (defun term-magic-space (arg)
1878 "Expand input history references before point and insert ARG spaces.
1879 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1881 (term-replace-by-expanded-history)
1882 (self-insert-command arg))
1884 (defun term-within-quotes (beg end)
1885 "Return t if the number of quotes between BEG and END is odd.
1886 Quotes are single and double."
1887 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1888 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1889 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1891 (defun term-how-many-region (regexp beg end)
1892 "Return number of matches for REGEXP from BEG to END."
1897 (while (re-search-forward regexp end t)
1898 (setq count (1+ count)))))
1901 (defun term-args (string begin end)
1902 ;; From STRING, return the args depending on the range specified in the text
1903 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1904 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1907 (term-arguments string 0 nil)
1908 (let* ((range (buffer-substring
1909 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1910 (nth (cond ((string-match "^[*^]" range) 1)
1911 ((string-match "^-" range) 0)
1912 ((string-equal range "$") nil)
1913 (t (string-to-number range))))
1914 (mth (cond ((string-match "[-*$]$" range) nil)
1915 ((string-match "-" range)
1916 (string-to-number (substring range (match-end 0))))
1918 (term-arguments string nth mth)))))
1920 ;; Return a list of arguments from ARG. Break it up at the
1921 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1922 (defun term-delim-arg (arg)
1923 (if (null term-delimiter-argument-list)
1929 (let ((char (aref arg pos))
1931 (if (memq char term-delimiter-argument-list)
1932 (while (and (< pos len) (eq (aref arg pos) char))
1933 (setq pos (1+ pos)))
1934 (while (and (< pos len)
1935 (not (memq (aref arg pos)
1936 term-delimiter-argument-list)))
1937 (setq pos (1+ pos))))
1938 (setq args (cons (substring arg start pos) args))))
1941 (defun term-arguments (string nth mth)
1942 "Return from STRING the NTH to MTH arguments.
1943 NTH and/or MTH can be nil, which means the last argument.
1944 Returned arguments are separated by single spaces.
1945 We assume whitespace separates arguments, except within quotes.
1946 Also, a run of one or more of a single character
1947 in `term-delimiter-argument-list' is a separate argument.
1948 Argument 0 is the command name."
1949 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1953 ;; Build a list of all the args until we have as many as we want.
1954 (while (and (or (null mth) (<= count mth))
1955 (string-match argpart string pos))
1956 (if (and beg (= pos (match-beginning 0)))
1957 ;; It's contiguous, part of the same arg.
1958 (setq pos (match-end 0)
1959 quotes (or quotes (match-beginning 1)))
1960 ;; It's a new separate arg.
1962 ;; Put the previous arg, if there was one, onto ARGS.
1963 (setq str (substring string beg pos)
1964 args (if quotes (cons str args)
1965 (nconc (term-delim-arg str) args))
1967 (setq quotes (match-beginning 1))
1968 (setq beg (match-beginning 0))
1969 (setq pos (match-end 0))))
1971 (setq str (substring string beg pos)
1972 args (if quotes (cons str args)
1973 (nconc (term-delim-arg str) args))
1975 (let ((n (or nth (1- count)))
1976 (m (if mth (1- (- count mth)) 0)))
1978 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1981 ;;; Input processing stuff [line mode]
1984 (defun term-send-input ()
1985 "Send input to process.
1986 After the process output mark, sends all text from the process mark to
1987 point as input to the process. Before the process output mark, calls value
1988 of variable term-get-old-input to retrieve old input, copies it to the
1989 process mark, and sends it. A terminal newline is also inserted into the
1990 buffer and sent to the process. The list of function names contained in the
1991 value of `term-input-filter-functions' is called on the input before sending
1992 it. The input is entered into the input history ring, if the value of variable
1993 term-input-filter returns non-nil when called on the input.
1995 Any history reference may be expanded depending on the value of the variable
1996 `term-input-autoexpand'. The list of function names contained in the value
1997 of `term-input-filter-functions' is called on the input before sending it.
1998 The input is entered into the input history ring, if the value of variable
1999 `term-input-filter' returns non-nil when called on the input.
2001 If variable `term-eol-on-send' is non-nil, then point is moved to the
2002 end of line before sending the input.
2004 The values of `term-get-old-input', `term-input-filter-functions', and
2005 `term-input-filter' are chosen according to the command interpreter running
2006 in the buffer. E.g.,
2008 If the interpreter is the csh,
2009 term-get-old-input is the default: take the current line, discard any
2010 initial string matching regexp term-prompt-regexp.
2011 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
2012 \"popd\" commands. When it sees one, it cd's the buffer.
2013 term-input-filter is the default: returns T if the input isn't all white
2016 If the term is Lucid Common Lisp,
2017 term-get-old-input snarfs the sexp ending at point.
2018 term-input-filter-functions does nothing.
2019 term-input-filter returns NIL if the input matches input-filter-regexp,
2020 which matches (1) all whitespace (2) :a, :c, etc.
2022 Similarly for Soar, Scheme, etc."
2024 ;; Note that the input string does not include its terminal newline.
2025 (let ((proc (get-buffer-process (current-buffer))))
2026 (if (not proc) (error "Current buffer has no process")
2027 (let* ((pmark (process-mark proc))
2028 (pmark-val (marker-position pmark))
2029 (input-is-new (>= (point) pmark-val))
2030 (intxt (if input-is-new
2031 (progn (if term-eol-on-send (end-of-line))
2032 (buffer-substring pmark (point)))
2033 (funcall term-get-old-input)))
2034 (input (if (not (eq term-input-autoexpand 'input))
2035 ;; Just whatever's already there
2037 ;; Expand and leave it visible in buffer
2038 (term-replace-by-expanded-history t)
2039 (buffer-substring pmark (point))))
2040 (history (if (not (eq term-input-autoexpand 'history))
2042 ;; This is messy 'cos ultimately the original
2043 ;; functions used do insertion, rather than return
2044 ;; strings. We have to expand, then insert back.
2045 (term-replace-by-expanded-history t)
2046 (let ((copy (buffer-substring pmark (point))))
2047 (delete-region pmark (point))
2050 (if (term-pager-enabled)
2052 (goto-char (process-mark proc))
2053 (setq term-pager-count (term-current-row))))
2054 (if (and (funcall term-input-filter history)
2055 (or (null term-input-ignoredups)
2056 (not (ring-p term-input-ring))
2057 (ring-empty-p term-input-ring)
2058 (not (string-equal (ring-ref term-input-ring 0)
2060 (ring-insert term-input-ring history))
2061 (let ((functions term-input-filter-functions))
2063 (funcall (car functions) (concat input "\n"))
2064 (setq functions (cdr functions))))
2065 (setq term-input-ring-index nil)
2067 ;; Update the markers before we send the input
2068 ;; in case we get output amidst sending the input.
2069 (set-marker term-last-input-start pmark)
2070 (set-marker term-last-input-end (point))
2073 ;; Set up to delete, because inferior should echo.
2074 (if (marker-buffer term-pending-delete-marker)
2075 (delete-region term-pending-delete-marker pmark))
2076 (set-marker term-pending-delete-marker pmark-val)
2077 (set-marker (process-mark proc) (point))))
2079 (funcall term-input-sender proc input)))))
2081 (defun term-get-old-input-default ()
2082 "Default for term-get-old-input.
2083 Take the current line, and discard any initial text matching
2084 term-prompt-regexp."
2088 (let ((beg (point)))
2090 (buffer-substring beg (point)))))
2092 (defun term-copy-old-input ()
2093 "Insert after prompt old input at point as new input to be edited.
2094 Calls `term-get-old-input' to get old input."
2096 (let ((input (funcall term-get-old-input))
2097 (process (get-buffer-process (current-buffer))))
2099 (error "Current buffer has no process")
2100 (goto-char (process-mark process))
2103 (defun term-skip-prompt ()
2104 "Skip past the text matching regexp term-prompt-regexp.
2105 If this takes us past the end of the current line, don't skip at all."
2106 (let ((eol (save-excursion (end-of-line) (point))))
2107 (if (and (looking-at term-prompt-regexp)
2108 (<= (match-end 0) eol))
2109 (goto-char (match-end 0)))))
2112 (defun term-after-pmark-p ()
2113 "Is point after the process output marker?"
2114 ;; Since output could come into the buffer after we looked at the point
2115 ;; but before we looked at the process marker's value, we explicitly
2116 ;; serialise. This is just because I don't know whether or not Emacs
2117 ;; services input during execution of lisp commands.
2118 (let ((proc-pos (marker-position
2119 (process-mark (get-buffer-process (current-buffer))))))
2120 (<= proc-pos (point))))
2122 (defun term-simple-send (proc string)
2123 "Default function for sending to PROC input STRING.
2124 This just sends STRING plus a newline. To override this,
2125 set the hook TERM-INPUT-SENDER."
2126 (term-send-string proc string)
2127 (term-send-string proc "\n"))
2129 (defun term-bol (arg)
2130 "Goes to the beginning of line, then skips past the prompt, if any.
2131 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2132 -- go straight to column 0.
2134 The prompt skip is done by skipping text matching the regular expression
2135 term-prompt-regexp, a buffer local variable."
2138 (if (null arg) (term-skip-prompt)))
2140 ;;; These two functions are for entering text you don't want echoed or
2141 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
2142 ;;; Just enter m-x term-send-invisible and type in your line.
2144 (defun term-read-noecho (prompt &optional stars)
2145 "Read a single line of text from user without echoing, and return it.
2146 Prompt with argument PROMPT, a string. Optional argument STARS causes
2147 input to be echoed with '*' characters on the prompt line. Input ends with
2148 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2149 `inhibit-quit' is set because e.g. this function was called from a process
2150 filter and C-g is pressed, this function returns nil rather than a string).
2152 Note that the keystrokes comprising the text can still be recovered
2153 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2158 (cursor-in-echo-area t)
2162 (message "%s%s" prompt (make-string (length ans) ?*))
2163 (message "%s" prompt))
2164 (setq c (read-char))
2166 ;; This function may get called from a process filter, where
2167 ;; inhibit-quit is set. In later versions of Emacs read-char
2168 ;; may clear quit-flag itself and return C-g. That would make
2169 ;; it impossible to quit this loop in a simple way, so
2170 ;; re-enable it here (for backward-compatibility the check for
2171 ;; quit-flag below would still be necessary, so this seems
2172 ;; like the simplest way to do things).
2175 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2179 ((and (/= c ?\b) (/= c ?\177))
2180 (setq ans (concat ans (char-to-string c))))
2182 (setq ans (substring ans 0 -1)))))
2184 ;; Emulate a true quit, except that we have to return a value.
2186 (setq quit-flag nil)
2192 (defun term-send-invisible (str &optional proc)
2193 "Read a string without echoing.
2194 Then send it to the process running in the current buffer. A new-line
2195 is additionally sent. String is not saved on term input history list.
2196 Security bug: your string can still be temporarily recovered with
2198 (interactive "P") ; Defeat snooping via C-x esc
2199 (if (not (stringp str))
2200 (setq str (term-read-noecho "Non-echoed text: " t)))
2202 (setq proc (get-buffer-process (current-buffer))))
2203 (if (not proc) (error "Current buffer has no process")
2204 (setq term-kill-echo-list (nconc term-kill-echo-list
2206 (term-send-string proc str)
2207 (term-send-string proc "\n")))
2210 ;;; Low-level process communication
2212 (defvar term-input-chunk-size 512
2213 "*Long inputs send to term processes are broken up into chunks of this size.
2214 If your process is choking on big inputs, try lowering the value.")
2216 (defun term-send-string (proc str)
2217 "Send PROCESS the contents of STRING as input.
2218 This is equivalent to process-send-string, except that long input strings
2219 are broken up into chunks of size term-input-chunk-size. Processes
2220 are given a chance to output between chunks. This can help prevent processes
2221 from hanging when you send them long inputs on some OS's."
2222 (let* ((len (length str))
2223 (i (min len term-input-chunk-size)))
2224 (process-send-string proc (substring str 0 i))
2226 (let ((next-i (+ i term-input-chunk-size)))
2227 (accept-process-output)
2228 (process-send-string proc (substring str i (min len next-i)))
2231 (defun term-send-region (proc start end)
2232 "Sends to PROC the region delimited by START and END.
2233 This is a replacement for process-send-region that tries to keep
2234 your process from hanging on long inputs. See term-send-string."
2235 (term-send-string proc (buffer-substring start end)))
2238 ;;; Random input hackage
2240 (defun term-kill-output ()
2241 "Kill all output from interpreter since last input."
2243 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2244 (kill-region term-last-input-end pmark)
2246 (insert "*** output flushed ***\n")
2247 (set-marker pmark (point))))
2249 (defun term-show-output ()
2250 "Display start of this batch of interpreter output at top of window.
2251 Sets mark to the value of point when this command is run."
2253 (goto-char term-last-input-end)
2256 (set-window-start (selected-window) (point))
2259 (defun term-interrupt-subjob ()
2260 "Interrupt the current subjob."
2262 (interrupt-process nil term-ptyp))
2264 (defun term-kill-subjob ()
2265 "Send kill signal to the current subjob."
2267 (kill-process nil term-ptyp))
2269 (defun term-quit-subjob ()
2270 "Send quit signal to the current subjob."
2272 (quit-process nil term-ptyp))
2274 (defun term-stop-subjob ()
2275 "Stop the current subjob.
2276 WARNING: if there is no current subjob, you can end up suspending
2277 the top-level process running in the buffer. If you accidentally do
2278 this, use \\[term-continue-subjob] to resume the process. (This
2279 is not a problem with most shells, since they ignore this signal.)"
2281 (stop-process nil term-ptyp))
2283 (defun term-continue-subjob ()
2284 "Send CONT signal to process buffer's process group.
2285 Useful if you accidentally suspend the top-level process."
2287 (continue-process nil term-ptyp))
2289 (defun term-kill-input ()
2290 "Kill all text from last stuff output by interpreter to point."
2292 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2293 (p-pos (marker-position pmark)))
2294 (if (> (point) p-pos)
2295 (kill-region pmark (point)))))
2297 (defun term-delchar-or-maybe-eof (arg)
2298 "Delete ARG characters forward, or send an EOF to process if at end of
2305 (defun term-send-eof ()
2306 "Send an EOF to the current buffer's process."
2310 (defun term-backward-matching-input (regexp arg)
2311 "Search backward through buffer for match for REGEXP.
2312 Matches are searched for on lines that match `term-prompt-regexp'.
2313 With prefix argument N, search for Nth previous match.
2314 If N is negative, find the next or Nth next match."
2315 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2316 (let* ((re (concat term-prompt-regexp ".*" regexp))
2317 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2318 (if (re-search-backward re nil t arg)
2321 (progn (message "Not found")
2326 (defun term-forward-matching-input (regexp arg)
2327 "Search forward through buffer for match for REGEXP.
2328 Matches are searched for on lines that match `term-prompt-regexp'.
2329 With prefix argument N, search for Nth following match.
2330 If N is negative, find the previous or Nth previous match."
2331 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2332 (term-backward-matching-input regexp (- arg)))
2335 (defun term-next-prompt (n)
2336 "Move to end of Nth next prompt in the buffer.
2337 See `term-prompt-regexp'."
2339 (let ((paragraph-start term-prompt-regexp))
2340 (end-of-line (if (> n 0) 1 0))
2341 (forward-paragraph n)
2342 (term-skip-prompt)))
2344 (defun term-previous-prompt (n)
2345 "Move to end of Nth previous prompt in the buffer.
2346 See `term-prompt-regexp'."
2348 (term-next-prompt (- n)))
2350 ;;; Support for source-file processing commands.
2351 ;;;============================================================================
2352 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2353 ;;; commands that process files of source text (e.g. loading or compiling
2354 ;;; files). So the corresponding process-in-a-buffer modes have commands
2355 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
2356 ;;; for defining these commands.
2358 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2359 ;;; and Soar, in that they don't know anything about file extensions.
2360 ;;; So the compile/load interface gets the wrong default occasionally.
2361 ;;; The load-file/compile-file default mechanism could be smarter -- it
2362 ;;; doesn't know about the relationship between filename extensions and
2363 ;;; whether the file is source or executable. If you compile foo.lisp
2364 ;;; with compile-file, then the next load-file should use foo.bin for
2365 ;;; the default, not foo.lisp. This is tricky to do right, particularly
2366 ;;; because the extension for executable files varies so much (.o, .bin,
2367 ;;; .lbin, .mo, .vo, .ao, ...).
2370 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2373 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2374 ;;; want to save the buffer before issuing any process requests to the command
2377 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2378 ;;; for the file to process.
2380 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2381 ;;;============================================================================
2382 ;;; This function computes the defaults for the load-file and compile-file
2383 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
2385 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2386 ;;; source-file processing command, or nil if there hasn't been one yet.
2387 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
2388 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2389 ;;; Typically, (lisp-mode) or (scheme-mode).
2391 ;;; If the command is given while the cursor is inside a string, *and*
2392 ;;; the string is an existing filename, *and* the filename is not a directory,
2393 ;;; then the string is taken as default. This allows you to just position
2394 ;;; your cursor over a string that's a filename and have it taken as default.
2396 ;;; If the command is given in a file buffer whose major mode is in
2397 ;;; SOURCE-MODES, then the the filename is the default file, and the
2398 ;;; file's directory is the default directory.
2400 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2401 ;;; then the default directory & file are what was used in the last source-file
2402 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2403 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2404 ;;; is the cwd, with no default file. (\"no default file\" = nil)
2406 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2407 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2408 ;;; for Soar programs, etc.
2410 ;;; The function returns a pair: (default-directory . default-file).
2412 (defun term-source-default (previous-dir/file source-modes)
2413 (cond ((and buffer-file-name (memq major-mode source-modes))
2414 (cons (file-name-directory buffer-file-name)
2415 (file-name-nondirectory buffer-file-name)))
2418 (cons default-directory nil))))
2421 ;;; (TERM-CHECK-SOURCE fname)
2422 ;;;============================================================================
2423 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2424 ;;; process-in-a-buffer modes), this function can be called on the filename.
2425 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
2426 ;;; is queried to see if he wants to save the buffer before proceeding with
2427 ;;; the load or compile.
2429 (defun term-check-source (fname)
2430 (let ((buff (get-file-buffer fname)))
2432 (buffer-modified-p buff)
2433 (y-or-n-p (format "Save buffer %s first? "
2434 (buffer-name buff))))
2436 (let ((old-buffer (current-buffer)))
2439 (set-buffer old-buffer)))))
2442 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2443 ;;;============================================================================
2444 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2445 ;;; commands that process source files (like loading or compiling a file).
2446 ;;; It prompts for the filename, provides a default, if there is one,
2447 ;;; and returns the result filename.
2449 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2451 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2452 ;;; from the last source processing command. SOURCE-MODES is a list of major
2453 ;;; modes used to determine what file buffers contain source files. (These
2454 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2455 ;;; then the filename reader will only accept a file that exists.
2458 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2459 ;;; '(lisp-mode) t))
2461 ;;; This is pretty stupid about strings. It decides we're in a string
2462 ;;; if there's a quote on both sides of point on the current line.
2463 (defun term-extract-string ()
2464 "Returns string around POINT that starts the current line or nil."
2466 (let* ((point (point))
2467 (bol (progn (beginning-of-line) (point)))
2468 (eol (progn (end-of-line) (point)))
2469 (start (progn (goto-char point)
2470 (and (search-backward "\"" bol t)
2472 (end (progn (goto-char point)
2473 (and (search-forward "\"" eol t)
2476 (buffer-substring start end)))))
2478 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2479 (let* ((def (term-source-default prev-dir/file source-modes))
2480 (stringfile (term-extract-string))
2481 (sfile-p (and stringfile
2483 (file-exists-p stringfile)
2485 (not (file-directory-p stringfile))))
2486 (defdir (if sfile-p (file-name-directory stringfile)
2488 (deffile (if sfile-p (file-name-nondirectory stringfile)
2490 (ans (read-file-name (if deffile (format "%s(default %s) "
2494 (concat defdir deffile)
2496 (list (expand-file-name (substitute-in-file-name ans)))))
2498 ;;; I am somewhat divided on this string-default feature. It seems
2499 ;;; to violate the principle-of-least-astonishment, in that it makes
2500 ;;; the default harder to predict, so you actually have to look and see
2501 ;;; what the default really is before choosing it. This can trip you up.
2502 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
2507 ;;; Simple process query facility.
2508 ;;; ===========================================================================
2509 ;;; This function is for commands that want to send a query to the process
2510 ;;; and show the response to the user. For example, a command to get the
2511 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2512 ;;; to an inferior Common Lisp process.
2514 ;;; This simple facility just sends strings to the inferior process and pops
2515 ;;; up a window for the process buffer so you can see what the process
2516 ;;; responds with. We don't do anything fancy like try to intercept what the
2517 ;;; process responds with and put it in a pop-up window or on the message
2518 ;;; line. We just display the buffer. Low tech. Simple. Works good.
2520 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
2521 ;;; a window for the inferior process so that its response can be seen.
2522 (defun term-proc-query (proc str)
2523 (let* ((proc-buf (process-buffer proc))
2524 (proc-mark (process-mark proc)))
2525 (display-buffer proc-buf)
2526 (set-buffer proc-buf) ; but it's not the selected *window*
2527 (let ((proc-win (get-buffer-window proc-buf))
2528 (proc-pt (marker-position proc-mark)))
2529 (term-send-string proc str) ; send the query
2530 (accept-process-output proc) ; wait for some output
2531 ;; Try to position the proc window so you can see the answer.
2532 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2533 ;; I don't know why. Wizards invited to improve it.
2534 (if (not (pos-visible-in-window-p proc-pt proc-win))
2535 (let ((opoint (window-point proc-win)))
2536 (set-window-point proc-win proc-mark) (sit-for 0)
2537 (if (not (pos-visible-in-window-p opoint proc-win))
2539 (set-window-point proc-win opoint)))))))
2541 ;;; Returns the current column in the current screen line.
2542 ;;; Note: (current-column) yields column in buffer line.
2544 (defun term-horizontal-column ()
2545 (- (term-current-column) (term-start-line-column)))
2547 ;; Calls either vertical-motion or buffer-vertical-motion
2548 (defmacro term-vertical-motion (count)
2549 (list 'funcall 'term-vertical-motion count))
2551 ;; An emulation of vertical-motion that is independent of having a window.
2552 ;; Instead, it uses the term-width variable as the logical window width.
2554 (defun buffer-vertical-motion (count)
2556 (move-to-column (* term-width (/ (current-column) term-width)))
2560 (todo (+ count (/ (current-column) term-width))))
2562 ;; The loop iterates over buffer lines;
2563 ;; H is the number of screen lines in the current line, i.e.
2564 ;; the ceiling of dividing the buffer line width by term-width.
2565 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2570 (setq todo (- todo H))
2571 (forward-char) ;; Move past the ?\n
2572 (end-of-line)) ;; and on to the end of the next line.
2573 (if (and (>= todo H) (> todo 0))
2574 (+ (- count todo) H -1) ;; Hit end of buffer.
2575 (move-to-column (* todo term-width))
2577 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2580 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2584 (progn (beginning-of-line)
2586 (setq todo (- todo H))
2587 (backward-char)) ;; Move to end of previous line.
2588 (if (and (>= todo H) (> todo 0))
2589 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2590 (move-to-column (* (- H todo 1) term-width))
2593 ;;; The term-start-line-column variable is used as a cache.
2594 (defun term-start-line-column ()
2595 (cond (term-start-line-column)
2596 ((let ((save-pos (point)))
2597 (term-vertical-motion 0)
2598 (setq term-start-line-column (current-column))
2599 (goto-char save-pos)
2600 term-start-line-column))))
2602 ;;; Same as (current-column), but uses term-current-column as a cache.
2603 (defun term-current-column ()
2604 (cond (term-current-column)
2605 ((setq term-current-column (current-column)))))
2607 ;;; Move DELTA column right (or left if delta < 0).
2609 (defun term-move-columns (delta)
2610 (setq term-current-column (+ (term-current-column) delta))
2611 (move-to-column term-current-column t))
2613 ;; Insert COUNT copies of CHAR in the default face.
2614 (defun term-insert-char (char count)
2615 (let ((old-point (point)))
2616 (insert-char char count)
2617 (put-text-property old-point (point) 'face 'default)))
2619 (defun term-current-row ()
2620 (cond (term-current-row)
2621 ((setq term-current-row
2624 (narrow-to-region term-home-marker (point-max))
2625 (- (term-vertical-motion -9999))))))))
2627 (defun term-adjust-current-row-cache (delta)
2628 (if term-current-row
2629 (setq term-current-row (+ term-current-row delta))))
2631 (defun term-terminal-pos ()
2632 (save-excursion ; save-restriction
2633 (let ((save-col (term-current-column))
2635 (term-vertical-motion 0)
2636 (setq x (- save-col (current-column)))
2637 (setq y (term-vertical-motion term-height))
2640 ;;;Function that handles term messages: code by rms ( and you can see the
2641 ;;;difference ;-) -mm
2643 (defun term-handle-ansi-terminal-messages (message)
2644 ;; Is there a command here?
2645 (while (string-match "\eAnSiT.+\n" message)
2646 ;; Extract the command code and the argument.
2647 (let* ((start (match-beginning 0))
2649 (command-code (aref message (+ start 6)))
2654 (string-match "\r?\n" message
2657 ;; Delete this command from MESSAGE.
2658 (setq message (replace-match "" t t message))
2660 ;; If we recognize the type of command, set the appropriate variable.
2661 (cond ((= command-code ?c)
2662 (setq term-ansi-at-dir argument))
2663 ((= command-code ?h)
2664 (setq term-ansi-at-host argument))
2665 ((= command-code ?u)
2666 (setq term-ansi-at-user argument))
2667 ;; Otherwise ignore this one.
2671 ;; Update default-directory based on the changes this command made.
2674 (setq default-directory
2675 (file-name-as-directory
2676 (if (and (string= term-ansi-at-host (system-name))
2677 (string= term-ansi-at-user (user-real-login-name)))
2678 (expand-file-name term-ansi-at-dir)
2679 (if (string= term-ansi-at-user (user-real-login-name))
2680 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2681 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2682 term-ansi-at-dir)))))
2684 ;; I'm not sure this is necessary,
2685 ;; but it's best to be on the safe side.
2686 (if (string= term-ansi-at-host (system-name))
2688 (setq ange-ftp-default-user term-ansi-at-save-user)
2689 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2690 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2691 (setq term-ansi-at-save-user ange-ftp-default-user)
2692 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2693 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2694 (setq ange-ftp-default-user nil)
2695 (setq ange-ftp-default-password nil)
2696 (setq ange-ftp-generate-anonymous-password nil)))))
2700 ;;; Terminal emulation
2701 ;;; This is the standard process filter for term buffers.
2702 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2704 (defun term-emulate-terminal (proc str)
2705 (let* ((previous-buffer (current-buffer))
2706 (i 0) char funny count save-point save-marker old-point temp win
2707 (selected (selected-window))
2709 (str-length (length str)))
2712 (set-buffer (process-buffer proc))
2714 ;;; Let's handle the messages. -mm
2716 (setq str (term-handle-ansi-terminal-messages str))
2717 (setq str-length (length str))
2719 (if (marker-buffer term-pending-delete-marker)
2721 ;; Delete text following term-pending-delete-marker.
2722 (delete-region term-pending-delete-marker (process-mark proc))
2723 (set-marker term-pending-delete-marker nil)))
2725 (if (eq (window-buffer) (current-buffer))
2727 (setq term-vertical-motion (symbol-function 'vertical-motion))
2728 (term-check-size proc))
2729 (setq term-vertical-motion
2730 (symbol-function 'buffer-vertical-motion)))
2732 (setq save-marker (copy-marker (process-mark proc)))
2734 (if (/= (point) (process-mark proc))
2735 (progn (setq save-point (point-marker))
2736 (goto-char (process-mark proc))))
2739 ;; If the buffer is in line mode, and there is a partial
2740 ;; input line, save the line (by narrowing to leave it
2741 ;; outside the restriction ) until we're done with output.
2742 (if (and (> (point-max) (process-mark proc))
2743 (term-in-line-mode))
2744 (narrow-to-region (point-min) (process-mark proc)))
2747 (princ str term-log-buffer))
2748 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2749 (setq str (concat term-terminal-parameter str))
2750 (setq term-terminal-parameter nil)
2751 (setq str-length (length str))
2752 (setq term-terminal-state 0)))
2754 (while (< i str-length)
2755 (setq char (aref str i))
2756 (cond ((< term-terminal-state 2)
2757 ;; Look for prefix of regular chars
2759 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2761 (if (not funny) (setq funny str-length))
2763 (cond ((eq term-terminal-state 1)
2764 (term-move-columns 1)
2765 (setq term-terminal-state 0)))
2766 (setq count (- funny i))
2767 (setq temp (- (+ (term-horizontal-column) count)
2769 (cond ((<= temp 0)) ;; All count chars fit in line.
2770 ((> count temp) ;; Some chars fit.
2771 ;; This iteration, handle only what fits.
2772 (setq count (- count temp))
2773 (setq funny (+ count i)))
2774 ((or (not (or term-pager-count
2775 term-scroll-with-delete))
2776 (> (term-handle-scroll 1) 0))
2777 (term-adjust-current-row-cache 1)
2778 (setq count (min count term-width))
2779 (setq funny (+ count i))
2780 (setq term-start-line-column
2781 term-current-column))
2782 (t ;; Doing PAGER processing.
2783 (setq count 0 funny i)
2784 (setq term-current-column nil)
2785 (setq term-start-line-column nil)))
2786 (setq old-point (point))
2787 ;; In the common case that we're at the end of
2788 ;; the buffer, we can save a little work.
2789 (cond ((/= (point) (point-max))
2790 (if term-insert-mode
2791 ;; Inserting spaces, then deleting them,
2792 ;; then inserting the actual text is
2793 ;; inefficient, but it is simple, and
2794 ;; the actual overhead is miniscule.
2795 (term-insert-spaces count))
2796 (term-move-columns count)
2797 (delete-region old-point (point)))
2798 (t (setq term-current-column (+ (term-current-column) count))))
2799 (insert (substring str i funny))
2800 (put-text-property old-point (point)
2801 'face term-current-face)
2802 ;; If the last char was written in last column,
2803 ;; back up one column, but remember we did so.
2804 ;; Thus we emulate xterm/vt100-style line-wrapping.
2806 (term-move-columns -1)
2807 (setq term-terminal-state 1)))
2808 (setq i (1- funny)))
2809 ((and (setq term-terminal-state 0)
2810 (eq char ?\^I)) ; TAB
2811 ;; FIXME: Does not handle line wrap!
2812 (setq count (term-current-column))
2813 (setq count (+ count 8 (- (mod count 8))))
2814 (if (< (move-to-column count nil) count)
2815 (term-insert-char char 1))
2816 (setq term-current-column count))
2818 ;; Optimize CRLF at end of buffer:
2819 (cond ((and (< (setq temp (1+ i)) str-length)
2820 (eq (aref str temp) ?\n)
2821 (= (point) (point-max))
2822 (not (or term-pager-count
2824 term-scroll-with-delete)))
2826 (term-adjust-current-row-cache 1)
2827 (setq term-start-line-column 0)
2828 (setq term-current-column 0)
2830 (t ;; Not followed by LF or can't optimize:
2831 (term-vertical-motion 0)
2832 (setq term-current-column term-start-line-column))))
2834 (if (not (and term-kill-echo-list
2835 (term-check-kill-echo-list)))
2838 (term-move-columns -1))
2839 ((eq char ?\033) ; Escape
2840 (setq term-terminal-state 2))
2841 ((eq char 0)) ; NUL: Do nothing
2842 ((eq char ?\016)) ; Shift Out - ignored
2843 ((eq char ?\017)) ; Shift In - ignored
2847 (let ((end (string-match "\n" str i)))
2849 (progn (funcall term-command-hook
2850 (substring str (1+ i) (1- end)))
2852 (setq term-terminal-parameter
2854 (setq term-terminal-state 4)
2855 (setq i str-length))))
2856 (t ; insert char FIXME: Should never happen
2857 (term-move-columns 1)
2858 (backward-delete-char 1)
2860 ((eq term-terminal-state 2) ; Seen Esc
2861 (cond ((eq char ?\133) ;; ?\133 = ?[
2863 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2864 ;;; Note that now the init value of term-terminal-previous-parameter has
2865 ;;; been changed to -1
2867 (make-local-variable 'term-terminal-parameter)
2868 (make-local-variable 'term-terminal-previous-parameter)
2869 (make-local-variable 'term-terminal-previous-parameter-2)
2870 (make-local-variable 'term-terminal-previous-parameter-3)
2871 (make-local-variable 'term-terminal-previous-parameter-4)
2872 (make-local-variable 'term-terminal-more-parameters)
2873 (setq term-terminal-parameter 0)
2874 (setq term-terminal-previous-parameter -1)
2875 (setq term-terminal-previous-parameter-2 -1)
2876 (setq term-terminal-previous-parameter-3 -1)
2877 (setq term-terminal-previous-parameter-4 -1)
2878 (setq term-terminal-more-parameters 0)
2879 (setq term-terminal-state 3))
2880 ((eq char ?D) ;; scroll forward
2881 (term-handle-deferred-scroll)
2883 (setq term-terminal-state 0))
2884 ((eq char ?M) ;; scroll reversed
2885 (term-insert-lines 1)
2886 (setq term-terminal-state 0))
2887 ((eq char ?7) ;; Save cursor
2888 (term-handle-deferred-scroll)
2889 (setq term-saved-cursor
2890 (cons (term-current-row)
2891 (term-horizontal-column)))
2892 (setq term-terminal-state 0))
2893 ((eq char ?8) ;; Restore cursor
2894 (if term-saved-cursor
2895 (term-goto (car term-saved-cursor)
2896 (cdr term-saved-cursor)))
2897 (setq term-terminal-state 0))
2898 ((setq term-terminal-state 0))))
2899 ((eq term-terminal-state 3) ; Seen Esc [
2900 (cond ((and (>= char ?0) (<= char ?9))
2901 (setq term-terminal-parameter
2902 (+ (* 10 term-terminal-parameter) (- char ?0))))
2904 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2905 (setq term-terminal-more-parameters 1)
2906 (setq term-terminal-previous-parameter-4
2907 term-terminal-previous-parameter-3)
2908 (setq term-terminal-previous-parameter-3
2909 term-terminal-previous-parameter-2)
2910 (setq term-terminal-previous-parameter-2
2911 term-terminal-previous-parameter)
2912 (setq term-terminal-previous-parameter
2913 term-terminal-parameter)
2914 (setq term-terminal-parameter 0))
2915 ((eq char ??)) ; Ignore ?
2917 (term-handle-ansi-escape proc char)
2918 (setq term-terminal-more-parameters 0)
2919 (setq term-terminal-previous-parameter-4 -1)
2920 (setq term-terminal-previous-parameter-3 -1)
2921 (setq term-terminal-previous-parameter-2 -1)
2922 (setq term-terminal-previous-parameter -1)
2923 (setq term-terminal-state 0)))))
2924 (if (term-handling-pager)
2925 ;; Finish stuff to get ready to handle PAGER.
2927 (if (> (% (current-column) term-width) 0)
2928 (setq term-terminal-parameter
2930 ;; We're at column 0. Goto end of buffer; to compensate,
2931 ;; prepend a ?\r for later. This looks more consistent.
2933 (setq term-terminal-parameter
2934 (concat "\r" (substring str i)))
2935 (setq term-terminal-parameter (substring str (1- i)))
2936 (aset term-terminal-parameter 0 ?\r))
2937 (goto-char (point-max)))
2938 (setq term-terminal-state 4)
2939 (make-local-variable 'term-pager-old-filter)
2940 (setq term-pager-old-filter (process-filter proc))
2941 (set-process-filter proc term-pager-filter)
2942 (setq i str-length)))
2945 (if (>= (term-current-row) term-height)
2946 (term-handle-deferred-scroll))
2948 (set-marker (process-mark proc) (point))
2950 (progn (goto-char save-point)
2951 (set-marker save-point nil)))
2953 ;; Check for a pending filename-and-line number to display.
2954 ;; We do this before scrolling, because we might create a new window.
2955 (if (and term-pending-frame
2956 (eq (window-buffer selected) (current-buffer)))
2957 (progn (term-display-line (car term-pending-frame)
2958 (cdr term-pending-frame))
2959 (setq term-pending-frame nil)
2960 ;; We have created a new window, so check the window size.
2961 (term-check-size proc)))
2963 ;; Scroll each window displaying the buffer but (by default)
2964 ;; only if the point matches the process-mark we started with.
2966 ;; Avoid infinite loop in strange case where minibuffer window
2967 ;; is selected but not active.
2968 (while (window-minibuffer-p win)
2969 (setq win (next-window win nil t)))
2972 (setq win (next-window win nil t))
2973 (if (eq (window-buffer win) (process-buffer proc))
2974 (let ((scroll term-scroll-to-bottom-on-output))
2976 (if (or (= (point) save-marker)
2977 (eq scroll t) (eq scroll 'all)
2978 ;; Maybe user wants point to jump to the end.
2979 (and (eq selected win)
2980 (or (eq scroll 'this) (not save-point)))
2981 (and (eq scroll 'others)
2982 (not (eq selected win))))
2984 (goto-char term-home-marker)
2986 (goto-char (process-mark proc))
2987 (if (not (pos-visible-in-window-p (point) win))
2989 ;; Optionally scroll so that the text
2990 ;; ends at the bottom of the window.
2991 (if (and term-scroll-show-maximum-output
2992 (>= (point) (process-mark proc)))
2994 (goto-char (point-max))
2996 (not (eq win last-win))))
2998 ;;; Stolen from comint.el and adapted -mm
2999 (if (> term-buffer-maximum-size 0)
3001 (goto-char (process-mark (get-buffer-process (current-buffer))))
3002 (forward-line (- term-buffer-maximum-size))
3004 (delete-region (point-min) (point))))
3007 (set-marker save-marker nil))
3008 ;; unwind-protect cleanup-forms follow:
3009 (set-buffer previous-buffer)
3010 (select-window selected))))
3012 (defun term-handle-deferred-scroll ()
3013 (let ((count (- (term-current-row) term-height)))
3016 (goto-char term-home-marker)
3017 (term-vertical-motion (1+ count))
3018 (set-marker term-home-marker (point))
3019 (setq term-current-row (1- term-height))))))
3021 ;;; New function to deal with ansi colorized output, as you can see you can
3022 ;;; have any bold/underline/fg/bg/reverse combination. -mm
3024 (defun term-handle-colors-array (parameter)
3029 (setq term-ansi-current-bold 1))
3033 (setq term-ansi-current-underline 1))
3035 ;;; Blink (unsupported by Emacs), will be translated to bold.
3036 ;;; This may change in the future though.
3038 (setq term-ansi-current-bold 1))
3042 (setq term-ansi-current-reverse 1))
3046 (setq term-ansi-current-invisible 1))
3049 ((and (>= parameter 30) (<= parameter 37))
3050 (setq term-ansi-current-color (- parameter 29)))
3052 ;;; Reset foreground
3054 (setq term-ansi-current-color 0))
3057 ((and (>= parameter 40) (<= parameter 47))
3058 (setq term-ansi-current-bg-color (- parameter 39)))
3060 ;;; Reset background
3062 (setq term-ansi-current-bg-color 0))
3064 ;;; 0 (Reset) or unknown (reset anyway)
3066 (setq term-current-face
3067 (list 'term-default-fg 'term-default-bg))
3068 (setq term-ansi-current-underline 0)
3069 (setq term-ansi-current-bold 0)
3070 (setq term-ansi-current-reverse 0)
3071 (setq term-ansi-current-color 0)
3072 (setq term-ansi-current-invisible 0)
3073 (setq term-ansi-face-alredy-done 1)
3074 (setq term-ansi-current-bg-color 0)))
3076 ; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3077 ; term-ansi-current-underline
3078 ; term-ansi-current-reverse
3079 ; term-ansi-current-bold
3080 ; term-ansi-current-invisible
3081 ; term-ansi-face-alredy-done
3082 ; term-ansi-current-color
3083 ; term-ansi-current-bg-color)
3086 (if (= term-ansi-face-alredy-done 0)
3087 (if (= term-ansi-current-reverse 1)
3089 (if (= term-ansi-current-invisible 1)
3090 (if (= term-ansi-current-color 0)
3091 (setq term-current-face
3092 '(term-default-bg-inv term-default-fg))
3093 (setq term-current-face
3094 (list (elt ansi-term-inv-fg-faces-vector term-ansi-current-color)
3095 (elt ansi-term-inv-bg-faces-vector term-ansi-current-color))))
3096 ;; No need to bother with anything else if it's invisible
3098 (setq term-current-face
3099 (list (elt ansi-term-inv-fg-faces-vector term-ansi-current-color)
3100 (elt ansi-term-inv-bg-faces-vector term-ansi-current-bg-color)))
3101 (if (= term-ansi-current-bold 1)
3102 (setq term-current-face
3103 (append '(term-bold) term-current-face)))
3104 (if (= term-ansi-current-underline 1)
3105 (setq term-current-face
3106 (append '(term-underline) term-current-face))))))
3107 (if (= term-ansi-current-invisible 1)
3108 (if (= term-ansi-current-bg-color 0)
3109 (setq term-current-face
3110 '(term-default-fg-inv term-default-bg))
3111 (setq term-current-face
3112 (list (elt ansi-term-fg-faces-vector term-ansi-current-bg-color)
3113 (elt ansi-term-bg-faces-vector term-ansi-current-bg-color))))
3114 ;; No need to bother with anything else if it's invisible
3115 (setq term-current-face
3116 (list (elt ansi-term-fg-faces-vector term-ansi-current-color)
3117 (elt ansi-term-bg-faces-vector term-ansi-current-bg-color)))
3118 (if (= term-ansi-current-bold 1)
3119 (setq term-current-face
3120 (append '(term-bold) term-current-face)))
3121 (if (= term-ansi-current-underline 1)
3122 (setq term-current-face
3123 (append '(term-underline) term-current-face))))))
3125 ; (message "Debug %S" term-current-face)
3127 (setq term-ansi-face-alredy-done 0))
3130 ;;; Handle a character assuming (eq terminal-state 2) -
3131 ;;; i.e. we have previously seen Escape followed by ?[.
3133 (defun term-handle-ansi-escape (proc char)
3135 ((eq char ?H) ; cursor motion
3136 (if (<= term-terminal-parameter 0)
3137 (setq term-terminal-parameter 1))
3138 (if (<= term-terminal-previous-parameter 0)
3139 (setq term-terminal-previous-parameter 1))
3140 (if (> term-terminal-previous-parameter term-height)
3141 (setq term-terminal-previous-parameter term-height))
3142 (if (> term-terminal-parameter term-width)
3143 (setq term-terminal-parameter term-width))
3145 (1- term-terminal-previous-parameter)
3146 (1- term-terminal-parameter)))
3149 (term-handle-deferred-scroll)
3150 (term-down (- (max 1 term-terminal-parameter)) t))
3151 ;; \E[B - cursor down
3153 (term-down (max 1 term-terminal-parameter) t))
3154 ;; \E[C - cursor right
3156 (term-move-columns (max 1 term-terminal-parameter)))
3157 ;; \E[D - cursor left
3159 (term-move-columns (- (max 1 term-terminal-parameter))))
3160 ;; \E[J - clear to end of screen
3162 (term-erase-in-display term-terminal-parameter))
3163 ;; \E[K - clear to end of line
3165 (term-erase-in-line term-terminal-parameter))
3166 ;; \E[L - insert lines
3168 (term-insert-lines (max 1 term-terminal-parameter)))
3169 ;; \E[M - delete lines
3171 (term-delete-lines (max 1 term-terminal-parameter)))
3172 ;; \E[P - delete chars
3174 (term-delete-chars (max 1 term-terminal-parameter)))
3175 ;; \E[@ - insert spaces
3177 (term-insert-spaces (max 1 term-terminal-parameter)))
3178 ;; \E[?h - DEC Private Mode Set
3180 (cond ((eq term-terminal-parameter 4)
3181 (setq term-insert-mode t))
3182 ((eq term-terminal-parameter 47)
3183 (term-switch-to-alternate-sub-buffer t))))
3184 ;; \E[?l - DEC Private Mode Reset
3186 (cond ((eq term-terminal-parameter 4)
3187 (setq term-insert-mode nil))
3188 ((eq term-terminal-parameter 47)
3189 (term-switch-to-alternate-sub-buffer nil))))
3191 ;;; Modified to allow ansi coloring -mm
3192 ;; \E[m - Set/reset standard mode
3194 (when (= term-terminal-more-parameters 1)
3195 (if (>= term-terminal-previous-parameter-4 0)
3196 (term-handle-colors-array term-terminal-previous-parameter-4))
3197 (if (>= term-terminal-previous-parameter-3 0)
3198 (term-handle-colors-array term-terminal-previous-parameter-3))
3199 (if (>= term-terminal-previous-parameter-2 0)
3200 (term-handle-colors-array term-terminal-previous-parameter-2))
3201 (term-handle-colors-array term-terminal-previous-parameter))
3202 (term-handle-colors-array term-terminal-parameter))
3204 ;; \E[6n - Report cursor position
3206 (term-handle-deferred-scroll)
3207 (process-send-string proc
3209 (1+ (term-current-row))
3210 (1+ (term-horizontal-column)))))
3211 ;; \E[r - Set scrolling region
3214 (1- term-terminal-previous-parameter)
3215 term-terminal-parameter))
3218 (defun term-scroll-region (top bottom)
3219 "Set scrolling region.
3220 TOP is the top-most line (inclusive) of the new scrolling region,
3221 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3222 The top-most line is line 0."
3223 (setq term-scroll-start
3224 (if (or (< top 0) (>= top term-height))
3227 (setq term-scroll-end
3228 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3231 (setq term-scroll-with-delete
3232 (or (term-using-alternate-sub-buffer)
3233 (not (and (= term-scroll-start 0)
3234 (= term-scroll-end term-height))))))
3236 (defun term-switch-to-alternate-sub-buffer (set)
3237 ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3238 ;; using it, do nothing. This test is needed for some programs (including
3239 ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3240 (term-handle-deferred-scroll)
3241 (if (eq set (not (term-using-alternate-sub-buffer)))
3242 (let ((row (term-current-row))
3243 (col (term-horizontal-column)))
3245 (goto-char (point-max))
3246 (if (not (eq (preceding-char) ?\n))
3247 (term-insert-char ?\n 1))
3248 (setq term-scroll-with-delete t)
3249 (setq term-saved-home-marker (copy-marker term-home-marker))
3250 (set-marker term-home-marker (point)))
3252 (setq term-scroll-with-delete
3253 (not (and (= term-scroll-start 0)
3254 (= term-scroll-end term-height))))
3255 (set-marker term-home-marker term-saved-home-marker)
3256 (set-marker term-saved-home-marker nil)
3257 (setq term-saved-home-marker nil)
3258 (goto-char term-home-marker)))
3259 (setq term-current-column nil)
3260 (setq term-current-row 0)
3261 (term-goto row col))))
3263 ;; Default value for the symbol term-command-hook.
3265 (defun term-command-hook (string)
3266 (cond ((= (aref string 0) ?\032)
3267 ;; gdb (when invoked with -fullname) prints:
3268 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3269 (let* ((first-colon (string-match ":" string 1))
3271 (string-match ":" string (1+ first-colon)))
3272 (filename (substring string 1 first-colon))
3273 (fileline (string-to-int
3274 (substring string (1+ first-colon) second-colon))))
3275 (setq term-pending-frame (cons filename fileline))))
3276 ((= (aref string 0) ?/)
3277 (cd (substring string 1)))
3278 ;; Allowing the inferior to call functions in Emacs is
3279 ;; probably too big a security hole.
3280 ;; ((= (aref string 0) ?!)
3281 ;; (eval (car (read-from-string string 1))))
3282 (t)));; Otherwise ignore it
3284 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3285 ;; and that its line LINE is visible.
3286 ;; Put the overlay-arrow on the line LINE in that buffer.
3287 ;; This is mainly used by gdb.
3289 (defun term-display-line (true-file line)
3290 (term-display-buffer-line (find-file-noselect true-file) line))
3292 (defun term-display-buffer-line (buffer line)
3293 (let* ((window (display-buffer buffer t))
3301 (setq overlay-arrow-string "=>")
3302 (or overlay-arrow-position
3303 (setq overlay-arrow-position (make-marker)))
3304 (set-marker overlay-arrow-position (point) (current-buffer)))
3305 (cond ((or (< pos (point-min)) (> pos (point-max)))
3308 (set-window-point window overlay-arrow-position)))
3310 ;;; The buffer-local marker term-home-marker defines the "home position"
3311 ;;; (in terms of cursor motion). However, we move the term-home-marker
3312 ;;; "down" as needed so that is no more that a window-full above (point-max).
3314 (defun term-goto-home ()
3315 (term-handle-deferred-scroll)
3316 (goto-char term-home-marker)
3317 (setq term-current-row 0)
3318 (setq term-current-column (current-column))
3319 (setq term-start-line-column term-current-column))
3321 (defun term-goto (row col)
3322 (term-handle-deferred-scroll)
3323 (cond ((and term-current-row (>= row term-current-row))
3324 ;; I assume this is a worthwhile optimization.
3325 (term-vertical-motion 0)
3326 (setq term-current-column term-start-line-column)
3327 (setq row (- row term-current-row)))
3331 (term-move-columns col))
3333 ; The page is full, so enter "pager" mode, and wait for input.
3335 (defun term-process-pager ()
3336 (if (not term-pager-break-map)
3337 (let* ((map (make-keymap))
3340 ; (define-key map (make-string 1 i) 'term-send-raw)
3342 (define-key map "\e"
3343 (lookup-key (current-global-map) "\e"))
3344 (define-key map "\C-x"
3345 (lookup-key (current-global-map) "\C-x"))
3346 (define-key map "\C-u"
3347 (lookup-key (current-global-map) "\C-u"))
3348 (define-key map " " 'term-pager-page)
3349 (define-key map "\r" 'term-pager-line)
3350 (define-key map "?" 'term-pager-help)
3351 (define-key map "h" 'term-pager-help)
3352 (define-key map "b" 'term-pager-back-page)
3353 (define-key map "\177" 'term-pager-back-line)
3354 (define-key map "q" 'term-pager-discard)
3355 (define-key map "D" 'term-pager-disable)
3356 (define-key map "<" 'term-pager-bob)
3357 (define-key map ">" 'term-pager-eob)
3362 (define-key map [menu-bar terminal] term-terminal-menu)
3363 (define-key map [menu-bar signals] term-signals-menu)
3364 (setq tmp (make-sparse-keymap "More pages?"))
3365 (define-key tmp [help] '("Help" . term-pager-help))
3366 (define-key tmp [disable]
3367 '("Disable paging" . term-fake-pager-disable))
3368 (define-key tmp [discard]
3369 '("Discard remaining output" . term-pager-discard))
3370 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3371 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3372 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3373 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3374 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3375 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3376 (define-key map [menu-bar page] (cons "More pages?" tmp))
3379 (setq term-pager-break-map map)))
3380 ; (let ((process (get-buffer-process (current-buffer))))
3381 ; (stop-process process))
3382 (setq term-pager-old-local-map (current-local-map))
3383 (use-local-map term-pager-break-map)
3384 (make-local-variable 'term-old-mode-line-format)
3385 (setq term-old-mode-line-format mode-line-format)
3386 (setq mode-line-format
3387 (list "-- **MORE** "
3388 mode-line-buffer-identification
3389 " [Type ? for help] "
3391 (force-mode-line-update))
3393 (defun term-pager-line (lines)
3395 (let* ((moved (vertical-motion (1+ lines)))
3396 (deficit (- lines moved)))
3399 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3400 (recenter (1- term-height)))
3401 ((term-pager-continue deficit)))))
3403 (defun term-pager-page (arg)
3404 "Proceed past the **MORE** break, allowing the next page of output to appear"
3406 (term-pager-line (* arg term-height)))
3408 ; Pager mode command to go to beginning of buffer
3409 (defun term-pager-bob ()
3411 (goto-char (point-min))
3412 (if (= (vertical-motion term-height) term-height)
3414 (recenter (1- term-height)))
3416 ; pager mode command to go to end of buffer
3417 (defun term-pager-eob ()
3419 (goto-char term-home-marker)
3421 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3423 (defun term-pager-back-line (lines)
3425 (vertical-motion (- 1 lines))
3429 ;; Move cursor to end of window.
3430 (vertical-motion term-height)
3432 (recenter (1- term-height)))
3434 (defun term-pager-back-page (arg)
3436 (term-pager-back-line (* arg term-height)))
3438 (defun term-pager-discard ()
3440 (setq term-terminal-parameter "")
3441 (interrupt-process nil t)
3442 (term-pager-continue term-height))
3444 ; Disable pager processing.
3445 ; Only callable while in pager mode. (Contrast term-disable-pager.)
3446 (defun term-pager-disable ()
3448 (if (term-handling-pager)
3449 (term-pager-continue nil)
3450 (setq term-pager-count nil))
3451 (term-update-mode-line))
3453 ; Enable pager processing.
3454 (defun term-pager-enable ()
3456 (or (term-pager-enabled)
3457 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3458 (term-update-mode-line))
3460 (defun term-pager-toggle ()
3462 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3465 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3466 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3467 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3468 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3469 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3470 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3472 (defun term-pager-help ()
3473 "Provide help on commands available in a terminal-emulator **MORE** break"
3475 (message "Terminal-emulator pager break help...")
3478 (function (lambda ()
3479 (princ (substitute-command-keys
3480 "\\<term-pager-break-map>\
3481 Terminal-emulator MORE break.\n\
3482 Type one of the following keys:\n\n\
3483 \\[term-pager-page]\t\tMove forward one page.\n\
3484 \\[term-pager-line]\t\tMove forward one line.\n\
3485 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3486 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3487 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3488 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3489 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3490 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3491 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3492 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3493 \\{term-pager-break-map}\n\
3494 Any other key is passed through to the program
3495 running under the terminal emulator and disables pager processing until
3496 all pending output has been dealt with."))
3499 (defun term-pager-continue (new-count)
3500 (let ((process (get-buffer-process (current-buffer))))
3501 (use-local-map term-pager-old-local-map)
3502 (setq term-pager-old-local-map nil)
3503 (setq mode-line-format term-old-mode-line-format)
3504 (force-mode-line-update)
3505 (setq term-pager-count new-count)
3506 (set-process-filter process term-pager-old-filter)
3507 (funcall term-pager-old-filter process "")
3508 (continue-process process)))
3510 ;; Make sure there are DOWN blank lines below the current one.
3511 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3513 (defun term-handle-scroll (down)
3514 (let ((scroll-needed
3515 (- (+ (term-current-row) down 1) term-scroll-end)))
3516 (if (> scroll-needed 0)
3517 (let ((save-point (copy-marker (point))) (save-top))
3518 (goto-char term-home-marker)
3519 (cond (term-scroll-with-delete
3520 ;; delete scroll-needed lines at term-scroll-start
3521 (term-vertical-motion term-scroll-start)
3522 (setq save-top (point))
3523 (term-vertical-motion scroll-needed)
3524 (delete-region save-top (point))
3525 (goto-char save-point)
3526 (term-vertical-motion down)
3527 (term-adjust-current-row-cache (- scroll-needed))
3528 (setq term-current-column nil)
3529 (term-insert-char ?\n scroll-needed))
3530 ((and (numberp term-pager-count)
3531 (< (setq term-pager-count (- term-pager-count down))
3534 (term-process-pager))
3536 (term-adjust-current-row-cache (- scroll-needed))
3537 (term-vertical-motion scroll-needed)
3538 (set-marker term-home-marker (point))))
3539 (goto-char save-point)
3540 (set-marker save-point nil))))
3543 (defun term-down (down &optional check-for-scroll)
3544 "Move down DOWN screen lines vertically."
3545 (let ((start-column (term-horizontal-column)))
3546 (if (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3547 (setq down (term-handle-scroll down)))
3548 (term-adjust-current-row-cache down)
3549 (if (/= (point) (point-max))
3550 (setq down (- down (term-vertical-motion down))))
3551 ;; Extend buffer with extra blank lines if needed.
3553 (term-insert-char ?\n down)
3554 (setq term-current-column 0)
3555 (setq term-start-line-column 0))
3557 (setq term-current-column nil)
3558 (setq term-start-line-column (current-column))))
3560 (term-move-columns start-column))))
3562 ;; Assuming point is at the beginning of a screen line,
3563 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3564 ;; FIXME: Probably should be called more than it is.
3565 (defun term-unwrap-line ()
3566 (if (not (bolp)) (insert-before-markers ?\n)))
3568 (defun term-erase-in-line (kind)
3569 (if (> kind 1) ;; erase left of point
3570 (let ((cols (term-horizontal-column)) (saved-point (point)))
3571 (term-vertical-motion 0)
3572 (delete-region (point) saved-point)
3573 (term-insert-char ?\n cols)))
3574 (if (not (eq kind 1)) ;; erase right of point
3575 (let ((saved-point (point))
3576 (wrapped (and (zerop (term-horizontal-column))
3577 (not (zerop (term-current-column))))))
3578 (term-vertical-motion 1)
3579 (delete-region saved-point (point))
3580 ;; wrapped is true if we're at the beginning of screen line,
3581 ;; but not a buffer line. If we delete the current screen line
3582 ;; that will make the previous line no longer wrap, and (because
3583 ;; of the way Emacs display works) point will be at the end of
3584 ;; the previous screen line rather then the beginning of the
3585 ;; current one. To avoid that, we make sure that current line
3586 ;; contain a space, to force the previous line to continue to wrap.
3587 ;; We could do this always, but it seems preferable to not add the
3588 ;; extra space when wrapped is false.
3592 (put-text-property saved-point (point) 'face 'default)
3593 (goto-char saved-point))))
3595 (defun term-erase-in-display (kind)
3596 "Erases (that is blanks out) part of the window.
3597 If KIND is 0, erase from (point) to (point-max);
3598 if KIND is 1, erase from home to point; else erase from home to point-max.
3599 Should only be called when point is at the start of a screen line."
3600 (term-handle-deferred-scroll)
3601 (cond ((eq term-terminal-parameter 0)
3602 (delete-region (point) (point-max))
3604 ((let ((row (term-current-row))
3605 (col (term-horizontal-column))
3606 (start-region term-home-marker)
3607 (end-region (if (eq kind 1) (point) (point-max))))
3608 (delete-region start-region end-region)
3611 (term-insert-char ?\n row))
3612 (setq term-current-column nil)
3613 (setq term-current-row nil)
3614 (term-goto row col)))))
3616 (defun term-delete-chars (count)
3617 (let ((save-point (point)))
3618 (term-vertical-motion 1)
3620 (goto-char save-point)
3621 (move-to-column (+ (term-current-column) count) t)
3622 (delete-region save-point (point))))
3624 ;;; Insert COUNT spaces after point, but do not change any of
3625 ;;; following screen lines. Hence we may have to delete characters
3626 ;;; at teh end of this screen line to make room.
3628 (defun term-insert-spaces (count)
3629 (let ((save-point (point)) (save-eol))
3630 (term-vertical-motion 1)
3633 (setq save-eol (point))
3634 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3635 (if (> save-eol (point))
3636 (delete-region (point) save-eol))
3637 (goto-char save-point)
3638 (term-insert-char ? count)
3639 (goto-char save-point)))
3641 (defun term-delete-lines (lines)
3642 (let ((start (point))
3643 (save-current-column term-current-column)
3644 (save-start-line-column term-start-line-column)
3645 (save-current-row (term-current-row)))
3647 (delete-region start (point))
3648 (term-down (- term-scroll-end save-current-row lines))
3649 (term-insert-char ?\n lines)
3650 (setq term-current-column save-current-column)
3651 (setq term-start-line-column save-start-line-column)
3652 (setq term-current-row save-current-row)
3655 (defun term-insert-lines (lines)
3656 (let ((start (point))
3658 (save-current-column term-current-column)
3659 (save-start-line-column term-start-line-column)
3660 (save-current-row (term-current-row)))
3661 (term-down (- term-scroll-end save-current-row lines))
3662 (setq start-deleted (point))
3664 (delete-region start-deleted (point))
3666 (setq term-current-column save-current-column)
3667 (setq term-start-line-column save-start-line-column)
3668 (setq term-current-row save-current-row)
3669 (term-insert-char ?\n lines)
3672 (defun term-set-output-log (name)
3673 "Record raw inferior process output in a buffer."
3674 (interactive (list (if term-log-buffer
3676 (read-buffer "Record output in buffer: "
3677 (format "%s output-log"
3678 (buffer-name (current-buffer)))
3680 (if (or (null name) (equal name ""))
3681 (progn (setq term-log-buffer nil)
3682 (message "Output logging off."))
3683 (if (get-buffer name)
3686 (set-buffer (get-buffer-create name))
3688 (buffer-disable-undo (current-buffer))
3690 (setq term-log-buffer (get-buffer name))
3691 (message "Recording terminal emulator output into buffer \"%s\""
3692 (buffer-name term-log-buffer))))
3694 (defun term-stop-photo ()
3695 "Discontinue raw inferior process logging."
3697 (term-set-output-log nil))
3699 (defun term-show-maximum-output ()
3700 "Put the end of the buffer at the bottom of the window."
3702 (goto-char (point-max))
3705 ;;; Do the user's customisation...
3707 (defvar term-load-hook nil
3708 "This hook is run when term is loaded in.
3709 This is a good place to put keybindings.")
3711 (run-hooks 'term-load-hook)
3714 ;;; Filename/command/history completion in a buffer
3715 ;;; ===========================================================================
3716 ;;; Useful completion functions, courtesy of the Ergo group.
3719 ;;; term-dynamic-complete Complete or expand command, filename,
3720 ;;; history at point.
3721 ;;; term-dynamic-complete-filename Complete filename at point.
3722 ;;; term-dynamic-list-filename-completions List completions in help buffer.
3723 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
3724 ;;; replace with expanded/completed name.
3725 ;;; term-dynamic-simple-complete Complete stub given candidates.
3727 ;;; These are not installed in the term-mode keymap. But they are
3728 ;;; available for people who want them. Shell-mode installs them:
3729 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3730 ;;; (define-key shell-mode-map "\M-?"
3731 ;;; 'term-dynamic-list-filename-completions)))
3733 ;;; Commands like this are fine things to put in load hooks if you
3734 ;;; want them present in specific modes.
3736 (defvar term-completion-autolist nil
3737 "*If non-nil, automatically list possibilities on partial completion.
3738 This mirrors the optional behavior of tcsh.")
3740 (defvar term-completion-addsuffix t
3741 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3742 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3743 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3744 completion. This mirrors the optional behavior of tcsh.")
3746 (defvar term-completion-recexact nil
3747 "*If non-nil, use shortest completion if characters cannot be added.
3748 This mirrors the optional behavior of tcsh.
3750 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3752 (defvar term-completion-fignore nil
3753 "*List of suffixes to be disregarded during file completion.
3754 This mirrors the optional behavior of bash and tcsh.
3756 Note that this applies to `term-dynamic-complete-filename' only.")
3758 (defvar term-file-name-prefix ""
3759 "Prefix prepended to absolute file names taken from process input.
3760 This is used by term's and shell's completion functions, and by shell's
3761 directory tracking functions.")
3764 (defun term-directory (directory)
3765 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3766 (expand-file-name (if (file-name-absolute-p directory)
3767 (concat term-file-name-prefix directory)
3771 (defun term-word (word-chars)
3772 "Return the word of WORD-CHARS at point, or nil if non is found.
3773 Word constituents are considered to be those in WORD-CHARS, which is like the
3774 inside of a \"[...]\" (see `skip-chars-forward')."
3776 (let ((limit (point))
3777 (word (concat "[" word-chars "]"))
3778 (non-word (concat "[^" word-chars "]")))
3779 (if (re-search-backward non-word nil 'move)
3781 ;; Anchor the search forwards.
3782 (if (or (eolp) (looking-at non-word))
3784 (re-search-forward (concat word "+") limit)
3785 (buffer-substring (match-beginning 0) (match-end 0))))))
3788 (defun term-match-partial-filename ()
3789 "Return the filename at point, or nil if non is found.
3790 Environment variables are substituted. See `term-word'."
3791 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3792 (and filename (substitute-in-file-name filename))))
3795 (defun term-dynamic-complete ()
3796 "Dynamically perform completion at point.
3797 Calls the functions in `term-dynamic-complete-functions' to perform
3798 completion until a function returns non-nil, at which point completion is
3799 assumed to have occurred."
3801 (let ((functions term-dynamic-complete-functions))
3802 (while (and functions (null (funcall (car functions))))
3803 (setq functions (cdr functions)))))
3806 (defun term-dynamic-complete-filename ()
3807 "Dynamically complete the filename at point.
3808 Completes if after a filename. See `term-match-partial-filename' and
3809 `term-dynamic-complete-as-filename'.
3810 This function is similar to `term-replace-by-expanded-filename', except that
3811 it won't change parts of the filename already entered in the buffer; it just
3812 adds completion characters to the end of the filename. A completions listing
3813 may be shown in a help buffer if completion is ambiguous.
3815 Completion is dependent on the value of `term-completion-addsuffix',
3816 `term-completion-recexact' and `term-completion-fignore', and the timing of
3817 completions listing is dependent on the value of `term-completion-autolist'.
3819 Returns t if successful."
3821 (if (term-match-partial-filename)
3822 (prog2 (or (eq (selected-window) (minibuffer-window))
3823 (message "Completing file name..."))
3824 (term-dynamic-complete-as-filename))))
3826 (defun term-dynamic-complete-as-filename ()
3827 "Dynamically complete at point as a filename.
3828 See `term-dynamic-complete-filename'. Returns t if successful."
3829 (let* ((completion-ignore-case nil)
3830 (completion-ignored-extensions term-completion-fignore)
3832 (dirsuffix (cond ((not term-completion-addsuffix) "")
3833 ((not (consp term-completion-addsuffix)) "/")
3834 (t (car term-completion-addsuffix))))
3835 (filesuffix (cond ((not term-completion-addsuffix) "")
3836 ((not (consp term-completion-addsuffix)) " ")
3837 (t (cdr term-completion-addsuffix))))
3838 (filename (or (term-match-partial-filename) ""))
3839 (pathdir (file-name-directory filename))
3840 (pathnondir (file-name-nondirectory filename))
3841 (directory (if pathdir (term-directory pathdir) default-directory))
3842 (completion (file-name-completion pathnondir directory))
3843 (mini-flag (eq (selected-window) (minibuffer-window))))
3844 (cond ((null completion)
3845 (message "No completions of %s" filename)
3847 ((eq completion t) ; Means already completed "file".
3848 (if term-completion-addsuffix (insert " "))
3849 (or mini-flag (message "Sole completion")))
3850 ((string-equal completion "") ; Means completion on "directory/".
3851 (term-dynamic-list-filename-completions))
3852 (t ; Completion string returned.
3853 (let ((file (concat (file-name-as-directory directory) completion)))
3854 (insert (substring (directory-file-name completion)
3855 (length pathnondir)))
3856 (cond ((symbolp (file-name-completion completion directory))
3857 ;; We inserted a unique completion.
3858 (insert (if (file-directory-p file) dirsuffix filesuffix))
3859 (or mini-flag (message "Completed")))
3860 ((and term-completion-recexact term-completion-addsuffix
3861 (string-equal pathnondir completion)
3862 (file-exists-p file))
3863 ;; It's not unique, but user wants shortest match.
3864 (insert (if (file-directory-p file) dirsuffix filesuffix))
3865 (or mini-flag (message "Completed shortest")))
3866 ((or term-completion-autolist
3867 (string-equal pathnondir completion))
3868 ;; It's not unique, list possible completions.
3869 (term-dynamic-list-filename-completions))
3871 (or mini-flag (message "Partially completed")))))))
3875 (defun term-replace-by-expanded-filename ()
3876 "Dynamically expand and complete the filename at point.
3877 Replace the filename with an expanded, canonicalised and completed replacement.
3878 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
3879 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
3880 removed, and the filename is made absolute instead of relative. For expansion
3881 see `expand-file-name' and `substitute-in-file-name'. For completion see
3882 `term-dynamic-complete-filename'."
3884 (replace-match (expand-file-name (term-match-partial-filename)) t t)
3885 (term-dynamic-complete-filename))
3888 (defun term-dynamic-simple-complete (stub candidates)
3889 "Dynamically complete STUB from CANDIDATES list.
3890 This function inserts completion characters at point by completing STUB from
3891 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3892 if completion is ambiguous.
3894 Returns nil if no completion was inserted.
3895 Returns `sole' if completed with the only completion match.
3896 Returns `shortest' if completed with the shortest of the completion matches.
3897 Returns `partial' if completed as far as possible with the completion matches.
3898 Returns `listed' if a completion listing was shown.
3900 See also `term-dynamic-complete-filename'."
3901 (let* ((completion-ignore-case nil)
3902 (candidates (mapcar (function (lambda (x) (list x))) candidates))
3903 (completions (all-completions stub candidates)))
3904 (cond ((null completions)
3905 (message "No completions of %s" stub)
3907 ((= 1 (length completions)) ; Gotcha!
3908 (let ((completion (car completions)))
3909 (if (string-equal completion stub)
3910 (message "Sole completion")
3911 (insert (substring completion (length stub)))
3912 (message "Completed"))
3913 (if term-completion-addsuffix (insert " "))
3915 (t ; There's no unique completion.
3916 (let ((completion (try-completion stub candidates)))
3917 ;; Insert the longest substring.
3918 (insert (substring completion (length stub)))
3919 (cond ((and term-completion-recexact term-completion-addsuffix
3920 (string-equal stub completion)
3921 (member completion completions))
3922 ;; It's not unique, but user wants shortest match.
3924 (message "Completed shortest")
3926 ((or term-completion-autolist
3927 (string-equal stub completion))
3928 ;; It's not unique, list possible completions.
3929 (term-dynamic-list-completions completions)
3932 (message "Partially completed")
3936 (defun term-dynamic-list-filename-completions ()
3937 "List in help buffer possible completions of the filename at point."
3939 (let* ((completion-ignore-case nil)
3940 (filename (or (term-match-partial-filename) ""))
3941 (pathdir (file-name-directory filename))
3942 (pathnondir (file-name-nondirectory filename))
3943 (directory (if pathdir (term-directory pathdir) default-directory))
3944 (completions (file-name-all-completions pathnondir directory)))
3946 (term-dynamic-list-completions completions)
3947 (message "No completions of %s" filename))))
3950 (defun term-dynamic-list-completions (completions)
3951 "List in help buffer sorted COMPLETIONS.
3952 Typing SPC flushes the help buffer."
3953 (let ((conf (current-window-configuration)))
3954 (with-output-to-temp-buffer "*Completions*"
3955 (display-completion-list (sort completions 'string-lessp)))
3956 (message "Hit space to flush")
3959 (set-buffer (get-buffer "*Completions*"))
3960 (setq key (read-key-sequence nil)
3963 (eq (window-buffer (posn-window (event-start first)))
3964 (get-buffer "*Completions*"))
3965 (eq (key-binding key) 'mouse-choose-completion)))
3966 ;; If the user does mouse-choose-completion with the mouse,
3967 ;; execute the command, then delete the completion window.
3969 (mouse-choose-completion first)
3970 (set-window-configuration conf))
3972 (set-window-configuration conf)
3973 (setq unread-command-events (listify-key-sequence key)))))))
3975 ;;; I need a make-term that doesn't surround with *s -mm
3976 (defun term-ansi-make-term (name program &optional startfile &rest switches)
3977 "Make a term process NAME in a buffer, running PROGRAM.
3978 The name of the buffer is NAME.
3979 If there is already a running process in that buffer, it is not restarted.
3980 Optional third arg STARTFILE is the name of a file to send the contents of to
3981 the process. Any more args are arguments to PROGRAM."
3982 (let ((buffer (get-buffer-create name )))
3983 ;; If no process, or nuked process, crank up a new one and put buffer in
3984 ;; term mode. Otherwise, leave buffer and existing process alone.
3985 (cond ((not (term-check-proc buffer))
3988 (term-mode)) ; Install local vars, mode, keymap, ...
3989 (term-exec buffer name program startfile switches)))
3992 (defvar term-ansi-buffer-name nil)
3993 (defvar term-ansi-default-program nil)
3994 (defvar term-ansi-buffer-base-name nil)
3997 (defun ansi-term (program &optional new-buffer-name)
3998 "Start a terminal-emulator in a new buffer."
3999 (interactive (list (read-from-minibuffer "Run program: "
4000 (or explicit-shell-file-name
4005 ;; Pick the name of the new buffer.
4006 (setq term-ansi-buffer-name
4009 (if term-ansi-buffer-base-name
4010 (if (eq term-ansi-buffer-base-name t)
4011 (file-name-nondirectory program)
4012 term-ansi-buffer-base-name)
4015 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
4017 ;; In order to have more than one term active at a time
4018 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
4019 ;; for now they have the *term-ansi-term*<?> form but we'll see...
4021 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
4022 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
4024 (set-buffer term-ansi-buffer-name)
4028 ;; I wanna have find-file on C-x C-f -mm
4029 ;; your mileage may definitely vary, maybe it's better to put this in your
4032 (term-set-escape-char ?\C-x)
4034 (switch-to-buffer term-ansi-buffer-name))
4037 ;;; Converting process modes to use term mode
4038 ;;; ===========================================================================
4039 ;;; Renaming variables
4040 ;;; Most of the work is renaming variables and functions. These are the common
4042 ;;; Local variables:
4043 ;;; last-input-start term-last-input-start
4044 ;;; last-input-end term-last-input-end
4045 ;;; shell-prompt-pattern term-prompt-regexp
4046 ;;; shell-set-directory-error-hook <no equivalent>
4048 ;;; shell-set-directory <unnecessary>
4049 ;;; shell-mode-map term-mode-map
4051 ;;; shell-send-input term-send-input
4052 ;;; shell-send-eof term-delchar-or-maybe-eof
4053 ;;; kill-shell-input term-kill-input
4054 ;;; interrupt-shell-subjob term-interrupt-subjob
4055 ;;; stop-shell-subjob term-stop-subjob
4056 ;;; quit-shell-subjob term-quit-subjob
4057 ;;; kill-shell-subjob term-kill-subjob
4058 ;;; kill-output-from-shell term-kill-output
4059 ;;; show-output-from-shell term-show-output
4060 ;;; copy-last-shell-input Use term-previous-input/term-next-input
4062 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4063 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4064 ;;; Term mode does not provide functionality equivalent to
4065 ;;; shell-set-directory-error-hook; it is gone.
4067 ;;; term-last-input-start is provided for modes which want to munge
4068 ;;; the buffer after input is sent, perhaps because the inferior
4069 ;;; insists on echoing the input. The LAST-INPUT-START variable in
4070 ;;; the old shell package was used to implement a history mechanism,
4071 ;;; but you should think twice before using term-last-input-start
4072 ;;; for this; the input history ring often does the job better.
4074 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4075 ;;; *not* create the term-mode local variables in your foo-mode function.
4076 ;;; This is not modular. Instead, call term-mode, and let *it* create the
4077 ;;; necessary term-specific local variables. Then create the
4078 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4079 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4080 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
4081 ;;; get-old-input) that need to be different from the defaults. Call
4082 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4083 ;;; term-mode will take care of it. The following example, from shell.el,
4086 ;;; (defvar shell-mode-map '())
4087 ;;; (cond ((not shell-mode-map)
4088 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
4089 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4090 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4091 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4092 ;;; (define-key shell-mode-map "\M-?"
4093 ;;; 'term-dynamic-list-filename-completions)))
4095 ;;; (defun shell-mode ()
4098 ;;; (setq term-prompt-regexp shell-prompt-pattern)
4099 ;;; (setq major-mode 'shell-mode)
4100 ;;; (setq mode-name "Shell")
4101 ;;; (use-local-map shell-mode-map)
4102 ;;; (make-local-variable 'shell-directory-stack)
4103 ;;; (setq shell-directory-stack nil)
4104 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4105 ;;; (run-hooks 'shell-mode-hook))
4108 ;;; Completion for term-mode users
4110 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
4111 ;;; hook to add completion functions to. Functions on this list should return
4112 ;;; non-nil if completion occurs (i.e., further completion should not occur).
4113 ;;; You could use term-dynamic-simple-complete to do the bulk of the
4118 ;;; term.el ends here