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