]> code.delx.au - gnu-emacs/blob - lisp/term.el
0a8b35f5b40e61035b9d4b274ee2e54a65bc54cb
[gnu-emacs] / lisp / term.el
1 ;;; term.el --- general command interpreter in a window stuff
2
3 ;; Copyright (C) 1988, 1990, 1992, 1994, 1995, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
6
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
11
12 ;; This file is part of GNU Emacs.
13
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.
18
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.
23
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/>.
26
27 ;; Marck 13 2001
28 ;; Fixes for CJK support by Yong Lu <lyongu@yahoo.com>.
29
30 ;; Dir/Hostname tracking and ANSI colorization by
31 ;; Marco Melgazzi <marco@techie.com>.
32
33 ;; To see what I've modified and where it came from search for '-mm'
34
35 ;;; Commentary:
36
37 ;; Speed considerations and a few caveats
38 ;; --------------------------------------
39 ;;
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
43 ;;
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:
50 ;;
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"))
58 ;;
59 ;;
60 ;; IMPORTANT: additions & changes
61 ;; ------------------------------
62 ;;
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 :).
66 ;;
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.
71 ;;
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!)
79 ;;
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
82 ;;
83 ;; # Local access
84 ;; allow root 127.0.0.1
85 ;;
86 ;; # By default nobody can't do anything
87 ;; deny root *
88 ;;
89 ;;
90 ;; ----------------------------------------
91 ;;
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...
95 ;;
96 ;; ----------------------------------------
97 ;;
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.
101 ;;
102 ;; ----------------------------------------
103 ;;
104 ;;
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...
109 ;;
110 ;; Blink, is not supported. Currently it's mapped as bold.
111 ;;
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.
116 ;;
117 ;; ----------------------------------------
118 ;;
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!)
124 ;;
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.
129 ;;
130 ;; ----------------------------------------
131 ;;
132 ;; TODO:
133 ;;
134 ;; - Add hooks to allow raw-mode keys to be configurable
135 ;; - Which keys are better ? \eOA or \e[A ?
136 ;;
137 ;;
138 ;; Changes:
139 ;;
140 ;; V4.0 January 1997
141 ;;
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.
145 ;;
146 ;; V3.0 January 1997
147 ;;
148 ;; - Now all the supportable ANSI commands work well.
149 ;; - Reworked a little the code: much less jsh-inspired stuff
150 ;;
151 ;; V2.3 November
152 ;;
153 ;; - Now all the faces are accessed through an array: much cleaner code.
154 ;;
155 ;; V2.2 November 4 1996
156 ;;
157 ;; - Implemented ANSI output colorization ( a bit rough but enough for
158 ;; color_ls )
159 ;;
160 ;; - Implemented a maximum limit for the scroll buffer (stolen from
161 ;; comint.el)
162 ;;
163 ;; v2.1 October 28 1996, first public release
164 ;;
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
168 ;;
169 ;; ----------------------------------------------------------------
170 ;; You should/could have something like this in your .emacs to take
171 ;; full advantage of this package
172 ;;
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 ))))
183 ;;
184 ;;
185 ;; ----------------------------------------
186 ;;
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 :)
192 ;;
193 ;; ----------------------------------------
194 ;;
195 ;;
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.
200 ;;
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
206 ;;
207 ;; # Below, there should be one TERM entry for each termtype that is
208 ;; # colorizable
209 ;; TERM eterm
210 ;;
211 ;; # EIGHTBIT, followed by '1' for on, '0' for off. (8-bit output)
212 ;; EIGHTBIT 1
213 ;;
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
230 ;;
231 ;; # This is for files with execute permission:
232 ;; EXEC 00;32
233 ;;
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
251 ;;
252 ;;
253 ;; ----------------------------------------
254 ;;
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 )
258 ;;
259 ;; ----------------------------------------
260 ;;
261 ;;
262 ;; set os = `uname`
263 ;; set host = `hostname`
264 ;; set date = `date`
265 ;;
266 ;; # su does not change this but I'd like it to
267 ;;
268 ;; set user = `whoami`
269 ;;
270 ;; # ...
271 ;;
272 ;; if ( eterm =~ $TERM ) then
273 ;;
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 --------------------------------------------------------------
279 ;;
280 ;; setenv EDITOR emacsclient
281 ;;
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
287 ;;
288 ;; # These are because we want the real cwd in the messages, not the login
289 ;; # time one !
290 ;;
291 ;; set cwd_hack='$cwd'
292 ;; set host_hack='$host'
293 ;; set user_hack='$user'
294 ;;
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
299 ;;
300 ;; foreach temp (cd pushd)
301 ;; alias $temp "$temp \!* ; echo '\eAnSiTc' $cwd_hack"
302 ;; end
303 ;; alias popd 'popd ;echo "\eAnSiTc" $cwd'
304 ;;
305 ;; # Every command that can modify the user/host/directory should be aliased
306 ;; # as follows for the tracking mechanism to work.
307 ;;
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
312 ;;
313 ;; # Start up & use color ls
314 ;;
315 ;; echo "\eAnSiTh" $host
316 ;; echo "\eAnSiTu" $user
317 ;; echo "\eAnSiTc" $cwd
318 ;;
319 ;; # some housekeeping
320 ;;
321 ;; unset cwd_hack
322 ;; unset host_hack
323 ;; unset user_hack
324 ;; unset temp
325 ;;
326 ;; eval `/bin/dircolors /home/marco/.emacs_dircolors`
327 ;; endif
328 ;;
329 ;; # ...
330 ;;
331 ;; # Let's not clutter user space
332 ;;
333 ;; unset os
334 ;; unset date
335 ;;
336 ;;
337
338 ;;; Original Commentary:
339 ;; ---------------------
340
341 ;; The changelog is at the end of this file.
342
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)
346
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.).
353
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.
357
358 \f
359 ;; Brief Command Documentation:
360 ;;============================================================================
361 ;; Term Mode Commands: (common to all derived modes, like cmushell & cmulisp
362 ;; mode)
363 ;;
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
379 ;;
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).
392
393 ;; term-mode-hook is the term mode hook. Basically for your keybindings.
394 ;; term-load-hook is run after loading in this package.
395
396 ;;; Code:
397
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")
401
402 (eval-when-compile
403 (require 'ange-ftp)
404 (require 'cl))
405 (require 'ring)
406 (require 'ehelp)
407
408 (defgroup term nil
409 "General command interpreter in a window."
410 :group 'processes)
411
412 \f
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.
483
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)
488
489 (defvar term-prompt-regexp "^"
490 "Regexp to recognize prompts in the inferior process.
491 Defaults to \"^\", the null string at BOL.
492
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: \"^>+ *\"
500
501 This is a good thing to set in mode hooks.")
502
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.
509
510 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
511
512 This is a good thing to set in mode hooks.")
513
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).
517
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'.
522
523 This variable is buffer-local."
524 :type '(choice (const nil) (const t) (const input) (const history))
525 :group 'term)
526
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.
530
531 This variable is buffer-local."
532 :type 'boolean
533 :group 'term)
534
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'.
538
539 This variable is buffer-local, and is a good thing to set in mode hooks."
540 :type 'boolean
541 :group 'term)
542
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.
548
549 The default is nil.
550
551 See variable `term-scroll-show-maximum-output'.
552 This variable is buffer-local."
553 :type 'boolean
554 :group 'term)
555
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.
559
560 See variable `term-scroll-to-bottom-on-output'.
561 This variable is buffer-local."
562 :type 'boolean
563 :group 'term)
564
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)
569
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'.")
577
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'.
583
584 This is a good thing to set in mode hooks.")
585
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.")
591
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.
595
596 This variable is buffer-local.")
597
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.")
604
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)
610
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)
616
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)
625
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)
656
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))
672
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)
679
680 (defvar term-pager-break-map nil)
681
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.")
685
686 (defvar term-last-input-match ""
687 "Last string searched for by term input history search, for defaulting.
688 Buffer local variable.")
689
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)
700
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)
709
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)
716
717 (defvar term-signals-menu)
718 (defvar term-terminal-menu)
719
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)
735
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)
741
742 ;;; faces -mm
743
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)
751
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)
759
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"])
764
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.")
771 \f
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])))
779
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))
798
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))
811
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))
851
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"))
874 ))
875 \f
876 ;; Set up term-raw-map, etc.
877
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))
896
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")))
911
912 ;; Added nearly all the 'grey keys' -mm
913
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))
934
935 (term-set-escape-char ?\C-c)
936
937 (defvar overflow-newline-into-fringe)
938
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)))))
945
946 \f
947 (put 'term-mode 'mode-class 'special)
948
949
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)))
954 i)
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))
969
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))
983
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.
987
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.
992
993 In line mode, you send a line of input at a time; use
994 \\[term-send-input] to send.
995
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'.
1004
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'.
1008
1009 If you accidentally suspend your process, use \\[term-continue-subjob]
1010 to continue it.
1011
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.
1018
1019 Commands in raw mode:
1020
1021 \\{term-raw-map}
1022
1023 Commands in line mode:
1024
1025 \\{term-mode-map}
1026
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))
1061
1062 (make-local-variable 'term-command-hook)
1063 (setq term-command-hook (symbol-function 'term-command-hook))
1064
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
1069
1070 (make-local-variable 'term-ansi-at-host)
1071 (setq term-ansi-at-host (system-name))
1072
1073 (make-local-variable 'term-ansi-at-dir)
1074 (setq term-ansi-at-dir default-directory)
1075
1076 (make-local-variable 'term-ansi-at-message)
1077 (setq term-ansi-at-message nil)
1078
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)
1083
1084 ;; You may want to have different scroll-back sizes -mm
1085 (make-local-variable 'term-buffer-maximum-size)
1086
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)
1095
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)
1102
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))
1148 \f
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))
1156
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.)
1164
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))
1184
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)))
1190
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))))
1202
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)))))))
1209
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)))))
1228
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)))))))
1244
1245 (defun term-paste ()
1246 "Insert the last stretch of killed text at point."
1247 (interactive)
1248 (term-send-raw-string (current-kill 0)))
1249
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-?"))
1265 \f
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)
1275
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)))
1288
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)))
1297
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))
1328
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)))))
1334
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))
1350
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.
1356
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*"))
1367
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))
1399
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))))))
1418
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))))
1432
1433
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.")
1453
1454 ;; This auxiliary function cranks up the process for term-exec in
1455 ;; the appropriate environment.
1456
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)))
1493
1494 \f
1495 ;;; Input history processing in a buffer
1496 ;; ===========================================================================
1497 ;; Useful input history functions, courtesy of the Ergo group.
1498
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.
1512 ;;
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.
1517
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.
1523
1524 If the optional argument SILENT is non-nil, we say nothing about a
1525 failure to read the history file.
1526
1527 This function is useful for major mode commands and mode hooks.
1528
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)))
1539 (t
1540 (let ((file term-input-ring-file-name)
1541 (count 0)
1542 (ring (make-ring term-input-ring-size)))
1543 (with-temp-buffer
1544 (insert-file-contents file)
1545 ;; Save restriction in case file is already visited...
1546 ;; Watch for those date stamps in history files!
1547 (goto-char (point-max))
1548 (while (and (< count term-input-ring-size)
1549 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1550 nil t))
1551 (let ((history (buffer-substring (match-beginning 1)
1552 (match-end 1))))
1553 (when (or (null term-input-ignoredups)
1554 (ring-empty-p ring)
1555 (not (string-equal (ring-ref ring 0) history)))
1556 (ring-insert-at-beginning ring history)))
1557 (setq count (1+ count))))
1558 (setq term-input-ring ring
1559 term-input-ring-index nil)))))
1560
1561 (defun term-write-input-ring ()
1562 "Write the buffer's `term-input-ring' to a history file.
1563 The name of the file is given by the variable `term-input-ring-file-name'.
1564 The original contents of the file are lost if `term-input-ring' is not empty.
1565 If `term-input-ring-file-name' is nil this function does nothing.
1566
1567 Useful within process sentinels.
1568
1569 See also `term-read-input-ring'."
1570 (cond ((or (null term-input-ring-file-name)
1571 (equal term-input-ring-file-name "")
1572 (null term-input-ring) (ring-empty-p term-input-ring))
1573 nil)
1574 ((not (file-writable-p term-input-ring-file-name))
1575 (message "Cannot write history file %s" term-input-ring-file-name))
1576 (t
1577 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1578 (ring term-input-ring)
1579 (file term-input-ring-file-name)
1580 (index (ring-length ring)))
1581 ;; Write it all out into a buffer first. Much faster, but messier,
1582 ;; than writing it one line at a time.
1583 (with-current-buffer history-buf
1584 (erase-buffer)
1585 (while (> index 0)
1586 (setq index (1- index))
1587 (insert (ring-ref ring index) ?\n))
1588 (write-region (buffer-string) nil file nil 'no-message)
1589 (kill-buffer nil))))))
1590
1591
1592 (defun term-dynamic-list-input-ring ()
1593 "List in help buffer the buffer's input history."
1594 (interactive)
1595 (if (or (not (ring-p term-input-ring))
1596 (ring-empty-p term-input-ring))
1597 (message "No history")
1598 (let ((history nil)
1599 (history-buffer " *Input History*")
1600 (index (1- (ring-length term-input-ring)))
1601 (conf (current-window-configuration)))
1602 ;; We have to build up a list ourselves from the ring vector.
1603 (while (>= index 0)
1604 (setq history (cons (ring-ref term-input-ring index) history)
1605 index (1- index)))
1606 ;; Change "completion" to "history reference"
1607 ;; to make the display accurate.
1608 (with-output-to-temp-buffer history-buffer
1609 (display-completion-list history)
1610 (set-buffer history-buffer)
1611 (forward-line 3)
1612 (while (search-backward "completion" nil 'move)
1613 (replace-match "history reference")))
1614 (sit-for 0)
1615 (message "Hit space to flush")
1616 (let ((ch (read-event)))
1617 (if (eq ch ?\s)
1618 (set-window-configuration conf)
1619 (setq unread-command-events (list ch)))))))
1620
1621
1622 (defun term-regexp-arg (prompt)
1623 ;; Return list of regexp and prefix arg using PROMPT.
1624 (let* (;; Don't clobber this.
1625 (last-command last-command)
1626 (regexp (read-from-minibuffer prompt nil nil nil
1627 'minibuffer-history-search-history)))
1628 (list (if (string-equal regexp "")
1629 (setcar minibuffer-history-search-history
1630 (nth 1 minibuffer-history-search-history))
1631 regexp)
1632 (prefix-numeric-value current-prefix-arg))))
1633
1634 (defun term-search-arg (arg)
1635 ;; First make sure there is a ring and that we are after the process mark
1636 (cond ((not (term-after-pmark-p))
1637 (error "Not at command line"))
1638 ((or (null term-input-ring)
1639 (ring-empty-p term-input-ring))
1640 (error "Empty input ring"))
1641 ((zerop arg)
1642 ;; arg of zero resets search from beginning, and uses arg of 1
1643 (setq term-input-ring-index nil)
1644 1)
1645 (t
1646 arg)))
1647
1648 (defun term-search-start (arg)
1649 ;; Index to start a directional search, starting at term-input-ring-index
1650 (if term-input-ring-index
1651 ;; If a search is running, offset by 1 in direction of arg
1652 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1653 (ring-length term-input-ring))
1654 ;; For a new search, start from beginning or end, as appropriate
1655 (if (>= arg 0)
1656 0 ; First elt for forward search
1657 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1658
1659 (defun term-previous-input-string (arg)
1660 "Return the string ARG places along the input ring.
1661 Moves relative to `term-input-ring-index'."
1662 (ring-ref term-input-ring (if term-input-ring-index
1663 (mod (+ arg term-input-ring-index)
1664 (ring-length term-input-ring))
1665 arg)))
1666
1667 (defun term-previous-input (arg)
1668 "Cycle backwards through input history."
1669 (interactive "*p")
1670 (term-previous-matching-input "." arg))
1671
1672 (defun term-next-input (arg)
1673 "Cycle forwards through input history."
1674 (interactive "*p")
1675 (term-previous-input (- arg)))
1676
1677 (defun term-previous-matching-input-string (regexp arg)
1678 "Return the string matching REGEXP ARG places along the input ring.
1679 Moves relative to `term-input-ring-index'."
1680 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1681 (when pos (ring-ref term-input-ring pos))))
1682
1683 (defun term-previous-matching-input-string-position
1684 (regexp arg &optional start)
1685 "Return the index matching REGEXP ARG places along the input ring.
1686 Moves relative to START, or `term-input-ring-index'."
1687 (when (or (not (ring-p term-input-ring))
1688 (ring-empty-p term-input-ring))
1689 (error "No history"))
1690 (let* ((len (ring-length term-input-ring))
1691 (motion (if (> arg 0) 1 -1))
1692 (n (mod (- (or start (term-search-start arg)) motion) len))
1693 (tried-each-ring-item nil)
1694 (prev nil))
1695 ;; Do the whole search as many times as the argument says.
1696 (while (and (/= arg 0) (not tried-each-ring-item))
1697 ;; Step once.
1698 (setq prev n
1699 n (mod (+ n motion) len))
1700 ;; If we haven't reached a match, step some more.
1701 (while (and (< n len) (not tried-each-ring-item)
1702 (not (string-match regexp (ring-ref term-input-ring n))))
1703 (setq n (mod (+ n motion) len)
1704 ;; If we have gone all the way around in this search.
1705 tried-each-ring-item (= n prev)))
1706 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1707 ;; Now that we know which ring element to use, if we found it, return that.
1708 (when (string-match regexp (ring-ref term-input-ring n))
1709 n)))
1710
1711 (defun term-previous-matching-input (regexp n)
1712 "Search backwards through input history for match for REGEXP.
1713 \(Previous history elements are earlier commands.)
1714 With prefix argument N, search for Nth previous match.
1715 If N is negative, find the next or Nth next match."
1716 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1717 (setq n (term-search-arg n))
1718 (let ((pos (term-previous-matching-input-string-position regexp n)))
1719 ;; Has a match been found?
1720 (if (null pos)
1721 (error "Not found")
1722 (setq term-input-ring-index pos)
1723 (message "History item: %d" (1+ pos))
1724 (delete-region
1725 ;; Can't use kill-region as it sets this-command
1726 (process-mark (get-buffer-process (current-buffer))) (point))
1727 (insert (ring-ref term-input-ring pos)))))
1728
1729 (defun term-next-matching-input (regexp n)
1730 "Search forwards through input history for match for REGEXP.
1731 \(Later history elements are more recent commands.)
1732 With prefix argument N, search for Nth following match.
1733 If N is negative, find the previous or Nth previous match."
1734 (interactive (term-regexp-arg "Next input matching (regexp): "))
1735 (term-previous-matching-input regexp (- n)))
1736
1737 (defun term-previous-matching-input-from-input (n)
1738 "Search backwards through input history for match for current input.
1739 \(Previous history elements are earlier commands.)
1740 With prefix argument N, search for Nth previous match.
1741 If N is negative, search forwards for the -Nth following match."
1742 (interactive "p")
1743 (when (not (memq last-command '(term-previous-matching-input-from-input
1744 term-next-matching-input-from-input)))
1745 ;; Starting a new search
1746 (setq term-matching-input-from-input-string
1747 (buffer-substring
1748 (process-mark (get-buffer-process (current-buffer)))
1749 (point))
1750 term-input-ring-index nil))
1751 (term-previous-matching-input
1752 (concat "^" (regexp-quote term-matching-input-from-input-string))
1753 n))
1754
1755 (defun term-next-matching-input-from-input (n)
1756 "Search forwards through input history for match for current input.
1757 \(Following history elements are more recent commands.)
1758 With prefix argument N, search for Nth following match.
1759 If N is negative, search backwards for the -Nth previous match."
1760 (interactive "p")
1761 (term-previous-matching-input-from-input (- n)))
1762
1763
1764 (defun term-replace-by-expanded-history (&optional silent)
1765 "Expand input command history references before point.
1766 Expansion is dependent on the value of `term-input-autoexpand'.
1767
1768 This function depends on the buffer's idea of the input history, which may not
1769 match the command interpreter's idea, assuming it has one.
1770
1771 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1772 cannot know the interpreter's idea of input line numbers, assuming it has one,
1773 it cannot expand absolute input line number references.
1774
1775 If the optional argument SILENT is non-nil, never complain
1776 even if history reference seems erroneous.
1777
1778 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1779
1780 Returns t if successful."
1781 (interactive)
1782 (when (and term-input-autoexpand
1783 (string-match "[!^]" (funcall term-get-old-input))
1784 (save-excursion (beginning-of-line)
1785 (looking-at term-prompt-regexp)))
1786 ;; Looks like there might be history references in the command.
1787 (let ((previous-modified-tick (buffer-modified-tick)))
1788 (message "Expanding history references...")
1789 (term-replace-by-expanded-history-before-point silent)
1790 (/= previous-modified-tick (buffer-modified-tick)))))
1791
1792
1793 (defun term-replace-by-expanded-history-before-point (silent)
1794 "Expand directory stack reference before point.
1795 See `term-replace-by-expanded-history'. Returns t if successful."
1796 (save-excursion
1797 (let ((toend (- (line-end-position) (point)))
1798 (start (progn (term-bol nil) (point))))
1799 (while (progn
1800 (skip-chars-forward "^!^" (- (line-end-position) toend))
1801 (< (point) (- (line-end-position) toend)))
1802 ;; This seems a bit complex. We look for references such as !!, !-num,
1803 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1804 ;; If that wasn't enough, the plings can be suffixed with argument
1805 ;; range specifiers.
1806 ;; Argument ranges are complex too, so we hive off the input line,
1807 ;; referenced with plings, with the range string to `term-args'.
1808 (setq term-input-ring-index nil)
1809 (cond ((or (= (preceding-char) ?\\)
1810 (term-within-quotes start (point)))
1811 ;; The history is quoted, or we're in quotes.
1812 (goto-char (1+ (point))))
1813 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1814 ;; We cannot know the interpreter's idea of input line numbers.
1815 (goto-char (match-end 0))
1816 (message "Absolute reference cannot be expanded"))
1817 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1818 ;; Just a number of args from `number' lines backward.
1819 (let ((number (1- (string-to-number
1820 (buffer-substring (match-beginning 1)
1821 (match-end 1))))))
1822 (if (<= number (ring-length term-input-ring))
1823 (progn
1824 (replace-match
1825 (term-args (term-previous-input-string number)
1826 (match-beginning 2) (match-end 2))
1827 t t)
1828 (setq term-input-ring-index number)
1829 (message "History item: %d" (1+ number)))
1830 (goto-char (match-end 0))
1831 (message "Relative reference exceeds input history size"))))
1832 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1833 ;; Just a number of args from the previous input line.
1834 (replace-match
1835 (term-args (term-previous-input-string 0)
1836 (match-beginning 1) (match-end 1))
1837 t t)
1838 (message "History item: previous"))
1839 ((looking-at
1840 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1841 ;; Most recent input starting with or containing (possibly
1842 ;; protected) string, maybe just a number of args. Phew.
1843 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1844 (mb2 (match-beginning 2)) (me2 (match-end 2))
1845 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1846 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1847 (pos (save-match-data
1848 (term-previous-matching-input-string-position
1849 (concat pref (regexp-quote exp)) 1))))
1850 (if (null pos)
1851 (progn
1852 (goto-char (match-end 0))
1853 (or silent
1854 (progn (message "Not found")
1855 (ding))))
1856 (setq term-input-ring-index pos)
1857 (replace-match
1858 (term-args (ring-ref term-input-ring pos)
1859 (match-beginning 4) (match-end 4))
1860 t t)
1861 (message "History item: %d" (1+ pos)))))
1862 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1863 ;; Quick substitution on the previous input line.
1864 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1865 (new (buffer-substring (match-beginning 2) (match-end 2)))
1866 (pos nil))
1867 (replace-match (term-previous-input-string 0) t t)
1868 (setq pos (point))
1869 (goto-char (match-beginning 0))
1870 (if (not (search-forward old pos t))
1871 (or silent
1872 (error "Not found"))
1873 (replace-match new t t)
1874 (message "History item: substituted"))))
1875 (t
1876 (goto-char (match-end 0))))))))
1877
1878
1879 (defun term-magic-space (arg)
1880 "Expand input history references before point and insert ARG spaces.
1881 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1882 (interactive "p")
1883 (term-replace-by-expanded-history)
1884 (self-insert-command arg))
1885 \f
1886 (defun term-within-quotes (beg end)
1887 "Return t if the number of quotes between BEG and END is odd.
1888 Quotes are single and double."
1889 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1890 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1891 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1892
1893 (defun term-how-many-region (regexp beg end)
1894 "Return number of matches for REGEXP from BEG to END."
1895 (let ((count 0))
1896 (save-excursion
1897 (save-match-data
1898 (goto-char beg)
1899 (while (re-search-forward regexp end t)
1900 (setq count (1+ count)))))
1901 count))
1902
1903 (defun term-args (string begin end)
1904 ;; From STRING, return the args depending on the range specified in the text
1905 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1906 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1907 (save-match-data
1908 (if (null begin)
1909 (term-arguments string 0 nil)
1910 (let* ((range (buffer-substring
1911 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1912 (nth (cond ((string-match "^[*^]" range) 1)
1913 ((string-match "^-" range) 0)
1914 ((string-equal range "$") nil)
1915 (t (string-to-number range))))
1916 (mth (cond ((string-match "[-*$]$" range) nil)
1917 ((string-match "-" range)
1918 (string-to-number (substring range (match-end 0))))
1919 (t nth))))
1920 (term-arguments string nth mth)))))
1921
1922 ;; Return a list of arguments from ARG. Break it up at the
1923 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1924 (defun term-delim-arg (arg)
1925 (if (null term-delimiter-argument-list)
1926 (list arg)
1927 (let ((args nil)
1928 (pos 0)
1929 (len (length arg)))
1930 (while (< pos len)
1931 (let ((char (aref arg pos))
1932 (start pos))
1933 (if (memq char term-delimiter-argument-list)
1934 (while (and (< pos len) (eq (aref arg pos) char))
1935 (setq pos (1+ pos)))
1936 (while (and (< pos len)
1937 (not (memq (aref arg pos)
1938 term-delimiter-argument-list)))
1939 (setq pos (1+ pos))))
1940 (setq args (cons (substring arg start pos) args))))
1941 args)))
1942
1943 (defun term-arguments (string nth mth)
1944 "Return from STRING the NTH to MTH arguments.
1945 NTH and/or MTH can be nil, which means the last argument.
1946 Returned arguments are separated by single spaces.
1947 We assume whitespace separates arguments, except within quotes.
1948 Also, a run of one or more of a single character
1949 in `term-delimiter-argument-list' is a separate argument.
1950 Argument 0 is the command name."
1951 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1952 (args ()) (pos 0)
1953 (count 0)
1954 beg str quotes)
1955 ;; Build a list of all the args until we have as many as we want.
1956 (while (and (or (null mth) (<= count mth))
1957 (string-match argpart string pos))
1958 (if (and beg (= pos (match-beginning 0)))
1959 ;; It's contiguous, part of the same arg.
1960 (setq pos (match-end 0)
1961 quotes (or quotes (match-beginning 1)))
1962 ;; It's a new separate arg.
1963 (if beg
1964 ;; Put the previous arg, if there was one, onto ARGS.
1965 (setq str (substring string beg pos)
1966 args (if quotes (cons str args)
1967 (nconc (term-delim-arg str) args))
1968 count (1+ count)))
1969 (setq quotes (match-beginning 1))
1970 (setq beg (match-beginning 0))
1971 (setq pos (match-end 0))))
1972 (if beg
1973 (setq str (substring string beg pos)
1974 args (if quotes (cons str args)
1975 (nconc (term-delim-arg str) args))
1976 count (1+ count)))
1977 (let ((n (or nth (1- count)))
1978 (m (if mth (1- (- count mth)) 0)))
1979 (mapconcat
1980 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1981 \f
1982 ;;;
1983 ;;; Input processing stuff [line mode]
1984 ;;;
1985
1986 (defun term-send-input ()
1987 "Send input to process.
1988 After the process output mark, sends all text from the process mark to
1989 point as input to the process. Before the process output mark, calls value
1990 of variable `term-get-old-input' to retrieve old input, copies it to the
1991 process mark, and sends it. A terminal newline is also inserted into the
1992 buffer and sent to the process. The list of function names contained in the
1993 value of `term-input-filter-functions' is called on the input before sending
1994 it. The input is entered into the input history ring, if the value of variable
1995 `term-input-filter' returns non-nil when called on the input.
1996
1997 Any history reference may be expanded depending on the value of the variable
1998 `term-input-autoexpand'. The list of function names contained in the value
1999 of `term-input-filter-functions' is called on the input before sending it.
2000 The input is entered into the input history ring, if the value of variable
2001 `term-input-filter' returns non-nil when called on the input.
2002
2003 If variable `term-eol-on-send' is non-nil, then point is moved to the
2004 end of line before sending the input.
2005
2006 The values of `term-get-old-input', `term-input-filter-functions', and
2007 `term-input-filter' are chosen according to the command interpreter running
2008 in the buffer. E.g.,
2009
2010 If the interpreter is the csh,
2011 term-get-old-input is the default: take the current line, discard any
2012 initial string matching regexp term-prompt-regexp.
2013 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
2014 \"popd\" commands. When it sees one, it cd's the buffer.
2015 term-input-filter is the default: returns t if the input isn't all white
2016 space.
2017
2018 If the term is Lucid Common Lisp,
2019 term-get-old-input snarfs the sexp ending at point.
2020 term-input-filter-functions does nothing.
2021 term-input-filter returns nil if the input matches input-filter-regexp,
2022 which matches (1) all whitespace (2) :a, :c, etc.
2023
2024 Similarly for Soar, Scheme, etc."
2025 (interactive)
2026 ;; Note that the input string does not include its terminal newline.
2027 (let ((proc (get-buffer-process (current-buffer))))
2028 (if (not proc) (error "Current buffer has no process")
2029 (let* ((pmark (process-mark proc))
2030 (pmark-val (marker-position pmark))
2031 (input-is-new (>= (point) pmark-val))
2032 (intxt (if input-is-new
2033 (progn (if term-eol-on-send (end-of-line))
2034 (buffer-substring pmark (point)))
2035 (funcall term-get-old-input)))
2036 (input (if (not (eq term-input-autoexpand 'input))
2037 ;; Just whatever's already there
2038 intxt
2039 ;; Expand and leave it visible in buffer
2040 (term-replace-by-expanded-history t)
2041 (buffer-substring pmark (point))))
2042 (history (if (not (eq term-input-autoexpand 'history))
2043 input
2044 ;; This is messy 'cos ultimately the original
2045 ;; functions used do insertion, rather than return
2046 ;; strings. We have to expand, then insert back.
2047 (term-replace-by-expanded-history t)
2048 (let ((copy (buffer-substring pmark (point))))
2049 (delete-region pmark (point))
2050 (insert input)
2051 copy))))
2052 (when (term-pager-enabled)
2053 (save-excursion
2054 (goto-char (process-mark proc))
2055 (setq term-pager-count (term-current-row))))
2056 (when (and (funcall term-input-filter history)
2057 (or (null term-input-ignoredups)
2058 (not (ring-p term-input-ring))
2059 (ring-empty-p term-input-ring)
2060 (not (string-equal (ring-ref term-input-ring 0)
2061 history))))
2062 (ring-insert term-input-ring history))
2063 (let ((functions term-input-filter-functions))
2064 (while functions
2065 (funcall (car functions) (concat input "\n"))
2066 (setq functions (cdr functions))))
2067 (setq term-input-ring-index nil)
2068
2069 ;; Update the markers before we send the input
2070 ;; in case we get output amidst sending the input.
2071 (set-marker term-last-input-start pmark)
2072 (set-marker term-last-input-end (point))
2073 (when input-is-new
2074 ;; Set up to delete, because inferior should echo.
2075 (when (marker-buffer term-pending-delete-marker)
2076 (delete-region term-pending-delete-marker pmark))
2077 (set-marker term-pending-delete-marker pmark-val)
2078 (set-marker (process-mark proc) (point)))
2079 (goto-char pmark)
2080 (funcall term-input-sender proc input)))))
2081
2082 (defun term-get-old-input-default ()
2083 "Default for `term-get-old-input'.
2084 Take the current line, and discard any initial text matching
2085 `term-prompt-regexp'."
2086 (save-excursion
2087 (beginning-of-line)
2088 (term-skip-prompt)
2089 (let ((beg (point)))
2090 (end-of-line)
2091 (buffer-substring beg (point)))))
2092
2093 (defun term-copy-old-input ()
2094 "Insert after prompt old input at point as new input to be edited.
2095 Calls `term-get-old-input' to get old input."
2096 (interactive)
2097 (let ((input (funcall term-get-old-input))
2098 (process (get-buffer-process (current-buffer))))
2099 (if (not process)
2100 (error "Current buffer has no process")
2101 (goto-char (process-mark process))
2102 (insert input))))
2103
2104 (defun term-skip-prompt ()
2105 "Skip past the text matching regexp `term-prompt-regexp'.
2106 If this takes us past the end of the current line, don't skip at all."
2107 (let ((eol (line-end-position)))
2108 (when (and (looking-at term-prompt-regexp)
2109 (<= (match-end 0) eol))
2110 (goto-char (match-end 0)))))
2111
2112
2113 (defun term-after-pmark-p ()
2114 "Is point after the process output marker?"
2115 ;; Since output could come into the buffer after we looked at the point
2116 ;; but before we looked at the process marker's value, we explicitly
2117 ;; serialise. This is just because I don't know whether or not Emacs
2118 ;; services input during execution of lisp commands.
2119 (let ((proc-pos (marker-position
2120 (process-mark (get-buffer-process (current-buffer))))))
2121 (<= proc-pos (point))))
2122
2123 (defun term-simple-send (proc string)
2124 "Default function for sending to PROC input STRING.
2125 This just sends STRING plus a newline. To override this,
2126 set the hook `term-input-sender'."
2127 (term-send-string proc string)
2128 (term-send-string proc "\n"))
2129
2130 (defun term-bol (arg)
2131 "Go to the beginning of line, then skip past the prompt, if any.
2132 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2133 -- go straight to column 0.
2134
2135 The prompt skip is done by skipping text matching the regular expression
2136 `term-prompt-regexp', a buffer local variable."
2137 (interactive "P")
2138 (beginning-of-line)
2139 (when (null arg) (term-skip-prompt)))
2140
2141 ;; These two functions are for entering text you don't want echoed or
2142 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2143 ;; Just enter m-x term-send-invisible and type in your line.
2144
2145 (defun term-read-noecho (prompt &optional stars)
2146 "Read a single line of text from user without echoing, and return it.
2147 Prompt with argument PROMPT, a string. Optional argument STARS causes
2148 input to be echoed with '*' characters on the prompt line. Input ends with
2149 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2150 `inhibit-quit' is set because e.g. this function was called from a process
2151 filter and C-g is pressed, this function returns nil rather than a string).
2152
2153 Note that the keystrokes comprising the text can still be recovered
2154 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2155 applications."
2156 (let ((ans "")
2157 (c 0)
2158 (echo-keystrokes 0)
2159 (cursor-in-echo-area t)
2160 (done nil))
2161 (while (not done)
2162 (if stars
2163 (message "%s%s" prompt (make-string (length ans) ?*))
2164 (message "%s" prompt))
2165 (setq c (read-char))
2166 (cond ((= c ?\C-g)
2167 ;; This function may get called from a process filter, where
2168 ;; inhibit-quit is set. In later versions of Emacs read-char
2169 ;; may clear quit-flag itself and return C-g. That would make
2170 ;; it impossible to quit this loop in a simple way, so
2171 ;; re-enable it here (for backward-compatibility the check for
2172 ;; quit-flag below would still be necessary, so this seems
2173 ;; like the simplest way to do things).
2174 (setq quit-flag t
2175 done t))
2176 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2177 (setq done t))
2178 ((= c ?\C-u)
2179 (setq ans ""))
2180 ((and (/= c ?\b) (/= c ?\177))
2181 (setq ans (concat ans (char-to-string c))))
2182 ((> (length ans) 0)
2183 (setq ans (substring ans 0 -1)))))
2184 (if quit-flag
2185 ;; Emulate a true quit, except that we have to return a value.
2186 (prog1
2187 (setq quit-flag nil)
2188 (message "Quit")
2189 (beep t))
2190 (message "")
2191 ans)))
2192
2193 (defun term-send-invisible (str &optional proc)
2194 "Read a string without echoing.
2195 Then send it to the process running in the current buffer. A new-line
2196 is additionally sent. String is not saved on term input history list.
2197 Security bug: your string can still be temporarily recovered with
2198 \\[view-lossage]."
2199 (interactive "P") ; Defeat snooping via C-x esc
2200 (when (not (stringp str))
2201 (setq str (term-read-noecho "Non-echoed text: " t)))
2202 (when (not proc)
2203 (setq proc (get-buffer-process (current-buffer))))
2204 (if (not proc) (error "Current buffer has no process")
2205 (setq term-kill-echo-list (nconc term-kill-echo-list
2206 (cons str nil)))
2207 (term-send-string proc str)
2208 (term-send-string proc "\n")))
2209
2210 \f
2211 ;;; Low-level process communication
2212
2213 (defvar term-input-chunk-size 512
2214 "*Long inputs send to term processes are broken up into chunks of this size.
2215 If your process is choking on big inputs, try lowering the value.")
2216
2217 (defun term-send-string (proc str)
2218 "Send to PROC the contents of STR as input.
2219 This is equivalent to `process-send-string', except that long input strings
2220 are broken up into chunks of size `term-input-chunk-size'. Processes
2221 are given a chance to output between chunks. This can help prevent processes
2222 from hanging when you send them long inputs on some OS's."
2223 (let* ((len (length str))
2224 (i (min len term-input-chunk-size)))
2225 (process-send-string proc (substring str 0 i))
2226 (while (< i len)
2227 (let ((next-i (+ i term-input-chunk-size)))
2228 (accept-process-output)
2229 (process-send-string proc (substring str i (min len next-i)))
2230 (setq i next-i)))))
2231
2232 (defun term-send-region (proc start end)
2233 "Send to PROC the region delimited by START and END.
2234 This is a replacement for `process-send-region' that tries to keep
2235 your process from hanging on long inputs. See `term-send-string'."
2236 (term-send-string proc (buffer-substring start end)))
2237
2238 \f
2239 ;;; Random input hackage
2240
2241 (defun term-kill-output ()
2242 "Kill all output from interpreter since last input."
2243 (interactive)
2244 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2245 (kill-region term-last-input-end pmark)
2246 (goto-char pmark)
2247 (insert "*** output flushed ***\n")
2248 (set-marker pmark (point))))
2249
2250 (defun term-show-output ()
2251 "Display start of this batch of interpreter output at top of window.
2252 Sets mark to the value of point when this command is run."
2253 (interactive)
2254 (goto-char term-last-input-end)
2255 (backward-char)
2256 (beginning-of-line)
2257 (set-window-start (selected-window) (point))
2258 (end-of-line))
2259
2260 (defun term-interrupt-subjob ()
2261 "Interrupt the current subjob."
2262 (interactive)
2263 (interrupt-process nil term-ptyp))
2264
2265 (defun term-kill-subjob ()
2266 "Send kill signal to the current subjob."
2267 (interactive)
2268 (kill-process nil term-ptyp))
2269
2270 (defun term-quit-subjob ()
2271 "Send quit signal to the current subjob."
2272 (interactive)
2273 (quit-process nil term-ptyp))
2274
2275 (defun term-stop-subjob ()
2276 "Stop the current subjob.
2277 WARNING: if there is no current subjob, you can end up suspending
2278 the top-level process running in the buffer. If you accidentally do
2279 this, use \\[term-continue-subjob] to resume the process. (This
2280 is not a problem with most shells, since they ignore this signal.)"
2281 (interactive)
2282 (stop-process nil term-ptyp))
2283
2284 (defun term-continue-subjob ()
2285 "Send CONT signal to process buffer's process group.
2286 Useful if you accidentally suspend the top-level process."
2287 (interactive)
2288 (continue-process nil term-ptyp))
2289
2290 (defun term-kill-input ()
2291 "Kill all text from last stuff output by interpreter to point."
2292 (interactive)
2293 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2294 (p-pos (marker-position pmark)))
2295 (when (> (point) p-pos)
2296 (kill-region pmark (point)))))
2297
2298 (defun term-delchar-or-maybe-eof (arg)
2299 "Delete ARG characters forward, or send an EOF to process if at end of
2300 buffer."
2301 (interactive "p")
2302 (if (eobp)
2303 (process-send-eof)
2304 (delete-char arg)))
2305
2306 (defun term-send-eof ()
2307 "Send an EOF to the current buffer's process."
2308 (interactive)
2309 (process-send-eof))
2310
2311 (defun term-backward-matching-input (regexp n)
2312 "Search backward through buffer for match for REGEXP.
2313 Matches are searched for on lines that match `term-prompt-regexp'.
2314 With prefix argument N, search for Nth previous match.
2315 If N is negative, find the next or Nth next match."
2316 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2317 (let* ((re (concat term-prompt-regexp ".*" regexp))
2318 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2319 (when (re-search-backward re nil t n)
2320 (point)))))
2321 (if (null pos)
2322 (progn (message "Not found")
2323 (ding))
2324 (goto-char pos)
2325 (term-bol nil))))
2326
2327 (defun term-forward-matching-input (regexp n)
2328 "Search forward through buffer for match for REGEXP.
2329 Matches are searched for on lines that match `term-prompt-regexp'.
2330 With prefix argument N, search for Nth following match.
2331 If N is negative, find the previous or Nth previous match."
2332 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2333 (term-backward-matching-input regexp (- n)))
2334
2335
2336 (defun term-next-prompt (n)
2337 "Move to end of Nth next prompt in the buffer.
2338 See `term-prompt-regexp'."
2339 (interactive "p")
2340 (let ((paragraph-start term-prompt-regexp))
2341 (end-of-line (if (> n 0) 1 0))
2342 (forward-paragraph n)
2343 (term-skip-prompt)))
2344
2345 (defun term-previous-prompt (n)
2346 "Move to end of Nth previous prompt in the buffer.
2347 See `term-prompt-regexp'."
2348 (interactive "p")
2349 (term-next-prompt (- n)))
2350 \f
2351 ;;; Support for source-file processing commands.
2352 ;;============================================================================
2353 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2354 ;; commands that process files of source text (e.g. loading or compiling
2355 ;; files). So the corresponding process-in-a-buffer modes have commands
2356 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2357 ;; for defining these commands.
2358 ;;
2359 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2360 ;; and Soar, in that they don't know anything about file extensions.
2361 ;; So the compile/load interface gets the wrong default occasionally.
2362 ;; The load-file/compile-file default mechanism could be smarter -- it
2363 ;; doesn't know about the relationship between filename extensions and
2364 ;; whether the file is source or executable. If you compile foo.lisp
2365 ;; with compile-file, then the next load-file should use foo.bin for
2366 ;; the default, not foo.lisp. This is tricky to do right, particularly
2367 ;; because the extension for executable files varies so much (.o, .bin,
2368 ;; .lbin, .mo, .vo, .ao, ...).
2369
2370
2371 ;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2372 ;; commands.
2373 ;;
2374 ;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2375 ;; want to save the buffer before issuing any process requests to the command
2376 ;; interpreter.
2377 ;;
2378 ;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2379 ;; for the file to process.
2380
2381 ;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2382 ;;============================================================================
2383 ;; This function computes the defaults for the load-file and compile-file
2384 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2385 ;;
2386 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2387 ;; source-file processing command, or nil if there hasn't been one yet.
2388 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2389 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2390 ;; Typically, (lisp-mode) or (scheme-mode).
2391 ;;
2392 ;; If the command is given while the cursor is inside a string, *and*
2393 ;; the string is an existing filename, *and* the filename is not a directory,
2394 ;; then the string is taken as default. This allows you to just position
2395 ;; your cursor over a string that's a filename and have it taken as default.
2396 ;;
2397 ;; If the command is given in a file buffer whose major mode is in
2398 ;; SOURCE-MODES, then the filename is the default file, and the
2399 ;; file's directory is the default directory.
2400 ;;
2401 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2402 ;; then the default directory & file are what was used in the last source-file
2403 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2404 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2405 ;; is the cwd, with no default file. (\"no default file\" = nil)
2406 ;;
2407 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2408 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2409 ;; for Soar programs, etc.
2410 ;;
2411 ;; The function returns a pair: (default-directory . default-file).
2412
2413 (defun term-source-default (previous-dir/file source-modes)
2414 (cond ((and buffer-file-name (memq major-mode source-modes))
2415 (cons (file-name-directory buffer-file-name)
2416 (file-name-nondirectory buffer-file-name)))
2417 (previous-dir/file)
2418 (t
2419 (cons default-directory nil))))
2420
2421
2422 ;; (TERM-CHECK-SOURCE fname)
2423 ;;============================================================================
2424 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2425 ;; process-in-a-buffer modes), this function can be called on the filename.
2426 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2427 ;; is queried to see if he wants to save the buffer before proceeding with
2428 ;; the load or compile.
2429
2430 (defun term-check-source (fname)
2431 (let ((buff (get-file-buffer fname)))
2432 (when (and buff
2433 (buffer-modified-p buff)
2434 (y-or-n-p (format "Save buffer %s first? "
2435 (buffer-name buff))))
2436 ;; save BUFF.
2437 (with-current-buffer buff
2438 (save-buffer)))))
2439
2440
2441 ;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2442 ;;============================================================================
2443 ;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2444 ;; commands that process source files (like loading or compiling a file).
2445 ;; It prompts for the filename, provides a default, if there is one,
2446 ;; and returns the result filename.
2447 ;;
2448 ;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2449 ;;
2450 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2451 ;; from the last source processing command. SOURCE-MODES is a list of major
2452 ;; modes used to determine what file buffers contain source files. (These
2453 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2454 ;; then the filename reader will only accept a file that exists.
2455 ;;
2456 ;; A typical use:
2457 ;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2458 ;; '(lisp-mode) t))
2459
2460 ;; This is pretty stupid about strings. It decides we're in a string
2461 ;; if there's a quote on both sides of point on the current line.
2462 (defun term-extract-string ()
2463 "Return string around `point' that starts the current line or nil."
2464 (save-excursion
2465 (let* ((point (point))
2466 (bol (line-beginning-position))
2467 (eol (line-end-position))
2468 (start (and (search-backward "\"" bol t)
2469 (1+ (point))))
2470 (end (progn (goto-char point)
2471 (and (search-forward "\"" eol t)
2472 (1- (point))))))
2473 (and start end
2474 (buffer-substring start end)))))
2475
2476 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2477 (let* ((def (term-source-default prev-dir/file source-modes))
2478 (stringfile (term-extract-string))
2479 (sfile-p (and stringfile
2480 (condition-case ()
2481 (file-exists-p stringfile)
2482 (error nil))
2483 (not (file-directory-p stringfile))))
2484 (defdir (if sfile-p (file-name-directory stringfile)
2485 (car def)))
2486 (deffile (if sfile-p (file-name-nondirectory stringfile)
2487 (cdr def)))
2488 (ans (read-file-name (if deffile (format "%s(default %s) "
2489 prompt deffile)
2490 prompt)
2491 defdir
2492 (concat defdir deffile)
2493 mustmatch-p)))
2494 (list (expand-file-name (substitute-in-file-name ans)))))
2495
2496 ;; I am somewhat divided on this string-default feature. It seems
2497 ;; to violate the principle-of-least-astonishment, in that it makes
2498 ;; the default harder to predict, so you actually have to look and see
2499 ;; what the default really is before choosing it. This can trip you up.
2500 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2501 ;; on this.
2502 ;; -Olin
2503
2504 \f
2505 ;;; Simple process query facility.
2506 ;; ===========================================================================
2507 ;; This function is for commands that want to send a query to the process
2508 ;; and show the response to the user. For example, a command to get the
2509 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2510 ;; to an inferior Common Lisp process.
2511 ;;
2512 ;; This simple facility just sends strings to the inferior process and pops
2513 ;; up a window for the process buffer so you can see what the process
2514 ;; responds with. We don't do anything fancy like try to intercept what the
2515 ;; process responds with and put it in a pop-up window or on the message
2516 ;; line. We just display the buffer. Low tech. Simple. Works good.
2517
2518 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2519 ;; a window for the inferior process so that its response can be seen.
2520 (defun term-proc-query (proc str)
2521 (let* ((proc-buf (process-buffer proc))
2522 (proc-mark (process-mark proc)))
2523 (display-buffer proc-buf)
2524 (set-buffer proc-buf) ; but it's not the selected *window*
2525 (let ((proc-win (get-buffer-window proc-buf))
2526 (proc-pt (marker-position proc-mark)))
2527 (term-send-string proc str) ; send the query
2528 (accept-process-output proc) ; wait for some output
2529 ;; Try to position the proc window so you can see the answer.
2530 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2531 ;; I don't know why. Wizards invited to improve it.
2532 (when (not (pos-visible-in-window-p proc-pt proc-win))
2533 (let ((opoint (window-point proc-win)))
2534 (set-window-point proc-win proc-mark) (sit-for 0)
2535 (if (not (pos-visible-in-window-p opoint proc-win))
2536 (push-mark opoint)
2537 (set-window-point proc-win opoint)))))))
2538 \f
2539 ;; Returns the current column in the current screen line.
2540 ;; Note: (current-column) yields column in buffer line.
2541
2542 (defun term-horizontal-column ()
2543 (- (term-current-column) (term-start-line-column)))
2544
2545 ;; Calls either vertical-motion or term-buffer-vertical-motion
2546 (defmacro term-vertical-motion (count)
2547 (list 'funcall 'term-vertical-motion count))
2548
2549 ; An emulation of vertical-motion that is independent of having a window.
2550 ; Instead, it uses the term-width variable as the logical window width.
2551
2552 (defun term-buffer-vertical-motion (count)
2553 (cond ((= count 0)
2554 (move-to-column (* term-width (/ (current-column) term-width)))
2555 0)
2556 ((> count 0)
2557 (let ((H)
2558 (todo (+ count (/ (current-column) term-width))))
2559 (end-of-line)
2560 ;; The loop iterates over buffer lines;
2561 ;; H is the number of screen lines in the current line, i.e.
2562 ;; the ceiling of dividing the buffer line width by term-width.
2563 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2564 term-width)
2565 1))
2566 todo)
2567 (not (eobp)))
2568 (setq todo (- todo H))
2569 (forward-char) ;; Move past the ?\n
2570 (end-of-line)) ;; and on to the end of the next line.
2571 (if (and (>= todo H) (> todo 0))
2572 (+ (- count todo) H -1) ;; Hit end of buffer.
2573 (move-to-column (* todo term-width))
2574 count)))
2575 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2576 (let ((H)
2577 (todo (- count)))
2578 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2579 term-width)
2580 1))
2581 todo)
2582 (progn (beginning-of-line)
2583 (not (bobp))))
2584 (setq todo (- todo H))
2585 (backward-char)) ;; Move to end of previous line.
2586 (if (and (>= todo H) (> todo 0))
2587 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2588 (move-to-column (* (- H todo 1) term-width))
2589 count)))))
2590
2591 ;; The term-start-line-column variable is used as a cache.
2592 (defun term-start-line-column ()
2593 (cond (term-start-line-column)
2594 ((let ((save-pos (point)))
2595 (term-vertical-motion 0)
2596 (setq term-start-line-column (current-column))
2597 (goto-char save-pos)
2598 term-start-line-column))))
2599
2600 ;; Same as (current-column), but uses term-current-column as a cache.
2601 (defun term-current-column ()
2602 (cond (term-current-column)
2603 ((setq term-current-column (current-column)))))
2604
2605 ;; Move DELTA column right (or left if delta < 0 limiting at column 0).
2606
2607 (defun term-move-columns (delta)
2608 (setq term-current-column (max 0 (+ (term-current-column) delta)))
2609 (let ((point-at-eol (line-end-position)))
2610 (move-to-column term-current-column t)
2611 ;; If move-to-column extends the current line it will use the face
2612 ;; from the last character on the line, set the face for the chars
2613 ;; to default.
2614 (when (> (point) point-at-eol)
2615 (put-text-property point-at-eol (point) 'face 'default))))
2616
2617 ;; Insert COUNT copies of CHAR in the default face.
2618 (defun term-insert-char (char count)
2619 (let ((old-point (point)))
2620 (insert-char char count)
2621 (put-text-property old-point (point) 'face 'default)))
2622
2623 (defun term-current-row ()
2624 (cond (term-current-row)
2625 ((setq term-current-row
2626 (save-restriction
2627 (save-excursion
2628 (narrow-to-region term-home-marker (point-max))
2629 (- (term-vertical-motion -9999))))))))
2630
2631 (defun term-adjust-current-row-cache (delta)
2632 (when term-current-row
2633 (setq term-current-row
2634 (max 0 (+ term-current-row delta)))))
2635
2636 (defun term-terminal-pos ()
2637 (save-excursion ; save-restriction
2638 (let ((save-col (term-current-column))
2639 x y)
2640 (term-vertical-motion 0)
2641 (setq x (- save-col (current-column)))
2642 (setq y (term-vertical-motion term-height))
2643 (cons x y))))
2644
2645 ;;Function that handles term messages: code by rms (and you can see the
2646 ;;difference ;-) -mm
2647
2648 (defun term-handle-ansi-terminal-messages (message)
2649 ;; Is there a command here?
2650 (while (string-match "\eAnSiT.+\n" message)
2651 ;; Extract the command code and the argument.
2652 (let* ((start (match-beginning 0))
2653 (command-code (aref message (+ start 6)))
2654 (argument
2655 (save-match-data
2656 (substring message
2657 (+ start 8)
2658 (string-match "\r?\n" message
2659 (+ start 8)))))
2660 ignore)
2661 ;; Delete this command from MESSAGE.
2662 (setq message (replace-match "" t t message))
2663
2664 ;; If we recognize the type of command, set the appropriate variable.
2665 (cond ((= command-code ?c)
2666 (setq term-ansi-at-dir argument))
2667 ((= command-code ?h)
2668 (setq term-ansi-at-host argument))
2669 ((= command-code ?u)
2670 (setq term-ansi-at-user argument))
2671 ;; Otherwise ignore this one.
2672 (t
2673 (setq ignore t)))
2674
2675 ;; Update default-directory based on the changes this command made.
2676 (if ignore
2677 nil
2678 (setq default-directory
2679 (file-name-as-directory
2680 (if (and (string= term-ansi-at-host (system-name))
2681 (string= term-ansi-at-user (user-real-login-name)))
2682 (expand-file-name term-ansi-at-dir)
2683 (if (string= term-ansi-at-user (user-real-login-name))
2684 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2685 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2686 term-ansi-at-dir)))))
2687
2688 ;; I'm not sure this is necessary,
2689 ;; but it's best to be on the safe side.
2690 (if (string= term-ansi-at-host (system-name))
2691 (progn
2692 (setq ange-ftp-default-user term-ansi-at-save-user)
2693 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2694 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2695 (setq term-ansi-at-save-user ange-ftp-default-user)
2696 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2697 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2698 (setq ange-ftp-default-user nil)
2699 (setq ange-ftp-default-password nil)
2700 (setq ange-ftp-generate-anonymous-password nil)))))
2701 message)
2702
2703
2704 ;; Terminal emulation
2705 ;; This is the standard process filter for term buffers.
2706 ;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2707
2708 (defun term-emulate-terminal (proc str)
2709 (with-current-buffer (process-buffer proc)
2710 (let* ((i 0) char funny
2711 count ; number of decoded chars in substring
2712 count-bytes ; number of bytes
2713 decoded-substring
2714 save-point save-marker old-point temp win
2715 (buffer-undo-list t)
2716 (selected (selected-window))
2717 last-win
2718 handled-ansi-message
2719 (str-length (length str)))
2720 (save-selected-window
2721
2722 ;; Let's handle the messages. -mm
2723
2724 (let* ((newstr (term-handle-ansi-terminal-messages str)))
2725 (when (not (eq str newstr))
2726 (setq handled-ansi-message t
2727 str newstr)))
2728 (setq str-length (length str))
2729
2730 (when (marker-buffer term-pending-delete-marker)
2731 ;; Delete text following term-pending-delete-marker.
2732 (delete-region term-pending-delete-marker (process-mark proc))
2733 (set-marker term-pending-delete-marker nil))
2734
2735 (if (eq (window-buffer) (current-buffer))
2736 (progn
2737 (setq term-vertical-motion (symbol-function 'vertical-motion))
2738 (term-check-size proc))
2739 (setq term-vertical-motion
2740 (symbol-function 'term-buffer-vertical-motion)))
2741
2742 (setq save-marker (copy-marker (process-mark proc)))
2743
2744 (when (/= (point) (process-mark proc))
2745 (setq save-point (point-marker))
2746 (goto-char (process-mark proc)))
2747
2748 (save-restriction
2749 ;; If the buffer is in line mode, and there is a partial
2750 ;; input line, save the line (by narrowing to leave it
2751 ;; outside the restriction ) until we're done with output.
2752 (when (and (> (point-max) (process-mark proc))
2753 (term-in-line-mode))
2754 (narrow-to-region (point-min) (process-mark proc)))
2755
2756 (when term-log-buffer
2757 (princ str term-log-buffer))
2758 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2759 (setq str (concat term-terminal-parameter str))
2760 (setq term-terminal-parameter nil)
2761 (setq str-length (length str))
2762 (setq term-terminal-state 0)))
2763
2764 (while (< i str-length)
2765 (setq char (aref str i))
2766 (cond ((< term-terminal-state 2)
2767 ;; Look for prefix of regular chars
2768 (setq funny
2769 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2770 str i))
2771 (when (not funny) (setq funny str-length))
2772 (cond ((> funny i)
2773 ;; Decode the string before counting
2774 ;; characters, to avoid garbling of certain
2775 ;; multibyte characters (bug#1006).
2776 (setq decoded-substring
2777 (decode-coding-string
2778 (substring str i funny)
2779 locale-coding-system))
2780 (cond ((eq term-terminal-state 1)
2781 ;; We are in state 1, we need to wrap
2782 ;; around. Go to the beginning of
2783 ;; the next line and switch to state
2784 ;; 0.
2785 (term-down 1 t)
2786 (term-move-columns (- (term-current-column)))
2787 (setq term-terminal-state 0)))
2788 (setq count (length decoded-substring))
2789 (setq temp (- (+ (term-horizontal-column) count)
2790 term-width))
2791 (cond ((<= temp 0)) ;; All count chars fit in line.
2792 ((> count temp) ;; Some chars fit.
2793 ;; This iteration, handle only what fits.
2794 (setq count (- count temp))
2795 (setq count-bytes
2796 (length
2797 (encode-coding-string
2798 (substring decoded-substring 0 count)
2799 'binary)))
2800 (setq temp 0)
2801 (setq funny (+ count-bytes i)))
2802 ((or (not (or term-pager-count
2803 term-scroll-with-delete))
2804 (> (term-handle-scroll 1) 0))
2805 (term-adjust-current-row-cache 1)
2806 (setq count (min count term-width))
2807 (setq count-bytes
2808 (length
2809 (encode-coding-string
2810 (substring decoded-substring 0 count)
2811 'binary)))
2812 (setq funny (+ count-bytes i))
2813 (setq term-start-line-column
2814 term-current-column))
2815 (t ;; Doing PAGER processing.
2816 (setq count 0 funny i)
2817 (setq term-current-column nil)
2818 (setq term-start-line-column nil)))
2819 (setq old-point (point))
2820
2821 ;; Insert a string, check how many columns
2822 ;; we moved, then delete that many columns
2823 ;; following point if not eob nor insert-mode.
2824 (let ((old-column (current-column))
2825 columns pos)
2826 (insert (decode-coding-string (substring str i funny) locale-coding-system))
2827 (setq term-current-column (current-column)
2828 columns (- term-current-column old-column))
2829 (when (not (or (eobp) term-insert-mode))
2830 (setq pos (point))
2831 (term-move-columns columns)
2832 (delete-region pos (point)))
2833 ;; In insert mode if the current line
2834 ;; has become too long it needs to be
2835 ;; chopped off.
2836 (when term-insert-mode
2837 (setq pos (point))
2838 (end-of-line)
2839 (when (> (current-column) term-width)
2840 (delete-region (- (point) (- (current-column) term-width))
2841 (point)))
2842 (goto-char pos)))
2843 (setq term-current-column nil)
2844
2845 (put-text-property old-point (point)
2846 'face term-current-face)
2847 ;; If the last char was written in last column,
2848 ;; back up one column, but remember we did so.
2849 ;; Thus we emulate xterm/vt100-style line-wrapping.
2850 (cond ((eq temp 0)
2851 (term-move-columns -1)
2852 (setq term-terminal-state 1)))
2853 (setq i (1- funny)))
2854 ((and (setq term-terminal-state 0)
2855 (eq char ?\^I)) ; TAB (terminfo: ht)
2856 (setq count (term-current-column))
2857 ;; The line cannot exceed term-width. TAB at
2858 ;; the end of a line should not cause wrapping.
2859 (setq count (min term-width
2860 (+ count 8 (- (mod count 8)))))
2861 (if (> term-width count)
2862 (progn
2863 (term-move-columns
2864 (- count (term-current-column)))
2865 (setq term-current-column count))
2866 (when (> term-width (term-current-column))
2867 (term-move-columns
2868 (1- (- term-width (term-current-column)))))
2869 (when (= term-width (term-current-column))
2870 (term-move-columns -1))))
2871 ((eq char ?\r) ;; (terminfo: cr)
2872 (term-vertical-motion 0)
2873 (setq term-current-column term-start-line-column))
2874 ((eq char ?\n) ;; (terminfo: cud1, ind)
2875 (unless (and term-kill-echo-list
2876 (term-check-kill-echo-list))
2877 (term-down 1 t)))
2878 ((eq char ?\b) ;; (terminfo: cub1)
2879 (term-move-columns -1))
2880 ((eq char ?\033) ; Escape
2881 (setq term-terminal-state 2))
2882 ((eq char 0)) ; NUL: Do nothing
2883 ((eq char ?\016)) ; Shift Out - ignored
2884 ((eq char ?\017)) ; Shift In - ignored
2885 ((eq char ?\^G) ;; (terminfo: bel)
2886 (beep t))
2887 ((and (eq char ?\032)
2888 (not handled-ansi-message))
2889 (let ((end (string-match "\r?$" str i)))
2890 (if end
2891 (funcall term-command-hook
2892 (prog1 (substring str (1+ i) end)
2893 (setq i (match-end 0))))
2894 (setq term-terminal-parameter (substring str i))
2895 (setq term-terminal-state 4)
2896 (setq i str-length))))
2897 (t ; insert char FIXME: Should never happen
2898 (term-move-columns 1)
2899 (backward-delete-char 1)
2900 (insert char))))
2901 ((eq term-terminal-state 2) ; Seen Esc
2902 (cond ((eq char ?\133) ;; ?\133 = ?[
2903
2904 ;; Some modifications to cope with multiple
2905 ;; settings like ^[[01;32;43m -mm
2906 ;; Note that now the init value of
2907 ;; term-terminal-previous-parameter has been
2908 ;; changed to -1
2909
2910 (setq term-terminal-parameter 0)
2911 (setq term-terminal-previous-parameter -1)
2912 (setq term-terminal-previous-parameter-2 -1)
2913 (setq term-terminal-previous-parameter-3 -1)
2914 (setq term-terminal-previous-parameter-4 -1)
2915 (setq term-terminal-more-parameters 0)
2916 (setq term-terminal-state 3))
2917 ((eq char ?D) ;; scroll forward
2918 (term-handle-deferred-scroll)
2919 (term-down 1 t)
2920 (setq term-terminal-state 0))
2921 ;; ((eq char ?E) ;; (terminfo: nw), not used for
2922 ;; ;; now, but this is a working
2923 ;; ;; implementation
2924 ;; (term-down 1)
2925 ;; (term-goto term-current-row 0)
2926 ;; (setq term-terminal-state 0))
2927 ((eq char ?M) ;; scroll reversed (terminfo: ri)
2928 (if (or (< (term-current-row) term-scroll-start)
2929 (>= (1- (term-current-row))
2930 term-scroll-start))
2931 ;; Scrolling up will not move outside
2932 ;; the scroll region.
2933 (term-down -1)
2934 ;; Scrolling the scroll region is needed.
2935 (term-down -1 t))
2936 (setq term-terminal-state 0))
2937 ((eq char ?7) ;; Save cursor (terminfo: sc)
2938 (term-handle-deferred-scroll)
2939 (setq term-saved-cursor
2940 (list (term-current-row)
2941 (term-horizontal-column)
2942 term-ansi-current-bg-color
2943 term-ansi-current-bold
2944 term-ansi-current-color
2945 term-ansi-current-invisible
2946 term-ansi-current-reverse
2947 term-ansi-current-underline
2948 term-current-face)
2949 )
2950 (setq term-terminal-state 0))
2951 ((eq char ?8) ;; Restore cursor (terminfo: rc)
2952 (when term-saved-cursor
2953 (term-goto (nth 0 term-saved-cursor)
2954 (nth 1 term-saved-cursor))
2955 (setq term-ansi-current-bg-color
2956 (nth 2 term-saved-cursor)
2957 term-ansi-current-bold
2958 (nth 3 term-saved-cursor)
2959 term-ansi-current-color
2960 (nth 4 term-saved-cursor)
2961 term-ansi-current-invisible
2962 (nth 5 term-saved-cursor)
2963 term-ansi-current-reverse
2964 (nth 6 term-saved-cursor)
2965 term-ansi-current-underline
2966 (nth 7 term-saved-cursor)
2967 term-current-face
2968 (nth 8 term-saved-cursor)))
2969 (setq term-terminal-state 0))
2970 ((eq char ?c) ;; \Ec - Reset (terminfo: rs1)
2971 ;; This is used by the "clear" program.
2972 (setq term-terminal-state 0)
2973 (term-reset-terminal))
2974 ;; The \E#8 reset sequence for xterm. We
2975 ;; probably don't need to handle it, but this
2976 ;; is the code to parse it.
2977 ;; ((eq char ?#)
2978 ;; (when (eq (aref str (1+ i)) ?8)
2979 ;; (setq i (1+ i))
2980 ;; (setq term-scroll-start 0)
2981 ;; (setq term-scroll-end term-height)
2982 ;; (setq term-terminal-state 0)))
2983 ((setq term-terminal-state 0))))
2984 ((eq term-terminal-state 3) ; Seen Esc [
2985 (cond ((and (>= char ?0) (<= char ?9))
2986 (setq term-terminal-parameter
2987 (+ (* 10 term-terminal-parameter) (- char ?0))))
2988 ((eq char ?\;)
2989 ;; Some modifications to cope with multiple
2990 ;; settings like ^[[01;32;43m -mm
2991 (setq term-terminal-more-parameters 1)
2992 (setq term-terminal-previous-parameter-4
2993 term-terminal-previous-parameter-3)
2994 (setq term-terminal-previous-parameter-3
2995 term-terminal-previous-parameter-2)
2996 (setq term-terminal-previous-parameter-2
2997 term-terminal-previous-parameter)
2998 (setq term-terminal-previous-parameter
2999 term-terminal-parameter)
3000 (setq term-terminal-parameter 0))
3001 ((eq char ??)) ; Ignore ?
3002 (t
3003 (term-handle-ansi-escape proc char)
3004 (setq term-terminal-more-parameters 0)
3005 (setq term-terminal-previous-parameter-4 -1)
3006 (setq term-terminal-previous-parameter-3 -1)
3007 (setq term-terminal-previous-parameter-2 -1)
3008 (setq term-terminal-previous-parameter -1)
3009 (setq term-terminal-state 0)))))
3010 (when (term-handling-pager)
3011 ;; Finish stuff to get ready to handle PAGER.
3012 (if (> (% (current-column) term-width) 0)
3013 (setq term-terminal-parameter
3014 (substring str i))
3015 ;; We're at column 0. Goto end of buffer; to compensate,
3016 ;; prepend a ?\r for later. This looks more consistent.
3017 (if (zerop i)
3018 (setq term-terminal-parameter
3019 (concat "\r" (substring str i)))
3020 (setq term-terminal-parameter (substring str (1- i)))
3021 (aset term-terminal-parameter 0 ?\r))
3022 (goto-char (point-max)))
3023 (setq term-terminal-state 4)
3024 (make-local-variable 'term-pager-old-filter)
3025 (setq term-pager-old-filter (process-filter proc))
3026 (set-process-filter proc term-pager-filter)
3027 (setq i str-length))
3028 (setq i (1+ i))))
3029
3030 (when (>= (term-current-row) term-height)
3031 (term-handle-deferred-scroll))
3032
3033 (set-marker (process-mark proc) (point))
3034 (when save-point
3035 (goto-char save-point)
3036 (set-marker save-point nil))
3037
3038 ;; Check for a pending filename-and-line number to display.
3039 ;; We do this before scrolling, because we might create a new window.
3040 (when (and term-pending-frame
3041 (eq (window-buffer selected) (current-buffer)))
3042 (term-display-line (car term-pending-frame)
3043 (cdr term-pending-frame))
3044 (setq term-pending-frame nil)
3045 ;; We have created a new window, so check the window size.
3046 (term-check-size proc))
3047
3048 ;; Scroll each window displaying the buffer but (by default)
3049 ;; only if the point matches the process-mark we started with.
3050 (setq win selected)
3051 ;; Avoid infinite loop in strange case where minibuffer window
3052 ;; is selected but not active.
3053 (while (window-minibuffer-p win)
3054 (setq win (next-window win nil t)))
3055 (setq last-win win)
3056 (while (progn
3057 (setq win (next-window win nil t))
3058 (when (eq (window-buffer win) (process-buffer proc))
3059 (let ((scroll term-scroll-to-bottom-on-output))
3060 (select-window win)
3061 (when (or (= (point) save-marker)
3062 (eq scroll t) (eq scroll 'all)
3063 ;; Maybe user wants point to jump to the end.
3064 (and (eq selected win)
3065 (or (eq scroll 'this) (not save-point)))
3066 (and (eq scroll 'others)
3067 (not (eq selected win))))
3068 (goto-char term-home-marker)
3069 (recenter 0)
3070 (goto-char (process-mark proc))
3071 (if (not (pos-visible-in-window-p (point) win))
3072 (recenter -1)))
3073 ;; Optionally scroll so that the text
3074 ;; ends at the bottom of the window.
3075 (when (and term-scroll-show-maximum-output
3076 (>= (point) (process-mark proc)))
3077 (save-excursion
3078 (goto-char (point-max))
3079 (recenter -1)))))
3080 (not (eq win last-win))))
3081
3082 ;; Stolen from comint.el and adapted -mm
3083 (when (> term-buffer-maximum-size 0)
3084 (save-excursion
3085 (goto-char (process-mark (get-buffer-process (current-buffer))))
3086 (forward-line (- term-buffer-maximum-size))
3087 (beginning-of-line)
3088 (delete-region (point-min) (point))))
3089 (set-marker save-marker nil)))
3090 ;; This might be expensive, but we need it to handle something
3091 ;; like `sleep 5 | less -c' in more-or-less real time.
3092 (when (get-buffer-window (current-buffer))
3093 (redisplay))))
3094
3095 (defun term-handle-deferred-scroll ()
3096 (let ((count (- (term-current-row) term-height)))
3097 (when (>= count 0)
3098 (save-excursion
3099 (goto-char term-home-marker)
3100 (term-vertical-motion (1+ count))
3101 (set-marker term-home-marker (point))
3102 (setq term-current-row (1- term-height))))))
3103
3104 (defun term-reset-terminal ()
3105 "Reset the terminal, delete all the content and set the face to the default one."
3106 (erase-buffer)
3107 (term-ansi-reset)
3108 (setq term-current-row 0)
3109 (setq term-current-column 1)
3110 (setq term-scroll-start 0)
3111 (setq term-scroll-end term-height)
3112 (setq term-insert-mode nil)
3113 ;; FIXME: No idea why this is here, it looks wrong. --Stef
3114 (setq term-ansi-face-already-done nil))
3115
3116 ;; New function to deal with ansi colorized output, as you can see you can
3117 ;; have any bold/underline/fg/bg/reverse combination. -mm
3118
3119 (defvar term-bold-attribute '(:weight bold)
3120 "Attribute to use for the bold terminal attribute.
3121 Set it to nil to disable bold.")
3122
3123 (defun term-handle-colors-array (parameter)
3124 (cond
3125
3126 ;; Bold (terminfo: bold)
3127 ((eq parameter 1)
3128 (setq term-ansi-current-bold t))
3129
3130 ;; Underline
3131 ((eq parameter 4)
3132 (setq term-ansi-current-underline t))
3133
3134 ;; Blink (unsupported by Emacs), will be translated to bold.
3135 ;; This may change in the future though.
3136 ((eq parameter 5)
3137 (setq term-ansi-current-bold t))
3138
3139 ;; Reverse (terminfo: smso)
3140 ((eq parameter 7)
3141 (setq term-ansi-current-reverse t))
3142
3143 ;; Invisible
3144 ((eq parameter 8)
3145 (setq term-ansi-current-invisible t))
3146
3147 ;; Reset underline (terminfo: rmul)
3148 ((eq parameter 24)
3149 (setq term-ansi-current-underline nil))
3150
3151 ;; Reset reverse (terminfo: rmso)
3152 ((eq parameter 27)
3153 (setq term-ansi-current-reverse nil))
3154
3155 ;; Foreground
3156 ((and (>= parameter 30) (<= parameter 37))
3157 (setq term-ansi-current-color (- parameter 29)))
3158
3159 ;; Reset foreground
3160 ((eq parameter 39)
3161 (setq term-ansi-current-color 0))
3162
3163 ;; Background
3164 ((and (>= parameter 40) (<= parameter 47))
3165 (setq term-ansi-current-bg-color (- parameter 39)))
3166
3167 ;; Reset background
3168 ((eq parameter 49)
3169 (setq term-ansi-current-bg-color 0))
3170
3171 ;; 0 (Reset) or unknown (reset anyway)
3172 (t
3173 (term-ansi-reset)))
3174
3175 ;; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3176 ;; term-ansi-current-underline
3177 ;; term-ansi-current-reverse
3178 ;; term-ansi-current-bold
3179 ;; term-ansi-current-invisible
3180 ;; term-ansi-face-already-done
3181 ;; term-ansi-current-color
3182 ;; term-ansi-current-bg-color)
3183
3184
3185 (unless term-ansi-face-already-done
3186 (if term-ansi-current-invisible
3187 (let ((color
3188 (if term-ansi-current-reverse
3189 (if (= term-ansi-current-color 0)
3190 term-default-fg-color
3191 (elt ansi-term-color-vector term-ansi-current-color))
3192 (if (= term-ansi-current-bg-color 0)
3193 term-default-bg-color
3194 (elt ansi-term-color-vector term-ansi-current-bg-color)))))
3195 (setq term-current-face
3196 (list :background color
3197 :foreground color))
3198 ) ;; No need to bother with anything else if it's invisible.
3199
3200 (setq term-current-face
3201 (if term-ansi-current-reverse
3202 (if (= term-ansi-current-color 0)
3203 (list :background term-default-fg-color
3204 :foreground term-default-bg-color)
3205 (list :background
3206 (elt ansi-term-color-vector term-ansi-current-color)
3207 :foreground
3208 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3209
3210 (if (= term-ansi-current-color 0)
3211 (list :foreground term-default-fg-color
3212 :background term-default-bg-color)
3213 (list :foreground
3214 (elt ansi-term-color-vector term-ansi-current-color)
3215 :background
3216 (elt ansi-term-color-vector term-ansi-current-bg-color)))))
3217
3218 (when term-ansi-current-bold
3219 (setq term-current-face
3220 (append term-bold-attribute term-current-face)))
3221 (when term-ansi-current-underline
3222 (setq term-current-face
3223 (list* :underline t term-current-face)))))
3224
3225 ;; (message "Debug %S" term-current-face)
3226 ;; FIXME: shouldn't we set term-ansi-face-already-done to t here? --Stef
3227 (setq term-ansi-face-already-done nil))
3228
3229
3230 ;; Handle a character assuming (eq terminal-state 2) -
3231 ;; i.e. we have previously seen Escape followed by ?[.
3232
3233 (defun term-handle-ansi-escape (proc char)
3234 (cond
3235 ((or (eq char ?H) ;; cursor motion (terminfo: cup,home)
3236 ;; (eq char ?f) ;; xterm seems to handle this sequence too, not
3237 ;; needed for now
3238 )
3239 (when (<= term-terminal-parameter 0)
3240 (setq term-terminal-parameter 1))
3241 (when (<= term-terminal-previous-parameter 0)
3242 (setq term-terminal-previous-parameter 1))
3243 (when (> term-terminal-previous-parameter term-height)
3244 (setq term-terminal-previous-parameter term-height))
3245 (when (> term-terminal-parameter term-width)
3246 (setq term-terminal-parameter term-width))
3247 (term-goto
3248 (1- term-terminal-previous-parameter)
3249 (1- term-terminal-parameter)))
3250 ;; \E[A - cursor up (terminfo: cuu, cuu1)
3251 ((eq char ?A)
3252 (term-handle-deferred-scroll)
3253 (let ((tcr (term-current-row)))
3254 (term-down
3255 (if (< (- tcr term-terminal-parameter) term-scroll-start)
3256 ;; If the amount to move is before scroll start, move
3257 ;; to scroll start.
3258 (- term-scroll-start tcr)
3259 (if (>= term-terminal-parameter tcr)
3260 (- tcr)
3261 (- (max 1 term-terminal-parameter)))) t)))
3262 ;; \E[B - cursor down (terminfo: cud)
3263 ((eq char ?B)
3264 (let ((tcr (term-current-row)))
3265 (unless (= tcr (1- term-scroll-end))
3266 (term-down
3267 (if (> (+ tcr term-terminal-parameter) term-scroll-end)
3268 (- term-scroll-end 1 tcr)
3269 (max 1 term-terminal-parameter)) t))))
3270 ;; \E[C - cursor right (terminfo: cuf, cuf1)
3271 ((eq char ?C)
3272 (term-move-columns
3273 (max 1
3274 (if (>= (+ term-terminal-parameter (term-current-column)) term-width)
3275 (- term-width (term-current-column) 1)
3276 term-terminal-parameter))))
3277 ;; \E[D - cursor left (terminfo: cub)
3278 ((eq char ?D)
3279 (term-move-columns (- (max 1 term-terminal-parameter))))
3280 ;; \E[J - clear to end of screen (terminfo: ed, clear)
3281 ((eq char ?J)
3282 (term-erase-in-display term-terminal-parameter))
3283 ;; \E[K - clear to end of line (terminfo: el, el1)
3284 ((eq char ?K)
3285 (term-erase-in-line term-terminal-parameter))
3286 ;; \E[L - insert lines (terminfo: il, il1)
3287 ((eq char ?L)
3288 (term-insert-lines (max 1 term-terminal-parameter)))
3289 ;; \E[M - delete lines (terminfo: dl, dl1)
3290 ((eq char ?M)
3291 (term-delete-lines (max 1 term-terminal-parameter)))
3292 ;; \E[P - delete chars (terminfo: dch, dch1)
3293 ((eq char ?P)
3294 (term-delete-chars (max 1 term-terminal-parameter)))
3295 ;; \E[@ - insert spaces (terminfo: ich)
3296 ((eq char ?@)
3297 (term-insert-spaces (max 1 term-terminal-parameter)))
3298 ;; \E[?h - DEC Private Mode Set
3299 ((eq char ?h)
3300 (cond ((eq term-terminal-parameter 4) ;; (terminfo: smir)
3301 (setq term-insert-mode t))
3302 ;; ((eq term-terminal-parameter 47) ;; (terminfo: smcup)
3303 ;; (term-switch-to-alternate-sub-buffer t))
3304 ))
3305 ;; \E[?l - DEC Private Mode Reset
3306 ((eq char ?l)
3307 (cond ((eq term-terminal-parameter 4) ;; (terminfo: rmir)
3308 (setq term-insert-mode nil))
3309 ;; ((eq term-terminal-parameter 47) ;; (terminfo: rmcup)
3310 ;; (term-switch-to-alternate-sub-buffer nil))
3311 ))
3312
3313 ;; Modified to allow ansi coloring -mm
3314 ;; \E[m - Set/reset modes, set bg/fg
3315 ;;(terminfo: smso,rmso,smul,rmul,rev,bold,sgr0,invis,op,setab,setaf)
3316 ((eq char ?m)
3317 (when (= term-terminal-more-parameters 1)
3318 (when (>= term-terminal-previous-parameter-4 0)
3319 (term-handle-colors-array term-terminal-previous-parameter-4))
3320 (when (>= term-terminal-previous-parameter-3 0)
3321 (term-handle-colors-array term-terminal-previous-parameter-3))
3322 (when (>= term-terminal-previous-parameter-2 0)
3323 (term-handle-colors-array term-terminal-previous-parameter-2))
3324 (term-handle-colors-array term-terminal-previous-parameter))
3325 (term-handle-colors-array term-terminal-parameter))
3326
3327 ;; \E[6n - Report cursor position (terminfo: u7)
3328 ((eq char ?n)
3329 (term-handle-deferred-scroll)
3330 (process-send-string proc
3331 ;; (terminfo: u6)
3332 (format "\e[%s;%sR"
3333 (1+ (term-current-row))
3334 (1+ (term-horizontal-column)))))
3335 ;; \E[r - Set scrolling region (terminfo: csr)
3336 ((eq char ?r)
3337 (term-set-scroll-region
3338 (1- term-terminal-previous-parameter)
3339 (1- term-terminal-parameter)))
3340 (t)))
3341
3342 (defun term-set-scroll-region (top bottom)
3343 "Set scrolling region.
3344 TOP is the top-most line (inclusive) of the new scrolling region,
3345 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3346 The top-most line is line 0."
3347 (setq term-scroll-start
3348 (if (or (< top 0) (>= top term-height))
3349 0
3350 top))
3351 (setq term-scroll-end
3352 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3353 term-height
3354 bottom))
3355 (setq term-scroll-with-delete
3356 (or (term-using-alternate-sub-buffer)
3357 (not (and (= term-scroll-start 0)
3358 (= term-scroll-end term-height)))))
3359 (term-move-columns (- (term-current-column)))
3360 (term-goto 0 0))
3361
3362 ;; (defun term-switch-to-alternate-sub-buffer (set)
3363 ;; ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3364 ;; ;; using it, do nothing. This test is needed for some programs (including
3365 ;; ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3366 ;; (term-handle-deferred-scroll)
3367 ;; (if (eq set (not (term-using-alternate-sub-buffer)))
3368 ;; (let ((row (term-current-row))
3369 ;; (col (term-horizontal-column)))
3370 ;; (cond (set
3371 ;; (goto-char (point-max))
3372 ;; (if (not (eq (preceding-char) ?\n))
3373 ;; (term-insert-char ?\n 1))
3374 ;; (setq term-scroll-with-delete t)
3375 ;; (setq term-saved-home-marker (copy-marker term-home-marker))
3376 ;; (set-marker term-home-marker (point)))
3377 ;; (t
3378 ;; (setq term-scroll-with-delete
3379 ;; (not (and (= term-scroll-start 0)
3380 ;; (= term-scroll-end term-height))))
3381 ;; (set-marker term-home-marker term-saved-home-marker)
3382 ;; (set-marker term-saved-home-marker nil)
3383 ;; (setq term-saved-home-marker nil)
3384 ;; (goto-char term-home-marker)))
3385 ;; (setq term-current-column nil)
3386 ;; (setq term-current-row 0)
3387 ;; (term-goto row col))))
3388
3389 ;; Default value for the symbol term-command-hook.
3390
3391 (defun term-command-hook (string)
3392 (cond ((equal string "")
3393 t)
3394 ((= (aref string 0) ?\032)
3395 ;; gdb (when invoked with -fullname) prints:
3396 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3397 (let* ((first-colon (string-match ":" string 1))
3398 (second-colon
3399 (string-match ":" string (1+ first-colon)))
3400 (filename (substring string 1 first-colon))
3401 (fileline (string-to-number
3402 (substring string (1+ first-colon) second-colon))))
3403 (setq term-pending-frame (cons filename fileline))))
3404 ((= (aref string 0) ?/)
3405 (cd (substring string 1)))
3406 ;; Allowing the inferior to call functions in Emacs is
3407 ;; probably too big a security hole.
3408 ;; ((= (aref string 0) ?!)
3409 ;; (eval (car (read-from-string string 1))))
3410 (t)));; Otherwise ignore it
3411
3412 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3413 ;; and that its line LINE is visible.
3414 ;; Put the overlay-arrow on the line LINE in that buffer.
3415 ;; This is mainly used by gdb.
3416
3417 (defun term-display-line (true-file line)
3418 (term-display-buffer-line (find-file-noselect true-file) line))
3419
3420 (defun term-display-buffer-line (buffer line)
3421 (let* ((window (display-buffer buffer t))
3422 (pos))
3423 (with-current-buffer buffer
3424 (save-restriction
3425 (widen)
3426 (goto-char (point-min))
3427 (forward-line (1- line))
3428 (setq pos (point))
3429 (setq overlay-arrow-string "=>")
3430 (or overlay-arrow-position
3431 (setq overlay-arrow-position (make-marker)))
3432 (set-marker overlay-arrow-position (point) (current-buffer)))
3433 (cond ((or (< pos (point-min)) (> pos (point-max)))
3434 (widen)
3435 (goto-char pos))))
3436 (set-window-point window overlay-arrow-position)))
3437
3438 ;; The buffer-local marker term-home-marker defines the "home position"
3439 ;; (in terms of cursor motion). However, we move the term-home-marker
3440 ;; "down" as needed so that is no more that a window-full above (point-max).
3441
3442 (defun term-goto-home ()
3443 (term-handle-deferred-scroll)
3444 (goto-char term-home-marker)
3445 (setq term-current-row 0)
3446 (setq term-current-column (current-column))
3447 (setq term-start-line-column term-current-column))
3448
3449 (defun term-goto (row col)
3450 (term-handle-deferred-scroll)
3451 (cond ((and term-current-row (>= row term-current-row))
3452 ;; I assume this is a worthwhile optimization.
3453 (term-vertical-motion 0)
3454 (setq term-current-column term-start-line-column)
3455 (setq row (- row term-current-row)))
3456 (t
3457 (term-goto-home)))
3458 (term-down row)
3459 (term-move-columns col))
3460
3461 ;; The page is full, so enter "pager" mode, and wait for input.
3462
3463 (defun term-process-pager ()
3464 (when (not term-pager-break-map)
3465 (let* ((map (make-keymap))
3466 ;; (i 0)
3467 tmp)
3468 ;; (while (< i 128)
3469 ;; (define-key map (make-string 1 i) 'term-send-raw)
3470 ;; (setq i (1+ i)))
3471 (define-key map "\e"
3472 (lookup-key (current-global-map) "\e"))
3473 (define-key map "\C-x"
3474 (lookup-key (current-global-map) "\C-x"))
3475 (define-key map "\C-u"
3476 (lookup-key (current-global-map) "\C-u"))
3477 (define-key map " " 'term-pager-page)
3478 (define-key map "\r" 'term-pager-line)
3479 (define-key map "?" 'term-pager-help)
3480 (define-key map "h" 'term-pager-help)
3481 (define-key map "b" 'term-pager-back-page)
3482 (define-key map "\177" 'term-pager-back-line)
3483 (define-key map "q" 'term-pager-discard)
3484 (define-key map "D" 'term-pager-disable)
3485 (define-key map "<" 'term-pager-bob)
3486 (define-key map ">" 'term-pager-eob)
3487
3488 ;; Add menu bar.
3489 (unless (featurep 'xemacs)
3490 (define-key map [menu-bar terminal] term-terminal-menu)
3491 (define-key map [menu-bar signals] term-signals-menu)
3492 (setq tmp (make-sparse-keymap "More pages?"))
3493 (define-key tmp [help] '("Help" . term-pager-help))
3494 (define-key tmp [disable]
3495 '("Disable paging" . term-fake-pager-disable))
3496 (define-key tmp [discard]
3497 '("Discard remaining output" . term-pager-discard))
3498 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3499 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3500 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3501 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3502 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3503 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3504 (define-key map [menu-bar page] (cons "More pages?" tmp))
3505 )
3506
3507 (setq term-pager-break-map map)))
3508 ;; (let ((process (get-buffer-process (current-buffer))))
3509 ;; (stop-process process))
3510 (setq term-pager-old-local-map (current-local-map))
3511 (use-local-map term-pager-break-map)
3512 (make-local-variable 'term-old-mode-line-format)
3513 (setq term-old-mode-line-format mode-line-format)
3514 (setq mode-line-format
3515 (list "-- **MORE** "
3516 mode-line-buffer-identification
3517 " [Type ? for help] "
3518 "%-"))
3519 (force-mode-line-update))
3520
3521 (defun term-pager-line (lines)
3522 (interactive "p")
3523 (let* ((moved (vertical-motion (1+ lines)))
3524 (deficit (- lines moved)))
3525 (when (> moved lines)
3526 (backward-char))
3527 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3528 (recenter (1- term-height)))
3529 ((term-pager-continue deficit)))))
3530
3531 (defun term-pager-page (arg)
3532 "Proceed past the **MORE** break, allowing the next page of output to appear."
3533 (interactive "p")
3534 (term-pager-line (* arg term-height)))
3535
3536 ;; Pager mode command to go to beginning of buffer.
3537 (defun term-pager-bob ()
3538 (interactive)
3539 (goto-char (point-min))
3540 (when (= (vertical-motion term-height) term-height)
3541 (backward-char))
3542 (recenter (1- term-height)))
3543
3544 ;; Pager mode command to go to end of buffer.
3545 (defun term-pager-eob ()
3546 (interactive)
3547 (goto-char term-home-marker)
3548 (recenter 0)
3549 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3550
3551 (defun term-pager-back-line (lines)
3552 (interactive "p")
3553 (vertical-motion (- 1 lines))
3554 (if (not (bobp))
3555 (backward-char)
3556 (beep)
3557 ;; Move cursor to end of window.
3558 (vertical-motion term-height)
3559 (backward-char))
3560 (recenter (1- term-height)))
3561
3562 (defun term-pager-back-page (arg)
3563 (interactive "p")
3564 (term-pager-back-line (* arg term-height)))
3565
3566 (defun term-pager-discard ()
3567 (interactive)
3568 (setq term-terminal-parameter "")
3569 (interrupt-process nil t)
3570 (term-pager-continue term-height))
3571
3572 ;; Disable pager processing.
3573 ;; Only callable while in pager mode. (Contrast term-disable-pager.)
3574 (defun term-pager-disable ()
3575 (interactive)
3576 (if (term-handling-pager)
3577 (term-pager-continue nil)
3578 (setq term-pager-count nil))
3579 (term-update-mode-line))
3580
3581 ;; Enable pager processing.
3582 (defun term-pager-enable ()
3583 (interactive)
3584 (or (term-pager-enabled)
3585 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3586 (term-update-mode-line))
3587
3588 (defun term-pager-toggle ()
3589 (interactive)
3590 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3591
3592 (unless (featurep 'xemacs)
3593 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3594 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3595 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3596 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3597 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3598 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3599
3600 (defun term-pager-help ()
3601 "Provide help on commands available in a terminal-emulator **MORE** break."
3602 (interactive)
3603 (message "Terminal-emulator pager break help...")
3604 (sit-for 0)
3605 (with-electric-help
3606 (function (lambda ()
3607 (princ (substitute-command-keys
3608 "\\<term-pager-break-map>\
3609 Terminal-emulator MORE break.\n\
3610 Type one of the following keys:\n\n\
3611 \\[term-pager-page]\t\tMove forward one page.\n\
3612 \\[term-pager-line]\t\tMove forward one line.\n\
3613 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3614 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3615 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3616 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3617 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3618 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3619 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3620 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3621 \\{term-pager-break-map}\n\
3622 Any other key is passed through to the program
3623 running under the terminal emulator and disables pager processing until
3624 all pending output has been dealt with."))
3625 nil))))
3626
3627 (defun term-pager-continue (new-count)
3628 (let ((process (get-buffer-process (current-buffer))))
3629 (use-local-map term-pager-old-local-map)
3630 (setq term-pager-old-local-map nil)
3631 (setq mode-line-format term-old-mode-line-format)
3632 (force-mode-line-update)
3633 (setq term-pager-count new-count)
3634 (set-process-filter process term-pager-old-filter)
3635 (funcall term-pager-old-filter process "")
3636 (continue-process process)))
3637
3638 ;; Make sure there are DOWN blank lines below the current one.
3639 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3640
3641 (defun term-handle-scroll (down)
3642 (let ((scroll-needed
3643 (- (+ (term-current-row) down)
3644 (if (< down 0) term-scroll-start term-scroll-end))))
3645 (when (or (and (< down 0) (< scroll-needed 0))
3646 (and (> down 0) (> scroll-needed 0)))
3647 (let ((save-point (copy-marker (point))) (save-top))
3648 (goto-char term-home-marker)
3649 (cond (term-scroll-with-delete
3650 (if (< down 0)
3651 (progn
3652 ;; Delete scroll-needed lines at term-scroll-end,
3653 ;; then insert scroll-needed lines.
3654 (term-vertical-motion term-scroll-end)
3655 (end-of-line)
3656 (setq save-top (point))
3657 (term-vertical-motion scroll-needed)
3658 (end-of-line)
3659 (delete-region save-top (point))
3660 (goto-char save-point)
3661 (setq down (- scroll-needed down))
3662 (term-vertical-motion down))
3663 ;; Delete scroll-needed lines at term-scroll-start.
3664 (term-vertical-motion term-scroll-start)
3665 (setq save-top (point))
3666 (term-vertical-motion scroll-needed)
3667 (delete-region save-top (point))
3668 (goto-char save-point)
3669 (term-vertical-motion down)
3670 (term-adjust-current-row-cache (- scroll-needed)))
3671 (setq term-current-column nil)
3672 (term-insert-char ?\n (abs scroll-needed)))
3673 ((and (numberp term-pager-count)
3674 (< (setq term-pager-count (- term-pager-count down))
3675 0))
3676 (setq down 0)
3677 (term-process-pager))
3678 (t
3679 (term-adjust-current-row-cache (- scroll-needed))
3680 (term-vertical-motion scroll-needed)
3681 (set-marker term-home-marker (point))))
3682 (goto-char save-point)
3683 (set-marker save-point nil))))
3684 down)
3685
3686 (defun term-down (down &optional check-for-scroll)
3687 "Move down DOWN screen lines vertically."
3688 (let ((start-column (term-horizontal-column)))
3689 (when (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3690 (setq down (term-handle-scroll down)))
3691 (unless (and (= term-current-row 0) (< down 0))
3692 (term-adjust-current-row-cache down)
3693 (when (or (/= (point) (point-max)) (< down 0))
3694 (setq down (- down (term-vertical-motion down)))))
3695 (cond ((>= down 0)
3696 ;; Extend buffer with extra blank lines if needed.
3697 (term-insert-char ?\n down)
3698 (setq term-current-column 0)
3699 (setq term-start-line-column 0))
3700 (t
3701 (when (= term-current-row 0)
3702 ;; Insert lines if at the beginning.
3703 (save-excursion (term-insert-char ?\n (- down)))
3704 (save-excursion
3705 (let (p)
3706 ;; Delete lines from the end.
3707 (forward-line term-height)
3708 (setq p (point))
3709 (forward-line (- down))
3710 (delete-region p (point)))))
3711 (setq term-current-column 0)
3712 (setq term-start-line-column (current-column))))
3713 (when start-column
3714 (term-move-columns start-column))))
3715
3716 ;; Assuming point is at the beginning of a screen line,
3717 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3718 ;; FIXME: Probably should be called more than it is.
3719 (defun term-unwrap-line ()
3720 (when (not (bolp)) (insert-before-markers ?\n)))
3721
3722 (defun term-erase-in-line (kind)
3723 (when (= kind 1) ;; erase left of point
3724 (let ((cols (term-horizontal-column)) (saved-point (point)))
3725 (term-vertical-motion 0)
3726 (delete-region (point) saved-point)
3727 (term-insert-char ? cols)))
3728 (when (not (eq kind 1)) ;; erase right of point
3729 (let ((saved-point (point))
3730 (wrapped (and (zerop (term-horizontal-column))
3731 (not (zerop (term-current-column))))))
3732 (term-vertical-motion 1)
3733 (delete-region saved-point (point))
3734 ;; wrapped is true if we're at the beginning of screen line,
3735 ;; but not a buffer line. If we delete the current screen line
3736 ;; that will make the previous line no longer wrap, and (because
3737 ;; of the way Emacs display works) point will be at the end of
3738 ;; the previous screen line rather then the beginning of the
3739 ;; current one. To avoid that, we make sure that current line
3740 ;; contain a space, to force the previous line to continue to wrap.
3741 ;; We could do this always, but it seems preferable to not add the
3742 ;; extra space when wrapped is false.
3743 (when wrapped
3744 (insert ? ))
3745 (insert ?\n)
3746 (put-text-property saved-point (point) 'face 'default)
3747 (goto-char saved-point))))
3748
3749 (defun term-erase-in-display (kind)
3750 "Erase (that is blank out) part of the window.
3751 If KIND is 0, erase from (point) to (point-max);
3752 if KIND is 1, erase from home to point; else erase from home to point-max."
3753 (term-handle-deferred-scroll)
3754 (cond ((eq term-terminal-parameter 0)
3755 (let ((need-unwrap (bolp)))
3756 (delete-region (point) (point-max))
3757 (when need-unwrap (term-unwrap-line))))
3758 ((let ((row (term-current-row))
3759 (col (term-horizontal-column))
3760 (start-region term-home-marker)
3761 (end-region (if (eq kind 1) (point) (point-max))))
3762 (delete-region start-region end-region)
3763 (term-unwrap-line)
3764 (when (eq kind 1)
3765 (term-insert-char ?\n row))
3766 (setq term-current-column nil)
3767 (setq term-current-row nil)
3768 (term-goto row col)))))
3769
3770 (defun term-delete-chars (count)
3771 (let ((save-point (point)))
3772 (term-vertical-motion 1)
3773 (term-unwrap-line)
3774 (goto-char save-point)
3775 (move-to-column (+ (term-current-column) count) t)
3776 (delete-region save-point (point))))
3777
3778 ;; Insert COUNT spaces after point, but do not change any of
3779 ;; following screen lines. Hence we may have to delete characters
3780 ;; at the end of this screen line to make room.
3781
3782 (defun term-insert-spaces (count)
3783 (let ((save-point (point)) (save-eol) (pnt-at-eol))
3784 (term-vertical-motion 1)
3785 (when (bolp)
3786 (backward-char))
3787 (setq save-eol (point)
3788 pnt-at-eol (line-end-position))
3789 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3790 ;; If move-to-column extends the current line it will use the face
3791 ;; from the last character on the line, set the face for the chars
3792 ;; to default.
3793 (when (>= (point) pnt-at-eol)
3794 (put-text-property pnt-at-eol (point) 'face 'default))
3795 (when (> save-eol (point))
3796 (delete-region (point) save-eol))
3797 (goto-char save-point)
3798 (term-insert-char ? count)
3799 (goto-char save-point)))
3800
3801 (defun term-delete-lines (lines)
3802 (let ((start (point))
3803 (save-current-column term-current-column)
3804 (save-start-line-column term-start-line-column)
3805 (save-current-row (term-current-row)))
3806 ;; The number of inserted lines shouldn't exceed the scroll region end.
3807 ;; The `term-scroll-end' line is part of the scrolling region, so
3808 ;; we need to go one line past it in order to ensure correct
3809 ;; scrolling.
3810 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3811 (setq lines (- lines (- (+ save-current-row lines) (1+ term-scroll-end)))))
3812 (term-down lines)
3813 (delete-region start (point))
3814 (term-down (- (1+ term-scroll-end) save-current-row lines))
3815 (term-insert-char ?\n lines)
3816 (setq term-current-column save-current-column)
3817 (setq term-start-line-column save-start-line-column)
3818 (setq term-current-row save-current-row)
3819 (goto-char start)))
3820
3821 (defun term-insert-lines (lines)
3822 (let ((start (point))
3823 (start-deleted)
3824 (save-current-column term-current-column)
3825 (save-start-line-column term-start-line-column)
3826 (save-current-row (term-current-row)))
3827 ;; Inserting lines should take into account the scroll region.
3828 ;; The `term-scroll-end' line is part of the scrolling region, so
3829 ;; we need to go one line past it in order to ensure correct
3830 ;; scrolling.
3831 (if (< save-current-row term-scroll-start)
3832 ;; If point is before scroll start,
3833 (progn
3834 (setq lines (- lines (- term-scroll-start save-current-row)))
3835 (term-down (- term-scroll-start save-current-row))
3836 (setq start (point)))
3837 ;; The number of inserted lines shouldn't exceed the scroll region end.
3838 (when (> (+ save-current-row lines) (1+ term-scroll-end))
3839 (setq lines (- lines (- (+ save-current-row lines)(1+ term-scroll-end)))))
3840 (term-down (- (1+ term-scroll-end) save-current-row lines)))
3841 (setq start-deleted (point))
3842 (term-down lines)
3843 (delete-region start-deleted (point))
3844 (goto-char start)
3845 (setq term-current-column save-current-column)
3846 (setq term-start-line-column save-start-line-column)
3847 (setq term-current-row save-current-row)
3848 (term-insert-char ?\n lines)
3849 (goto-char start)))
3850 \f
3851 (defun term-start-output-log (name)
3852 "Record raw inferior process output in a buffer."
3853 (interactive (list (if term-log-buffer
3854 nil
3855 (read-buffer "Record output in buffer: "
3856 (format "%s output-log"
3857 (buffer-name (current-buffer)))
3858 nil))))
3859 (if (or (null name) (equal name ""))
3860 (progn (setq term-log-buffer nil)
3861 (message "Output logging off."))
3862 (if (get-buffer name)
3863 nil
3864 (with-current-buffer (get-buffer-create name)
3865 (fundamental-mode)
3866 (buffer-disable-undo (current-buffer))
3867 (erase-buffer)))
3868 (setq term-log-buffer (get-buffer name))
3869 (message "Recording terminal emulator output into buffer \"%s\""
3870 (buffer-name term-log-buffer))))
3871
3872 (defun term-stop-output-log ()
3873 "Discontinue raw inferior process logging."
3874 (interactive)
3875 (term-start-output-log nil))
3876
3877 (defun term-show-maximum-output ()
3878 "Put the end of the buffer at the bottom of the window."
3879 (interactive)
3880 (goto-char (point-max))
3881 (recenter -1))
3882 \f
3883 ;;; Do the user's customisation...
3884
3885 (defvar term-load-hook nil
3886 "This hook is run when term is loaded in.
3887 This is a good place to put keybindings.")
3888
3889 (run-hooks 'term-load-hook)
3890
3891 \f
3892 ;;; Filename/command/history completion in a buffer
3893 ;; ===========================================================================
3894 ;; Useful completion functions, courtesy of the Ergo group.
3895
3896 ;; Six commands:
3897 ;; term-dynamic-complete Complete or expand command, filename,
3898 ;; history at point.
3899 ;; term-dynamic-complete-filename Complete filename at point.
3900 ;; term-dynamic-list-filename-completions List completions in help buffer.
3901 ;; term-replace-by-expanded-filename Expand and complete filename at point;
3902 ;; replace with expanded/completed name.
3903
3904 ;; These are not installed in the term-mode keymap. But they are
3905 ;; available for people who want them. Shell-mode installs them:
3906 ;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3907 ;; (define-key shell-mode-map "\M-?"
3908 ;; 'term-dynamic-list-filename-completions)))
3909 ;;
3910 ;; Commands like this are fine things to put in load hooks if you
3911 ;; want them present in specific modes.
3912
3913 (defvar term-completion-autolist nil
3914 "*If non-nil, automatically list possibilities on partial completion.
3915 This mirrors the optional behavior of tcsh.")
3916
3917 (defvar term-completion-addsuffix t
3918 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3919 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3920 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3921 completion. This mirrors the optional behavior of tcsh.")
3922
3923 (defvar term-completion-recexact nil
3924 "*If non-nil, use shortest completion if characters cannot be added.
3925 This mirrors the optional behavior of tcsh.
3926
3927 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3928
3929 (defvar term-completion-fignore nil
3930 "*List of suffixes to be disregarded during file completion.
3931 This mirrors the optional behavior of bash and tcsh.
3932
3933 Note that this applies to `term-dynamic-complete-filename' only.")
3934
3935 (defvar term-file-name-prefix ""
3936 "Prefix prepended to absolute file names taken from process input.
3937 This is used by term's and shell's completion functions, and by shell's
3938 directory tracking functions.")
3939
3940
3941 (defun term-directory (directory)
3942 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3943 (expand-file-name (if (file-name-absolute-p directory)
3944 (concat term-file-name-prefix directory)
3945 directory)))
3946
3947
3948 (defun term-word (word-chars)
3949 "Return the word of WORD-CHARS at point, or nil if none is found.
3950 Word constituents are considered to be those in WORD-CHARS, which is like the
3951 inside of a \"[...]\" (see `skip-chars-forward')."
3952 (save-excursion
3953 (let ((limit (point))
3954 (word (concat "[" word-chars "]"))
3955 (non-word (concat "[^" word-chars "]")))
3956 (when (re-search-backward non-word nil 'move)
3957 (forward-char 1))
3958 ;; Anchor the search forwards.
3959 (if (or (eolp) (looking-at non-word))
3960 nil
3961 (re-search-forward (concat word "+") limit)
3962 (buffer-substring (match-beginning 0) (match-end 0))))))
3963
3964
3965 (defun term-match-partial-filename ()
3966 "Return the filename at point, or nil if none is found.
3967 Environment variables are substituted. See `term-word'."
3968 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3969 (and filename (substitute-in-file-name filename))))
3970
3971
3972 (defun term-dynamic-complete ()
3973 "Dynamically perform completion at point.
3974 Calls the functions in `term-dynamic-complete-functions' to perform
3975 completion until a function returns non-nil, at which point completion is
3976 assumed to have occurred."
3977 (interactive)
3978 (let ((functions term-dynamic-complete-functions))
3979 (while (and functions (null (funcall (car functions))))
3980 (setq functions (cdr functions)))))
3981
3982
3983 (defun term-dynamic-complete-filename ()
3984 "Dynamically complete the filename at point.
3985 Completes if after a filename. See `term-match-partial-filename' and
3986 `term-dynamic-complete-as-filename'.
3987 This function is similar to `term-replace-by-expanded-filename', except that
3988 it won't change parts of the filename already entered in the buffer; it just
3989 adds completion characters to the end of the filename. A completions listing
3990 may be shown in a help buffer if completion is ambiguous.
3991
3992 Completion is dependent on the value of `term-completion-addsuffix',
3993 `term-completion-recexact' and `term-completion-fignore', and the timing of
3994 completions listing is dependent on the value of `term-completion-autolist'.
3995
3996 Returns t if successful."
3997 (interactive)
3998 (when (term-match-partial-filename)
3999 (prog2 (or (eq (selected-window) (minibuffer-window))
4000 (message "Completing file name..."))
4001 (term-dynamic-complete-as-filename))))
4002
4003 (defun term-dynamic-complete-as-filename ()
4004 "Dynamically complete at point as a filename.
4005 See `term-dynamic-complete-filename'. Returns t if successful."
4006 (let* ((completion-ignore-case nil)
4007 (completion-ignored-extensions term-completion-fignore)
4008 (success t)
4009 (dirsuffix (cond ((not term-completion-addsuffix) "")
4010 ((not (consp term-completion-addsuffix)) "/")
4011 (t (car term-completion-addsuffix))))
4012 (filesuffix (cond ((not term-completion-addsuffix) "")
4013 ((not (consp term-completion-addsuffix)) " ")
4014 (t (cdr term-completion-addsuffix))))
4015 (filename (or (term-match-partial-filename) ""))
4016 (pathdir (file-name-directory filename))
4017 (pathnondir (file-name-nondirectory filename))
4018 (directory (if pathdir (term-directory pathdir) default-directory))
4019 (completion (file-name-completion pathnondir directory))
4020 (mini-flag (eq (selected-window) (minibuffer-window))))
4021 (cond ((null completion)
4022 (message "No completions of %s" filename)
4023 (setq success nil))
4024 ((eq completion t) ; Means already completed "file".
4025 (when term-completion-addsuffix (insert " "))
4026 (or mini-flag (message "Sole completion")))
4027 ((string-equal completion "") ; Means completion on "directory/".
4028 (term-dynamic-list-filename-completions))
4029 (t ; Completion string returned.
4030 (let ((file (concat (file-name-as-directory directory) completion)))
4031 (insert (substring (directory-file-name completion)
4032 (length pathnondir)))
4033 (cond ((symbolp (file-name-completion completion directory))
4034 ;; We inserted a unique completion.
4035 (insert (if (file-directory-p file) dirsuffix filesuffix))
4036 (or mini-flag (message "Completed")))
4037 ((and term-completion-recexact term-completion-addsuffix
4038 (string-equal pathnondir completion)
4039 (file-exists-p file))
4040 ;; It's not unique, but user wants shortest match.
4041 (insert (if (file-directory-p file) dirsuffix filesuffix))
4042 (or mini-flag (message "Completed shortest")))
4043 ((or term-completion-autolist
4044 (string-equal pathnondir completion))
4045 ;; It's not unique, list possible completions.
4046 (term-dynamic-list-filename-completions))
4047 (t
4048 (or mini-flag (message "Partially completed")))))))
4049 success))
4050
4051
4052 (defun term-replace-by-expanded-filename ()
4053 "Dynamically expand and complete the filename at point.
4054 Replace the filename with an expanded, canonicalized and completed replacement.
4055 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
4056 with the corresponding directories. \"Canonicalized\" means `..' and `.' are
4057 removed, and the filename is made absolute instead of relative. For expansion
4058 see `expand-file-name' and `substitute-in-file-name'. For completion see
4059 `term-dynamic-complete-filename'."
4060 (interactive)
4061 (replace-match (expand-file-name (term-match-partial-filename)) t t)
4062 (term-dynamic-complete-filename))
4063
4064
4065 (defun term-dynamic-simple-complete (stub candidates)
4066 "Dynamically complete STUB from CANDIDATES list.
4067 This function inserts completion characters at point by completing STUB from
4068 the strings in CANDIDATES. A completions listing may be shown in a help buffer
4069 if completion is ambiguous.
4070
4071 Returns nil if no completion was inserted.
4072 Returns `sole' if completed with the only completion match.
4073 Returns `shortest' if completed with the shortest of the completion matches.
4074 Returns `partial' if completed as far as possible with the completion matches.
4075 Returns `listed' if a completion listing was shown.
4076
4077 See also `term-dynamic-complete-filename'."
4078 (let* ((completion-ignore-case nil)
4079 (candidates (mapcar (function (lambda (x) (list x))) candidates))
4080 (completions (all-completions stub candidates)))
4081 (cond ((null completions)
4082 (message "No completions of %s" stub)
4083 nil)
4084 ((= 1 (length completions)) ; Gotcha!
4085 (let ((completion (car completions)))
4086 (if (string-equal completion stub)
4087 (message "Sole completion")
4088 (insert (substring completion (length stub)))
4089 (message "Completed"))
4090 (when term-completion-addsuffix (insert " "))
4091 'sole))
4092 (t ; There's no unique completion.
4093 (let ((completion (try-completion stub candidates)))
4094 ;; Insert the longest substring.
4095 (insert (substring completion (length stub)))
4096 (cond ((and term-completion-recexact term-completion-addsuffix
4097 (string-equal stub completion)
4098 (member completion completions))
4099 ;; It's not unique, but user wants shortest match.
4100 (insert " ")
4101 (message "Completed shortest")
4102 'shortest)
4103 ((or term-completion-autolist
4104 (string-equal stub completion))
4105 ;; It's not unique, list possible completions.
4106 (term-dynamic-list-completions completions)
4107 'listed)
4108 (t
4109 (message "Partially completed")
4110 'partial)))))))
4111 (make-obsolete 'term-dynamic-simple-complete 'completion-in-region "23.2")
4112
4113
4114 (defun term-dynamic-list-filename-completions ()
4115 "List in help buffer possible completions of the filename at point."
4116 (interactive)
4117 (let* ((completion-ignore-case nil)
4118 (filename (or (term-match-partial-filename) ""))
4119 (pathdir (file-name-directory filename))
4120 (pathnondir (file-name-nondirectory filename))
4121 (directory (if pathdir (term-directory pathdir) default-directory))
4122 (completions (file-name-all-completions pathnondir directory)))
4123 (if completions
4124 (term-dynamic-list-completions completions)
4125 (message "No completions of %s" filename))))
4126
4127
4128 (defun term-dynamic-list-completions (completions)
4129 "List in help buffer sorted COMPLETIONS.
4130 Typing SPC flushes the help buffer."
4131 (let ((conf (current-window-configuration)))
4132 (with-output-to-temp-buffer "*Completions*"
4133 (display-completion-list (sort completions 'string-lessp)))
4134 (message "Hit space to flush")
4135 (let (key first)
4136 (if (with-current-buffer (get-buffer "*Completions*")
4137 (setq key (read-key-sequence nil)
4138 first (aref key 0))
4139 (and (consp first)
4140 (eq (window-buffer (posn-window (event-start first)))
4141 (get-buffer "*Completions*"))
4142 (eq (key-binding key) 'mouse-choose-completion)))
4143 ;; If the user does mouse-choose-completion with the mouse,
4144 ;; execute the command, then delete the completion window.
4145 (progn
4146 (choose-completion first)
4147 (set-window-configuration conf))
4148 (if (eq first ?\s)
4149 (set-window-configuration conf)
4150 (setq unread-command-events (listify-key-sequence key)))))))
4151
4152 ;; I need a make-term that doesn't surround with *s -mm
4153 (defun term-ansi-make-term (name program &optional startfile &rest switches)
4154 "Make a term process NAME in a buffer, running PROGRAM.
4155 The name of the buffer is NAME.
4156 If there is already a running process in that buffer, it is not restarted.
4157 Optional third arg STARTFILE is the name of a file to send the contents of to
4158 the process. Any more args are arguments to PROGRAM."
4159 (let ((buffer (get-buffer-create name )))
4160 ;; If no process, or nuked process, crank up a new one and put buffer in
4161 ;; term mode. Otherwise, leave buffer and existing process alone.
4162 (cond ((not (term-check-proc buffer))
4163 (with-current-buffer buffer
4164 (term-mode)) ; Install local vars, mode, keymap, ...
4165 (term-exec buffer name program startfile switches)))
4166 buffer))
4167
4168 (defvar term-ansi-buffer-name nil)
4169 (defvar term-ansi-default-program nil)
4170 (defvar term-ansi-buffer-base-name nil)
4171
4172 ;;;###autoload
4173 (defun ansi-term (program &optional new-buffer-name)
4174 "Start a terminal-emulator in a new buffer."
4175 (interactive (list (read-from-minibuffer "Run program: "
4176 (or explicit-shell-file-name
4177 (getenv "ESHELL")
4178 (getenv "SHELL")
4179 "/bin/sh"))))
4180
4181 ;; Pick the name of the new buffer.
4182 (setq term-ansi-buffer-name
4183 (if new-buffer-name
4184 new-buffer-name
4185 (if term-ansi-buffer-base-name
4186 (if (eq term-ansi-buffer-base-name t)
4187 (file-name-nondirectory program)
4188 term-ansi-buffer-base-name)
4189 "ansi-term")))
4190
4191 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
4192
4193 ;; In order to have more than one term active at a time
4194 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
4195 ;; for now they have the *term-ansi-term*<?> form but we'll see...
4196
4197 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
4198 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
4199
4200 (set-buffer term-ansi-buffer-name)
4201 (term-mode)
4202 (term-char-mode)
4203
4204 ;; I wanna have find-file on C-x C-f -mm
4205 ;; your mileage may definitely vary, maybe it's better to put this in your
4206 ;; .emacs ...
4207
4208 (term-set-escape-char ?\C-x)
4209
4210 (switch-to-buffer term-ansi-buffer-name))
4211
4212 \f
4213 ;;; Serial terminals
4214 ;; ===========================================================================
4215 (defun serial-port-is-file-p ()
4216 "Guess whether serial ports are files on this system.
4217 Return t if this is a Unix-based system, where serial ports are
4218 files, such as /dev/ttyS0.
4219 Return nil if this is Windows or DOS, where serial ports have
4220 special identifiers such as COM1."
4221 (not (memq system-type '(windows-nt cygwin ms-dos))))
4222
4223 (defvar serial-name-history
4224 (if (serial-port-is-file-p)
4225 (or (when (file-exists-p "/dev/ttys0") (list "/dev/ttys0"))
4226 (when (file-exists-p "/dev/ttyS0") (list "/dev/ttyS0")))
4227 (list "COM1"))
4228 "History of serial ports used by `serial-read-name'.")
4229
4230 (defvar serial-speed-history
4231 ;; Initialised with reasonable values for newbies.
4232 (list "9600" ;; Given twice because 9600 b/s is the most common speed
4233 "1200" "2400" "4800" "9600" "14400" "19200"
4234 "28800" "38400" "57600" "115200")
4235 "History of serial port speeds used by `serial-read-speed'.")
4236
4237 (defun serial-nice-speed-history ()
4238 "Return `serial-speed-history' cleaned up for a mouse-menu."
4239 (let ((x) (y))
4240 (setq x
4241 (sort
4242 (copy-sequence serial-speed-history)
4243 '(lambda (a b) (when (and (stringp a) (stringp b))
4244 (> (string-to-number a) (string-to-number b))))))
4245 (dolist (i x) (when (not (equal i (car y))) (push i y)))
4246 y))
4247
4248 (defconst serial-no-speed "nil"
4249 "String for `serial-read-speed' for special serial ports.
4250 If `serial-read-speed' reads this string from the user, it
4251 returns nil, which is recognized by `serial-process-configure'
4252 for special serial ports that cannot be configured.")
4253
4254 (defun serial-supported-or-barf ()
4255 "Signal an error if serial processes are not supported."
4256 (unless (fboundp 'make-serial-process)
4257 (error "Serial processes are not supported on this system")))
4258
4259 (defun serial-read-name ()
4260 "Read a serial port name from the user.
4261 Try to be nice by providing useful defaults and history.
4262 On Windows, prepend \\.\ to the port name unless it already
4263 contains a backslash. This handles the legacy ports COM1-COM9 as
4264 well as the newer ports COM10 and higher."
4265 (serial-supported-or-barf)
4266 (let* ((file-name-history serial-name-history)
4267 (h (car file-name-history))
4268 (x (if (serial-port-is-file-p)
4269 (read-file-name
4270 ;; `prompt': The most recently used port is provided as
4271 ;; the default value, which is used when the user
4272 ;; simply presses return.
4273 (if (stringp h) (format "Serial port (default %s): " h)
4274 "Serial port: ")
4275 ;; `directory': Most systems have their serial ports
4276 ;; in the same directory, so start in the directory
4277 ;; of the most recently used port, or in a reasonable
4278 ;; default directory.
4279 (or (and h (file-name-directory h))
4280 (and (file-exists-p "/dev/") "/dev/")
4281 (and (file-exists-p "/") "/"))
4282 ;; `default': This causes (read-file-name) to return
4283 ;; the empty string if he user simply presses return.
4284 ;; Using nil here may result in a default directory
4285 ;; of the current buffer, which is not useful for
4286 ;; serial port.
4287 "")
4288 (read-from-minibuffer
4289 (if (stringp h) (format "Serial port (default %s): " h)
4290 "Serial port: ")
4291 nil nil nil '(file-name-history . 1) nil nil))))
4292 (if (or (null x) (and (stringp x) (zerop (length x))))
4293 (setq x h)
4294 (setq serial-name-history file-name-history))
4295 (when (or (null x) (and (stringp x) (zerop (length x))))
4296 (error "No serial port selected"))
4297 (when (and (not (serial-port-is-file-p))
4298 (not (string-match "\\\\" x)))
4299 (set 'x (concat "\\\\.\\" x)))
4300 x))
4301
4302 (defun serial-read-speed ()
4303 "Read a serial port speed (in bits per second) from the user.
4304 Try to be nice by providing useful defaults and history."
4305 (serial-supported-or-barf)
4306 (let* ((history serial-speed-history)
4307 (h (car history))
4308 (x (read-from-minibuffer
4309 (cond ((string= h serial-no-speed)
4310 "Speed (default nil = set by port): ")
4311 (h
4312 (format "Speed (default %s b/s): " h))
4313 (t
4314 (format "Speed (b/s): ")))
4315 nil nil nil '(history . 1) nil nil)))
4316 (when (or (null x) (and (stringp x) (zerop (length x))))
4317 (setq x h))
4318 (when (or (null x) (not (stringp x)) (zerop (length x)))
4319 (error "Invalid speed"))
4320 (if (string= x serial-no-speed)
4321 (setq x nil)
4322 (setq x (string-to-number x))
4323 (when (or (null x) (not (integerp x)) (<= x 0))
4324 (error "Invalid speed")))
4325 (setq serial-speed-history history)
4326 x))
4327
4328 ;;;###autoload
4329 (defun serial-term (port speed)
4330 "Start a terminal-emulator for a serial port in a new buffer.
4331 PORT is the path or name of the serial port. For example, this
4332 could be \"/dev/ttyS0\" on Unix. On Windows, this could be
4333 \"COM1\" or \"\\\\.\\COM10\".
4334 SPEED is the speed of the serial port in bits per second. 9600
4335 is a common value. SPEED can be nil, see
4336 `serial-process-configure' for details.
4337 The buffer is in Term mode; see `term-mode' for the commands to
4338 use in that buffer.
4339 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
4340 (interactive (list (serial-read-name) (serial-read-speed)))
4341 (serial-supported-or-barf)
4342 (let* ((process (make-serial-process
4343 :port port
4344 :speed speed
4345 :coding 'no-conversion
4346 :noquery t))
4347 (buffer (process-buffer process)))
4348 (with-current-buffer buffer
4349 (term-mode)
4350 (term-char-mode)
4351 (goto-char (point-max))
4352 (set-marker (process-mark process) (point))
4353 (set-process-filter process 'term-emulate-terminal)
4354 (set-process-sentinel process 'term-sentinel))
4355 (switch-to-buffer buffer)
4356 buffer))
4357
4358 (defvar serial-mode-line-speed-menu nil)
4359 (defvar serial-mode-line-config-menu nil)
4360
4361 (defun serial-speed ()
4362 "Return the speed of the serial port of the current buffer's process.
4363 The return value may be nil for a special serial port."
4364 (process-contact (get-buffer-process (current-buffer)) :speed))
4365
4366 (defun serial-mode-line-speed-menu-1 (event)
4367 (interactive "e")
4368 (save-selected-window
4369 (select-window (posn-window (event-start event)))
4370 (serial-update-speed-menu)
4371 (let* ((selection (serial-mode-line-speed-menu event))
4372 (binding (and selection (lookup-key serial-mode-line-speed-menu
4373 (vector (car selection))))))
4374 (when binding (call-interactively binding)))))
4375
4376 (defun serial-mode-line-speed-menu (event)
4377 (x-popup-menu event serial-mode-line-speed-menu))
4378
4379 (defun serial-update-speed-menu ()
4380 (setq serial-mode-line-speed-menu (make-sparse-keymap "Speed (b/s)"))
4381 (define-key serial-mode-line-speed-menu [serial-mode-line-speed-menu-other]
4382 '(menu-item "Other..."
4383 (lambda (event) (interactive "e")
4384 (let ((speed (serial-read-speed)))
4385 (serial-process-configure :speed speed)
4386 (term-update-mode-line)
4387 (message "Speed set to %d b/s" speed)))))
4388 (dolist (str (serial-nice-speed-history))
4389 (let ((num (or (and (stringp str) (string-to-number str)) 0)))
4390 (define-key
4391 serial-mode-line-speed-menu
4392 (vector (make-symbol (format "serial-mode-line-speed-menu-%s" str)))
4393 `(menu-item
4394 ,str
4395 (lambda (event) (interactive "e")
4396 (serial-process-configure :speed ,num)
4397 (term-update-mode-line)
4398 (message "Speed set to %d b/s" ,num))
4399 :button (:toggle . (= (serial-speed) ,num)))))))
4400
4401 (defun serial-mode-line-config-menu-1 (event)
4402 (interactive "e")
4403 (save-selected-window
4404 (select-window (posn-window (event-start event)))
4405 (serial-update-config-menu)
4406 (let* ((selection (serial-mode-line-config-menu event))
4407 (binding (and selection (lookup-key serial-mode-line-config-menu
4408 (vector (car selection))))))
4409 (when binding (call-interactively binding)))))
4410
4411 (defun serial-mode-line-config-menu (event)
4412 (x-popup-menu event serial-mode-line-config-menu))
4413
4414 (defun serial-update-config-menu ()
4415 (setq serial-mode-line-config-menu (make-sparse-keymap "Configuration"))
4416 (let ((config (process-contact
4417 (get-buffer-process (current-buffer)) t)))
4418 (dolist (y '((:flowcontrol hw "Hardware flowcontrol (RTS/CTS)")
4419 (:flowcontrol sw "Software flowcontrol (XON/XOFF)")
4420 (:flowcontrol nil "No flowcontrol")
4421 (:stopbits 2 "2 stopbits")
4422 (:stopbits 1 "1 stopbit")
4423 (:parity odd "Odd parity")
4424 (:parity even "Even parity")
4425 (:parity nil "No parity")
4426 (:bytesize 7 "7 bits per byte")
4427 (:bytesize 8 "8 bits per byte")))
4428 (define-key serial-mode-line-config-menu
4429 (vector (make-symbol (format "%s-%s" (nth 0 y) (nth 1 y))))
4430 `(menu-item
4431 ,(nth 2 y)
4432 (lambda (event) (interactive "e")
4433 (serial-process-configure ,(nth 0 y) ',(nth 1 y))
4434 (term-update-mode-line)
4435 (message "%s" ,(nth 2 y)))
4436 ;; Use :toggle instead of :radio because a non-standard port
4437 ;; configuration may not match any menu items.
4438 :button (:toggle . ,(equal (plist-get config (nth 0 y))
4439 (nth 1 y))))))))
4440
4441 \f
4442 ;;; Converting process modes to use term mode
4443 ;; ===========================================================================
4444 ;; Renaming variables
4445 ;; Most of the work is renaming variables and functions. These are the common
4446 ;; ones:
4447 ;; Local variables:
4448 ;; last-input-start term-last-input-start
4449 ;; last-input-end term-last-input-end
4450 ;; shell-prompt-pattern term-prompt-regexp
4451 ;; shell-set-directory-error-hook <no equivalent>
4452 ;; Miscellaneous:
4453 ;; shell-set-directory <unnecessary>
4454 ;; shell-mode-map term-mode-map
4455 ;; Commands:
4456 ;; shell-send-input term-send-input
4457 ;; shell-send-eof term-delchar-or-maybe-eof
4458 ;; kill-shell-input term-kill-input
4459 ;; interrupt-shell-subjob term-interrupt-subjob
4460 ;; stop-shell-subjob term-stop-subjob
4461 ;; quit-shell-subjob term-quit-subjob
4462 ;; kill-shell-subjob term-kill-subjob
4463 ;; kill-output-from-shell term-kill-output
4464 ;; show-output-from-shell term-show-output
4465 ;; copy-last-shell-input Use term-previous-input/term-next-input
4466 ;;
4467 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4468 ;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4469 ;; Term mode does not provide functionality equivalent to
4470 ;; shell-set-directory-error-hook; it is gone.
4471 ;;
4472 ;; term-last-input-start is provided for modes which want to munge
4473 ;; the buffer after input is sent, perhaps because the inferior
4474 ;; insists on echoing the input. The LAST-INPUT-START variable in
4475 ;; the old shell package was used to implement a history mechanism,
4476 ;; but you should think twice before using term-last-input-start
4477 ;; for this; the input history ring often does the job better.
4478 ;;
4479 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4480 ;; *not* create the term-mode local variables in your foo-mode function.
4481 ;; This is not modular. Instead, call term-mode, and let *it* create the
4482 ;; necessary term-specific local variables. Then create the
4483 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4484 ;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4485 ;; (term-{prompt-regexp, input-filter, input-filter-functions,
4486 ;; get-old-input) that need to be different from the defaults. Call
4487 ;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4488 ;; term-mode will take care of it. The following example, from shell.el,
4489 ;; is typical:
4490 ;;
4491 ;; (defvar shell-mode-map '())
4492 ;; (cond ((not shell-mode-map)
4493 ;; (setq shell-mode-map (copy-keymap term-mode-map))
4494 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4495 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4496 ;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4497 ;; (define-key shell-mode-map "\M-?"
4498 ;; 'term-dynamic-list-filename-completions)))
4499 ;;
4500 ;; (defun shell-mode ()
4501 ;; (interactive)
4502 ;; (term-mode)
4503 ;; (setq term-prompt-regexp shell-prompt-pattern)
4504 ;; (setq major-mode 'shell-mode)
4505 ;; (setq mode-name "Shell")
4506 ;; (use-local-map shell-mode-map)
4507 ;; (make-local-variable 'shell-directory-stack)
4508 ;; (setq shell-directory-stack nil)
4509 ;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4510 ;; (run-mode-hooks 'shell-mode-hook))
4511 ;;
4512 ;;
4513 ;; Completion for term-mode users
4514 ;;
4515 ;; For modes that use term-mode, term-dynamic-complete-functions is the
4516 ;; hook to add completion functions to. Functions on this list should return
4517 ;; non-nil if completion occurs (i.e., further completion should not occur).
4518 ;; You could use completion-in-region to do the bulk of the
4519 ;; completion job.
4520 \f
4521 (provide 'term)
4522
4523 ;;; term.el ends here