Doc fix for just-one-space change. Document it in NEWS.
[emacs.git] / lisp / term.el
blob9c5115921651b2161f04af9e79cc7660d5ab2b03
1 ;;; term.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1994, 1995, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Per Bothner <per@bothner.com>
8 ;; Maintainer: Dan Nicolaescu <dann@ics.uci.edu>, Per Bothner <per@bothner.com>
9 ;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
10 ;; Keywords: processes
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; Marck 13 2001
28 ;; Fixes for CJK support by Yong Lu <lyongu@yahoo.com>.
30 ;; Dir/Hostname tracking and ANSI colorization by
31 ;; Marco Melgazzi <marco@techie.com>.
33 ;; To see what I've modified and where it came from search for '-mm'
35 ;;; Commentary:
37 ;; Speed considerations and a few caveats
38 ;; --------------------------------------
40 ;; While the message passing and the colorization surely introduce some
41 ;; overhead this has became so small that IMHO is surely outweighted by
42 ;; the benefits you get but, as usual, YMMV
44 ;; Important caveat, when deciding the cursor/'grey keys' keycodes I had to
45 ;; make a choice: on my Linux box this choice allows me to run all the
46 ;; ncurses applications without problems but make these keys
47 ;; uncomprehensible to all the cursesX programs. Your mileage may vary so
48 ;; you may consider changing the default 'emulation'. Just search for this
49 ;; piece of code and modify it as you like:
51 ;; ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
52 ;; ;; For my configuration it's definitely better \eOA but YMMV. -mm
53 ;; ;; For example: vi works with \eOA while elm wants \e[A ...
54 ;; (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
55 ;; (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
56 ;; (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
57 ;; (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
60 ;; IMPORTANT: additions & changes
61 ;; ------------------------------
63 ;; With this enhanced ansi-term.el you will get a reliable mechanism of
64 ;; directory/username/host tracking: the only drawback is that you will
65 ;; have to modify your shell start-up script. It's worth it, believe me :).
67 ;; When you rlogin/su/telnet and the account you access has a modified
68 ;; startup script, you will be able to access the remote files as usual
69 ;; with C-x C-f, if it's needed you will have to enter a password,
70 ;; otherwise the file should get loaded straight away.
72 ;; This is useful even if you work only on one host: it often happens that,
73 ;; for maintenance reasons, you have to edit files 'as root': before
74 ;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
75 ;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
76 ;; 'as-root'. ( If you don't want to enter the root password every time you
77 ;; can put it in your .netrc: note that this is -not- advisable if you're
78 ;; connected to the internet or if somebody else works on your workstation!)
80 ;; If you use wu-ftpd you can use some of its features to avoid root ftp
81 ;; access to the rest of the world: just put in /etc/ftphosts something like
83 ;; # Local access
84 ;; allow root 127.0.0.1
86 ;; # By default nobody can't do anything
87 ;; deny root *
90 ;; ----------------------------------------
92 ;; If, instead of 'term', you call 'ansi-term', you get multiple term
93 ;; buffers, after every new call ansi-term opens a new *ansi-term*<xx> window,
94 ;; where <xx> is, as usual, a number...
96 ;; ----------------------------------------
98 ;; With the term-buffer-maximum-size you can finally decide how many
99 ;; scrollback lines to keep: its default is 2048 but you can change it as
100 ;; usual.
102 ;; ----------------------------------------
105 ;; ANSI colorization should work well, I've decided to limit the interpreter
106 ;; to five outstanding commands (like ESC [ 01;04;32;41;07m.
107 ;; You shouldn't need more, if you do, tell me and I'll increase it. It's
108 ;; so easy you could do it yourself...
110 ;; Blink, is not supported. Currently it's mapped as bold.
112 ;; Important caveat:
113 ;; -----------------
114 ;; if you want custom colors in term.el redefine term-default-fg-color
115 ;; and term-default-bg-color BEFORE loading it.
117 ;; ----------------------------------------
119 ;; If you'd like to check out my complete configuration, you can download
120 ;; it from http://www.polito.it/~s64912/things.html, it's ~500k in size and
121 ;; contains my .cshrc, .emacs and my whole site-lisp subdirectory. (notice
122 ;; that this term.el may be newer/older than the one in there, please
123 ;; check!)
125 ;; This complete configuration contains, among other things, a complete
126 ;; rectangular marking solution (based on rect-mark.el and
127 ;; pc-bindings.el) and should be a good example of how extensively Emacs
128 ;; can be configured on a ppp-connected ws.
130 ;; ----------------------------------------
132 ;; TODO:
134 ;; - Add hooks to allow raw-mode keys to be configurable
135 ;; - Which keys are better ? \eOA or \e[A ?
138 ;; Changes:
140 ;; V4.0 January 1997
142 ;; - Huge reworking of the faces code: now we only have roughly 20-30
143 ;; faces for everything so we're even faster than the old md-term.el !
144 ;; - Finished removing all the J-Shell code.
146 ;; V3.0 January 1997
148 ;; - Now all the supportable ANSI commands work well.
149 ;; - Reworked a little the code: much less jsh-inspired stuff
151 ;; V2.3 November
153 ;; - Now all the faces are accessed through an array: much cleaner code.
155 ;; V2.2 November 4 1996
157 ;; - Implemented ANSI output colorization ( a bit rough but enough for
158 ;; color_ls )
160 ;; - Implemented a maximum limit for the scroll buffer (stolen from
161 ;; comint.el)
163 ;; v2.1 October 28 1996, first public release
165 ;; - Some new keybindings for term-char mode ( notably home/end/...)
166 ;; - Directory, hostname and username tracking via ange-ftp
167 ;; - Multi-term capability via the ansi-term call
169 ;; ----------------------------------------------------------------
170 ;; You should/could have something like this in your .emacs to take
171 ;; full advantage of this package
173 ;; (add-hook 'term-mode-hook
174 ;; (function
175 ;; (lambda ()
176 ;; (setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *")
177 ;; (make-local-variable 'mouse-yank-at-point)
178 ;; (make-local-variable 'transient-mark-mode)
179 ;; (setq mouse-yank-at-point t)
180 ;; (setq transient-mark-mode nil)
181 ;; (auto-fill-mode -1)
182 ;; (setq tab-width 8 ))))
185 ;; ----------------------------------------
187 ;; If you want to use color ls the best setup is to have a different file
188 ;; when you use eterm ( see above, mine is named .emacs_dircolors ). This
189 ;; is necessary because some terminals, rxvt for example, need non-ansi
190 ;; hacks to work ( for example on my rxvt white is wired to fg, and to
191 ;; obtain normal white I have to do bold-white :)
193 ;; ----------------------------------------
196 ;; # Configuration file for the color ls utility
197 ;; # This file goes in the /etc directory, and must be world readable.
198 ;; # You can copy this file to .dir_colors in your $HOME directory to
199 ;; # override the system defaults.
201 ;; # COLOR needs one of these arguments: 'tty' colorizes output to ttys, but
202 ;; # not pipes. 'all' adds color characters to all output. 'none' shuts
203 ;; # colorization off.
204 ;; COLOR tty
205 ;; OPTIONS -F
207 ;; # Below, there should be one TERM entry for each termtype that is
208 ;; # colorizable
209 ;; TERM eterm
211 ;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
212 ;; EIGHTBIT 1
214 ;; # Below are the color init strings for the basic file types. A color init
215 ;; # string consists of one or more of the following numeric codes:
216 ;; # Attribute codes:
217 ;; # 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
218 ;; # Text color codes:
219 ;; # 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
220 ;; # Background color codes:
221 ;; # 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
222 ;; NORMAL 00 # global default, although everything should be something.
223 ;; FILE 00 # normal file
224 ;; DIR 00;37 # directory
225 ;; LINK 00;36 # symbolic link
226 ;; FIFO 00;37 # pipe
227 ;; SOCK 40;35 # socket
228 ;; BLK 33;01 # block device driver
229 ;; CHR 33;01 # character device driver
231 ;; # This is for files with execute permission:
232 ;; EXEC 00;32
234 ;; # List any file extensions like '.gz' or '.tar' that you would like ls
235 ;; # to colorize below. Put the extension, a space, and the color init
236 ;; # string. (and any comments you want to add after a '#')
237 ;; .tar 01;33 # archives or compressed
238 ;; .tgz 01;33
239 ;; .arj 01;33
240 ;; .taz 01;33
241 ;; .lzh 01;33
242 ;; .zip 01;33
243 ;; .z 01;33
244 ;; .Z 01;33
245 ;; .gz 01;33
246 ;; .jpg 01;35 # image formats
247 ;; .gif 01;35
248 ;; .bmp 01;35
249 ;; .xbm 01;35
250 ;; .xpm 01;35
253 ;; ----------------------------------------
255 ;; Notice: for directory/host/user tracking you need to have something
256 ;; like this in your shell startup script ( this is for tcsh but should
257 ;; be quite easy to port to other shells )
259 ;; ----------------------------------------
262 ;; set os = `uname`
263 ;; set host = `hostname`
264 ;; set date = `date`
266 ;; # su does not change this but I'd like it to
268 ;; set user = `whoami`
270 ;; # ...
272 ;; if ( eterm =~ $TERM ) then
274 ;; echo --------------------------------------------------------------
275 ;; echo Hello $user
276 ;; echo Today is $date
277 ;; echo We are on $host running $os under Emacs term mode
278 ;; echo --------------------------------------------------------------
280 ;; setenv EDITOR emacsclient
282 ;; # Notice: $host and $user have been set before to 'hostname' and 'whoami'
283 ;; # this is necessary because, f.e., certain versions of 'su' do not change
284 ;; # $user, YMMV: if you don't want to fiddle with them define a couple
285 ;; # of new variables and use these instead.
286 ;; # NOTICE that there is a space between "AnSiT?" and $whatever NOTICE
288 ;; # These are because we want the real cwd in the messages, not the login
289 ;; # time one !
291 ;; set cwd_hack='$cwd'
292 ;; set host_hack='$host'
293 ;; set user_hack='$user'
295 ;; # Notice that the ^[ character is an ESC, not two chars. You can
296 ;; # get it in various ways, for example by typing
297 ;; # echo -e '\033' > escape.file
298 ;; # or by using your favourite editor
300 ;; foreach temp (cd pushd)
301 ;; alias $temp "$temp \!* ; echo '\eAnSiTc' $cwd_hack"
302 ;; end
303 ;; alias popd 'popd ;echo "\eAnSiTc" $cwd'
305 ;; # Every command that can modify the user/host/directory should be aliased
306 ;; # as follows for the tracking mechanism to work.
308 ;; foreach temp ( rlogin telnet rsh sh ksh csh tcsh zsh bash tcl su )
309 ;; alias $temp "$temp \!* ; echo '\eAnSiTh' $host_hack ; \
310 ;; echo '\eAnSiTu' $user_hack ;echo '\eAnSiTc' $cwd_hack"
311 ;; end
313 ;; # Start up & use color ls
315 ;; echo "\eAnSiTh" $host
316 ;; echo "\eAnSiTu" $user
317 ;; echo "\eAnSiTc" $cwd
319 ;; # some housekeeping
321 ;; unset cwd_hack
322 ;; unset host_hack
323 ;; unset user_hack
324 ;; unset temp
326 ;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
327 ;; endif
329 ;; # ...
331 ;; # Let's not clutter user space
333 ;; unset os
334 ;; unset date
338 ;;; Original Commentary:
339 ;; ---------------------
341 ;; The changelog is at the end of this file.
343 ;; Please send me bug reports, bug fixes, and extensions, so that I can
344 ;; merge them into the master source.
345 ;; - Per Bothner (bothner@cygnus.com)
347 ;; This file defines a general command-interpreter-in-a-buffer package
348 ;; (term mode). The idea is that you can build specific process-in-a-buffer
349 ;; modes on top of term mode -- e.g., lisp, shell, scheme, T, soar, ....
350 ;; This way, all these specific packages share a common base functionality,
351 ;; and a common set of bindings, which makes them easier to use (and
352 ;; saves code, implementation time, etc., etc.).
354 ;; For hints on converting existing process modes (e.g., tex-mode,
355 ;; background, dbx, gdb, kermit, prolog, telnet) to use term-mode
356 ;; instead of shell-mode, see the notes at the end of this file.
359 ;; Brief Command Documentation:
360 ;;============================================================================
361 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
362 ;; mode)
364 ;; m-p term-previous-input Cycle backwards in input history
365 ;; m-n term-next-input Cycle forwards
366 ;; m-r term-previous-matching-input Previous input matching a regexp
367 ;; m-s comint-next-matching-input Next input that matches
368 ;; return term-send-input
369 ;; c-c c-a term-bol Beginning of line; skip prompt.
370 ;; c-d term-delchar-or-maybe-eof Delete char unless at end of buff.
371 ;; c-c c-u term-kill-input ^u
372 ;; c-c c-w backward-kill-word ^w
373 ;; c-c c-c term-interrupt-subjob ^c
374 ;; c-c c-z term-stop-subjob ^z
375 ;; c-c c-\ term-quit-subjob ^\
376 ;; c-c c-o term-kill-output Delete last batch of process output
377 ;; c-c c-r term-show-output Show last batch of process output
378 ;; c-c c-h term-dynamic-list-input-ring List input history
380 ;; Not bound by default in term-mode
381 ;; term-send-invisible Read a line w/o echo, and send to proc
382 ;; (These are bound in shell-mode)
383 ;; term-dynamic-complete Complete filename at point.
384 ;; term-dynamic-list-completions List completions in help buffer.
385 ;; term-replace-by-expanded-filename Expand and complete filename at point;
386 ;; replace with expanded/completed name.
387 ;; term-kill-subjob No mercy.
388 ;; term-show-maximum-output Show as much output as possible.
389 ;; term-continue-subjob Send CONT signal to buffer's process
390 ;; group. Useful if you accidentally
391 ;; suspend your process (with C-c C-z).
393 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
394 ;; term-load-hook is run after loading in this package.
396 ;;; Code:
398 ;; This is passed to the inferior in the EMACS environment variable,
399 ;; so it is important to increase it if there are protocol-relevant changes.
400 (defconst term-protocol-version "0.96")
402 (eval-when-compile
403 (require 'ange-ftp)
404 (require 'cl))
405 (require 'ring)
406 (require 'ehelp)
408 (defgroup term nil
409 "General command interpreter in a window."
410 :group 'processes)
413 ;;; Buffer Local Variables:
414 ;;============================================================================
415 ;; Term mode buffer local variables:
416 ;; term-prompt-regexp - string term-bol uses to match prompt.
417 ;; term-delimiter-argument-list - list For delimiters and arguments
418 ;; term-last-input-start - marker Handy if inferior always echoes
419 ;; term-last-input-end - marker For term-kill-output command
420 ;; For the input history mechanism:
421 (defvar term-input-ring-size 32 "Size of input history ring.")
422 ;; term-input-ring-size - integer
423 ;; term-input-ring - ring
424 ;; term-input-ring-index - number ...
425 ;; term-input-autoexpand - symbol ...
426 ;; term-input-ignoredups - boolean ...
427 ;; term-last-input-match - string ...
428 ;; term-dynamic-complete-functions - hook For the completion mechanism
429 ;; term-completion-fignore - list ...
430 ;; term-get-old-input - function Hooks for specific
431 ;; term-input-filter-functions - hook process-in-a-buffer
432 ;; term-input-filter - function modes.
433 ;; term-input-send - function
434 ;; term-scroll-to-bottom-on-output - symbol ...
435 ;; term-scroll-show-maximum-output - boolean...
436 (defvar term-height) ; Number of lines in window.
437 (defvar term-width) ; Number of columns in window.
438 (defvar term-home-marker) ; Marks the "home" position for cursor addressing.
439 (defvar term-saved-home-marker nil
440 "When using alternate sub-buffer,
441 contains saved term-home-marker from original sub-buffer.")
442 (defvar term-start-line-column 0
443 "(current-column) at start of screen line, or nil if unknown.")
444 (defvar term-current-column 0 "If non-nil, is cache for (current-column).")
445 (defvar term-current-row 0
446 "Current vertical row (relative to home-marker) or nil if unknown.")
447 (defvar term-insert-mode nil)
448 (defvar term-vertical-motion)
449 (defvar term-terminal-state 0
450 "State of the terminal emulator:
451 state 0: Normal state
452 state 1: Last character was a graphic in the last column.
453 If next char is graphic, first move one column right
454 \(and line warp) before displaying it.
455 This emulates (more or less) the behavior of xterm.
456 state 2: seen ESC
457 state 3: seen ESC [ (or ESC [ ?)
458 state 4: term-terminal-parameter contains pending output.")
459 (defvar term-kill-echo-list nil
460 "A queue of strings whose echo we want suppressed.")
461 (defvar term-terminal-parameter)
462 (defvar term-terminal-previous-parameter)
463 (defvar term-current-face 'default)
464 (defvar term-scroll-start 0 "Top-most line (inclusive) of scrolling region.")
465 (defvar term-scroll-end) ; Number of line (zero-based) after scrolling region.
466 (defvar term-pager-count nil
467 "Number of lines before we need to page; if nil, paging is disabled.")
468 (defvar term-saved-cursor nil)
469 (defvar term-command-hook)
470 (defvar term-log-buffer nil)
471 (defvar term-scroll-with-delete nil
472 "If t, forward scrolling should be implemented by delete to
473 top-most line(s); and if nil, scrolling should be implemented
474 by moving term-home-marker. It is set to t if there is a
475 \(non-default) scroll-region OR the alternate buffer is used.")
476 (defvar term-pending-delete-marker) ; New user input in line mode
477 ; needs to be deleted, because it gets echoed by the inferior.
478 ; To reduce flicker, we defer the delete until the next output.
479 (defvar term-old-mode-map nil "Saves the old keymap when in char mode.")
480 (defvar term-old-mode-line-format) ; Saves old mode-line-format while paging.
481 (defvar term-pager-old-local-map nil "Saves old keymap while paging.")
482 (defvar term-pager-old-filter) ; Saved process-filter while paging.
484 (defcustom explicit-shell-file-name nil
485 "If non-nil, is file name to use for explicitly requested inferior shell."
486 :type '(choice (const nil) file)
487 :group 'term)
489 (defvar term-prompt-regexp "^"
490 "Regexp to recognize prompts in the inferior process.
491 Defaults to \"^\", the null string at BOL.
493 Good choices:
494 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
495 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
496 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
497 kcl: \"^>+ *\"
498 shell: \"^[^#$%>\\n]*[#$%>] *\"
499 T: \"^>+ *\"
501 This is a good thing to set in mode hooks.")
503 (defvar term-delimiter-argument-list ()
504 "List of characters to recognize as separate arguments in input.
505 Strings comprising a character in this list will separate the arguments
506 surrounding them, and also be regarded as arguments in their own right
507 \(unlike whitespace). See `term-arguments'.
508 Defaults to the empty list.
510 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
512 This is a good thing to set in mode hooks.")
514 (defcustom term-input-autoexpand nil
515 "If non-nil, expand input command history references on completion.
516 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
518 If the value is `input', then the expansion is seen on input.
519 If the value is `history', then the expansion is only when inserting
520 into the buffer's input ring. See also `term-magic-space' and
521 `term-dynamic-complete'.
523 This variable is buffer-local."
524 :type '(choice (const nil) (const t) (const input) (const history))
525 :group 'term)
527 (defcustom term-input-ignoredups nil
528 "If non-nil, don't add input matching the last on the input ring.
529 This mirrors the optional behavior of bash.
531 This variable is buffer-local."
532 :type 'boolean
533 :group 'term)
535 (defcustom term-input-ring-file-name nil
536 "If non-nil, name of the file to read/write input history.
537 See also `term-read-input-ring' and `term-write-input-ring'.
539 This variable is buffer-local, and is a good thing to set in mode hooks."
540 :type 'boolean
541 :group 'term)
543 (defcustom term-scroll-to-bottom-on-output nil
544 "Controls whether interpreter output causes window to scroll.
545 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
546 If `this', scroll only the selected window.
547 If `others', scroll only those that are not the selected window.
549 The default is nil.
551 See variable `term-scroll-show-maximum-output'.
552 This variable is buffer-local."
553 :type 'boolean
554 :group 'term)
556 (defcustom term-scroll-show-maximum-output nil
557 "Controls how interpreter output causes window to scroll.
558 If non-nil, then show the maximum output when the window is scrolled.
560 See variable `term-scroll-to-bottom-on-output'.
561 This variable is buffer-local."
562 :type 'boolean
563 :group 'term)
565 ;; Where gud-display-frame should put the debugging arrow. This is
566 ;; set by the marker-filter, which scans the debugger's output for
567 ;; indications of the current pc.
568 (defvar term-pending-frame nil)
570 ;;; Here are the per-interpreter hooks.
571 (defvar term-get-old-input (function term-get-old-input-default)
572 "Function that submits old text in term mode.
573 This function is called when return is typed while the point is in old text.
574 It returns the text to be submitted as process input. The default is
575 `term-get-old-input-default', which grabs the current line, and strips off
576 leading text matching `term-prompt-regexp'.")
578 (defvar term-dynamic-complete-functions
579 '(term-replace-by-expanded-history term-dynamic-complete-filename)
580 "List of functions called to perform completion.
581 Functions should return non-nil if completion was performed.
582 See also `term-dynamic-complete'.
584 This is a good thing to set in mode hooks.")
586 (defvar term-input-filter
587 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
588 "Predicate for filtering additions to input history.
589 Only inputs answering true to this function are saved on the input
590 history list. Default is to save anything that isn't all whitespace.")
592 (defvar term-input-filter-functions '()
593 "Functions to call before input is sent to the process.
594 These functions get one argument, a string containing the text to send.
596 This variable is buffer-local.")
598 (defvar term-input-sender (function term-simple-send)
599 "Function to actually send to PROCESS the STRING submitted by user.
600 Usually this is just `term-simple-send', but if your mode needs to
601 massage the input string, this is your hook. This is called from
602 the user command `term-send-input'. `term-simple-send' just sends
603 the string plus a newline.")
605 (defcustom term-eol-on-send t
606 "Non-nil means go to the end of the line before sending input.
607 See `term-send-input'."
608 :type 'boolean
609 :group 'term)
611 (defcustom term-mode-hook '()
612 "Called upon entry into term mode.
613 This is run before the process is cranked up."
614 :type 'hook
615 :group 'term)
617 (defcustom term-exec-hook '()
618 "Called each time a process is exec'd by `term-exec'.
619 This is called after the process is cranked up. It is useful for things that
620 must be done each time a process is executed in a term mode buffer (e.g.,
621 `process-kill-without-query'). In contrast, `term-mode-hook' is only
622 executed once when the buffer is created."
623 :type 'hook
624 :group 'term)
626 (defvar term-mode-map
627 (let ((map (make-sparse-keymap)))
628 (define-key map "\ep" 'term-previous-input)
629 (define-key map "\en" 'term-next-input)
630 (define-key map "\er" 'term-previous-matching-input)
631 (define-key map "\es" 'term-next-matching-input)
632 (unless (featurep 'xemacs)
633 (define-key map [?\A-\M-r]
634 'term-previous-matching-input-from-input)
635 (define-key map [?\A-\M-s] 'term-next-matching-input-from-input))
636 (define-key map "\e\C-l" 'term-show-output)
637 (define-key map "\C-m" 'term-send-input)
638 (define-key map "\C-d" 'term-delchar-or-maybe-eof)
639 (define-key map "\C-c\C-a" 'term-bol)
640 (define-key map "\C-c\C-u" 'term-kill-input)
641 (define-key map "\C-c\C-w" 'backward-kill-word)
642 (define-key map "\C-c\C-c" 'term-interrupt-subjob)
643 (define-key map "\C-c\C-z" 'term-stop-subjob)
644 (define-key map "\C-c\C-\\" 'term-quit-subjob)
645 (define-key map "\C-c\C-m" 'term-copy-old-input)
646 (define-key map "\C-c\C-o" 'term-kill-output)
647 (define-key map "\C-c\C-r" 'term-show-output)
648 (define-key map "\C-c\C-e" 'term-show-maximum-output)
649 (define-key map "\C-c\C-l" 'term-dynamic-list-input-ring)
650 (define-key map "\C-c\C-n" 'term-next-prompt)
651 (define-key map "\C-c\C-p" 'term-previous-prompt)
652 (define-key map "\C-c\C-d" 'term-send-eof)
653 (define-key map "\C-c\C-k" 'term-char-mode)
654 (define-key map "\C-c\C-j" 'term-line-mode)
655 (define-key map "\C-c\C-q" 'term-pager-toggle)
657 ;; ;; completion:
658 ;; (define-key map [menu-bar completion]
659 ;; (cons "Complete" (make-sparse-keymap "Complete")))
660 ;; (define-key map [menu-bar completion complete-expand]
661 ;; '("Expand File Name" . term-replace-by-expanded-filename))
662 ;; (define-key map [menu-bar completion complete-listing]
663 ;; '("File Completion Listing" . term-dynamic-list-filename-completions))
664 ;; (define-key map [menu-bar completion complete-file]
665 ;; '("Complete File Name" . term-dynamic-complete-filename))
666 ;; (define-key map [menu-bar completion complete]
667 ;; '("Complete Before Point" . term-dynamic-complete))
668 ;; ;; Put them in the menu bar:
669 ;; (setq menu-bar-final-items (append '(terminal completion inout signals)
670 ;; menu-bar-final-items))
671 map))
673 (defvar term-raw-map nil
674 "Keyboard map for sending characters directly to the inferior process.")
675 (defvar term-escape-char nil
676 "Escape character for char sub-mode of term mode.
677 Do not change it directly; use `term-set-escape-char' instead.")
678 (defvar term-raw-escape-map nil)
680 (defvar term-pager-break-map nil)
682 (defvar term-ptyp t
683 "True if communications via pty; false if by pipe. Buffer local.
684 This is to work around a bug in Emacs process signaling.")
686 (defvar term-last-input-match ""
687 "Last string searched for by term input history search, for defaulting.
688 Buffer local variable.")
690 (defvar term-input-ring nil)
691 (defvar term-last-input-start)
692 (defvar term-last-input-end)
693 (defvar term-input-ring-index nil
694 "Index of last matched history element.")
695 (defvar term-matching-input-from-input-string ""
696 "Input previously used to match input history.")
697 ; This argument to set-process-filter disables reading from the process,
698 ; assuming this is Emacs 19.20 or newer.
699 (defvar term-pager-filter t)
701 (put 'term-replace-by-expanded-history 'menu-enable 'term-input-autoexpand)
702 (put 'term-input-ring 'permanent-local t)
703 (put 'term-input-ring-index 'permanent-local t)
704 (put 'term-input-autoexpand 'permanent-local t)
705 (put 'term-input-filter-functions 'permanent-local t)
706 (put 'term-scroll-to-bottom-on-output 'permanent-local t)
707 (put 'term-scroll-show-maximum-output 'permanent-local t)
708 (put 'term-ptyp 'permanent-local t)
710 (defmacro term-in-char-mode () '(eq (current-local-map) term-raw-map))
711 (defmacro term-in-line-mode () '(not (term-in-char-mode)))
712 ;; True if currently doing PAGER handling.
713 (defmacro term-pager-enabled () 'term-pager-count)
714 (defmacro term-handling-pager () 'term-pager-old-local-map)
715 (defmacro term-using-alternate-sub-buffer () 'term-saved-home-marker)
717 (defvar term-signals-menu)
718 (defvar term-terminal-menu)
720 ;; Let's silence the byte-compiler -mm
721 (defvar term-ansi-at-host nil)
722 (defvar term-ansi-at-dir nil)
723 (defvar term-ansi-at-user nil)
724 (defvar term-ansi-at-message nil)
725 (defvar term-ansi-at-save-user nil)
726 (defvar term-ansi-at-save-pwd nil)
727 (defvar term-ansi-at-save-anon nil)
728 (defvar term-ansi-current-bold nil)
729 (defvar term-ansi-current-color 0)
730 (defvar term-ansi-face-already-done nil)
731 (defvar term-ansi-current-bg-color 0)
732 (defvar term-ansi-current-underline nil)
733 (defvar term-ansi-current-reverse nil)
734 (defvar term-ansi-current-invisible nil)
736 ;; Four should be enough, if you want more, just add. -mm
737 (defvar term-terminal-more-parameters 0)
738 (defvar term-terminal-previous-parameter-2 -1)
739 (defvar term-terminal-previous-parameter-3 -1)
740 (defvar term-terminal-previous-parameter-4 -1)
742 ;;; faces -mm
744 (defcustom term-default-fg-color
745 ;; FIXME: This depends on the current frame, so depending on when
746 ;; it's loaded, the result may be different.
747 (face-foreground term-current-face)
748 "Default color for foreground in `term'."
749 :group 'term
750 :type 'string)
752 (defcustom term-default-bg-color
753 ;; FIXME: This depends on the current frame, so depending on when
754 ;; it's loaded, the result may be different.
755 (face-background term-current-face)
756 "Default color for background in `term'."
757 :group 'term
758 :type 'string)
760 ;; Use the same colors that xterm uses, see `xterm-standard-colors'.
761 (defvar ansi-term-color-vector
762 [unspecified "black" "red3" "green3" "yellow3" "blue2"
763 "magenta3" "cyan3" "white"])
765 ;; Inspiration came from comint.el -mm
766 (defvar term-buffer-maximum-size 2048
767 "*The maximum size in lines for term buffers.
768 Term buffers are truncated from the top to be no greater than this number.
769 Notice that a setting of 0 means \"don't truncate anything\". This variable
770 is buffer-local.")
772 (when (featurep 'xemacs)
773 (defvar term-terminal-menu
774 '("Terminal"
775 [ "Character mode" term-char-mode (term-in-line-mode)]
776 [ "Line mode" term-line-mode (term-in-char-mode)]
777 [ "Enable paging" term-pager-toggle (not term-pager-count)]
778 [ "Disable paging" term-pager-toggle term-pager-count])))
780 ;; Menu bars:
781 (unless (featurep 'xemacs)
782 ;; terminal:
783 (let (newmap)
784 (setq newmap (make-sparse-keymap "Terminal"))
785 (define-key newmap [terminal-pager-enable]
786 '(menu-item "Enable paging" term-fake-pager-enable
787 :help "Enable paging feature"))
788 (define-key newmap [terminal-pager-disable]
789 '(menu-item "Disable paging" term-fake-pager-disable
790 :help "Disable paging feature"))
791 (define-key newmap [terminal-char-mode]
792 '(menu-item "Character mode" term-char-mode
793 :help "Switch to char (raw) sub-mode of term mode"))
794 (define-key newmap [terminal-line-mode]
795 '(menu-item "Line mode" term-line-mode
796 :help "Switch to line (cooked) sub-mode of term mode"))
797 (setq term-terminal-menu (cons "Terminal" newmap))
799 ;; completion: (line mode only)
800 (defvar term-completion-menu (make-sparse-keymap "Complete"))
801 (define-key term-mode-map [menu-bar completion]
802 (cons "Complete" term-completion-menu))
803 (define-key term-completion-menu [complete-expand]
804 '("Expand File Name" . term-replace-by-expanded-filename))
805 (define-key term-completion-menu [complete-listing]
806 '("File Completion Listing" . term-dynamic-list-filename-completions))
807 (define-key term-completion-menu [menu-bar completion complete-file]
808 '("Complete File Name" . term-dynamic-complete-filename))
809 (define-key term-completion-menu [menu-bar completion complete]
810 '("Complete Before Point" . term-dynamic-complete))
812 ;; Input history: (line mode only)
813 (defvar term-inout-menu (make-sparse-keymap "In/Out"))
814 (define-key term-mode-map [menu-bar inout]
815 (cons "In/Out" term-inout-menu))
816 (define-key term-inout-menu [kill-output]
817 '("Kill Current Output Group" . term-kill-output))
818 (define-key term-inout-menu [next-prompt]
819 '("Forward Output Group" . term-next-prompt))
820 (define-key term-inout-menu [previous-prompt]
821 '("Backward Output Group" . term-previous-prompt))
822 (define-key term-inout-menu [show-maximum-output]
823 '("Show Maximum Output" . term-show-maximum-output))
824 (define-key term-inout-menu [show-output]
825 '("Show Current Output Group" . term-show-output))
826 (define-key term-inout-menu [kill-input]
827 '("Kill Current Input" . term-kill-input))
828 (define-key term-inout-menu [copy-input]
829 '("Copy Old Input" . term-copy-old-input))
830 (define-key term-inout-menu [forward-matching-history]
831 '("Forward Matching Input..." . term-forward-matching-input))
832 (define-key term-inout-menu [backward-matching-history]
833 '("Backward Matching Input..." . term-backward-matching-input))
834 (define-key term-inout-menu [next-matching-history]
835 '("Next Matching Input..." . term-next-matching-input))
836 (define-key term-inout-menu [previous-matching-history]
837 '("Previous Matching Input..." . term-previous-matching-input))
838 (define-key term-inout-menu [next-matching-history-from-input]
839 '("Next Matching Current Input" . term-next-matching-input-from-input))
840 (define-key term-inout-menu [previous-matching-history-from-input]
841 '("Previous Matching Current Input" .
842 term-previous-matching-input-from-input))
843 (define-key term-inout-menu [next-history]
844 '("Next Input" . term-next-input))
845 (define-key term-inout-menu [previous-history]
846 '("Previous Input" . term-previous-input))
847 (define-key term-inout-menu [list-history]
848 '("List Input History" . term-dynamic-list-input-ring))
849 (define-key term-inout-menu [expand-history]
850 '("Expand History Before Point" . term-replace-by-expanded-history))
852 ;; Signals
853 (setq newmap (make-sparse-keymap "Signals"))
854 (define-key term-mode-map [menu-bar signals]
855 (setq term-signals-menu (cons "Signals" newmap)))
856 (define-key newmap [eof]
857 '(menu-item "EOF" term-send-eof
858 :help "Send an EOF to the current buffer's process"))
859 (define-key newmap [kill]
860 '(menu-item "KILL" term-kill-subjob
861 :help "Send kill signal to the current subjob"))
862 (define-key newmap [quit]
863 '(menu-item "QUIT" term-quit-subjob
864 :help "Send quit signal to the current subjob."))
865 (define-key newmap [cont]
866 '(menu-item "CONT" term-continue-subjob
867 :help "Send CONT signal to process buffer's process group"))
868 (define-key newmap [stop]
869 '(menu-item "STOP" term-stop-subjob
870 :help "Stop the current subjob"))
871 (define-key newmap [brk]
872 '(menu-item "BREAK" term-interrupt-subjob
873 :help "Interrupt the current subjob"))
876 ;; Set up term-raw-map, etc.
878 (defun term-set-escape-char (c)
879 "Change `term-escape-char' and keymaps that depend on it."
880 (when term-escape-char
881 (define-key term-raw-map term-escape-char 'term-send-raw))
882 (setq c (make-string 1 c))
883 (define-key term-raw-map c term-raw-escape-map)
884 ;; Define standard bindings in term-raw-escape-map
885 (define-key term-raw-escape-map "\C-v"
886 (lookup-key (current-global-map) "\C-v"))
887 (define-key term-raw-escape-map "\C-u"
888 (lookup-key (current-global-map) "\C-u"))
889 (define-key term-raw-escape-map c 'term-send-raw)
890 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
891 ;; The keybinding for term-char-mode is needed by the menubar code.
892 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
893 (define-key term-raw-escape-map "\C-j" 'term-line-mode)
894 ;; It's convenient to have execute-extended-command here.
895 (define-key term-raw-escape-map [?\M-x] 'execute-extended-command))
897 (let* ((map (make-keymap))
898 (esc-map (make-keymap))
899 (i 0))
900 (while (< i 128)
901 (define-key map (make-string 1 i) 'term-send-raw)
902 ;; Avoid O and [. They are used in escape sequences for various keys.
903 (unless (or (eq i ?O) (eq i 91))
904 (define-key esc-map (make-string 1 i) 'term-send-raw-meta))
905 (setq i (1+ i)))
906 (define-key map [remap self-insert-command] 'term-send-raw)
907 (define-key map "\e" esc-map)
908 (setq term-raw-map map)
909 (setq term-raw-escape-map
910 (copy-keymap (lookup-key (current-global-map) "\C-x")))
912 ;; Added nearly all the 'grey keys' -mm
914 (if (featurep 'xemacs)
915 (define-key term-raw-map [button2] 'term-mouse-paste)
916 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
917 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
918 (define-key term-raw-map [menu-bar signals] term-signals-menu))
919 (define-key term-raw-map [up] 'term-send-up)
920 (define-key term-raw-map [down] 'term-send-down)
921 (define-key term-raw-map [right] 'term-send-right)
922 (define-key term-raw-map [left] 'term-send-left)
923 (define-key term-raw-map [delete] 'term-send-del)
924 (define-key term-raw-map [deletechar] 'term-send-del)
925 (define-key term-raw-map [backspace] 'term-send-backspace)
926 (define-key term-raw-map [home] 'term-send-home)
927 (define-key term-raw-map [end] 'term-send-end)
928 (define-key term-raw-map [insert] 'term-send-insert)
929 (define-key term-raw-map [S-prior] 'scroll-down)
930 (define-key term-raw-map [S-next] 'scroll-up)
931 (define-key term-raw-map [S-insert] 'term-paste)
932 (define-key term-raw-map [prior] 'term-send-prior)
933 (define-key term-raw-map [next] 'term-send-next))
935 (term-set-escape-char ?\C-c)
937 (defvar overflow-newline-into-fringe)
939 (defun term-window-width ()
940 (if (featurep 'xemacs)
941 (1- (window-width))
942 (if (and window-system overflow-newline-into-fringe)
943 (window-width)
944 (1- (window-width)))))
947 (put 'term-mode 'mode-class 'special)
950 ;; Use this variable as a display table for `term-mode'.
951 (defvar term-display-table
952 (let ((dt (or (copy-sequence standard-display-table)
953 (make-display-table)))
955 ;; avoid changing the display table for ^J
956 (setq i 0)
957 (while (< i 10)
958 (aset dt i (vector i))
959 (setq i (1+ i)))
960 (setq i 11)
961 (while (< i 32)
962 (aset dt i (vector i))
963 (setq i (1+ i)))
964 (setq i 128)
965 (while (< i 256)
966 (aset dt i (vector i))
967 (setq i (1+ i)))
968 dt))
970 (defun term-ansi-reset ()
971 (setq term-current-face (nconc
972 (if term-default-bg-color
973 (list :background term-default-bg-color))
974 (if term-default-fg-color
975 (list :foreground term-default-fg-color))))
976 (setq term-ansi-current-underline nil)
977 (setq term-ansi-current-bold nil)
978 (setq term-ansi-current-reverse nil)
979 (setq term-ansi-current-color 0)
980 (setq term-ansi-current-invisible nil)
981 (setq term-ansi-face-already-done t)
982 (setq term-ansi-current-bg-color 0))
984 (defun term-mode ()
985 "Major mode for interacting with an inferior interpreter.
986 The interpreter name is same as buffer name, sans the asterisks.
988 There are two submodes: line mode and char mode. By default, you are
989 in char mode. In char sub-mode, each character (except
990 `term-escape-char') is sent immediately to the subprocess.
991 The escape character is equivalent to the usual meaning of C-x.
993 In line mode, you send a line of input at a time; use
994 \\[term-send-input] to send.
996 In line mode, this maintains an input history of size
997 `term-input-ring-size', and you can access it with the commands
998 \\[term-next-input], \\[term-previous-input], and
999 \\[term-dynamic-list-input-ring]. Input ring history expansion can be
1000 achieved with the commands \\[term-replace-by-expanded-history] or
1001 \\[term-magic-space]. Input ring expansion is controlled by the
1002 variable `term-input-autoexpand', and addition is controlled by the
1003 variable `term-input-ignoredups'.
1005 Input to, and output from, the subprocess can cause the window to scroll to
1006 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
1007 and `term-scroll-to-bottom-on-output'.
1009 If you accidentally suspend your process, use \\[term-continue-subjob]
1010 to continue it.
1012 This mode can be customized to create specific modes for running
1013 particular subprocesses. This can be done by setting the hooks
1014 `term-input-filter-functions', `term-input-filter',
1015 `term-input-sender' and `term-get-old-input' to appropriate functions,
1016 and the variable `term-prompt-regexp' to the appropriate regular
1017 expression.
1019 Commands in raw mode:
1021 \\{term-raw-map}
1023 Commands in line mode:
1025 \\{term-mode-map}
1027 Entry to this mode runs the hooks on `term-mode-hook'."
1028 (interactive)
1029 ;; Do not remove this. All major modes must do this.
1030 (kill-all-local-variables)
1031 (setq major-mode 'term-mode)
1032 (setq mode-name "Term")
1033 (use-local-map term-mode-map)
1034 ;; we do not want indent to sneak in any tabs
1035 (setq indent-tabs-mode nil)
1036 (setq buffer-display-table term-display-table)
1037 (make-local-variable 'term-home-marker)
1038 (setq term-home-marker (copy-marker 0))
1039 (make-local-variable 'term-saved-home-marker)
1040 (make-local-variable 'term-height)
1041 (make-local-variable 'term-width)
1042 (setq term-width (term-window-width))
1043 (setq term-height (1- (window-height)))
1044 (make-local-variable 'term-terminal-parameter)
1045 (make-local-variable 'term-saved-cursor)
1046 (make-local-variable 'term-last-input-start)
1047 (setq term-last-input-start (make-marker))
1048 (make-local-variable 'term-last-input-end)
1049 (setq term-last-input-end (make-marker))
1050 (make-local-variable 'term-last-input-match)
1051 (setq term-last-input-match "")
1052 (make-local-variable 'term-prompt-regexp) ; Don't set; default
1053 (make-local-variable 'term-input-ring-size) ; ...to global val.
1054 (make-local-variable 'term-input-ring)
1055 (make-local-variable 'term-input-ring-file-name)
1056 (or (and (boundp 'term-input-ring) term-input-ring)
1057 (setq term-input-ring (make-ring term-input-ring-size)))
1058 (make-local-variable 'term-input-ring-index)
1059 (or (and (boundp 'term-input-ring-index) term-input-ring-index)
1060 (setq term-input-ring-index nil))
1062 (make-local-variable 'term-command-hook)
1063 (setq term-command-hook (symbol-function 'term-command-hook))
1065 ;; I'm not sure these saves are necessary but, since I
1066 ;; haven't tested the whole thing on a net connected machine with
1067 ;; a properly configured ange-ftp, I've decided to be conservative
1068 ;; and put them in. -mm
1070 (make-local-variable 'term-ansi-at-host)
1071 (setq term-ansi-at-host (system-name))
1073 (make-local-variable 'term-ansi-at-dir)
1074 (setq term-ansi-at-dir default-directory)
1076 (make-local-variable 'term-ansi-at-message)
1077 (setq term-ansi-at-message nil)
1079 ;; For user tracking purposes -mm
1080 (make-local-variable 'ange-ftp-default-user)
1081 (make-local-variable 'ange-ftp-default-password)
1082 (make-local-variable 'ange-ftp-generate-anonymous-password)
1084 ;; You may want to have different scroll-back sizes -mm
1085 (make-local-variable 'term-buffer-maximum-size)
1087 ;; Of course these have to be buffer-local -mm
1088 (make-local-variable 'term-ansi-current-bold)
1089 (make-local-variable 'term-ansi-current-color)
1090 (make-local-variable 'term-ansi-face-already-done)
1091 (make-local-variable 'term-ansi-current-bg-color)
1092 (make-local-variable 'term-ansi-current-underline)
1093 (make-local-variable 'term-ansi-current-reverse)
1094 (make-local-variable 'term-ansi-current-invisible)
1096 (make-local-variable 'term-terminal-parameter)
1097 (make-local-variable 'term-terminal-previous-parameter)
1098 (make-local-variable 'term-terminal-previous-parameter-2)
1099 (make-local-variable 'term-terminal-previous-parameter-3)
1100 (make-local-variable 'term-terminal-previous-parameter-4)
1101 (make-local-variable 'term-terminal-more-parameters)
1103 (make-local-variable 'term-terminal-state)
1104 (make-local-variable 'term-kill-echo-list)
1105 (make-local-variable 'term-start-line-column)
1106 (make-local-variable 'term-current-column)
1107 (make-local-variable 'term-current-row)
1108 (make-local-variable 'term-log-buffer)
1109 (make-local-variable 'term-scroll-start)
1110 (make-local-variable 'term-scroll-end)
1111 (setq term-scroll-end term-height)
1112 (make-local-variable 'term-scroll-with-delete)
1113 (make-local-variable 'term-pager-count)
1114 (make-local-variable 'term-pager-old-local-map)
1115 (make-local-variable 'term-old-mode-map)
1116 (make-local-variable 'term-insert-mode)
1117 (make-local-variable 'term-dynamic-complete-functions)
1118 (make-local-variable 'term-completion-fignore)
1119 (make-local-variable 'term-get-old-input)
1120 (make-local-variable 'term-matching-input-from-input-string)
1121 (make-local-variable 'term-input-autoexpand)
1122 (make-local-variable 'term-input-ignoredups)
1123 (make-local-variable 'term-delimiter-argument-list)
1124 (make-local-variable 'term-input-filter-functions)
1125 (make-local-variable 'term-input-filter)
1126 (make-local-variable 'term-input-sender)
1127 (make-local-variable 'term-eol-on-send)
1128 (make-local-variable 'term-scroll-to-bottom-on-output)
1129 (make-local-variable 'term-scroll-show-maximum-output)
1130 (make-local-variable 'term-ptyp)
1131 (make-local-variable 'term-exec-hook)
1132 (make-local-variable 'term-vertical-motion)
1133 (make-local-variable 'term-pending-delete-marker)
1134 (setq term-pending-delete-marker (make-marker))
1135 (make-local-variable 'term-current-face)
1136 (term-ansi-reset)
1137 (make-local-variable 'term-pending-frame)
1138 (setq term-pending-frame nil)
1139 ;; Cua-mode's keybindings interfere with the term keybindings, disable it.
1140 (set (make-local-variable 'cua-mode) nil)
1141 (run-mode-hooks 'term-mode-hook)
1142 (when (featurep 'xemacs)
1143 (set-buffer-menubar
1144 (append current-menubar (list term-terminal-menu))))
1145 (or term-input-ring
1146 (setq term-input-ring (make-ring term-input-ring-size)))
1147 (term-update-mode-line))
1149 (defun term-reset-size (height width)
1150 (setq term-height height)
1151 (setq term-width width)
1152 (setq term-start-line-column nil)
1153 (setq term-current-row nil)
1154 (setq term-current-column nil)
1155 (term-set-scroll-region 0 height))
1157 ;; Recursive routine used to check if any string in term-kill-echo-list
1158 ;; matches part of the buffer before point.
1159 ;; If so, delete that matched part of the buffer - this suppresses echo.
1160 ;; Also, remove that string from the term-kill-echo-list.
1161 ;; We *also* remove any older string on the list, as a sanity measure,
1162 ;; in case something gets out of sync. (Except for type-ahead, there
1163 ;; should only be one element in the list.)
1165 (defun term-check-kill-echo-list ()
1166 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1167 (unwind-protect
1168 (progn
1169 (end-of-line)
1170 (while cur
1171 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1172 (if (and (>= start (point-min))
1173 (string= str (buffer-substring start (point))))
1174 (progn (delete-char (- len))
1175 (setq term-kill-echo-list (cdr cur))
1176 (setq term-current-column nil)
1177 (setq term-current-row nil)
1178 (setq term-start-line-column nil)
1179 (setq cur nil found t))
1180 (setq cur (cdr cur))))))
1181 (when (not found)
1182 (goto-char save-point)))
1183 found))
1185 (defun term-check-size (process)
1186 (when (or (/= term-height (1- (window-height)))
1187 (/= term-width (term-window-width)))
1188 (term-reset-size (1- (window-height)) (term-window-width))
1189 (set-process-window-size process term-height term-width)))
1191 (defun term-send-raw-string (chars)
1192 (deactivate-mark)
1193 (let ((proc (get-buffer-process (current-buffer))))
1194 (if (not proc)
1195 (error "Current buffer has no process")
1196 ;; Note that (term-current-row) must be called *after*
1197 ;; (point) has been updated to (process-mark proc).
1198 (goto-char (process-mark proc))
1199 (when (term-pager-enabled)
1200 (setq term-pager-count (term-current-row)))
1201 (process-send-string proc chars))))
1203 (defun term-send-raw ()
1204 "Send the last character typed through the terminal-emulator
1205 without any interpretation."
1206 (interactive)
1207 (let ((keys (this-command-keys)))
1208 (term-send-raw-string (string (aref keys (1- (length keys)))))))
1210 (defun term-send-raw-meta ()
1211 (interactive)
1212 (let ((char last-input-event))
1213 (when (symbolp last-input-event)
1214 ;; Convert `return' to C-m, etc.
1215 (let ((tmp (get char 'event-symbol-elements)))
1216 (when tmp
1217 (setq char (car tmp)))
1218 (when (symbolp char)
1219 (setq tmp (get char 'ascii-character))
1220 (when tmp
1221 (setq char tmp)))))
1222 (setq char (event-basic-type char))
1223 (term-send-raw-string (if (and (numberp char)
1224 (> char 127)
1225 (< char 256))
1226 (make-string 1 char)
1227 (format "\e%c" char)))))
1229 (defun term-mouse-paste (click arg)
1230 "Insert the last stretch of killed text at the position clicked on."
1231 (interactive "e\nP")
1232 (if (featurep 'xemacs)
1233 (term-send-raw-string
1234 (or (condition-case () (x-get-selection) (error ()))
1235 (error "No selection available")))
1236 ;; Give temporary modes such as isearch a chance to turn off.
1237 (run-hooks 'mouse-leave-buffer-hook)
1238 (setq this-command 'yank)
1239 (mouse-set-point click)
1240 (term-send-raw-string (current-kill (cond
1241 ((listp arg) 0)
1242 ((eq arg '-) -1)
1243 (t (1- arg)))))))
1245 (defun term-paste ()
1246 "Insert the last stretch of killed text at point."
1247 (interactive)
1248 (term-send-raw-string (current-kill 0)))
1250 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1251 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1252 ;; For example: vi works with \eOA while elm wants \e[A ...
1253 ;; (terminfo: kcuu1, kcud1, kcuf1, kcub1, khome, kend, kpp, knp, kdch1, kbs)
1254 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1255 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1256 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1257 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1258 (defun term-send-home () (interactive) (term-send-raw-string "\e[1~"))
1259 (defun term-send-insert() (interactive) (term-send-raw-string "\e[2~"))
1260 (defun term-send-end () (interactive) (term-send-raw-string "\e[4~"))
1261 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1262 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1263 (defun term-send-del () (interactive) (term-send-raw-string "\e[3~"))
1264 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-?"))
1266 (defun term-char-mode ()
1267 "Switch to char (\"raw\") sub-mode of term mode.
1268 Each character you type is sent directly to the inferior without
1269 intervention from Emacs, except for the escape character (usually C-c)."
1270 (interactive)
1271 ;; FIXME: Emit message? Cfr ilisp-raw-message
1272 (when (term-in-line-mode)
1273 (setq term-old-mode-map (current-local-map))
1274 (use-local-map term-raw-map)
1276 ;; Send existing partial line to inferior (without newline).
1277 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1278 (save-input-sender term-input-sender))
1279 (when (> (point) pmark)
1280 (unwind-protect
1281 (progn
1282 (setq term-input-sender
1283 (symbol-function 'term-send-string))
1284 (end-of-line)
1285 (term-send-input))
1286 (setq term-input-sender save-input-sender))))
1287 (term-update-mode-line)))
1289 (defun term-line-mode ()
1290 "Switch to line (\"cooked\") sub-mode of term mode.
1291 This means that Emacs editing commands work as normally, until
1292 you type \\[term-send-input] which sends the current line to the inferior."
1293 (interactive)
1294 (when (term-in-char-mode)
1295 (use-local-map term-old-mode-map)
1296 (term-update-mode-line)))
1298 (defun term-update-mode-line ()
1299 (let ((term-mode (if (term-in-char-mode) "char" "line"))
1300 (term-page (when (term-pager-enabled) " page"))
1301 (serial-item-speed)
1302 (serial-item-config)
1303 (proc (get-buffer-process (current-buffer))))
1304 (when (and (term-check-proc (current-buffer))
1305 (equal (process-type nil) 'serial))
1306 (let ((temp (serial-speed)))
1307 (setq serial-item-speed
1308 `(:propertize
1309 ,(or (and temp (format " %d" temp)) "")
1310 help-echo "mouse-1: Change the speed of the serial port"
1311 mouse-face mode-line-highlight
1312 local-map (keymap (mode-line keymap
1313 (down-mouse-1 . serial-mode-line-speed-menu-1))))))
1314 (let ((temp (process-contact proc :summary)))
1315 (setq serial-item-config
1316 `(:propertize
1317 ,(or (and temp (format " %s" temp)) "")
1318 help-echo "mouse-1: Change the configuration of the serial port"
1319 mouse-face mode-line-highlight
1320 local-map (keymap (mode-line keymap
1321 (down-mouse-1 . serial-mode-line-config-menu-1)))))))
1322 (setq mode-line-process
1323 (list ": " term-mode term-page
1324 serial-item-speed
1325 serial-item-config
1326 " %s")))
1327 (force-mode-line-update))
1329 (defun term-check-proc (buffer)
1330 "True if there is a process associated w/buffer BUFFER, and it
1331 is alive. BUFFER can be either a buffer or the name of one."
1332 (let ((proc (get-buffer-process buffer)))
1333 (and proc (memq (process-status proc) '(run stop open listen connect)))))
1335 ;;;###autoload
1336 (defun make-term (name program &optional startfile &rest switches)
1337 "Make a term process NAME in a buffer, running PROGRAM.
1338 The name of the buffer is made by surrounding NAME with `*'s.
1339 If there is already a running process in that buffer, it is not restarted.
1340 Optional third arg STARTFILE is the name of a file to send the contents of to
1341 the process. Any more args are arguments to PROGRAM."
1342 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1343 ;; If no process, or nuked process, crank up a new one and put buffer in
1344 ;; term mode. Otherwise, leave buffer and existing process alone.
1345 (cond ((not (term-check-proc buffer))
1346 (with-current-buffer buffer
1347 (term-mode)) ; Install local vars, mode, keymap, ...
1348 (term-exec buffer name program startfile switches)))
1349 buffer))
1351 ;;;###autoload
1352 (defun term (program)
1353 "Start a terminal-emulator in a new buffer.
1354 The buffer is in Term mode; see `term-mode' for the
1355 commands to use in that buffer.
1357 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
1358 (interactive (list (read-from-minibuffer "Run program: "
1359 (or explicit-shell-file-name
1360 (getenv "ESHELL")
1361 (getenv "SHELL")
1362 "/bin/sh"))))
1363 (set-buffer (make-term "terminal" program))
1364 (term-mode)
1365 (term-char-mode)
1366 (switch-to-buffer "*terminal*"))
1368 (defun term-exec (buffer name command startfile switches)
1369 "Start up a process in buffer for term modes.
1370 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1371 You can use this to cheaply run a series of processes in the same term
1372 buffer. The hook `term-exec-hook' is run after each exec."
1373 (with-current-buffer buffer
1374 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1375 (when proc (delete-process proc)))
1376 ;; Crank up a new process
1377 (let ((proc (term-exec-1 name buffer command switches)))
1378 (make-local-variable 'term-ptyp)
1379 (setq term-ptyp process-connection-type) ; t if pty, nil if pipe.
1380 ;; Jump to the end, and set the process mark.
1381 (goto-char (point-max))
1382 (set-marker (process-mark proc) (point))
1383 (set-process-filter proc 'term-emulate-terminal)
1384 (set-process-sentinel proc 'term-sentinel)
1385 ;; Feed it the startfile.
1386 (when startfile
1387 ;;This is guaranteed to wait long enough
1388 ;;but has bad results if the term does not prompt at all
1389 ;; (while (= size (buffer-size))
1390 ;; (sleep-for 1))
1391 ;;I hope 1 second is enough!
1392 (sleep-for 1)
1393 (goto-char (point-max))
1394 (insert-file-contents startfile)
1395 (term-send-string
1396 proc (delete-and-extract-region (point) (point-max)))))
1397 (run-hooks 'term-exec-hook)
1398 buffer))
1400 (defun term-sentinel (proc msg)
1401 "Sentinel for term buffers.
1402 The main purpose is to get rid of the local keymap."
1403 (let ((buffer (process-buffer proc)))
1404 (when (memq (process-status proc) '(signal exit))
1405 (if (null (buffer-name buffer))
1406 ;; buffer killed
1407 (set-process-buffer proc nil)
1408 (with-current-buffer buffer
1409 ;; Write something in the compilation buffer
1410 ;; and hack its mode line.
1411 ;; Get rid of local keymap.
1412 (use-local-map nil)
1413 (term-handle-exit (process-name proc) msg)
1414 ;; Since the buffer and mode line will show that the
1415 ;; process is dead, we can delete it now. Otherwise it
1416 ;; will stay around until M-x list-processes.
1417 (delete-process proc))))))
1419 (defun term-handle-exit (process-name msg)
1420 "Write process exit (or other change) message MSG in the current buffer."
1421 (let ((buffer-read-only nil)
1422 (omax (point-max))
1423 (opoint (point)))
1424 ;; Record where we put the message, so we can ignore it
1425 ;; later on.
1426 (goto-char omax)
1427 (insert ?\n "Process " process-name " " msg)
1428 ;; Force mode line redisplay soon.
1429 (force-mode-line-update)
1430 (when (and opoint (< opoint omax))
1431 (goto-char opoint))))
1434 (defvar term-term-name "eterm-color"
1435 "Name to use for TERM.
1436 Using \"emacs\" loses, because bash disables editing if $TERM == emacs.")
1437 ;; Format string, usage:
1438 ;; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1439 (defvar term-termcap-format
1440 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1441 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1442 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=^J\
1443 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1444 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1445 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC\
1446 :kl=\\EOD:kd=\\EOB:kr=\\EOC:ku=\\EOA:kN=\\E[6~:kP=\\E[5~:@7=\\E[4~:kh=\\E[1~\
1447 :mk=\\E[8m:cb=\\E[1K:op=\\E[39;49m:Co#8:pa#64:AB=\\E[4%%dm:AF=\\E[3%%dm:cr=^M\
1448 :bl=^G:do=^J:le=^H:ta=^I:se=\\E[27m:ue=\\E24m\
1449 :kb=^?:kD=^[[3~:sc=\\E7:rc=\\E8:r1=\\Ec:"
1450 ;; : -undefine ic
1451 ;; don't define :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1452 "Termcap capabilities supported.")
1454 ;; This auxiliary function cranks up the process for term-exec in
1455 ;; the appropriate environment.
1457 (defun term-exec-1 (name buffer command switches)
1458 ;; We need to do an extra (fork-less) exec to run stty.
1459 ;; (This would not be needed if we had suitable Emacs primitives.)
1460 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1461 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1462 ;; Thus we add an extra dummy argument "..", and then remove it.
1463 (let ((process-environment
1464 (nconc
1465 (list
1466 (format "TERM=%s" term-term-name)
1467 (format "TERMINFO=%s" data-directory)
1468 (format term-termcap-format "TERMCAP="
1469 term-term-name term-height term-width)
1470 ;; We are going to get rid of the binding for EMACS,
1471 ;; probably in Emacs 23, because it breaks
1472 ;; `./configure' of some packages that expect it to
1473 ;; say where to find EMACS.
1474 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1475 (format "INSIDE_EMACS=%s,term:%s" emacs-version term-protocol-version)
1476 (format "LINES=%d" term-height)
1477 (format "COLUMNS=%d" term-width))
1478 process-environment))
1479 (process-connection-type t)
1480 ;; We should suppress conversion of end-of-line format.
1481 (inhibit-eol-conversion t)
1482 ;; The process's output contains not just chars but also binary
1483 ;; escape codes, so we need to see the raw output. We will have to
1484 ;; do the decoding by hand on the parts that are made of chars.
1485 (coding-system-for-read 'binary))
1486 (apply 'start-process name buffer
1487 "/bin/sh" "-c"
1488 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1489 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1490 term-height term-width)
1491 ".."
1492 command switches)))
1495 ;;; Input history processing in a buffer
1496 ;; ===========================================================================
1497 ;; Useful input history functions, courtesy of the Ergo group.
1499 ;; Eleven commands:
1500 ;; term-dynamic-list-input-ring List history in help buffer.
1501 ;; term-previous-input Previous input...
1502 ;; term-previous-matching-input ...matching a string.
1503 ;; term-previous-matching-input-from-input ... matching the current input.
1504 ;; term-next-input Next input...
1505 ;; term-next-matching-input ...matching a string.
1506 ;; term-next-matching-input-from-input ... matching the current input.
1507 ;; term-backward-matching-input Backwards input...
1508 ;; term-forward-matching-input ...matching a string.
1509 ;; term-replace-by-expanded-history Expand history at point;
1510 ;; replace with expanded history.
1511 ;; term-magic-space Expand history and insert space.
1513 ;; Three functions:
1514 ;; term-read-input-ring Read into term-input-ring...
1515 ;; term-write-input-ring Write to term-input-ring-file-name.
1516 ;; term-replace-by-expanded-history-before-point Workhorse function.
1518 (defun term-read-input-ring (&optional silent)
1519 "Set the buffer's `term-input-ring' from a history file.
1520 The name of the file is given by the variable `term-input-ring-file-name'.
1521 The history ring is of size `term-input-ring-size', regardless of file size.
1522 If `term-input-ring-file-name' is nil this function does nothing.
1524 If the optional argument SILENT is non-nil, we say nothing about a
1525 failure to read the history file.
1527 This function is useful for major mode commands and mode hooks.
1529 The structure of the history file should be one input command per line,
1530 with the most recent command last.
1531 See also `term-input-ignoredups' and `term-write-input-ring'."
1532 (cond ((or (null term-input-ring-file-name)
1533 (equal term-input-ring-file-name ""))
1534 nil)
1535 ((not (file-readable-p term-input-ring-file-name))
1536 (or silent
1537 (message "Cannot read history file %s"
1538 term-input-ring-file-name)))
1540 (let ((history-buf (get-buffer-create " *temp*"))
1541 (file term-input-ring-file-name)
1542 (count 0)
1543 (ring (make-ring term-input-ring-size)))
1544 (unwind-protect
1545 (with-current-buffer history-buf
1546 (widen)
1547 (erase-buffer)
1548 (insert-file-contents file)
1549 ;; Save restriction in case file is already visited...
1550 ;; Watch for those date stamps in history files!
1551 (goto-char (point-max))
1552 (while (and (< count term-input-ring-size)
1553 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1554 nil t))
1555 (let ((history (buffer-substring (match-beginning 1)
1556 (match-end 1))))
1557 (when (or (null term-input-ignoredups)
1558 (ring-empty-p ring)
1559 (not (string-equal (ring-ref ring 0) history)))
1560 (ring-insert-at-beginning ring history)))
1561 (setq count (1+ count))))
1562 (kill-buffer history-buf))
1563 (setq term-input-ring ring
1564 term-input-ring-index nil)))))
1566 (defun term-write-input-ring ()
1567 "Write the buffer's `term-input-ring' to a history file.
1568 The name of the file is given by the variable `term-input-ring-file-name'.
1569 The original contents of the file are lost if `term-input-ring' is not empty.
1570 If `term-input-ring-file-name' is nil this function does nothing.
1572 Useful within process sentinels.
1574 See also `term-read-input-ring'."
1575 (cond ((or (null term-input-ring-file-name)
1576 (equal term-input-ring-file-name "")
1577 (null term-input-ring) (ring-empty-p term-input-ring))
1578 nil)
1579 ((not (file-writable-p term-input-ring-file-name))
1580 (message "Cannot write history file %s" term-input-ring-file-name))
1582 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1583 (ring term-input-ring)
1584 (file term-input-ring-file-name)
1585 (index (ring-length ring)))
1586 ;; Write it all out into a buffer first. Much faster, but messier,
1587 ;; than writing it one line at a time.
1588 (with-current-buffer history-buf
1589 (erase-buffer)
1590 (while (> index 0)
1591 (setq index (1- index))
1592 (insert (ring-ref ring index) ?\n))
1593 (write-region (buffer-string) nil file nil 'no-message)
1594 (kill-buffer nil))))))
1597 (defun term-dynamic-list-input-ring ()
1598 "List in help buffer the buffer's input history."
1599 (interactive)
1600 (if (or (not (ring-p term-input-ring))
1601 (ring-empty-p term-input-ring))
1602 (message "No history")
1603 (let ((history nil)
1604 (history-buffer " *Input History*")
1605 (index (1- (ring-length term-input-ring)))
1606 (conf (current-window-configuration)))
1607 ;; We have to build up a list ourselves from the ring vector.
1608 (while (>= index 0)
1609 (setq history (cons (ring-ref term-input-ring index) history)
1610 index (1- index)))
1611 ;; Change "completion" to "history reference"
1612 ;; to make the display accurate.
1613 (with-output-to-temp-buffer history-buffer
1614 (display-completion-list history)
1615 (set-buffer history-buffer)
1616 (forward-line 3)
1617 (while (search-backward "completion" nil 'move)
1618 (replace-match "history reference")))
1619 (sit-for 0)
1620 (message "Hit space to flush")
1621 (let ((ch (read-event)))
1622 (if (eq ch ?\s)
1623 (set-window-configuration conf)
1624 (setq unread-command-events (list ch)))))))
1627 (defun term-regexp-arg (prompt)
1628 ;; Return list of regexp and prefix arg using PROMPT.
1629 (let* (;; Don't clobber this.
1630 (last-command last-command)
1631 (regexp (read-from-minibuffer prompt nil nil nil
1632 'minibuffer-history-search-history)))
1633 (list (if (string-equal regexp "")
1634 (setcar minibuffer-history-search-history
1635 (nth 1 minibuffer-history-search-history))
1636 regexp)
1637 (prefix-numeric-value current-prefix-arg))))
1639 (defun term-search-arg (arg)
1640 ;; First make sure there is a ring and that we are after the process mark
1641 (cond ((not (term-after-pmark-p))
1642 (error "Not at command line"))
1643 ((or (null term-input-ring)
1644 (ring-empty-p term-input-ring))
1645 (error "Empty input ring"))
1646 ((zerop arg)
1647 ;; arg of zero resets search from beginning, and uses arg of 1
1648 (setq term-input-ring-index nil)
1651 arg)))
1653 (defun term-search-start (arg)
1654 ;; Index to start a directional search, starting at term-input-ring-index
1655 (if term-input-ring-index
1656 ;; If a search is running, offset by 1 in direction of arg
1657 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1658 (ring-length term-input-ring))
1659 ;; For a new search, start from beginning or end, as appropriate
1660 (if (>= arg 0)
1661 0 ; First elt for forward search
1662 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1664 (defun term-previous-input-string (arg)
1665 "Return the string ARG places along the input ring.
1666 Moves relative to `term-input-ring-index'."
1667 (ring-ref term-input-ring (if term-input-ring-index
1668 (mod (+ arg term-input-ring-index)
1669 (ring-length term-input-ring))
1670 arg)))
1672 (defun term-previous-input (arg)
1673 "Cycle backwards through input history."
1674 (interactive "*p")
1675 (term-previous-matching-input "." arg))
1677 (defun term-next-input (arg)
1678 "Cycle forwards through input history."
1679 (interactive "*p")
1680 (term-previous-input (- arg)))
1682 (defun term-previous-matching-input-string (regexp arg)
1683 "Return the string matching REGEXP ARG places along the input ring.
1684 Moves relative to `term-input-ring-index'."
1685 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1686 (when pos (ring-ref term-input-ring pos))))
1688 (defun term-previous-matching-input-string-position
1689 (regexp arg &optional start)
1690 "Return the index matching REGEXP ARG places along the input ring.
1691 Moves relative to START, or `term-input-ring-index'."
1692 (when (or (not (ring-p term-input-ring))
1693 (ring-empty-p term-input-ring))
1694 (error "No history"))
1695 (let* ((len (ring-length term-input-ring))
1696 (motion (if (> arg 0) 1 -1))
1697 (n (mod (- (or start (term-search-start arg)) motion) len))
1698 (tried-each-ring-item nil)
1699 (prev nil))
1700 ;; Do the whole search as many times as the argument says.
1701 (while (and (/= arg 0) (not tried-each-ring-item))
1702 ;; Step once.
1703 (setq prev n
1704 n (mod (+ n motion) len))
1705 ;; If we haven't reached a match, step some more.
1706 (while (and (< n len) (not tried-each-ring-item)
1707 (not (string-match regexp (ring-ref term-input-ring n))))
1708 (setq n (mod (+ n motion) len)
1709 ;; If we have gone all the way around in this search.
1710 tried-each-ring-item (= n prev)))
1711 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1712 ;; Now that we know which ring element to use, if we found it, return that.
1713 (when (string-match regexp (ring-ref term-input-ring n))
1714 n)))
1716 (defun term-previous-matching-input (regexp n)
1717 "Search backwards through input history for match for REGEXP.
1718 \(Previous history elements are earlier commands.)
1719 With prefix argument N, search for Nth previous match.
1720 If N is negative, find the next or Nth next match."
1721 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1722 (setq n (term-search-arg n))
1723 (let ((pos (term-previous-matching-input-string-position regexp n)))
1724 ;; Has a match been found?
1725 (if (null pos)
1726 (error "Not found")
1727 (setq term-input-ring-index pos)
1728 (message "History item: %d" (1+ pos))
1729 (delete-region
1730 ;; Can't use kill-region as it sets this-command
1731 (process-mark (get-buffer-process (current-buffer))) (point))
1732 (insert (ring-ref term-input-ring pos)))))
1734 (defun term-next-matching-input (regexp n)
1735 "Search forwards through input history for match for REGEXP.
1736 \(Later history elements are more recent commands.)
1737 With prefix argument N, search for Nth following match.
1738 If N is negative, find the previous or Nth previous match."
1739 (interactive (term-regexp-arg "Next input matching (regexp): "))
1740 (term-previous-matching-input regexp (- n)))
1742 (defun term-previous-matching-input-from-input (n)
1743 "Search backwards through input history for match for current input.
1744 \(Previous history elements are earlier commands.)
1745 With prefix argument N, search for Nth previous match.
1746 If N is negative, search forwards for the -Nth following match."
1747 (interactive "p")
1748 (when (not (memq last-command '(term-previous-matching-input-from-input
1749 term-next-matching-input-from-input)))
1750 ;; Starting a new search
1751 (setq term-matching-input-from-input-string
1752 (buffer-substring
1753 (process-mark (get-buffer-process (current-buffer)))
1754 (point))
1755 term-input-ring-index nil))
1756 (term-previous-matching-input
1757 (concat "^" (regexp-quote term-matching-input-from-input-string))
1760 (defun term-next-matching-input-from-input (n)
1761 "Search forwards through input history for match for current input.
1762 \(Following history elements are more recent commands.)
1763 With prefix argument N, search for Nth following match.
1764 If N is negative, search backwards for the -Nth previous match."
1765 (interactive "p")
1766 (term-previous-matching-input-from-input (- n)))
1769 (defun term-replace-by-expanded-history (&optional silent)
1770 "Expand input command history references before point.
1771 Expansion is dependent on the value of `term-input-autoexpand'.
1773 This function depends on the buffer's idea of the input history, which may not
1774 match the command interpreter's idea, assuming it has one.
1776 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1777 cannot know the interpreter's idea of input line numbers, assuming it has one,
1778 it cannot expand absolute input line number references.
1780 If the optional argument SILENT is non-nil, never complain
1781 even if history reference seems erroneous.
1783 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1785 Returns t if successful."
1786 (interactive)
1787 (when (and term-input-autoexpand
1788 (string-match "[!^]" (funcall term-get-old-input))
1789 (save-excursion (beginning-of-line)
1790 (looking-at term-prompt-regexp)))
1791 ;; Looks like there might be history references in the command.
1792 (let ((previous-modified-tick (buffer-modified-tick)))
1793 (message "Expanding history references...")
1794 (term-replace-by-expanded-history-before-point silent)
1795 (/= previous-modified-tick (buffer-modified-tick)))))
1798 (defun term-replace-by-expanded-history-before-point (silent)
1799 "Expand directory stack reference before point.
1800 See `term-replace-by-expanded-history'. Returns t if successful."
1801 (save-excursion
1802 (let ((toend (- (line-end-position) (point)))
1803 (start (progn (term-bol nil) (point))))
1804 (while (progn
1805 (skip-chars-forward "^!^" (- (line-end-position) toend))
1806 (< (point) (- (line-end-position) toend)))
1807 ;; This seems a bit complex. We look for references such as !!, !-num,
1808 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1809 ;; If that wasn't enough, the plings can be suffixed with argument
1810 ;; range specifiers.
1811 ;; Argument ranges are complex too, so we hive off the input line,
1812 ;; referenced with plings, with the range string to `term-args'.
1813 (setq term-input-ring-index nil)
1814 (cond ((or (= (preceding-char) ?\\)
1815 (term-within-quotes start (point)))
1816 ;; The history is quoted, or we're in quotes.
1817 (goto-char (1+ (point))))
1818 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1819 ;; We cannot know the interpreter's idea of input line numbers.
1820 (goto-char (match-end 0))
1821 (message "Absolute reference cannot be expanded"))
1822 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1823 ;; Just a number of args from `number' lines backward.
1824 (let ((number (1- (string-to-number
1825 (buffer-substring (match-beginning 1)
1826 (match-end 1))))))
1827 (if (<= number (ring-length term-input-ring))
1828 (progn
1829 (replace-match
1830 (term-args (term-previous-input-string number)
1831 (match-beginning 2) (match-end 2))
1832 t t)
1833 (setq term-input-ring-index number)
1834 (message "History item: %d" (1+ number)))
1835 (goto-char (match-end 0))
1836 (message "Relative reference exceeds input history size"))))
1837 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1838 ;; Just a number of args from the previous input line.
1839 (replace-match
1840 (term-args (term-previous-input-string 0)
1841 (match-beginning 1) (match-end 1))
1842 t t)
1843 (message "History item: previous"))
1844 ((looking-at
1845 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1846 ;; Most recent input starting with or containing (possibly
1847 ;; protected) string, maybe just a number of args. Phew.
1848 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1849 (mb2 (match-beginning 2)) (me2 (match-end 2))
1850 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1851 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1852 (pos (save-match-data
1853 (term-previous-matching-input-string-position
1854 (concat pref (regexp-quote exp)) 1))))
1855 (if (null pos)
1856 (progn
1857 (goto-char (match-end 0))
1858 (or silent
1859 (progn (message "Not found")
1860 (ding))))
1861 (setq term-input-ring-index pos)
1862 (replace-match
1863 (term-args (ring-ref term-input-ring pos)
1864 (match-beginning 4) (match-end 4))
1865 t t)
1866 (message "History item: %d" (1+ pos)))))
1867 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1868 ;; Quick substitution on the previous input line.
1869 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1870 (new (buffer-substring (match-beginning 2) (match-end 2)))
1871 (pos nil))
1872 (replace-match (term-previous-input-string 0) t t)
1873 (setq pos (point))
1874 (goto-char (match-beginning 0))
1875 (if (not (search-forward old pos t))
1876 (or silent
1877 (error "Not found"))
1878 (replace-match new t t)
1879 (message "History item: substituted"))))
1881 (goto-char (match-end 0))))))))
1884 (defun term-magic-space (arg)
1885 "Expand input history references before point and insert ARG spaces.
1886 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1887 (interactive "p")
1888 (term-replace-by-expanded-history)
1889 (self-insert-command arg))
1891 (defun term-within-quotes (beg end)
1892 "Return t if the number of quotes between BEG and END is odd.
1893 Quotes are single and double."
1894 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1895 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1896 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1898 (defun term-how-many-region (regexp beg end)
1899 "Return number of matches for REGEXP from BEG to END."
1900 (let ((count 0))
1901 (save-excursion
1902 (save-match-data
1903 (goto-char beg)
1904 (while (re-search-forward regexp end t)
1905 (setq count (1+ count)))))
1906 count))
1908 (defun term-args (string begin end)
1909 ;; From STRING, return the args depending on the range specified in the text
1910 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1911 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1912 (save-match-data
1913 (if (null begin)
1914 (term-arguments string 0 nil)
1915 (let* ((range (buffer-substring
1916 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1917 (nth (cond ((string-match "^[*^]" range) 1)
1918 ((string-match "^-" range) 0)
1919 ((string-equal range "$") nil)
1920 (t (string-to-number range))))
1921 (mth (cond ((string-match "[-*$]$" range) nil)
1922 ((string-match "-" range)
1923 (string-to-number (substring range (match-end 0))))
1924 (t nth))))
1925 (term-arguments string nth mth)))))
1927 ;; Return a list of arguments from ARG. Break it up at the
1928 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1929 (defun term-delim-arg (arg)
1930 (if (null term-delimiter-argument-list)
1931 (list arg)
1932 (let ((args nil)
1933 (pos 0)
1934 (len (length arg)))
1935 (while (< pos len)
1936 (let ((char (aref arg pos))
1937 (start pos))
1938 (if (memq char term-delimiter-argument-list)
1939 (while (and (< pos len) (eq (aref arg pos) char))
1940 (setq pos (1+ pos)))
1941 (while (and (< pos len)
1942 (not (memq (aref arg pos)
1943 term-delimiter-argument-list)))
1944 (setq pos (1+ pos))))
1945 (setq args (cons (substring arg start pos) args))))
1946 args)))
1948 (defun term-arguments (string nth mth)
1949 "Return from STRING the NTH to MTH arguments.
1950 NTH and/or MTH can be nil, which means the last argument.
1951 Returned arguments are separated by single spaces.
1952 We assume whitespace separates arguments, except within quotes.
1953 Also, a run of one or more of a single character
1954 in `term-delimiter-argument-list' is a separate argument.
1955 Argument 0 is the command name."
1956 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1957 (args ()) (pos 0)
1958 (count 0)
1959 beg str quotes)
1960 ;; Build a list of all the args until we have as many as we want.
1961 (while (and (or (null mth) (<= count mth))
1962 (string-match argpart string pos))
1963 (if (and beg (= pos (match-beginning 0)))
1964 ;; It's contiguous, part of the same arg.
1965 (setq pos (match-end 0)
1966 quotes (or quotes (match-beginning 1)))
1967 ;; It's a new separate arg.
1968 (if beg
1969 ;; Put the previous arg, if there was one, onto ARGS.
1970 (setq str (substring string beg pos)
1971 args (if quotes (cons str args)
1972 (nconc (term-delim-arg str) args))
1973 count (1+ count)))
1974 (setq quotes (match-beginning 1))
1975 (setq beg (match-beginning 0))
1976 (setq pos (match-end 0))))
1977 (if beg
1978 (setq str (substring string beg pos)
1979 args (if quotes (cons str args)
1980 (nconc (term-delim-arg str) args))
1981 count (1+ count)))
1982 (let ((n (or nth (1- count)))
1983 (m (if mth (1- (- count mth)) 0)))
1984 (mapconcat
1985 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1988 ;;; Input processing stuff [line mode]
1991 (defun term-send-input ()
1992 "Send input to process.
1993 After the process output mark, sends all text from the process mark to
1994 point as input to the process. Before the process output mark, calls value
1995 of variable `term-get-old-input' to retrieve old input, copies it to the
1996 process mark, and sends it. A terminal newline is also inserted into the
1997 buffer and sent to the process. The list of function names contained in the
1998 value of `term-input-filter-functions' is called on the input before sending
1999 it. The input is entered into the input history ring, if the value of variable
2000 `term-input-filter' returns non-nil when called on the input.
2002 Any history reference may be expanded depending on the value of the variable
2003 `term-input-autoexpand'. The list of function names contained in the value
2004 of `term-input-filter-functions' is called on the input before sending it.
2005 The input is entered into the input history ring, if the value of variable
2006 `term-input-filter' returns non-nil when called on the input.
2008 If variable `term-eol-on-send' is non-nil, then point is moved to the
2009 end of line before sending the input.
2011 The values of `term-get-old-input', `term-input-filter-functions', and
2012 `term-input-filter' are chosen according to the command interpreter running
2013 in the buffer. E.g.,
2015 If the interpreter is the csh,
2016 term-get-old-input is the default: take the current line, discard any
2017 initial string matching regexp term-prompt-regexp.
2018 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
2019 \"popd\" commands. When it sees one, it cd's the buffer.
2020 term-input-filter is the default: returns t if the input isn't all white
2021 space.
2023 If the term is Lucid Common Lisp,
2024 term-get-old-input snarfs the sexp ending at point.
2025 term-input-filter-functions does nothing.
2026 term-input-filter returns nil if the input matches input-filter-regexp,
2027 which matches (1) all whitespace (2) :a, :c, etc.
2029 Similarly for Soar, Scheme, etc."
2030 (interactive)
2031 ;; Note that the input string does not include its terminal newline.
2032 (let ((proc (get-buffer-process (current-buffer))))
2033 (if (not proc) (error "Current buffer has no process")
2034 (let* ((pmark (process-mark proc))
2035 (pmark-val (marker-position pmark))
2036 (input-is-new (>= (point) pmark-val))
2037 (intxt (if input-is-new
2038 (progn (if term-eol-on-send (end-of-line))
2039 (buffer-substring pmark (point)))
2040 (funcall term-get-old-input)))
2041 (input (if (not (eq term-input-autoexpand 'input))
2042 ;; Just whatever's already there
2043 intxt
2044 ;; Expand and leave it visible in buffer
2045 (term-replace-by-expanded-history t)
2046 (buffer-substring pmark (point))))
2047 (history (if (not (eq term-input-autoexpand 'history))
2048 input
2049 ;; This is messy 'cos ultimately the original
2050 ;; functions used do insertion, rather than return
2051 ;; strings. We have to expand, then insert back.
2052 (term-replace-by-expanded-history t)
2053 (let ((copy (buffer-substring pmark (point))))
2054 (delete-region pmark (point))
2055 (insert input)
2056 copy))))
2057 (when (term-pager-enabled)
2058 (save-excursion
2059 (goto-char (process-mark proc))
2060 (setq term-pager-count (term-current-row))))
2061 (when (and (funcall term-input-filter history)
2062 (or (null term-input-ignoredups)
2063 (not (ring-p term-input-ring))
2064 (ring-empty-p term-input-ring)
2065 (not (string-equal (ring-ref term-input-ring 0)
2066 history))))
2067 (ring-insert term-input-ring history))
2068 (let ((functions term-input-filter-functions))
2069 (while functions
2070 (funcall (car functions) (concat input "\n"))
2071 (setq functions (cdr functions))))
2072 (setq term-input-ring-index nil)
2074 ;; Update the markers before we send the input
2075 ;; in case we get output amidst sending the input.
2076 (set-marker term-last-input-start pmark)
2077 (set-marker term-last-input-end (point))
2078 (when input-is-new
2079 ;; Set up to delete, because inferior should echo.
2080 (when (marker-buffer term-pending-delete-marker)
2081 (delete-region term-pending-delete-marker pmark))
2082 (set-marker term-pending-delete-marker pmark-val)
2083 (set-marker (process-mark proc) (point)))
2084 (goto-char pmark)
2085 (funcall term-input-sender proc input)))))
2087 (defun term-get-old-input-default ()
2088 "Default for `term-get-old-input'.
2089 Take the current line, and discard any initial text matching
2090 `term-prompt-regexp'."
2091 (save-excursion
2092 (beginning-of-line)
2093 (term-skip-prompt)
2094 (let ((beg (point)))
2095 (end-of-line)
2096 (buffer-substring beg (point)))))
2098 (defun term-copy-old-input ()
2099 "Insert after prompt old input at point as new input to be edited.
2100 Calls `term-get-old-input' to get old input."
2101 (interactive)
2102 (let ((input (funcall term-get-old-input))
2103 (process (get-buffer-process (current-buffer))))
2104 (if (not process)
2105 (error "Current buffer has no process")
2106 (goto-char (process-mark process))
2107 (insert input))))
2109 (defun term-skip-prompt ()
2110 "Skip past the text matching regexp `term-prompt-regexp'.
2111 If this takes us past the end of the current line, don't skip at all."
2112 (let ((eol (line-end-position)))
2113 (when (and (looking-at term-prompt-regexp)
2114 (<= (match-end 0) eol))
2115 (goto-char (match-end 0)))))
2118 (defun term-after-pmark-p ()
2119 "Is point after the process output marker?"
2120 ;; Since output could come into the buffer after we looked at the point
2121 ;; but before we looked at the process marker's value, we explicitly
2122 ;; serialise. This is just because I don't know whether or not Emacs
2123 ;; services input during execution of lisp commands.
2124 (let ((proc-pos (marker-position
2125 (process-mark (get-buffer-process (current-buffer))))))
2126 (<= proc-pos (point))))
2128 (defun term-simple-send (proc string)
2129 "Default function for sending to PROC input STRING.
2130 This just sends STRING plus a newline. To override this,
2131 set the hook `term-input-sender'."
2132 (term-send-string proc string)
2133 (term-send-string proc "\n"))
2135 (defun term-bol (arg)
2136 "Go to the beginning of line, then skip past the prompt, if any.
2137 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2138 -- go straight to column 0.
2140 The prompt skip is done by skipping text matching the regular expression
2141 `term-prompt-regexp', a buffer local variable."
2142 (interactive "P")
2143 (beginning-of-line)
2144 (when (null arg) (term-skip-prompt)))
2146 ;; These two functions are for entering text you don't want echoed or
2147 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2148 ;; Just enter m-x term-send-invisible and type in your line.
2150 (defun term-read-noecho (prompt &optional stars)
2151 "Read a single line of text from user without echoing, and return it.
2152 Prompt with argument PROMPT, a string. Optional argument STARS causes
2153 input to be echoed with '*' characters on the prompt line. Input ends with
2154 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2155 `inhibit-quit' is set because e.g. this function was called from a process
2156 filter and C-g is pressed, this function returns nil rather than a string).
2158 Note that the keystrokes comprising the text can still be recovered
2159 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2160 applications."
2161 (let ((ans "")
2162 (c 0)
2163 (echo-keystrokes 0)
2164 (cursor-in-echo-area t)
2165 (done nil))
2166 (while (not done)
2167 (if stars
2168 (message "%s%s" prompt (make-string (length ans) ?*))
2169 (message "%s" prompt))
2170 (setq c (read-char))
2171 (cond ((= c ?\C-g)
2172 ;; This function may get called from a process filter, where
2173 ;; inhibit-quit is set. In later versions of Emacs read-char
2174 ;; may clear quit-flag itself and return C-g. That would make
2175 ;; it impossible to quit this loop in a simple way, so
2176 ;; re-enable it here (for backward-compatibility the check for
2177 ;; quit-flag below would still be necessary, so this seems
2178 ;; like the simplest way to do things).
2179 (setq quit-flag t
2180 done t))
2181 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2182 (setq done t))
2183 ((= c ?\C-u)
2184 (setq ans ""))
2185 ((and (/= c ?\b) (/= c ?\177))
2186 (setq ans (concat ans (char-to-string c))))
2187 ((> (length ans) 0)
2188 (setq ans (substring ans 0 -1)))))
2189 (if quit-flag
2190 ;; Emulate a true quit, except that we have to return a value.
2191 (prog1
2192 (setq quit-flag nil)
2193 (message "Quit")
2194 (beep t))
2195 (message "")
2196 ans)))
2198 (defun term-send-invisible (str &optional proc)
2199 "Read a string without echoing.
2200 Then send it to the process running in the current buffer. A new-line
2201 is additionally sent. String is not saved on term input history list.
2202 Security bug: your string can still be temporarily recovered with
2203 \\[view-lossage]."
2204 (interactive "P") ; Defeat snooping via C-x esc
2205 (when (not (stringp str))
2206 (setq str (term-read-noecho "Non-echoed text: " t)))
2207 (when (not proc)
2208 (setq proc (get-buffer-process (current-buffer))))
2209 (if (not proc) (error "Current buffer has no process")
2210 (setq term-kill-echo-list (nconc term-kill-echo-list
2211 (cons str nil)))
2212 (term-send-string proc str)
2213 (term-send-string proc "\n")))
2216 ;;; Low-level process communication
2218 (defvar term-input-chunk-size 512
2219 "*Long inputs send to term processes are broken up into chunks of this size.
2220 If your process is choking on big inputs, try lowering the value.")
2222 (defun term-send-string (proc str)
2223 "Send to PROC the contents of STR as input.
2224 This is equivalent to `process-send-string', except that long input strings
2225 are broken up into chunks of size `term-input-chunk-size'. Processes
2226 are given a chance to output between chunks. This can help prevent processes
2227 from hanging when you send them long inputs on some OS's."
2228 (let* ((len (length str))
2229 (i (min len term-input-chunk-size)))
2230 (process-send-string proc (substring str 0 i))
2231 (while (< i len)
2232 (let ((next-i (+ i term-input-chunk-size)))
2233 (accept-process-output)
2234 (process-send-string proc (substring str i (min len next-i)))
2235 (setq i next-i)))))
2237 (defun term-send-region (proc start end)
2238 "Send to PROC the region delimited by START and END.
2239 This is a replacement for `process-send-region' that tries to keep
2240 your process from hanging on long inputs. See `term-send-string'."
2241 (term-send-string proc (buffer-substring start end)))
2244 ;;; Random input hackage
2246 (defun term-kill-output ()
2247 "Kill all output from interpreter since last input."
2248 (interactive)
2249 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2250 (kill-region term-last-input-end pmark)
2251 (goto-char pmark)
2252 (insert "*** output flushed ***\n")
2253 (set-marker pmark (point))))
2255 (defun term-show-output ()
2256 "Display start of this batch of interpreter output at top of window.
2257 Sets mark to the value of point when this command is run."
2258 (interactive)
2259 (goto-char term-last-input-end)
2260 (backward-char)
2261 (beginning-of-line)
2262 (set-window-start (selected-window) (point))
2263 (end-of-line))
2265 (defun term-interrupt-subjob ()
2266 "Interrupt the current subjob."
2267 (interactive)
2268 (interrupt-process nil term-ptyp))
2270 (defun term-kill-subjob ()
2271 "Send kill signal to the current subjob."
2272 (interactive)
2273 (kill-process nil term-ptyp))
2275 (defun term-quit-subjob ()
2276 "Send quit signal to the current subjob."
2277 (interactive)
2278 (quit-process nil term-ptyp))
2280 (defun term-stop-subjob ()
2281 "Stop the current subjob.
2282 WARNING: if there is no current subjob, you can end up suspending
2283 the top-level process running in the buffer. If you accidentally do
2284 this, use \\[term-continue-subjob] to resume the process. (This
2285 is not a problem with most shells, since they ignore this signal.)"
2286 (interactive)
2287 (stop-process nil term-ptyp))
2289 (defun term-continue-subjob ()
2290 "Send CONT signal to process buffer's process group.
2291 Useful if you accidentally suspend the top-level process."
2292 (interactive)
2293 (continue-process nil term-ptyp))
2295 (defun term-kill-input ()
2296 "Kill all text from last stuff output by interpreter to point."
2297 (interactive)
2298 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2299 (p-pos (marker-position pmark)))
2300 (when (> (point) p-pos)
2301 (kill-region pmark (point)))))
2303 (defun term-delchar-or-maybe-eof (arg)
2304 "Delete ARG characters forward, or send an EOF to process if at end of
2305 buffer."
2306 (interactive "p")
2307 (if (eobp)
2308 (process-send-eof)
2309 (delete-char arg)))
2311 (defun term-send-eof ()
2312 "Send an EOF to the current buffer's process."
2313 (interactive)
2314 (process-send-eof))
2316 (defun term-backward-matching-input (regexp n)
2317 "Search backward through buffer for match for REGEXP.
2318 Matches are searched for on lines that match `term-prompt-regexp'.
2319 With prefix argument N, search for Nth previous match.
2320 If N is negative, find the next or Nth next match."
2321 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2322 (let* ((re (concat term-prompt-regexp ".*" regexp))
2323 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2324 (when (re-search-backward re nil t n)
2325 (point)))))
2326 (if (null pos)
2327 (progn (message "Not found")
2328 (ding))
2329 (goto-char pos)
2330 (term-bol nil))))
2332 (defun term-forward-matching-input (regexp n)
2333 "Search forward through buffer for match for REGEXP.
2334 Matches are searched for on lines that match `term-prompt-regexp'.
2335 With prefix argument N, search for Nth following match.
2336 If N is negative, find the previous or Nth previous match."
2337 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2338 (term-backward-matching-input regexp (- n)))
2341 (defun term-next-prompt (n)
2342 "Move to end of Nth next prompt in the buffer.
2343 See `term-prompt-regexp'."
2344 (interactive "p")
2345 (let ((paragraph-start term-prompt-regexp))
2346 (end-of-line (if (> n 0) 1 0))
2347 (forward-paragraph n)
2348 (term-skip-prompt)))
2350 (defun term-previous-prompt (n)
2351 "Move to end of Nth previous prompt in the buffer.
2352 See `term-prompt-regexp'."
2353 (interactive "p")
2354 (term-next-prompt (- n)))
2356 ;;; Support for source-file processing commands.
2357 ;;============================================================================
2358 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2359 ;; commands that process files of source text (e.g. loading or compiling
2360 ;; files). So the corresponding process-in-a-buffer modes have commands
2361 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2362 ;; for defining these commands.
2364 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2365 ;; and Soar, in that they don't know anything about file extensions.
2366 ;; So the compile/load interface gets the wrong default occasionally.
2367 ;; The load-file/compile-file default mechanism could be smarter -- it
2368 ;; doesn't know about the relationship between filename extensions and
2369 ;; whether the file is source or executable. If you compile foo.lisp
2370 ;; with compile-file, then the next load-file should use foo.bin for
2371 ;; the default, not foo.lisp. This is tricky to do right, particularly
2372 ;; because the extension for executable files varies so much (.o, .bin,
2373 ;; .lbin, .mo, .vo, .ao, ...).
2376 ;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2377 ;; commands.
2379 ;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2380 ;; want to save the buffer before issuing any process requests to the command
2381 ;; interpreter.
2383 ;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2384 ;; for the file to process.
2386 ;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2387 ;;============================================================================
2388 ;; This function computes the defaults for the load-file and compile-file
2389 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2391 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2392 ;; source-file processing command, or nil if there hasn't been one yet.
2393 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2394 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2395 ;; Typically, (lisp-mode) or (scheme-mode).
2397 ;; If the command is given while the cursor is inside a string, *and*
2398 ;; the string is an existing filename, *and* the filename is not a directory,
2399 ;; then the string is taken as default. This allows you to just position
2400 ;; your cursor over a string that's a filename and have it taken as default.
2402 ;; If the command is given in a file buffer whose major mode is in
2403 ;; SOURCE-MODES, then the filename is the default file, and the
2404 ;; file's directory is the default directory.
2406 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2407 ;; then the default directory & file are what was used in the last source-file
2408 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2409 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2410 ;; is the cwd, with no default file. (\"no default file\" = nil)
2412 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2413 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2414 ;; for Soar programs, etc.
2416 ;; The function returns a pair: (default-directory . default-file).
2418 (defun term-source-default (previous-dir/file source-modes)
2419 (cond ((and buffer-file-name (memq major-mode source-modes))
2420 (cons (file-name-directory buffer-file-name)
2421 (file-name-nondirectory buffer-file-name)))
2422 (previous-dir/file)
2424 (cons default-directory nil))))
2427 ;; (TERM-CHECK-SOURCE fname)
2428 ;;============================================================================
2429 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2430 ;; process-in-a-buffer modes), this function can be called on the filename.
2431 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2432 ;; is queried to see if he wants to save the buffer before proceeding with
2433 ;; the load or compile.
2435 (defun term-check-source (fname)
2436 (let ((buff (get-file-buffer fname)))
2437 (when (and buff
2438 (buffer-modified-p buff)
2439 (y-or-n-p (format "Save buffer %s first? "
2440 (buffer-name buff))))
2441 ;; save BUFF.
2442 (with-current-buffer buff
2443 (save-buffer)))))
2446 ;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2447 ;;============================================================================
2448 ;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2449 ;; commands that process source files (like loading or compiling a file).
2450 ;; It prompts for the filename, provides a default, if there is one,
2451 ;; and returns the result filename.
2453 ;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2455 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2456 ;; from the last source processing command. SOURCE-MODES is a list of major
2457 ;; modes used to determine what file buffers contain source files. (These
2458 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2459 ;; then the filename reader will only accept a file that exists.
2461 ;; A typical use:
2462 ;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2463 ;; '(lisp-mode) t))
2465 ;; This is pretty stupid about strings. It decides we're in a string
2466 ;; if there's a quote on both sides of point on the current line.
2467 (defun term-extract-string ()
2468 "Return string around `point' that starts the current line or nil."
2469 (save-excursion
2470 (let* ((point (point))
2471 (bol (line-beginning-position))
2472 (eol (line-end-position))
2473 (start (and (search-backward "\"" bol t)
2474 (1+ (point))))
2475 (end (progn (goto-char point)
2476 (and (search-forward "\"" eol t)
2477 (1- (point))))))
2478 (and start end
2479 (buffer-substring start end)))))
2481 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2482 (let* ((def (term-source-default prev-dir/file source-modes))
2483 (stringfile (term-extract-string))
2484 (sfile-p (and stringfile
2485 (condition-case ()
2486 (file-exists-p stringfile)
2487 (error nil))
2488 (not (file-directory-p stringfile))))
2489 (defdir (if sfile-p (file-name-directory stringfile)
2490 (car def)))
2491 (deffile (if sfile-p (file-name-nondirectory stringfile)
2492 (cdr def)))
2493 (ans (read-file-name (if deffile (format "%s(default %s) "
2494 prompt deffile)
2495 prompt)
2496 defdir
2497 (concat defdir deffile)
2498 mustmatch-p)))
2499 (list (expand-file-name (substitute-in-file-name ans)))))
2501 ;; I am somewhat divided on this string-default feature. It seems
2502 ;; to violate the principle-of-least-astonishment, in that it makes
2503 ;; the default harder to predict, so you actually have to look and see
2504 ;; what the default really is before choosing it. This can trip you up.
2505 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2506 ;; on this.
2507 ;; -Olin
2510 ;;; Simple process query facility.
2511 ;; ===========================================================================
2512 ;; This function is for commands that want to send a query to the process
2513 ;; and show the response to the user. For example, a command to get the
2514 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2515 ;; to an inferior Common Lisp process.
2517 ;; This simple facility just sends strings to the inferior process and pops
2518 ;; up a window for the process buffer so you can see what the process
2519 ;; responds with. We don't do anything fancy like try to intercept what the
2520 ;; process responds with and put it in a pop-up window or on the message
2521 ;; line. We just display the buffer. Low tech. Simple. Works good.
2523 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2524 ;; a window for the inferior process so that its response can be seen.
2525 (defun term-proc-query (proc str)
2526 (let* ((proc-buf (process-buffer proc))
2527 (proc-mark (process-mark proc)))
2528 (display-buffer proc-buf)
2529 (set-buffer proc-buf) ; but it's not the selected *window*
2530 (let ((proc-win (get-buffer-window proc-buf))
2531 (proc-pt (marker-position proc-mark)))
2532 (term-send-string proc str) ; send the query
2533 (accept-process-output proc) ; wait for some output
2534 ;; Try to position the proc window so you can see the answer.
2535 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2536 ;; I don't know why. Wizards invited to improve it.
2537 (when (not (pos-visible-in-window-p proc-pt proc-win))
2538 (let ((opoint (window-point proc-win)))
2539 (set-window-point proc-win proc-mark) (sit-for 0)
2540 (if (not (pos-visible-in-window-p opoint proc-win))
2541 (push-mark opoint)
2542 (set-window-point proc-win opoint)))))))
2544 ;; Returns the current column in the current screen line.
2545 ;; Note: (current-column) yields column in buffer line.
2547 (defun term-horizontal-column ()
2548 (- (term-current-column) (term-start-line-column)))
2550 ;; Calls either vertical-motion or term-buffer-vertical-motion
2551 (defmacro term-vertical-motion (count)
2552 (list 'funcall 'term-vertical-motion count))
2554 ; An emulation of vertical-motion that is independent of having a window.
2555 ; Instead, it uses the term-width variable as the logical window width.
2557 (defun term-buffer-vertical-motion (count)
2558 (cond ((= count 0)
2559 (move-to-column (* term-width (/ (current-column) term-width)))
2561 ((> count 0)
2562 (let ((H)
2563 (todo (+ count (/ (current-column) term-width))))
2564 (end-of-line)
2565 ;; The loop iterates over buffer lines;
2566 ;; H is the number of screen lines in the current line, i.e.
2567 ;; the ceiling of dividing the buffer line width by term-width.
2568 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2569 term-width)
2571 todo)
2572 (not (eobp)))
2573 (setq todo (- todo H))
2574 (forward-char) ;; Move past the ?\n
2575 (end-of-line)) ;; and on to the end of the next line.
2576 (if (and (>= todo H) (> todo 0))
2577 (+ (- count todo) H -1) ;; Hit end of buffer.
2578 (move-to-column (* todo term-width))
2579 count)))
2580 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2581 (let ((H)
2582 (todo (- count)))
2583 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2584 term-width)
2586 todo)
2587 (progn (beginning-of-line)
2588 (not (bobp))))
2589 (setq todo (- todo H))
2590 (backward-char)) ;; Move to end of previous line.
2591 (if (and (>= todo H) (> todo 0))
2592 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2593 (move-to-column (* (- H todo 1) term-width))
2594 count)))))
2596 ;; The term-start-line-column variable is used as a cache.
2597 (defun term-start-line-column ()
2598 (cond (term-start-line-column)
2599 ((let ((save-pos (point)))
2600 (term-vertical-motion 0)
2601 (setq term-start-line-column (current-column))
2602 (goto-char save-pos)
2603 term-start-line-column))))
2605 ;; Same as (current-column), but uses term-current-column as a cache.
2606 (defun term-current-column ()
2607 (cond (term-current-column)
2608 ((setq term-current-column (current-column)))))
2610 ;; Move DELTA column right (or left if delta < 0 limiting at column 0).
2612 (defun term-move-columns (delta)
2613 (setq term-current-column (max 0 (+ (term-current-column) delta)))
2614 (let ((point-at-eol (line-end-position)))
2615 (move-to-column term-current-column t)
2616 ;; If move-to-column extends the current line it will use the face
2617 ;; from the last character on the line, set the face for the chars
2618 ;; to default.
2619 (when (> (point) point-at-eol)
2620 (put-text-property point-at-eol (point) 'face 'default))))
2622 ;; Insert COUNT copies of CHAR in the default face.
2623 (defun term-insert-char (char count)
2624 (let ((old-point (point)))
2625 (insert-char char count)
2626 (put-text-property old-point (point) 'face 'default)))
2628 (defun term-current-row ()
2629 (cond (term-current-row)
2630 ((setq term-current-row
2631 (save-restriction
2632 (save-excursion
2633 (narrow-to-region term-home-marker (point-max))
2634 (- (term-vertical-motion -9999))))))))
2636 (defun term-adjust-current-row-cache (delta)
2637 (when term-current-row
2638 (setq term-current-row
2639 (max 0 (+ term-current-row delta)))))
2641 (defun term-terminal-pos ()
2642 (save-excursion ; save-restriction
2643 (let ((save-col (term-current-column))
2644 x y)
2645 (term-vertical-motion 0)
2646 (setq x (- save-col (current-column)))
2647 (setq y (term-vertical-motion term-height))
2648 (cons x y))))
2650 ;;Function that handles term messages: code by rms (and you can see the
2651 ;;difference ;-) -mm
2653 (defun term-handle-ansi-terminal-messages (message)
2654 ;; Is there a command here?
2655 (while (string-match "\eAnSiT.+\n" message)
2656 ;; Extract the command code and the argument.
2657 (let* ((start (match-beginning 0))
2658 (command-code (aref message (+ start 6)))
2659 (argument
2660 (save-match-data
2661 (substring message
2662 (+ start 8)
2663 (string-match "\r?\n" message
2664 (+ start 8)))))
2665 ignore)
2666 ;; Delete this command from MESSAGE.
2667 (setq message (replace-match "" t t message))
2669 ;; If we recognize the type of command, set the appropriate variable.
2670 (cond ((= command-code ?c)
2671 (setq term-ansi-at-dir argument))
2672 ((= command-code ?h)
2673 (setq term-ansi-at-host argument))
2674 ((= command-code ?u)
2675 (setq term-ansi-at-user argument))
2676 ;; Otherwise ignore this one.
2678 (setq ignore t)))
2680 ;; Update default-directory based on the changes this command made.
2681 (if ignore
2683 (setq default-directory
2684 (file-name-as-directory
2685 (if (and (string= term-ansi-at-host (system-name))
2686 (string= term-ansi-at-user (user-real-login-name)))
2687 (expand-file-name term-ansi-at-dir)
2688 (if (string= term-ansi-at-user (user-real-login-name))
2689 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2690 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2691 term-ansi-at-dir)))))
2693 ;; I'm not sure this is necessary,
2694 ;; but it's best to be on the safe side.
2695 (if (string= term-ansi-at-host (system-name))
2696 (progn
2697 (setq ange-ftp-default-user term-ansi-at-save-user)
2698 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2699 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2700 (setq term-ansi-at-save-user ange-ftp-default-user)
2701 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2702 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2703 (setq ange-ftp-default-user nil)
2704 (setq ange-ftp-default-password nil)
2705 (setq ange-ftp-generate-anonymous-password nil)))))
2706 message)
2709 ;; Terminal emulation
2710 ;; This is the standard process filter for term buffers.
2711 ;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2713 (defun term-emulate-terminal (proc str)
2714 (with-current-buffer (process-buffer proc)
2715 (let* ((i 0) char funny
2716 count ; number of decoded chars in substring
2717 count-bytes ; number of bytes
2718 decoded-substring
2719 save-point save-marker old-point temp win
2720 (buffer-undo-list t)
2721 (selected (selected-window))
2722 last-win
2723 handled-ansi-message
2724 (str-length (length str)))
2725 (save-selected-window
2727 ;; Let's handle the messages. -mm
2729 (let* ((newstr (term-handle-ansi-terminal-messages str)))
2730 (when (not (eq str newstr))
2731 (setq handled-ansi-message t
2732 str newstr)))
2733 (setq str-length (length str))
2735 (when (marker-buffer term-pending-delete-marker)
2736 ;; Delete text following term-pending-delete-marker.
2737 (delete-region term-pending-delete-marker (process-mark proc))
2738 (set-marker term-pending-delete-marker nil))
2740 (if (eq (window-buffer) (current-buffer))
2741 (progn
2742 (setq term-vertical-motion (symbol-function 'vertical-motion))
2743 (term-check-size proc))
2744 (setq term-vertical-motion
2745 (symbol-function 'term-buffer-vertical-motion)))
2747 (setq save-marker (copy-marker (process-mark proc)))
2749 (when (/= (point) (process-mark proc))
2750 (setq save-point (point-marker))
2751 (goto-char (process-mark proc)))
2753 (save-restriction
2754 ;; If the buffer is in line mode, and there is a partial
2755 ;; input line, save the line (by narrowing to leave it
2756 ;; outside the restriction ) until we're done with output.
2757 (when (and (> (point-max) (process-mark proc))
2758 (term-in-line-mode))
2759 (narrow-to-region (point-min) (process-mark proc)))
2761 (when term-log-buffer
2762 (princ str term-log-buffer))
2763 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2764 (setq str (concat term-terminal-parameter str))
2765 (setq term-terminal-parameter nil)
2766 (setq str-length (length str))
2767 (setq term-terminal-state 0)))
2769 (while (< i str-length)
2770 (setq char (aref str i))
2771 (cond ((< term-terminal-state 2)
2772 ;; Look for prefix of regular chars
2773 (setq funny
2774 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2775 str i))
2776 (when (not funny) (setq funny str-length))
2777 (cond ((> funny i)
2778 ;; Decode the string before counting
2779 ;; characters, to avoid garbling of certain
2780 ;; multibyte characters (bug#1006).
2781 (setq decoded-substring
2782 (decode-coding-string
2783 (substring str i funny)
2784 locale-coding-system))
2785 (cond ((eq term-terminal-state 1)
2786 ;; We are in state 1, we need to wrap
2787 ;; around. Go to the beginning of
2788 ;; the next line and switch to state
2789 ;; 0.
2790 (term-down 1 t)
2791 (term-move-columns (- (term-current-column)))
2792 (setq term-terminal-state 0)))
2793 (setq count (length decoded-substring))
2794 (setq temp (- (+ (term-horizontal-column) count)
2795 term-width))
2796 (cond ((<= temp 0)) ;; All count chars fit in line.
2797 ((> count temp) ;; Some chars fit.
2798 ;; This iteration, handle only what fits.
2799 (setq count (- count temp))
2800 (setq count-bytes
2801 (length
2802 (encode-coding-string
2803 (substring decoded-substring 0 count)
2804 'binary)))
2805 (setq temp 0)
2806 (setq funny (+ count-bytes i)))
2807 ((or (not (or term-pager-count
2808 term-scroll-with-delete))
2809 (> (term-handle-scroll 1) 0))
2810 (term-adjust-current-row-cache 1)
2811 (setq count (min count term-width))
2812 (setq count-bytes
2813 (length
2814 (encode-coding-string
2815 (substring decoded-substring 0 count)
2816 'binary)))
2817 (setq funny (+ count-bytes i))
2818 (setq term-start-line-column
2819 term-current-column))
2820 (t ;; Doing PAGER processing.
2821 (setq count 0 funny i)
2822 (setq term-current-column nil)
2823 (setq term-start-line-column nil)))
2824 (setq old-point (point))
2826 ;; Insert a string, check how many columns
2827 ;; we moved, then delete that many columns
2828 ;; following point if not eob nor insert-mode.
2829 (let ((old-column (current-column))
2830 columns pos)
2831 (insert (decode-coding-string (substring str i funny) locale-coding-system))
2832 (setq term-current-column (current-column)
2833 columns (- term-current-column old-column))
2834 (when (not (or (eobp) term-insert-mode))
2835 (setq pos (point))
2836 (term-move-columns columns)
2837 (delete-region pos (point)))
2838 ;; In insert mode if the current line
2839 ;; has become too long it needs to be
2840 ;; chopped off.
2841 (when term-insert-mode
2842 (setq pos (point))
2843 (end-of-line)
2844 (when (> (current-column) term-width)
2845 (delete-region (- (point) (- (current-column) term-width))
2846 (point)))
2847 (goto-char pos)))
2848 (setq term-current-column nil)
2850 (put-text-property old-point (point)
2851 'face term-current-face)
2852 ;; If the last char was written in last column,
2853 ;; back up one column, but remember we did so.
2854 ;; Thus we emulate xterm/vt100-style line-wrapping.
2855 (cond ((eq temp 0)
2856 (term-move-columns -1)
2857 (setq term-terminal-state 1)))
2858 (setq i (1- funny)))
2859 ((and (setq term-terminal-state 0)
2860 (eq char ?\^I)) ; TAB (terminfo: ht)
2861 (setq count (term-current-column))
2862 ;; The line cannot exceed term-width. TAB at
2863 ;; the end of a line should not cause wrapping.
2864 (setq count (min term-width
2865 (+ count 8 (- (mod count 8)))))
2866 (if (> term-width count)
2867 (progn
2868 (term-move-columns
2869 (- count (term-current-column)))
2870 (setq term-current-column count))
2871 (when (> term-width (term-current-column))
2872 (term-move-columns
2873 (1- (- term-width (term-current-column)))))
2874 (when (= term-width (term-current-column))
2875 (term-move-columns -1))))
2876 ((eq char ?\r) ;; (terminfo: cr)
2877 (term-vertical-motion 0)
2878 (setq term-current-column term-start-line-column))
2879 ((eq char ?\n) ;; (terminfo: cud1, ind)
2880 (unless (and term-kill-echo-list
2881 (term-check-kill-echo-list))
2882 (term-down 1 t)))
2883 ((eq char ?\b) ;; (terminfo: cub1)
2884 (term-move-columns -1))
2885 ((eq char ?\033) ; Escape
2886 (setq term-terminal-state 2))
2887 ((eq char 0)) ; NUL: Do nothing
2888 ((eq char ?\016)) ; Shift Out - ignored
2889 ((eq char ?\017)) ; Shift In - ignored
2890 ((eq char ?\^G) ;; (terminfo: bel)
2891 (beep t))
2892 ((and (eq char ?\032)
2893 (not handled-ansi-message))
2894 (let ((end (string-match "\r?$" str i)))
2895 (if end
2896 (funcall term-command-hook
2897 (prog1 (substring str (1+ i) end)
2898 (setq i (match-end 0))))
2899 (setq term-terminal-parameter (substring str i))
2900 (setq term-terminal-state 4)
2901 (setq i str-length))))
2902 (t ; insert char FIXME: Should never happen
2903 (term-move-columns 1)
2904 (backward-delete-char 1)
2905 (insert char))))
2906 ((eq term-terminal-state 2) ; Seen Esc
2907 (cond ((eq char ?\133) ;; ?\133 = ?[
2909 ;; Some modifications to cope with multiple
2910 ;; settings like ^[[01;32;43m -mm
2911 ;; Note that now the init value of
2912 ;; term-terminal-previous-parameter has been
2913 ;; changed to -1
2915 (setq term-terminal-parameter 0)
2916 (setq term-terminal-previous-parameter -1)
2917 (setq term-terminal-previous-parameter-2 -1)
2918 (setq term-terminal-previous-parameter-3 -1)
2919 (setq term-terminal-previous-parameter-4 -1)
2920 (setq term-terminal-more-parameters 0)
2921 (setq term-terminal-state 3))
2922 ((eq char ?D) ;; scroll forward
2923 (term-handle-deferred-scroll)
2924 (term-down 1 t)
2925 (setq term-terminal-state 0))
2926 ;; ((eq char ?E) ;; (terminfo: nw), not used for
2927 ;; ;; now, but this is a working
2928 ;; ;; implementation
2929 ;; (term-down 1)
2930 ;; (term-goto term-current-row 0)
2931 ;; (setq term-terminal-state 0))
2932 ((eq char ?M) ;; scroll reversed (terminfo: ri)
2933 (if (or (< (term-current-row) term-scroll-start)
2934 (>= (1- (term-current-row))
2935 term-scroll-start))
2936 ;; Scrolling up will not move outside
2937 ;; the scroll region.
2938 (term-down -1)
2939 ;; Scrolling the scroll region is needed.
2940 (term-down -1 t))
2941 (setq term-terminal-state 0))
2942 ((eq char ?7) ;; Save cursor (terminfo: sc)
2943 (term-handle-deferred-scroll)
2944 (setq term-saved-cursor
2945 (list (term-current-row)
2946 (term-horizontal-column)
2947 term-ansi-current-bg-color
2948 term-ansi-current-bold
2949 term-ansi-current-color
2950 term-ansi-current-invisible
2951 term-ansi-current-reverse
2952 term-ansi-current-underline
2953 term-current-face)
2955 (setq term-terminal-state 0))
2956 ((eq char ?8) ;; Restore cursor (terminfo: rc)
2957 (when term-saved-cursor
2958 (term-goto (nth 0 term-saved-cursor)
2959 (nth 1 term-saved-cursor))
2960 (setq term-ansi-current-bg-color
2961 (nth 2 term-saved-cursor)
2962 term-ansi-current-bold
2963 (nth 3 term-saved-cursor)
2964 term-ansi-current-color
2965 (nth 4 term-saved-cursor)
2966 term-ansi-current-invisible
2967 (nth 5 term-saved-cursor)
2968 term-ansi-current-reverse
2969 (nth 6 term-saved-cursor)
2970 term-ansi-current-underline
2971 (nth 7 term-saved-cursor)
2972 term-current-face
2973 (nth 8 term-saved-cursor)))
2974 (setq term-terminal-state 0))
2975 ((eq char ?c) ;; \Ec - Reset (terminfo: rs1)
2976 ;; This is used by the "clear" program.
2977 (setq term-terminal-state 0)
2978 (term-reset-terminal))
2979 ;; The \E#8 reset sequence for xterm. We
2980 ;; probably don't need to handle it, but this
2981 ;; is the code to parse it.
2982 ;; ((eq char ?#)
2983 ;; (when (eq (aref str (1+ i)) ?8)
2984 ;; (setq i (1+ i))
2985 ;; (setq term-scroll-start 0)
2986 ;; (setq term-scroll-end term-height)
2987 ;; (setq term-terminal-state 0)))
2988 ((setq term-terminal-state 0))))
2989 ((eq term-terminal-state 3) ; Seen Esc [
2990 (cond ((and (>= char ?0) (<= char ?9))
2991 (setq term-terminal-parameter
2992 (+ (* 10 term-terminal-parameter) (- char ?0))))
2993 ((eq char ?\;)
2994 ;; Some modifications to cope with multiple
2995 ;; settings like ^[[01;32;43m -mm
2996 (setq term-terminal-more-parameters 1)
2997 (setq term-terminal-previous-parameter-4
2998 term-terminal-previous-parameter-3)
2999 (setq term-terminal-previous-parameter-3
3000 term-terminal-previous-parameter-2)
3001 (setq term-terminal-previous-parameter-2
3002 term-terminal-previous-parameter)
3003 (setq term-terminal-previous-parameter
3004 term-terminal-parameter)
3005 (setq term-terminal-parameter 0))
3006 ((eq char ??)) ; Ignore ?
3008 (term-handle-ansi-escape proc char)
3009 (setq term-terminal-more-parameters 0)
3010 (setq term-terminal-previous-parameter-4 -1)
3011 (setq term-terminal-previous-parameter-3 -1)
3012 (setq term-terminal-previous-parameter-2 -1)
3013 (setq term-terminal-previous-parameter -1)
3014 (setq term-terminal-state 0)))))
3015 (when (term-handling-pager)
3016 ;; Finish stuff to get ready to handle PAGER.
3017 (if (> (% (current-column) term-width) 0)
3018 (setq term-terminal-parameter
3019 (substring str i))
3020 ;; We're at column 0. Goto end of buffer; to compensate,
3021 ;; prepend a ?\r for later. This looks more consistent.
3022 (if (zerop i)
3023 (setq term-terminal-parameter
3024 (concat "\r" (substring str i)))
3025 (setq term-terminal-parameter (substring str (1- i)))
3026 (aset term-terminal-parameter 0 ?\r))
3027 (goto-char (point-max)))
3028 (setq term-terminal-state 4)
3029 (make-local-variable 'term-pager-old-filter)
3030 (setq term-pager-old-filter (process-filter proc))
3031 (set-process-filter proc term-pager-filter)
3032 (setq i str-length))
3033 (setq i (1+ i))))
3035 (when (>= (term-current-row) term-height)
3036 (term-handle-deferred-scroll))
3038 (set-marker (process-mark proc) (point))
3039 (when save-point
3040 (goto-char save-point)
3041 (set-marker save-point nil))
3043 ;; Check for a pending filename-and-line number to display.
3044 ;; We do this before scrolling, because we might create a new window.
3045 (when (and term-pending-frame
3046 (eq (window-buffer selected) (current-buffer)))
3047 (term-display-line (car term-pending-frame)
3048 (cdr term-pending-frame))
3049 (setq term-pending-frame nil)
3050 ;; We have created a new window, so check the window size.
3051 (term-check-size proc))
3053 ;; Scroll each window displaying the buffer but (by default)
3054 ;; only if the point matches the process-mark we started with.
3055 (setq win selected)
3056 ;; Avoid infinite loop in strange case where minibuffer window
3057 ;; is selected but not active.
3058 (while (window-minibuffer-p win)
3059 (setq win (next-window win nil t)))
3060 (setq last-win win)
3061 (while (progn
3062 (setq win (next-window win nil t))
3063 (when (eq (window-buffer win) (process-buffer proc))
3064 (let ((scroll term-scroll-to-bottom-on-output))
3065 (select-window win)
3066 (when (or (= (point) save-marker)
3067 (eq scroll t) (eq scroll 'all)
3068 ;; Maybe user wants point to jump to the end.
3069 (and (eq selected win)
3070 (or (eq scroll 'this) (not save-point)))
3071 (and (eq scroll 'others)
3072 (not (eq selected win))))
3073 (goto-char term-home-marker)
3074 (recenter 0)
3075 (goto-char (process-mark proc))
3076 (if (not (pos-visible-in-window-p (point) win))
3077 (recenter -1)))
3078 ;; Optionally scroll so that the text
3079 ;; ends at the bottom of the window.
3080 (when (and term-scroll-show-maximum-output
3081 (>= (point) (process-mark proc)))
3082 (save-excursion
3083 (goto-char (point-max))
3084 (recenter -1)))))
3085 (not (eq win last-win))))
3087 ;; Stolen from comint.el and adapted -mm
3088 (when (> term-buffer-maximum-size 0)
3089 (save-excursion
3090 (goto-char (process-mark (get-buffer-process (current-buffer))))
3091 (forward-line (- term-buffer-maximum-size))
3092 (beginning-of-line)
3093 (delete-region (point-min) (point))))
3094 (set-marker save-marker nil)))
3095 ;; This might be expensive, but we need it to handle something
3096 ;; like `sleep 5 | less -c' in more-or-less real time.
3097 (when (get-buffer-window (current-buffer))
3098 (redisplay))))
3100 (defun term-handle-deferred-scroll ()
3101 (let ((count (- (term-current-row) term-height)))
3102 (when (>= count 0)
3103 (save-excursion
3104 (goto-char term-home-marker)
3105 (term-vertical-motion (1+ count))
3106 (set-marker term-home-marker (point))
3107 (setq term-current-row (1- term-height))))))
3109 (defun term-reset-terminal ()
3110 "Reset the terminal, delete all the content and set the face to the default one."
3111 (erase-buffer)
3112 (term-ansi-reset)
3113 (setq term-current-row 0)
3114 (setq term-current-column 1)
3115 (setq term-scroll-start 0)
3116 (setq term-scroll-end term-height)
3117 (setq term-insert-mode nil)
3118 ;; FIXME: No idea why this is here, it looks wrong. --Stef
3119 (setq term-ansi-face-already-done nil))
3121 ;; New function to deal with ansi colorized output, as you can see you can
3122 ;; have any bold/underline/fg/bg/reverse combination. -mm
3124 (defvar term-bold-attribute '(:weight bold)
3125 "Attribute to use for the bold terminal attribute.
3126 Set it to nil to disable bold.")
3128 (defun term-handle-colors-array (parameter)
3129 (cond
3131 ;; Bold (terminfo: bold)
3132 ((eq parameter 1)
3133 (setq term-ansi-current-bold t))
3135 ;; Underline
3136 ((eq parameter 4)
3137 (setq term-ansi-current-underline t))
3139 ;; Blink (unsupported by Emacs), will be translated to bold.
3140 ;; This may change in the future though.
3141 ((eq parameter 5)
3142 (setq term-ansi-current-bold t))
3144 ;; Reverse (terminfo: smso)
3145 ((eq parameter 7)
3146 (setq term-ansi-current-reverse t))
3148 ;; Invisible
3149 ((eq parameter 8)
3150 (setq term-ansi-current-invisible t))
3152 ;; Reset underline (terminfo: rmul)
3153 ((eq parameter 24)
3154 (setq term-ansi-current-underline nil))
3156 ;; Reset reverse (terminfo: rmso)
3157 ((eq parameter 27)
3158 (setq term-ansi-current-reverse nil))
3160 ;; Foreground
3161 ((and (>= parameter 30) (<= parameter 37))
3162 (setq term-ansi-current-color (- parameter 29)))
3164 ;; Reset foreground
3165 ((eq parameter 39)
3166 (setq term-ansi-current-color 0))
3168 ;; Background
3169 ((and (>= parameter 40) (<= parameter 47))
3170 (setq term-ansi-current-bg-color (- parameter 39)))
3172 ;; Reset background
3173 ((eq parameter 49)
3174 (setq term-ansi-current-bg-color 0))
3176 ;; 0 (Reset) or unknown (reset anyway)
3178 (term-ansi-reset)))
3180 ;; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3181 ;; term-ansi-current-underline
3182 ;; term-ansi-current-reverse
3183 ;; term-ansi-current-bold
3184 ;; term-ansi-current-invisible
3185 ;; term-ansi-face-already-done
3186 ;; term-ansi-current-color
3187 ;; term-ansi-current-bg-color)
3190 (unless term-ansi-face-already-done
3191 (if term-ansi-current-invisible
3192 (let ((color
3193 (if term-ansi-current-reverse
3194 (if (= term-ansi-current-color 0)
3195 term-default-fg-color
3196 (elt ansi-term-color-vector term-ansi-current-color))
3197 (if (= term-ansi-current-bg-color 0)
3198 term-default-bg-color
3199 (elt ansi-term-color-vector term-ansi-current-bg-color)))))
3200 (setq term-current-face
3201 (list :background color
3202 :foreground color))
3203 ) ;; No need to bother with anything else if it's invisible.
3205 (setq term-current-face
3206 (if term-ansi-current-reverse
3207 (if (= term-ansi-current-color 0)
3208 (list :background term-default-fg-color
3209 :foreground term-default-bg-color)
3210 (list :background
3211 (elt ansi-term-color-vector term-ansi-current-color)
3212 :foreground
3213 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3215 (if (= term-ansi-current-color 0)
3216 (list :foreground term-default-fg-color
3217 :background term-default-bg-color)
3218 (list :foreground
3219 (elt ansi-term-color-vector term-ansi-current-color)
3220 :background
3221 (elt ansi-term-color-vector term-ansi-current-bg-color)))))
3223 (when term-ansi-current-bold
3224 (setq term-current-face
3225 (append term-bold-attribute term-current-face)))
3226 (when term-ansi-current-underline
3227 (setq term-current-face
3228 (list* :underline t term-current-face)))))
3230 ;; (message "Debug %S" term-current-face)
3231 ;; FIXME: shouldn't we set term-ansi-face-already-done to t here? --Stef
3232 (setq term-ansi-face-already-done nil))
3235 ;; Handle a character assuming (eq terminal-state 2) -
3236 ;; i.e. we have previously seen Escape followed by ?[.
3238 (defun term-handle-ansi-escape (proc char)
3239 (cond
3240 ((or (eq char ?H) ;; cursor motion (terminfo: cup,home)
3241 ;; (eq char ?f) ;; xterm seems to handle this sequence too, not
3242 ;; needed for now
3244 (when (<= term-terminal-parameter 0)
3245 (setq term-terminal-parameter 1))
3246 (when (<= term-terminal-previous-parameter 0)
3247 (setq term-terminal-previous-parameter 1))
3248 (when (> term-terminal-previous-parameter term-height)
3249 (setq term-terminal-previous-parameter term-height))
3250 (when (> term-terminal-parameter term-width)
3251 (setq term-terminal-parameter term-width))
3252 (term-goto
3253 (1- term-terminal-previous-parameter)
3254 (1- term-terminal-parameter)))
3255 ;; \E[A - cursor up (terminfo: cuu, cuu1)
3256 ((eq char ?A)
3257 (term-handle-deferred-scroll)
3258 (let ((tcr (term-current-row)))
3259 (term-down
3260 (if (< (- tcr term-terminal-parameter) term-scroll-start)
3261 ;; If the amount to move is before scroll start, move
3262 ;; to scroll start.
3263 (- term-scroll-start tcr)
3264 (if (>= term-terminal-parameter tcr)
3265 (- tcr)
3266 (- (max 1 term-terminal-parameter)))) t)))
3267 ;; \E[B - cursor down (terminfo: cud)
3268 ((eq char ?B)
3269 (let ((tcr (term-current-row)))
3270 (unless (= tcr (1- term-scroll-end))
3271 (term-down
3272 (if (> (+ tcr term-terminal-parameter) term-scroll-end)
3273 (- term-scroll-end 1 tcr)
3274 (max 1 term-terminal-parameter)) t))))
3275 ;; \E[C - cursor right (terminfo: cuf, cuf1)
3276 ((eq char ?C)
3277 (term-move-columns
3278 (max 1
3279 (if (>= (+ term-terminal-parameter (term-current-column)) term-width)
3280 (- term-width (term-current-column) 1)
3281 term-terminal-parameter))))
3282 ;; \E[D - cursor left (terminfo: cub)
3283 ((eq char ?D)
3284 (term-move-columns (- (max 1 term-terminal-parameter))))
3285 ;; \E[J - clear to end of screen (terminfo: ed, clear)
3286 ((eq char ?J)
3287 (term-erase-in-display term-terminal-parameter))
3288 ;; \E[K - clear to end of line (terminfo: el, el1)
3289 ((eq char ?K)
3290 (term-erase-in-line term-terminal-parameter))
3291 ;; \E[L - insert lines (terminfo: il, il1)
3292 ((eq char ?L)
3293 (term-insert-lines (max 1 term-terminal-parameter)))
3294 ;; \E[M - delete lines (terminfo: dl, dl1)
3295 ((eq char ?M)
3296 (term-delete-lines (max 1 term-terminal-parameter)))
3297 ;; \E[P - delete chars (terminfo: dch, dch1)
3298 ((eq char ?P)
3299 (term-delete-chars (max 1 term-terminal-parameter)))
3300 ;; \E[@ - insert spaces (terminfo: ich)
3301 ((eq char ?@)
3302 (term-insert-spaces (max 1 term-terminal-parameter)))
3303 ;; \E[?h - DEC Private Mode Set
3304 ((eq char ?h)
3305 (cond ((eq term-terminal-parameter 4) ;; (terminfo: smir)
3306 (setq term-insert-mode t))
3307 ;; ((eq term-terminal-parameter 47) ;; (terminfo: smcup)
3308 ;; (term-switch-to-alternate-sub-buffer t))
3310 ;; \E[?l - DEC Private Mode Reset
3311 ((eq char ?l)
3312 (cond ((eq term-terminal-parameter 4) ;; (terminfo: rmir)
3313 (setq term-insert-mode nil))
3314 ;; ((eq term-terminal-parameter 47) ;; (terminfo: rmcup)
3315 ;; (term-switch-to-alternate-sub-buffer nil))
3318 ;; Modified to allow ansi coloring -mm
3319 ;; \E[m - Set/reset modes, set bg/fg
3320 ;;(terminfo: smso,rmso,smul,rmul,rev,bold,sgr0,invis,op,setab,setaf)
3321 ((eq char ?m)
3322 (when (= term-terminal-more-parameters 1)
3323 (when (>= term-terminal-previous-parameter-4 0)
3324 (term-handle-colors-array term-terminal-previous-parameter-4))
3325 (when (>= term-terminal-previous-parameter-3 0)
3326 (term-handle-colors-array term-terminal-previous-parameter-3))
3327 (when (>= term-terminal-previous-parameter-2 0)
3328 (term-handle-colors-array term-terminal-previous-parameter-2))
3329 (term-handle-colors-array term-terminal-previous-parameter))
3330 (term-handle-colors-array term-terminal-parameter))
3332 ;; \E[6n - Report cursor position (terminfo: u7)
3333 ((eq char ?n)
3334 (term-handle-deferred-scroll)
3335 (process-send-string proc
3336 ;; (terminfo: u6)
3337 (format "\e[%s;%sR"
3338 (1+ (term-current-row))
3339 (1+ (term-horizontal-column)))))
3340 ;; \E[r - Set scrolling region (terminfo: csr)
3341 ((eq char ?r)
3342 (term-set-scroll-region
3343 (1- term-terminal-previous-parameter)
3344 (1- term-terminal-parameter)))
3345 (t)))
3347 (defun term-set-scroll-region (top bottom)
3348 "Set scrolling region.
3349 TOP is the top-most line (inclusive) of the new scrolling region,
3350 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3351 The top-most line is line 0."
3352 (setq term-scroll-start
3353 (if (or (< top 0) (>= top term-height))
3355 top))
3356 (setq term-scroll-end
3357 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3358 term-height
3359 bottom))
3360 (setq term-scroll-with-delete
3361 (or (term-using-alternate-sub-buffer)
3362 (not (and (= term-scroll-start 0)
3363 (= term-scroll-end term-height)))))
3364 (term-move-columns (- (term-current-column)))
3365 (term-goto 0 0))
3367 ;; (defun term-switch-to-alternate-sub-buffer (set)
3368 ;; ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3369 ;; ;; using it, do nothing. This test is needed for some programs (including
3370 ;; ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3371 ;; (term-handle-deferred-scroll)
3372 ;; (if (eq set (not (term-using-alternate-sub-buffer)))
3373 ;; (let ((row (term-current-row))
3374 ;; (col (term-horizontal-column)))
3375 ;; (cond (set
3376 ;; (goto-char (point-max))
3377 ;; (if (not (eq (preceding-char) ?\n))
3378 ;; (term-insert-char ?\n 1))
3379 ;; (setq term-scroll-with-delete t)
3380 ;; (setq term-saved-home-marker (copy-marker term-home-marker))
3381 ;; (set-marker term-home-marker (point)))
3382 ;; (t
3383 ;; (setq term-scroll-with-delete
3384 ;; (not (and (= term-scroll-start 0)
3385 ;; (= term-scroll-end term-height))))
3386 ;; (set-marker term-home-marker term-saved-home-marker)
3387 ;; (set-marker term-saved-home-marker nil)
3388 ;; (setq term-saved-home-marker nil)
3389 ;; (goto-char term-home-marker)))
3390 ;; (setq term-current-column nil)
3391 ;; (setq term-current-row 0)
3392 ;; (term-goto row col))))
3394 ;; Default value for the symbol term-command-hook.
3396 (defun term-command-hook (string)
3397 (cond ((equal string "")
3399 ((= (aref string 0) ?\032)
3400 ;; gdb (when invoked with -fullname) prints:
3401 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3402 (let* ((first-colon (string-match ":" string 1))
3403 (second-colon
3404 (string-match ":" string (1+ first-colon)))
3405 (filename (substring string 1 first-colon))
3406 (fileline (string-to-number
3407 (substring string (1+ first-colon) second-colon))))
3408 (setq term-pending-frame (cons filename fileline))))
3409 ((= (aref string 0) ?/)
3410 (cd (substring string 1)))
3411 ;; Allowing the inferior to call functions in Emacs is
3412 ;; probably too big a security hole.
3413 ;; ((= (aref string 0) ?!)
3414 ;; (eval (car (read-from-string string 1))))
3415 (t)));; Otherwise ignore it
3417 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3418 ;; and that its line LINE is visible.
3419 ;; Put the overlay-arrow on the line LINE in that buffer.
3420 ;; This is mainly used by gdb.
3422 (defun term-display-line (true-file line)
3423 (term-display-buffer-line (find-file-noselect true-file) line))
3425 (defun term-display-buffer-line (buffer line)
3426 (let* ((window (display-buffer buffer t))
3427 (pos))
3428 (with-current-buffer buffer
3429 (save-restriction
3430 (widen)
3431 (goto-char (point-min))
3432 (forward-line (1- line))
3433 (setq pos (point))
3434 (setq overlay-arrow-string "=>")
3435 (or overlay-arrow-position
3436 (setq overlay-arrow-position (make-marker)))
3437 (set-marker overlay-arrow-position (point) (current-buffer)))
3438 (cond ((or (< pos (point-min)) (> pos (point-max)))
3439 (widen)
3440 (goto-char pos))))
3441 (set-window-point window overlay-arrow-position)))
3443 ;; The buffer-local marker term-home-marker defines the "home position"
3444 ;; (in terms of cursor motion). However, we move the term-home-marker
3445 ;; "down" as needed so that is no more that a window-full above (point-max).
3447 (defun term-goto-home ()
3448 (term-handle-deferred-scroll)
3449 (goto-char term-home-marker)
3450 (setq term-current-row 0)
3451 (setq term-current-column (current-column))
3452 (setq term-start-line-column term-current-column))
3454 (defun term-goto (row col)
3455 (term-handle-deferred-scroll)
3456 (cond ((and term-current-row (>= row term-current-row))
3457 ;; I assume this is a worthwhile optimization.
3458 (term-vertical-motion 0)
3459 (setq term-current-column term-start-line-column)
3460 (setq row (- row term-current-row)))
3462 (term-goto-home)))
3463 (term-down row)
3464 (term-move-columns col))
3466 ;; The page is full, so enter "pager" mode, and wait for input.
3468 (defun term-process-pager ()
3469 (when (not term-pager-break-map)
3470 (let* ((map (make-keymap))
3471 ;; (i 0)
3472 tmp)
3473 ;; (while (< i 128)
3474 ;; (define-key map (make-string 1 i) 'term-send-raw)
3475 ;; (setq i (1+ i)))
3476 (define-key map "\e"
3477 (lookup-key (current-global-map) "\e"))
3478 (define-key map "\C-x"
3479 (lookup-key (current-global-map) "\C-x"))
3480 (define-key map "\C-u"
3481 (lookup-key (current-global-map) "\C-u"))
3482 (define-key map " " 'term-pager-page)
3483 (define-key map "\r" 'term-pager-line)
3484 (define-key map "?" 'term-pager-help)
3485 (define-key map "h" 'term-pager-help)
3486 (define-key map "b" 'term-pager-back-page)
3487 (define-key map "\177" 'term-pager-back-line)
3488 (define-key map "q" 'term-pager-discard)
3489 (define-key map "D" 'term-pager-disable)
3490 (define-key map "<" 'term-pager-bob)
3491 (define-key map ">" 'term-pager-eob)
3493 ;; Add menu bar.
3494 (unless (featurep 'xemacs)
3495 (define-key map [menu-bar terminal] term-terminal-menu)
3496 (define-key map [menu-bar signals] term-signals-menu)
3497 (setq tmp (make-sparse-keymap "More pages?"))
3498 (define-key tmp [help] '("Help" . term-pager-help))
3499 (define-key tmp [disable]
3500 '("Disable paging" . term-fake-pager-disable))
3501 (define-key tmp [discard]
3502 '("Discard remaining output" . term-pager-discard))
3503 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3504 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3505 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3506 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3507 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3508 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3509 (define-key map [menu-bar page] (cons "More pages?" tmp))
3512 (setq term-pager-break-map map)))
3513 ;; (let ((process (get-buffer-process (current-buffer))))
3514 ;; (stop-process process))
3515 (setq term-pager-old-local-map (current-local-map))
3516 (use-local-map term-pager-break-map)
3517 (make-local-variable 'term-old-mode-line-format)
3518 (setq term-old-mode-line-format mode-line-format)
3519 (setq mode-line-format
3520 (list "-- **MORE** "
3521 mode-line-buffer-identification
3522 " [Type ? for help] "
3523 "%-"))
3524 (force-mode-line-update))
3526 (defun term-pager-line (lines)
3527 (interactive "p")
3528 (let* ((moved (vertical-motion (1+ lines)))
3529 (deficit (- lines moved)))
3530 (when (> moved lines)
3531 (backward-char))
3532 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3533 (recenter (1- term-height)))
3534 ((term-pager-continue deficit)))))
3536 (defun term-pager-page (arg)
3537 "Proceed past the **MORE** break, allowing the next page of output to appear."
3538 (interactive "p")
3539 (term-pager-line (* arg term-height)))
3541 ;; Pager mode command to go to beginning of buffer.
3542 (defun term-pager-bob ()
3543 (interactive)
3544 (goto-char (point-min))
3545 (when (= (vertical-motion term-height) term-height)
3546 (backward-char))
3547 (recenter (1- term-height)))
3549 ;; Pager mode command to go to end of buffer.
3550 (defun term-pager-eob ()
3551 (interactive)
3552 (goto-char term-home-marker)
3553 (recenter 0)
3554 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3556 (defun term-pager-back-line (lines)
3557 (interactive "p")
3558 (vertical-motion (- 1 lines))
3559 (if (not (bobp))
3560 (backward-char)
3561 (beep)
3562 ;; Move cursor to end of window.
3563 (vertical-motion term-height)
3564 (backward-char))
3565 (recenter (1- term-height)))
3567 (defun term-pager-back-page (arg)
3568 (interactive "p")
3569 (term-pager-back-line (* arg term-height)))
3571 (defun term-pager-discard ()
3572 (interactive)
3573 (setq term-terminal-parameter "")
3574 (interrupt-process nil t)
3575 (term-pager-continue term-height))
3577 ;; Disable pager processing.
3578 ;; Only callable while in pager mode. (Contrast term-disable-pager.)
3579 (defun term-pager-disable ()
3580 (interactive)
3581 (if (term-handling-pager)
3582 (term-pager-continue nil)
3583 (setq term-pager-count nil))
3584 (term-update-mode-line))
3586 ;; Enable pager processing.
3587 (defun term-pager-enable ()
3588 (interactive)
3589 (or (term-pager-enabled)
3590 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3591 (term-update-mode-line))
3593 (defun term-pager-toggle ()
3594 (interactive)
3595 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3597 (unless (featurep 'xemacs)
3598 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3599 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3600 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3601 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3602 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3603 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3605 (defun term-pager-help ()
3606 "Provide help on commands available in a terminal-emulator **MORE** break."
3607 (interactive)
3608 (message "Terminal-emulator pager break help...")
3609 (sit-for 0)
3610 (with-electric-help
3611 (function (lambda ()
3612 (princ (substitute-command-keys
3613 "\\<term-pager-break-map>\
3614 Terminal-emulator MORE break.\n\
3615 Type one of the following keys:\n\n\
3616 \\[term-pager-page]\t\tMove forward one page.\n\
3617 \\[term-pager-line]\t\tMove forward one line.\n\
3618 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3619 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3620 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3621 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3622 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3623 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3624 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3625 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3626 \\{term-pager-break-map}\n\
3627 Any other key is passed through to the program
3628 running under the terminal emulator and disables pager processing until
3629 all pending output has been dealt with."))
3630 nil))))
3632 (defun term-pager-continue (new-count)
3633 (let ((process (get-buffer-process (current-buffer))))
3634 (use-local-map term-pager-old-local-map)
3635 (setq term-pager-old-local-map nil)
3636 (setq mode-line-format term-old-mode-line-format)
3637 (force-mode-line-update)
3638 (setq term-pager-count new-count)
3639 (set-process-filter process term-pager-old-filter)
3640 (funcall term-pager-old-filter process "")
3641 (continue-process process)))
3643 ;; Make sure there are DOWN blank lines below the current one.
3644 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3646 (defun term-handle-scroll (down)
3647 (let ((scroll-needed
3648 (- (+ (term-current-row) down)
3649 (if (< down 0) term-scroll-start term-scroll-end))))
3650 (when (or (and (< down 0) (< scroll-needed 0))
3651 (and (> down 0) (> scroll-needed 0)))
3652 (let ((save-point (copy-marker (point))) (save-top))
3653 (goto-char term-home-marker)
3654 (cond (term-scroll-with-delete
3655 (if (< down 0)
3656 (progn
3657 ;; Delete scroll-needed lines at term-scroll-end,
3658 ;; then insert scroll-needed lines.
3659 (term-vertical-motion term-scroll-end)
3660 (end-of-line)
3661 (setq save-top (point))
3662 (term-vertical-motion scroll-needed)
3663 (end-of-line)
3664 (delete-region save-top (point))
3665 (goto-char save-point)
3666 (setq down (- scroll-needed down))
3667 (term-vertical-motion down))
3668 ;; Delete scroll-needed lines at term-scroll-start.
3669 (term-vertical-motion term-scroll-start)
3670 (setq save-top (point))
3671 (term-vertical-motion scroll-needed)
3672 (delete-region save-top (point))
3673 (goto-char save-point)
3674 (term-vertical-motion down)
3675 (term-adjust-current-row-cache (- scroll-needed)))
3676 (setq term-current-column nil)
3677 (term-insert-char ?\n (abs scroll-needed)))
3678 ((and (numberp term-pager-count)
3679 (< (setq term-pager-count (- term-pager-count down))
3681 (setq down 0)
3682 (term-process-pager))
3684 (term-adjust-current-row-cache (- scroll-needed))
3685 (term-vertical-motion scroll-needed)
3686 (set-marker term-home-marker (point))))
3687 (goto-char save-point)
3688 (set-marker save-point nil))))
3689 down)
3691 (defun term-down (down &optional check-for-scroll)
3692 "Move down DOWN screen lines vertically."
3693 (let ((start-column (term-horizontal-column)))
3694 (when (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3695 (setq down (term-handle-scroll down)))
3696 (unless (and (= term-current-row 0) (< down 0))
3697 (term-adjust-current-row-cache down)
3698 (when (or (/= (point) (point-max)) (< down 0))
3699 (setq down (- down (term-vertical-motion down)))))
3700 (cond ((>= down 0)
3701 ;; Extend buffer with extra blank lines if needed.
3702 (term-insert-char ?\n down)
3703 (setq term-current-column 0)
3704 (setq term-start-line-column 0))
3706 (when (= term-current-row 0)
3707 ;; Insert lines if at the beginning.
3708 (save-excursion (term-insert-char ?\n (- down)))
3709 (save-excursion
3710 (let (p)
3711 ;; Delete lines from the end.
3712 (forward-line term-height)
3713 (setq p (point))
3714 (forward-line (- down))
3715 (delete-region p (point)))))
3716 (setq term-current-column 0)
3717 (setq term-start-line-column (current-column))))
3718 (when start-column
3719 (term-move-columns start-column))))
3721 ;; Assuming point is at the beginning of a screen line,
3722 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3723 ;; FIXME: Probably should be called more than it is.
3724 (defun term-unwrap-line ()
3725 (when (not (bolp)) (insert-before-markers ?\n)))
3727 (defun term-erase-in-line (kind)
3728 (when (= kind 1) ;; erase left of point
3729 (let ((cols (term-horizontal-column)) (saved-point (point)))
3730 (term-vertical-motion 0)
3731 (delete-region (point) saved-point)
3732 (term-insert-char ? cols)))
3733 (when (not (eq kind 1)) ;; erase right of point
3734 (let ((saved-point (point))
3735 (wrapped (and (zerop (term-horizontal-column))
3736 (not (zerop (term-current-column))))))
3737 (term-vertical-motion 1)
3738 (delete-region saved-point (point))
3739 ;; wrapped is true if we're at the beginning of screen line,
3740 ;; but not a buffer line. If we delete the current screen line
3741 ;; that will make the previous line no longer wrap, and (because
3742 ;; of the way Emacs display works) point will be at the end of
3743 ;; the previous screen line rather then the beginning of the
3744 ;; current one. To avoid that, we make sure that current line
3745 ;; contain a space, to force the previous line to continue to wrap.
3746 ;; We could do this always, but it seems preferable to not add the
3747 ;; extra space when wrapped is false.
3748 (when wrapped
3749 (insert ? ))
3750 (insert ?\n)
3751 (put-text-property saved-point (point) 'face 'default)
3752 (goto-char saved-point))))
3754 (defun term-erase-in-display (kind)
3755 "Erase (that is blank out) part of the window.
3756 If KIND is 0, erase from (point) to (point-max);
3757 if KIND is 1, erase from home to point; else erase from home to point-max."
3758 (term-handle-deferred-scroll)
3759 (cond ((eq term-terminal-parameter 0)
3760 (let ((need-unwrap (bolp)))
3761 (delete-region (point) (point-max))
3762 (when need-unwrap (term-unwrap-line))))
3763 ((let ((row (term-current-row))
3764 (col (term-horizontal-column))
3765 (start-region term-home-marker)
3766 (end-region (if (eq kind 1) (point) (point-max))))
3767 (delete-region start-region end-region)
3768 (term-unwrap-line)
3769 (when (eq kind 1)
3770 (term-insert-char ?\n row))
3771 (setq term-current-column nil)
3772 (setq term-current-row nil)
3773 (term-goto row col)))))
3775 (defun term-delete-chars (count)
3776 (let ((save-point (point)))
3777 (term-vertical-motion 1)
3778 (term-unwrap-line)
3779 (goto-char save-point)
3780 (move-to-column (+ (term-current-column) count) t)
3781 (delete-region save-point (point))))
3783 ;; Insert COUNT spaces after point, but do not change any of
3784 ;; following screen lines. Hence we may have to delete characters
3785 ;; at the end of this screen line to make room.
3787 (defun term-insert-spaces (count)
3788 (let ((save-point (point)) (save-eol) (pnt-at-eol))
3789 (term-vertical-motion 1)
3790 (when (bolp)
3791 (backward-char))
3792 (setq save-eol (point)
3793 pnt-at-eol (line-end-position))
3794 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3795 ;; If move-to-column extends the current line it will use the face
3796 ;; from the last character on the line, set the face for the chars
3797 ;; to default.
3798 (when (>= (point) pnt-at-eol)
3799 (put-text-property pnt-at-eol (point) 'face 'default))
3800 (when (> save-eol (point))
3801 (delete-region (point) save-eol))
3802 (goto-char save-point)
3803 (term-insert-char ? count)
3804 (goto-char save-point)))
3806 (defun term-delete-lines (lines)
3807 (let ((start (point))
3808 (save-current-column term-current-column)
3809 (save-start-line-column term-start-line-column)
3810 (save-current-row (term-current-row)))
3811 ;; The number of inserted lines shouldn't exceed the scroll region end.
3812 ;; The `term-scroll-end' line is part of the scrolling region, so
3813 ;; we need to go one line past it in order to ensure correct
3814 ;; scrolling.
3815 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3816 (setq lines (- lines (- (+ save-current-row lines) (1+ term-scroll-end)))))
3817 (term-down lines)
3818 (delete-region start (point))
3819 (term-down (- (1+ term-scroll-end) save-current-row lines))
3820 (term-insert-char ?\n lines)
3821 (setq term-current-column save-current-column)
3822 (setq term-start-line-column save-start-line-column)
3823 (setq term-current-row save-current-row)
3824 (goto-char start)))
3826 (defun term-insert-lines (lines)
3827 (let ((start (point))
3828 (start-deleted)
3829 (save-current-column term-current-column)
3830 (save-start-line-column term-start-line-column)
3831 (save-current-row (term-current-row)))
3832 ;; Inserting lines should take into account the scroll region.
3833 ;; The `term-scroll-end' line is part of the scrolling region, so
3834 ;; we need to go one line past it in order to ensure correct
3835 ;; scrolling.
3836 (if (< save-current-row term-scroll-start)
3837 ;; If point is before scroll start,
3838 (progn
3839 (setq lines (- lines (- term-scroll-start save-current-row)))
3840 (term-down (- term-scroll-start save-current-row))
3841 (setq start (point)))
3842 ;; The number of inserted lines shouldn't exceed the scroll region end.
3843 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3844 (setq lines (- lines (- (+ save-current-row lines)(1+ term-scroll-end)))))
3845 (term-down (- (1+ term-scroll-end) save-current-row lines)))
3846 (setq start-deleted (point))
3847 (term-down lines)
3848 (delete-region start-deleted (point))
3849 (goto-char start)
3850 (setq term-current-column save-current-column)
3851 (setq term-start-line-column save-start-line-column)
3852 (setq term-current-row save-current-row)
3853 (term-insert-char ?\n lines)
3854 (goto-char start)))
3856 (defun term-start-output-log (name)
3857 "Record raw inferior process output in a buffer."
3858 (interactive (list (if term-log-buffer
3860 (read-buffer "Record output in buffer: "
3861 (format "%s output-log"
3862 (buffer-name (current-buffer)))
3863 nil))))
3864 (if (or (null name) (equal name ""))
3865 (progn (setq term-log-buffer nil)
3866 (message "Output logging off."))
3867 (if (get-buffer name)
3869 (with-current-buffer (get-buffer-create name)
3870 (fundamental-mode)
3871 (buffer-disable-undo (current-buffer))
3872 (erase-buffer)))
3873 (setq term-log-buffer (get-buffer name))
3874 (message "Recording terminal emulator output into buffer \"%s\""
3875 (buffer-name term-log-buffer))))
3877 (defun term-stop-output-log ()
3878 "Discontinue raw inferior process logging."
3879 (interactive)
3880 (term-start-output-log nil))
3882 (defun term-show-maximum-output ()
3883 "Put the end of the buffer at the bottom of the window."
3884 (interactive)
3885 (goto-char (point-max))
3886 (recenter -1))
3888 ;;; Do the user's customisation...
3890 (defvar term-load-hook nil
3891 "This hook is run when term is loaded in.
3892 This is a good place to put keybindings.")
3894 (run-hooks 'term-load-hook)
3897 ;;; Filename/command/history completion in a buffer
3898 ;; ===========================================================================
3899 ;; Useful completion functions, courtesy of the Ergo group.
3901 ;; Six commands:
3902 ;; term-dynamic-complete Complete or expand command, filename,
3903 ;; history at point.
3904 ;; term-dynamic-complete-filename Complete filename at point.
3905 ;; term-dynamic-list-filename-completions List completions in help buffer.
3906 ;; term-replace-by-expanded-filename Expand and complete filename at point;
3907 ;; replace with expanded/completed name.
3909 ;; These are not installed in the term-mode keymap. But they are
3910 ;; available for people who want them. Shell-mode installs them:
3911 ;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3912 ;; (define-key shell-mode-map "\M-?"
3913 ;; 'term-dynamic-list-filename-completions)))
3915 ;; Commands like this are fine things to put in load hooks if you
3916 ;; want them present in specific modes.
3918 (defvar term-completion-autolist nil
3919 "*If non-nil, automatically list possibilities on partial completion.
3920 This mirrors the optional behavior of tcsh.")
3922 (defvar term-completion-addsuffix t
3923 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3924 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3925 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3926 completion. This mirrors the optional behavior of tcsh.")
3928 (defvar term-completion-recexact nil
3929 "*If non-nil, use shortest completion if characters cannot be added.
3930 This mirrors the optional behavior of tcsh.
3932 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3934 (defvar term-completion-fignore nil
3935 "*List of suffixes to be disregarded during file completion.
3936 This mirrors the optional behavior of bash and tcsh.
3938 Note that this applies to `term-dynamic-complete-filename' only.")
3940 (defvar term-file-name-prefix ""
3941 "Prefix prepended to absolute file names taken from process input.
3942 This is used by term's and shell's completion functions, and by shell's
3943 directory tracking functions.")
3946 (defun term-directory (directory)
3947 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3948 (expand-file-name (if (file-name-absolute-p directory)
3949 (concat term-file-name-prefix directory)
3950 directory)))
3953 (defun term-word (word-chars)
3954 "Return the word of WORD-CHARS at point, or nil if none is found.
3955 Word constituents are considered to be those in WORD-CHARS, which is like the
3956 inside of a \"[...]\" (see `skip-chars-forward')."
3957 (save-excursion
3958 (let ((limit (point))
3959 (word (concat "[" word-chars "]"))
3960 (non-word (concat "[^" word-chars "]")))
3961 (when (re-search-backward non-word nil 'move)
3962 (forward-char 1))
3963 ;; Anchor the search forwards.
3964 (if (or (eolp) (looking-at non-word))
3966 (re-search-forward (concat word "+") limit)
3967 (buffer-substring (match-beginning 0) (match-end 0))))))
3970 (defun term-match-partial-filename ()
3971 "Return the filename at point, or nil if none is found.
3972 Environment variables are substituted. See `term-word'."
3973 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3974 (and filename (substitute-in-file-name filename))))
3977 (defun term-dynamic-complete ()
3978 "Dynamically perform completion at point.
3979 Calls the functions in `term-dynamic-complete-functions' to perform
3980 completion until a function returns non-nil, at which point completion is
3981 assumed to have occurred."
3982 (interactive)
3983 (let ((functions term-dynamic-complete-functions))
3984 (while (and functions (null (funcall (car functions))))
3985 (setq functions (cdr functions)))))
3988 (defun term-dynamic-complete-filename ()
3989 "Dynamically complete the filename at point.
3990 Completes if after a filename. See `term-match-partial-filename' and
3991 `term-dynamic-complete-as-filename'.
3992 This function is similar to `term-replace-by-expanded-filename', except that
3993 it won't change parts of the filename already entered in the buffer; it just
3994 adds completion characters to the end of the filename. A completions listing
3995 may be shown in a help buffer if completion is ambiguous.
3997 Completion is dependent on the value of `term-completion-addsuffix',
3998 `term-completion-recexact' and `term-completion-fignore', and the timing of
3999 completions listing is dependent on the value of `term-completion-autolist'.
4001 Returns t if successful."
4002 (interactive)
4003 (when (term-match-partial-filename)
4004 (prog2 (or (eq (selected-window) (minibuffer-window))
4005 (message "Completing file name..."))
4006 (term-dynamic-complete-as-filename))))
4008 (defun term-dynamic-complete-as-filename ()
4009 "Dynamically complete at point as a filename.
4010 See `term-dynamic-complete-filename'. Returns t if successful."
4011 (let* ((completion-ignore-case nil)
4012 (completion-ignored-extensions term-completion-fignore)
4013 (success t)
4014 (dirsuffix (cond ((not term-completion-addsuffix) "")
4015 ((not (consp term-completion-addsuffix)) "/")
4016 (t (car term-completion-addsuffix))))
4017 (filesuffix (cond ((not term-completion-addsuffix) "")
4018 ((not (consp term-completion-addsuffix)) " ")
4019 (t (cdr term-completion-addsuffix))))
4020 (filename (or (term-match-partial-filename) ""))
4021 (pathdir (file-name-directory filename))
4022 (pathnondir (file-name-nondirectory filename))
4023 (directory (if pathdir (term-directory pathdir) default-directory))
4024 (completion (file-name-completion pathnondir directory))
4025 (mini-flag (eq (selected-window) (minibuffer-window))))
4026 (cond ((null completion)
4027 (message "No completions of %s" filename)
4028 (setq success nil))
4029 ((eq completion t) ; Means already completed "file".
4030 (when term-completion-addsuffix (insert " "))
4031 (or mini-flag (message "Sole completion")))
4032 ((string-equal completion "") ; Means completion on "directory/".
4033 (term-dynamic-list-filename-completions))
4034 (t ; Completion string returned.
4035 (let ((file (concat (file-name-as-directory directory) completion)))
4036 (insert (substring (directory-file-name completion)
4037 (length pathnondir)))
4038 (cond ((symbolp (file-name-completion completion directory))
4039 ;; We inserted a unique completion.
4040 (insert (if (file-directory-p file) dirsuffix filesuffix))
4041 (or mini-flag (message "Completed")))
4042 ((and term-completion-recexact term-completion-addsuffix
4043 (string-equal pathnondir completion)
4044 (file-exists-p file))
4045 ;; It's not unique, but user wants shortest match.
4046 (insert (if (file-directory-p file) dirsuffix filesuffix))
4047 (or mini-flag (message "Completed shortest")))
4048 ((or term-completion-autolist
4049 (string-equal pathnondir completion))
4050 ;; It's not unique, list possible completions.
4051 (term-dynamic-list-filename-completions))
4053 (or mini-flag (message "Partially completed")))))))
4054 success))
4057 (defun term-replace-by-expanded-filename ()
4058 "Dynamically expand and complete the filename at point.
4059 Replace the filename with an expanded, canonicalized and completed replacement.
4060 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
4061 with the corresponding directories. \"Canonicalized\" means `..' and `.' are
4062 removed, and the filename is made absolute instead of relative. For expansion
4063 see `expand-file-name' and `substitute-in-file-name'. For completion see
4064 `term-dynamic-complete-filename'."
4065 (interactive)
4066 (replace-match (expand-file-name (term-match-partial-filename)) t t)
4067 (term-dynamic-complete-filename))
4070 (defun term-dynamic-simple-complete (stub candidates)
4071 "Dynamically complete STUB from CANDIDATES list.
4072 This function inserts completion characters at point by completing STUB from
4073 the strings in CANDIDATES. A completions listing may be shown in a help buffer
4074 if completion is ambiguous.
4076 Returns nil if no completion was inserted.
4077 Returns `sole' if completed with the only completion match.
4078 Returns `shortest' if completed with the shortest of the completion matches.
4079 Returns `partial' if completed as far as possible with the completion matches.
4080 Returns `listed' if a completion listing was shown.
4082 See also `term-dynamic-complete-filename'."
4083 (let* ((completion-ignore-case nil)
4084 (candidates (mapcar (function (lambda (x) (list x))) candidates))
4085 (completions (all-completions stub candidates)))
4086 (cond ((null completions)
4087 (message "No completions of %s" stub)
4088 nil)
4089 ((= 1 (length completions)) ; Gotcha!
4090 (let ((completion (car completions)))
4091 (if (string-equal completion stub)
4092 (message "Sole completion")
4093 (insert (substring completion (length stub)))
4094 (message "Completed"))
4095 (when term-completion-addsuffix (insert " "))
4096 'sole))
4097 (t ; There's no unique completion.
4098 (let ((completion (try-completion stub candidates)))
4099 ;; Insert the longest substring.
4100 (insert (substring completion (length stub)))
4101 (cond ((and term-completion-recexact term-completion-addsuffix
4102 (string-equal stub completion)
4103 (member completion completions))
4104 ;; It's not unique, but user wants shortest match.
4105 (insert " ")
4106 (message "Completed shortest")
4107 'shortest)
4108 ((or term-completion-autolist
4109 (string-equal stub completion))
4110 ;; It's not unique, list possible completions.
4111 (term-dynamic-list-completions completions)
4112 'listed)
4114 (message "Partially completed")
4115 'partial)))))))
4116 (make-obsolete 'term-dynamic-simple-complete 'completion-in-region "23.2")
4119 (defun term-dynamic-list-filename-completions ()
4120 "List in help buffer possible completions of the filename at point."
4121 (interactive)
4122 (let* ((completion-ignore-case nil)
4123 (filename (or (term-match-partial-filename) ""))
4124 (pathdir (file-name-directory filename))
4125 (pathnondir (file-name-nondirectory filename))
4126 (directory (if pathdir (term-directory pathdir) default-directory))
4127 (completions (file-name-all-completions pathnondir directory)))
4128 (if completions
4129 (term-dynamic-list-completions completions)
4130 (message "No completions of %s" filename))))
4133 (defun term-dynamic-list-completions (completions)
4134 "List in help buffer sorted COMPLETIONS.
4135 Typing SPC flushes the help buffer."
4136 (let ((conf (current-window-configuration)))
4137 (with-output-to-temp-buffer "*Completions*"
4138 (display-completion-list (sort completions 'string-lessp)))
4139 (message "Hit space to flush")
4140 (let (key first)
4141 (if (with-current-buffer (get-buffer "*Completions*")
4142 (setq key (read-key-sequence nil)
4143 first (aref key 0))
4144 (and (consp first)
4145 (eq (window-buffer (posn-window (event-start first)))
4146 (get-buffer "*Completions*"))
4147 (eq (key-binding key) 'mouse-choose-completion)))
4148 ;; If the user does mouse-choose-completion with the mouse,
4149 ;; execute the command, then delete the completion window.
4150 (progn
4151 (choose-completion first)
4152 (set-window-configuration conf))
4153 (if (eq first ?\s)
4154 (set-window-configuration conf)
4155 (setq unread-command-events (listify-key-sequence key)))))))
4157 ;; I need a make-term that doesn't surround with *s -mm
4158 (defun term-ansi-make-term (name program &optional startfile &rest switches)
4159 "Make a term process NAME in a buffer, running PROGRAM.
4160 The name of the buffer is NAME.
4161 If there is already a running process in that buffer, it is not restarted.
4162 Optional third arg STARTFILE is the name of a file to send the contents of to
4163 the process. Any more args are arguments to PROGRAM."
4164 (let ((buffer (get-buffer-create name )))
4165 ;; If no process, or nuked process, crank up a new one and put buffer in
4166 ;; term mode. Otherwise, leave buffer and existing process alone.
4167 (cond ((not (term-check-proc buffer))
4168 (with-current-buffer buffer
4169 (term-mode)) ; Install local vars, mode, keymap, ...
4170 (term-exec buffer name program startfile switches)))
4171 buffer))
4173 (defvar term-ansi-buffer-name nil)
4174 (defvar term-ansi-default-program nil)
4175 (defvar term-ansi-buffer-base-name nil)
4177 ;;;###autoload
4178 (defun ansi-term (program &optional new-buffer-name)
4179 "Start a terminal-emulator in a new buffer."
4180 (interactive (list (read-from-minibuffer "Run program: "
4181 (or explicit-shell-file-name
4182 (getenv "ESHELL")
4183 (getenv "SHELL")
4184 "/bin/sh"))))
4186 ;; Pick the name of the new buffer.
4187 (setq term-ansi-buffer-name
4188 (if new-buffer-name
4189 new-buffer-name
4190 (if term-ansi-buffer-base-name
4191 (if (eq term-ansi-buffer-base-name t)
4192 (file-name-nondirectory program)
4193 term-ansi-buffer-base-name)
4194 "ansi-term")))
4196 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
4198 ;; In order to have more than one term active at a time
4199 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
4200 ;; for now they have the *term-ansi-term*<?> form but we'll see...
4202 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
4203 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
4205 (set-buffer term-ansi-buffer-name)
4206 (term-mode)
4207 (term-char-mode)
4209 ;; I wanna have find-file on C-x C-f -mm
4210 ;; your mileage may definitely vary, maybe it's better to put this in your
4211 ;; .emacs ...
4213 (term-set-escape-char ?\C-x)
4215 (switch-to-buffer term-ansi-buffer-name))
4218 ;;; Serial terminals
4219 ;; ===========================================================================
4220 (defun serial-port-is-file-p ()
4221 "Guess whether serial ports are files on this system.
4222 Return t if this is a Unix-based system, where serial ports are
4223 files, such as /dev/ttyS0.
4224 Return nil if this is Windows or DOS, where serial ports have
4225 special identifiers such as COM1."
4226 (not (memq system-type '(windows-nt cygwin ms-dos))))
4228 (defvar serial-name-history
4229 (if (serial-port-is-file-p)
4230 (or (when (file-exists-p "/dev/ttys0") (list "/dev/ttys0"))
4231 (when (file-exists-p "/dev/ttyS0") (list "/dev/ttyS0")))
4232 (list "COM1"))
4233 "History of serial ports used by `serial-read-name'.")
4235 (defvar serial-speed-history
4236 ;; Initialised with reasonable values for newbies.
4237 (list "9600" ;; Given twice because 9600 b/s is the most common speed
4238 "1200" "2400" "4800" "9600" "14400" "19200"
4239 "28800" "38400" "57600" "115200")
4240 "History of serial port speeds used by `serial-read-speed'.")
4242 (defun serial-nice-speed-history ()
4243 "Return `serial-speed-history' cleaned up for a mouse-menu."
4244 (let ((x) (y))
4245 (setq x
4246 (sort
4247 (copy-sequence serial-speed-history)
4248 '(lambda (a b) (when (and (stringp a) (stringp b))
4249 (> (string-to-number a) (string-to-number b))))))
4250 (dolist (i x) (when (not (equal i (car y))) (push i y)))
4253 (defconst serial-no-speed "nil"
4254 "String for `serial-read-speed' for special serial ports.
4255 If `serial-read-speed' reads this string from the user, it
4256 returns nil, which is recognized by `serial-process-configure'
4257 for special serial ports that cannot be configured.")
4259 (defun serial-supported-or-barf ()
4260 "Signal an error if serial processes are not supported."
4261 (unless (fboundp 'make-serial-process)
4262 (error "Serial processes are not supported on this system")))
4264 (defun serial-read-name ()
4265 "Read a serial port name from the user.
4266 Try to be nice by providing useful defaults and history.
4267 On Windows, prepend \\.\ to the port name unless it already
4268 contains a backslash. This handles the legacy ports COM1-COM9 as
4269 well as the newer ports COM10 and higher."
4270 (serial-supported-or-barf)
4271 (let* ((file-name-history serial-name-history)
4272 (h (car file-name-history))
4273 (x (if (serial-port-is-file-p)
4274 (read-file-name
4275 ;; `prompt': The most recently used port is provided as
4276 ;; the default value, which is used when the user
4277 ;; simply presses return.
4278 (if (stringp h) (format "Serial port (default %s): " h)
4279 "Serial port: ")
4280 ;; `directory': Most systems have their serial ports
4281 ;; in the same directory, so start in the directory
4282 ;; of the most recently used port, or in a reasonable
4283 ;; default directory.
4284 (or (and h (file-name-directory h))
4285 (and (file-exists-p "/dev/") "/dev/")
4286 (and (file-exists-p "/") "/"))
4287 ;; `default': This causes (read-file-name) to return
4288 ;; the empty string if he user simply presses return.
4289 ;; Using nil here may result in a default directory
4290 ;; of the current buffer, which is not useful for
4291 ;; serial port.
4293 (read-from-minibuffer
4294 (if (stringp h) (format "Serial port (default %s): " h)
4295 "Serial port: ")
4296 nil nil nil '(file-name-history . 1) nil nil))))
4297 (if (or (null x) (and (stringp x) (zerop (length x))))
4298 (setq x h)
4299 (setq serial-name-history file-name-history))
4300 (when (or (null x) (and (stringp x) (zerop (length x))))
4301 (error "No serial port selected"))
4302 (when (and (not (serial-port-is-file-p))
4303 (not (string-match "\\\\" x)))
4304 (set 'x (concat "\\\\.\\" x)))
4307 (defun serial-read-speed ()
4308 "Read a serial port speed (in bits per second) from the user.
4309 Try to be nice by providing useful defaults and history."
4310 (serial-supported-or-barf)
4311 (let* ((history serial-speed-history)
4312 (h (car history))
4313 (x (read-from-minibuffer
4314 (cond ((string= h serial-no-speed)
4315 "Speed (default nil = set by port): ")
4317 (format "Speed (default %s b/s): " h))
4319 (format "Speed (b/s): ")))
4320 nil nil nil '(history . 1) nil nil)))
4321 (when (or (null x) (and (stringp x) (zerop (length x))))
4322 (setq x h))
4323 (when (or (null x) (not (stringp x)) (zerop (length x)))
4324 (error "Invalid speed"))
4325 (if (string= x serial-no-speed)
4326 (setq x nil)
4327 (setq x (string-to-number x))
4328 (when (or (null x) (not (integerp x)) (<= x 0))
4329 (error "Invalid speed")))
4330 (setq serial-speed-history history)
4333 ;;;###autoload
4334 (defun serial-term (port speed)
4335 "Start a terminal-emulator for a serial port in a new buffer.
4336 PORT is the path or name of the serial port. For example, this
4337 could be \"/dev/ttyS0\" on Unix. On Windows, this could be
4338 \"COM1\" or \"\\\\.\\COM10\".
4339 SPEED is the speed of the serial port in bits per second. 9600
4340 is a common value. SPEED can be nil, see
4341 `serial-process-configure' for details.
4342 The buffer is in Term mode; see `term-mode' for the commands to
4343 use in that buffer.
4344 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
4345 (interactive (list (serial-read-name) (serial-read-speed)))
4346 (serial-supported-or-barf)
4347 (let* ((process (make-serial-process
4348 :port port
4349 :speed speed
4350 :coding 'no-conversion
4351 :noquery t))
4352 (buffer (process-buffer process)))
4353 (with-current-buffer buffer
4354 (term-mode)
4355 (term-char-mode)
4356 (goto-char (point-max))
4357 (set-marker (process-mark process) (point))
4358 (set-process-filter process 'term-emulate-terminal)
4359 (set-process-sentinel process 'term-sentinel))
4360 (switch-to-buffer buffer)
4361 buffer))
4363 (defvar serial-mode-line-speed-menu nil)
4364 (defvar serial-mode-line-config-menu nil)
4366 (defun serial-speed ()
4367 "Return the speed of the serial port of the current buffer's process.
4368 The return value may be nil for a special serial port."
4369 (process-contact (get-buffer-process (current-buffer)) :speed))
4371 (defun serial-mode-line-speed-menu-1 (event)
4372 (interactive "e")
4373 (save-selected-window
4374 (select-window (posn-window (event-start event)))
4375 (serial-update-speed-menu)
4376 (let* ((selection (serial-mode-line-speed-menu event))
4377 (binding (and selection (lookup-key serial-mode-line-speed-menu
4378 (vector (car selection))))))
4379 (when binding (call-interactively binding)))))
4381 (defun serial-mode-line-speed-menu (event)
4382 (x-popup-menu event serial-mode-line-speed-menu))
4384 (defun serial-update-speed-menu ()
4385 (setq serial-mode-line-speed-menu (make-sparse-keymap "Speed (b/s)"))
4386 (define-key serial-mode-line-speed-menu [serial-mode-line-speed-menu-other]
4387 '(menu-item "Other..."
4388 (lambda (event) (interactive "e")
4389 (let ((speed (serial-read-speed)))
4390 (serial-process-configure :speed speed)
4391 (term-update-mode-line)
4392 (message "Speed set to %d b/s" speed)))))
4393 (dolist (str (serial-nice-speed-history))
4394 (let ((num (or (and (stringp str) (string-to-number str)) 0)))
4395 (define-key
4396 serial-mode-line-speed-menu
4397 (vector (make-symbol (format "serial-mode-line-speed-menu-%s" str)))
4398 `(menu-item
4399 ,str
4400 (lambda (event) (interactive "e")
4401 (serial-process-configure :speed ,num)
4402 (term-update-mode-line)
4403 (message "Speed set to %d b/s" ,num))
4404 :button (:toggle . (= (serial-speed) ,num)))))))
4406 (defun serial-mode-line-config-menu-1 (event)
4407 (interactive "e")
4408 (save-selected-window
4409 (select-window (posn-window (event-start event)))
4410 (serial-update-config-menu)
4411 (let* ((selection (serial-mode-line-config-menu event))
4412 (binding (and selection (lookup-key serial-mode-line-config-menu
4413 (vector (car selection))))))
4414 (when binding (call-interactively binding)))))
4416 (defun serial-mode-line-config-menu (event)
4417 (x-popup-menu event serial-mode-line-config-menu))
4419 (defun serial-update-config-menu ()
4420 (setq serial-mode-line-config-menu (make-sparse-keymap "Configuration"))
4421 (let ((config (process-contact
4422 (get-buffer-process (current-buffer)) t)))
4423 (dolist (y '((:flowcontrol hw "Hardware flowcontrol (RTS/CTS)")
4424 (:flowcontrol sw "Software flowcontrol (XON/XOFF)")
4425 (:flowcontrol nil "No flowcontrol")
4426 (:stopbits 2 "2 stopbits")
4427 (:stopbits 1 "1 stopbit")
4428 (:parity odd "Odd parity")
4429 (:parity even "Even parity")
4430 (:parity nil "No parity")
4431 (:bytesize 7 "7 bits per byte")
4432 (:bytesize 8 "8 bits per byte")))
4433 (define-key serial-mode-line-config-menu
4434 (vector (make-symbol (format "%s-%s" (nth 0 y) (nth 1 y))))
4435 `(menu-item
4436 ,(nth 2 y)
4437 (lambda (event) (interactive "e")
4438 (serial-process-configure ,(nth 0 y) ',(nth 1 y))
4439 (term-update-mode-line)
4440 (message "%s" ,(nth 2 y)))
4441 ;; Use :toggle instead of :radio because a non-standard port
4442 ;; configuration may not match any menu items.
4443 :button (:toggle . ,(equal (plist-get config (nth 0 y))
4444 (nth 1 y))))))))
4447 ;;; Converting process modes to use term mode
4448 ;; ===========================================================================
4449 ;; Renaming variables
4450 ;; Most of the work is renaming variables and functions. These are the common
4451 ;; ones:
4452 ;; Local variables:
4453 ;; last-input-start term-last-input-start
4454 ;; last-input-end term-last-input-end
4455 ;; shell-prompt-pattern term-prompt-regexp
4456 ;; shell-set-directory-error-hook <no equivalent>
4457 ;; Miscellaneous:
4458 ;; shell-set-directory <unnecessary>
4459 ;; shell-mode-map term-mode-map
4460 ;; Commands:
4461 ;; shell-send-input term-send-input
4462 ;; shell-send-eof term-delchar-or-maybe-eof
4463 ;; kill-shell-input term-kill-input
4464 ;; interrupt-shell-subjob term-interrupt-subjob
4465 ;; stop-shell-subjob term-stop-subjob
4466 ;; quit-shell-subjob term-quit-subjob
4467 ;; kill-shell-subjob term-kill-subjob
4468 ;; kill-output-from-shell term-kill-output
4469 ;; show-output-from-shell term-show-output
4470 ;; copy-last-shell-input Use term-previous-input/term-next-input
4472 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4473 ;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4474 ;; Term mode does not provide functionality equivalent to
4475 ;; shell-set-directory-error-hook; it is gone.
4477 ;; term-last-input-start is provided for modes which want to munge
4478 ;; the buffer after input is sent, perhaps because the inferior
4479 ;; insists on echoing the input. The LAST-INPUT-START variable in
4480 ;; the old shell package was used to implement a history mechanism,
4481 ;; but you should think twice before using term-last-input-start
4482 ;; for this; the input history ring often does the job better.
4484 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4485 ;; *not* create the term-mode local variables in your foo-mode function.
4486 ;; This is not modular. Instead, call term-mode, and let *it* create the
4487 ;; necessary term-specific local variables. Then create the
4488 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4489 ;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4490 ;; (term-{prompt-regexp, input-filter, input-filter-functions,
4491 ;; get-old-input) that need to be different from the defaults. Call
4492 ;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4493 ;; term-mode will take care of it. The following example, from shell.el,
4494 ;; is typical:
4496 ;; (defvar shell-mode-map '())
4497 ;; (cond ((not shell-mode-map)
4498 ;; (setq shell-mode-map (copy-keymap term-mode-map))
4499 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4500 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4501 ;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4502 ;; (define-key shell-mode-map "\M-?"
4503 ;; 'term-dynamic-list-filename-completions)))
4505 ;; (defun shell-mode ()
4506 ;; (interactive)
4507 ;; (term-mode)
4508 ;; (setq term-prompt-regexp shell-prompt-pattern)
4509 ;; (setq major-mode 'shell-mode)
4510 ;; (setq mode-name "Shell")
4511 ;; (use-local-map shell-mode-map)
4512 ;; (make-local-variable 'shell-directory-stack)
4513 ;; (setq shell-directory-stack nil)
4514 ;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4515 ;; (run-mode-hooks 'shell-mode-hook))
4518 ;; Completion for term-mode users
4520 ;; For modes that use term-mode, term-dynamic-complete-functions is the
4521 ;; hook to add completion functions to. Functions on this list should return
4522 ;; non-nil if completion occurs (i.e., further completion should not occur).
4523 ;; You could use completion-in-region to do the bulk of the
4524 ;; completion job.
4526 (provide 'term)
4528 ;;; term.el ends here