Sync to HEAD
[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 Free Software Foundation, Inc.
4
5 ;; Author: Per Bothner <bothner@cygnus.com>
6 ;; Based on comint mode written by: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Keywords: processes
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
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.95")
400
401 (eval-when-compile
402 (require 'ange-ftp))
403 (require 'ring)
404 (require 'ehelp)
405
406 (defgroup term nil
407 "General command interpreter in a window"
408 :group 'processes
409 :group 'unix)
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) ;; When using alternate sub-buffer,
439 ;; contains saved term-home-marker from original sub-buffer .
440 (defvar term-start-line-column 0) ;; (current-column) at start of screen line,
441 ;; or nil if unknown.
442 (defvar term-current-column 0) ;; If non-nil, is cache for (current-column).
443 (defvar term-current-row 0) ;; Current vertical row (relative to home-marker)
444 ;; or nil if unknown.
445 (defvar term-insert-mode nil)
446 (defvar term-vertical-motion)
447 (defvar term-terminal-state 0) ;; State of the terminal emulator:
448 ;; state 0: Normal state
449 ;; state 1: Last character was a graphic in the last column.
450 ;; If next char is graphic, first move one column right
451 ;; (and line warp) before displaying it.
452 ;; This emulates (more or less) the behavior of xterm.
453 ;; state 2: seen ESC
454 ;; state 3: seen ESC [ (or ESC [ ?)
455 ;; state 4: term-terminal-parameter contains pending output.
456 (defvar term-kill-echo-list nil) ;; A queue of strings whose echo
457 ;; we want suppressed.
458 (defvar term-terminal-parameter)
459 (defvar term-terminal-previous-parameter)
460 (defvar term-current-face 'term-default)
461 (defvar term-scroll-start 0) ;; Top-most line (inclusive) of scrolling region.
462 (defvar term-scroll-end) ;; Number of line (zero-based) after scrolling region.
463 (defvar term-pager-count nil) ;; If nil, paging is disabled.
464 ;; Otherwise, number of lines before we need to page.
465 (defvar term-saved-cursor nil)
466 (defvar term-command-hook)
467 (defvar term-log-buffer nil)
468 (defvar term-scroll-with-delete nil) ;; term-scroll-with-delete is t if
469 ;; forward scrolling should be implemented by delete to
470 ;; top-most line(s); and nil if scrolling should be implemented
471 ;; by moving term-home-marker. It is set to t iff there is a
472 ;; (non-default) scroll-region OR the alternate buffer is used.
473 (defvar term-pending-delete-marker) ;; New user input in line mode needs to
474 ;; be deleted, because it gets echoed by the inferior.
475 ;; To reduce flicker, we defer the delete until the next output.
476 (defvar term-old-mode-map nil) ;; Saves the old keymap when in char mode.
477 (defvar term-old-mode-line-format) ;; Saves old mode-line-format while paging.
478 (defvar term-pager-old-local-map nil) ;; Saves old keymap while paging.
479 (defvar term-pager-old-filter) ;; Saved process-filter while paging.
480
481 (defcustom explicit-shell-file-name nil
482 "*If non-nil, is file name to use for explicitly requested inferior shell."
483 :type '(choice (const nil) file)
484 :group 'term)
485
486 (defvar term-prompt-regexp "^"
487 "Regexp to recognise prompts in the inferior process.
488 Defaults to \"^\", the null string at BOL.
489
490 Good choices:
491 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
492 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
493 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
494 kcl: \"^>+ *\"
495 shell: \"^[^#$%>\\n]*[#$%>] *\"
496 T: \"^>+ *\"
497
498 This is a good thing to set in mode hooks.")
499
500 (defvar term-delimiter-argument-list ()
501 "List of characters to recognise as separate arguments in input.
502 Strings comprising a character in this list will separate the arguments
503 surrounding them, and also be regarded as arguments in their own right (unlike
504 whitespace). See `term-arguments'.
505 Defaults to the empty list.
506
507 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
508
509 This is a good thing to set in mode hooks.")
510
511 (defcustom term-input-autoexpand nil
512 "*If non-nil, expand input command history references on completion.
513 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
514
515 If the value is `input', then the expansion is seen on input.
516 If the value is `history', then the expansion is only when inserting
517 into the buffer's input ring. See also `term-magic-space' and
518 `term-dynamic-complete'.
519
520 This variable is buffer-local."
521 :type '(choice (const nil) (const t) (const input) (const history))
522 :group 'term)
523
524 (defcustom term-input-ignoredups nil
525 "*If non-nil, don't add input matching the last on the input ring.
526 This mirrors the optional behavior of bash.
527
528 This variable is buffer-local."
529 :type 'boolean
530 :group 'term)
531
532 (defcustom term-input-ring-file-name nil
533 "*If non-nil, name of the file to read/write input history.
534 See also `term-read-input-ring' and `term-write-input-ring'.
535
536 This variable is buffer-local, and is a good thing to set in mode hooks."
537 :type 'boolean
538 :group 'term)
539
540 (defcustom term-scroll-to-bottom-on-output nil
541 "*Controls whether interpreter output causes window to scroll.
542 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
543 If `this', scroll only the selected window.
544 If `others', scroll only those that are not the selected window.
545
546 The default is nil.
547
548 See variable `term-scroll-show-maximum-output'.
549 This variable is buffer-local."
550 :type 'boolean
551 :group 'term)
552
553 (defcustom term-scroll-show-maximum-output nil
554 "*Controls how interpreter output causes window to scroll.
555 If non-nil, then show the maximum output when the window is scrolled.
556
557 See variable `term-scroll-to-bottom-on-output'.
558 This variable is buffer-local."
559 :type 'boolean
560 :group 'term)
561
562 ;; Where gud-display-frame should put the debugging arrow. This is
563 ;; set by the marker-filter, which scans the debugger's output for
564 ;; indications of the current pc.
565 (defvar term-pending-frame nil)
566
567 ;;; Here are the per-interpreter hooks.
568 (defvar term-get-old-input (function term-get-old-input-default)
569 "Function that submits old text in term mode.
570 This function is called when return is typed while the point is in old text.
571 It returns the text to be submitted as process input. The default is
572 term-get-old-input-default, which grabs the current line, and strips off
573 leading text matching term-prompt-regexp")
574
575 (defvar term-dynamic-complete-functions
576 '(term-replace-by-expanded-history term-dynamic-complete-filename)
577 "List of functions called to perform completion.
578 Functions should return non-nil if completion was performed.
579 See also `term-dynamic-complete'.
580
581 This is a good thing to set in mode hooks.")
582
583 (defvar term-input-filter
584 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
585 "Predicate for filtering additions to input history.
586 Only inputs answering true to this function are saved on the input
587 history list. Default is to save anything that isn't all whitespace")
588
589 (defvar term-input-filter-functions '()
590 "Functions to call before input is sent to the process.
591 These functions get one argument, a string containing the text to send.
592
593 This variable is buffer-local.")
594
595 (defvar term-input-sender (function term-simple-send)
596 "Function to actually send to PROCESS the STRING submitted by user.
597 Usually this is just 'term-simple-send, but if your mode needs to
598 massage the input string, this is your hook. This is called from
599 the user command term-send-input. term-simple-send just sends
600 the string plus a newline.")
601
602 (defcustom term-eol-on-send t
603 "*Non-nil means go to the end of the line before sending input.
604 See `term-send-input'."
605 :type 'boolean
606 :group 'term)
607
608 (defcustom term-mode-hook '()
609 "Called upon entry into term-mode
610 This is run before the process is cranked up."
611 :type 'hook
612 :group 'term)
613
614 (defcustom term-exec-hook '()
615 "Called each time a process is exec'd by term-exec.
616 This is called after the process is cranked up. It is useful for things that
617 must be done each time a process is executed in a term-mode buffer (e.g.,
618 \(process-kill-without-query)). In contrast, the term-mode-hook is only
619 executed once when the buffer is created."
620 :type 'hook
621 :group 'term)
622
623 (defvar term-mode-map nil)
624 (defvar term-raw-map nil
625 "Keyboard map for sending characters directly to the inferior process.")
626 (defvar term-escape-char nil
627 "Escape character for char-sub-mode of term mode.
628 Do not change it directly; use term-set-escape-char instead.")
629 (defvar term-raw-escape-map nil)
630
631 (defvar term-pager-break-map nil)
632
633 (defvar term-ptyp t
634 "True if communications via pty; false if by pipe. Buffer local.
635 This is to work around a bug in Emacs process signaling.")
636
637 (defvar term-last-input-match ""
638 "Last string searched for by term input history search, for defaulting.
639 Buffer local variable.")
640
641 (defvar term-input-ring nil)
642 (defvar term-last-input-start)
643 (defvar term-last-input-end)
644 (defvar term-input-ring-index nil
645 "Index of last matched history element.")
646 (defvar term-matching-input-from-input-string ""
647 "Input previously used to match input history.")
648 ; This argument to set-process-filter disables reading from the process,
649 ; assuming this is Emacs 19.20 or newer.
650 (defvar term-pager-filter t)
651
652 (put 'term-replace-by-expanded-history 'menu-enable 'term-input-autoexpand)
653 (put 'term-input-ring 'permanent-local t)
654 (put 'term-input-ring-index 'permanent-local t)
655 (put 'term-input-autoexpand 'permanent-local t)
656 (put 'term-input-filter-functions 'permanent-local t)
657 (put 'term-scroll-to-bottom-on-output 'permanent-local t)
658 (put 'term-scroll-show-maximum-output 'permanent-local t)
659 (put 'term-ptyp 'permanent-local t)
660
661 ;; Do FORM if running under XEmacs (previously Lucid Emacs).
662 (defmacro term-if-xemacs (&rest forms)
663 (if (featurep 'xemacs) (cons 'progn forms)))
664 ;; Do FORM if NOT running under XEmacs (previously Lucid Emacs).
665 (defmacro term-ifnot-xemacs (&rest forms)
666 (if (not (featurep 'xemacs)) (cons 'progn forms)))
667
668 (defmacro term-in-char-mode () '(eq (current-local-map) term-raw-map))
669 (defmacro term-in-line-mode () '(not (term-in-char-mode)))
670 ;; True if currently doing PAGER handling.
671 (defmacro term-pager-enabled () 'term-pager-count)
672 (defmacro term-handling-pager () 'term-pager-old-local-map)
673 (defmacro term-using-alternate-sub-buffer () 'term-saved-home-marker)
674
675 (defvar term-signals-menu)
676 (defvar term-terminal-menu)
677
678 ;;; Let's silence the byte-compiler -mm
679 (defvar term-ansi-at-eval-string nil)
680 (defvar term-ansi-at-host nil)
681 (defvar term-ansi-at-dir nil)
682 (defvar term-ansi-at-user nil)
683 (defvar term-ansi-at-message nil)
684 (defvar term-ansi-at-save-user nil)
685 (defvar term-ansi-at-save-pwd nil)
686 (defvar term-ansi-at-save-anon nil)
687 (defvar term-ansi-current-bold 0)
688 (defvar term-ansi-current-color 0)
689 (defvar term-ansi-face-already-done 0)
690 (defvar term-ansi-current-bg-color 0)
691 (defvar term-ansi-current-underline 0)
692 (defvar term-ansi-current-highlight 0)
693 (defvar term-ansi-current-reverse 0)
694 (defvar term-ansi-current-invisible 0)
695 (defvar term-ansi-default-fg 0)
696 (defvar term-ansi-default-bg 0)
697 (defvar term-ansi-current-temp 0)
698
699 ;;; Four should be enough, if you want more, just add. -mm
700 (defvar term-terminal-more-parameters 0)
701 (defvar term-terminal-previous-parameter-2 -1)
702 (defvar term-terminal-previous-parameter-3 -1)
703 (defvar term-terminal-previous-parameter-4 -1)
704 ;;;
705
706 ;;; faces -mm
707
708 (defcustom term-default-fg-color nil
709 "Default color for foreground in `term'."
710 :group 'term
711 :type 'string)
712
713 (defcustom term-default-bg-color nil
714 "Default color for background in `term'."
715 :group 'term
716 :type 'string)
717
718 (defvar ansi-term-color-vector
719 [nil "black" "red" "green" "yellow" "blue"
720 "magenta" "cyan" "white"])
721
722 ;;; Inspiration came from comint.el -mm
723 (defvar term-buffer-maximum-size 2048
724 "*The maximum size in lines for term buffers.
725 Term buffers are truncated from the top to be no greater than this number.
726 Notice that a setting of 0 means 'don't truncate anything'. This variable
727 is buffer-local.")
728 ;;;
729 \f
730 (term-if-xemacs
731 (defvar term-terminal-menu
732 '("Terminal"
733 [ "Character mode" term-char-mode (term-in-line-mode)]
734 [ "Line mode" term-line-mode (term-in-char-mode)]
735 [ "Enable paging" term-pager-toggle (not term-pager-count)]
736 [ "Disable paging" term-pager-toggle term-pager-count])))
737
738 (if term-mode-map
739 nil
740 (setq term-mode-map (make-sparse-keymap))
741 (define-key term-mode-map "\ep" 'term-previous-input)
742 (define-key term-mode-map "\en" 'term-next-input)
743 (define-key term-mode-map "\er" 'term-previous-matching-input)
744 (define-key term-mode-map "\es" 'term-next-matching-input)
745 (term-ifnot-xemacs
746 (define-key term-mode-map [?\A-\M-r]
747 'term-previous-matching-input-from-input)
748 (define-key term-mode-map [?\A-\M-s] 'term-next-matching-input-from-input))
749 (define-key term-mode-map "\e\C-l" 'term-show-output)
750 (define-key term-mode-map "\C-m" 'term-send-input)
751 (define-key term-mode-map "\C-d" 'term-delchar-or-maybe-eof)
752 (define-key term-mode-map "\C-c\C-a" 'term-bol)
753 (define-key term-mode-map "\C-c\C-u" 'term-kill-input)
754 (define-key term-mode-map "\C-c\C-w" 'backward-kill-word)
755 (define-key term-mode-map "\C-c\C-c" 'term-interrupt-subjob)
756 (define-key term-mode-map "\C-c\C-z" 'term-stop-subjob)
757 (define-key term-mode-map "\C-c\C-\\" 'term-quit-subjob)
758 (define-key term-mode-map "\C-c\C-m" 'term-copy-old-input)
759 (define-key term-mode-map "\C-c\C-o" 'term-kill-output)
760 (define-key term-mode-map "\C-c\C-r" 'term-show-output)
761 (define-key term-mode-map "\C-c\C-e" 'term-show-maximum-output)
762 (define-key term-mode-map "\C-c\C-l" 'term-dynamic-list-input-ring)
763 (define-key term-mode-map "\C-c\C-n" 'term-next-prompt)
764 (define-key term-mode-map "\C-c\C-p" 'term-previous-prompt)
765 (define-key term-mode-map "\C-c\C-d" 'term-send-eof)
766 (define-key term-mode-map "\C-c\C-k" 'term-char-mode)
767 (define-key term-mode-map "\C-c\C-j" 'term-line-mode)
768 (define-key term-mode-map "\C-c\C-q" 'term-pager-toggle)
769
770 ; ;; completion:
771 ; (define-key term-mode-map [menu-bar completion]
772 ; (cons "Complete" (make-sparse-keymap "Complete")))
773 ; (define-key term-mode-map [menu-bar completion complete-expand]
774 ; '("Expand File Name" . term-replace-by-expanded-filename))
775 ; (define-key term-mode-map [menu-bar completion complete-listing]
776 ; '("File Completion Listing" . term-dynamic-list-filename-completions))
777 ; (define-key term-mode-map [menu-bar completion complete-file]
778 ; '("Complete File Name" . term-dynamic-complete-filename))
779 ; (define-key term-mode-map [menu-bar completion complete]
780 ; '("Complete Before Point" . term-dynamic-complete))
781 ; ;; Put them in the menu bar:
782 ; (setq menu-bar-final-items (append '(terminal completion inout signals)
783 ; menu-bar-final-items))
784 )
785
786 ;; Menu bars:
787 (term-ifnot-xemacs
788 (progn
789
790 ;; terminal:
791 (let (newmap)
792 (setq newmap (make-sparse-keymap "Terminal"))
793 (define-key newmap [terminal-pager-enable]
794 '("Enable paging" . term-fake-pager-enable))
795 (define-key newmap [terminal-pager-disable]
796 '("Disable paging" . term-fake-pager-disable))
797 (define-key newmap [terminal-char-mode]
798 '("Character mode" . term-char-mode))
799 (define-key newmap [terminal-line-mode]
800 '("Line mode" . term-line-mode))
801 (setq term-terminal-menu (cons "Terminal" newmap))
802
803 ;; completion: (line mode only)
804 (defvar term-completion-menu (make-sparse-keymap "Complete"))
805 (define-key term-mode-map [menu-bar completion]
806 (cons "Complete" term-completion-menu))
807 (define-key term-completion-menu [complete-expand]
808 '("Expand File Name" . term-replace-by-expanded-filename))
809 (define-key term-completion-menu [complete-listing]
810 '("File Completion Listing" . term-dynamic-list-filename-completions))
811 (define-key term-completion-menu [menu-bar completion complete-file]
812 '("Complete File Name" . term-dynamic-complete-filename))
813 (define-key term-completion-menu [menu-bar completion complete]
814 '("Complete Before Point" . term-dynamic-complete))
815
816 ;; Input history: (line mode only)
817 (defvar term-inout-menu (make-sparse-keymap "In/Out"))
818 (define-key term-mode-map [menu-bar inout]
819 (cons "In/Out" term-inout-menu))
820 (define-key term-inout-menu [kill-output]
821 '("Kill Current Output Group" . term-kill-output))
822 (define-key term-inout-menu [next-prompt]
823 '("Forward Output Group" . term-next-prompt))
824 (define-key term-inout-menu [previous-prompt]
825 '("Backward Output Group" . term-previous-prompt))
826 (define-key term-inout-menu [show-maximum-output]
827 '("Show Maximum Output" . term-show-maximum-output))
828 (define-key term-inout-menu [show-output]
829 '("Show Current Output Group" . term-show-output))
830 (define-key term-inout-menu [kill-input]
831 '("Kill Current Input" . term-kill-input))
832 (define-key term-inout-menu [copy-input]
833 '("Copy Old Input" . term-copy-old-input))
834 (define-key term-inout-menu [forward-matching-history]
835 '("Forward Matching Input..." . term-forward-matching-input))
836 (define-key term-inout-menu [backward-matching-history]
837 '("Backward Matching Input..." . term-backward-matching-input))
838 (define-key term-inout-menu [next-matching-history]
839 '("Next Matching Input..." . term-next-matching-input))
840 (define-key term-inout-menu [previous-matching-history]
841 '("Previous Matching Input..." . term-previous-matching-input))
842 (define-key term-inout-menu [next-matching-history-from-input]
843 '("Next Matching Current Input" . term-next-matching-input-from-input))
844 (define-key term-inout-menu [previous-matching-history-from-input]
845 '("Previous Matching Current Input" .
846 term-previous-matching-input-from-input))
847 (define-key term-inout-menu [next-history]
848 '("Next Input" . term-next-input))
849 (define-key term-inout-menu [previous-history]
850 '("Previous Input" . term-previous-input))
851 (define-key term-inout-menu [list-history]
852 '("List Input History" . term-dynamic-list-input-ring))
853 (define-key term-inout-menu [expand-history]
854 '("Expand History Before Point" . term-replace-by-expanded-history))
855
856 ;; Signals
857 (setq newmap (make-sparse-keymap "Signals"))
858 (define-key newmap [eof] '("EOF" . term-send-eof))
859 (define-key newmap [kill] '("KILL" . term-kill-subjob))
860 (define-key newmap [quit] '("QUIT" . term-quit-subjob))
861 (define-key newmap [cont] '("CONT" . term-continue-subjob))
862 (define-key newmap [stop] '("STOP" . term-stop-subjob))
863 (define-key newmap [] '("BREAK" . term-interrupt-subjob))
864 (define-key term-mode-map [menu-bar signals]
865 (setq term-signals-menu (cons "Signals" newmap)))
866 )))
867 \f
868 ;; Set up term-raw-map, etc.
869
870 (defun term-set-escape-char (c)
871 "Change term-escape-char and keymaps that depend on it."
872 (if term-escape-char
873 (define-key term-raw-map term-escape-char 'term-send-raw))
874 (setq c (make-string 1 c))
875 (define-key term-raw-map c term-raw-escape-map)
876 ;; Define standard bindings in term-raw-escape-map
877 (define-key term-raw-escape-map "\C-v"
878 (lookup-key (current-global-map) "\C-v"))
879 (define-key term-raw-escape-map "\C-u"
880 (lookup-key (current-global-map) "\C-u"))
881 (define-key term-raw-escape-map c 'term-send-raw)
882 (define-key term-raw-escape-map "\C-q" 'term-pager-toggle)
883 ;; The keybinding for term-char-mode is needed by the menubar code.
884 (define-key term-raw-escape-map "\C-k" 'term-char-mode)
885 (define-key term-raw-escape-map "\C-j" 'term-line-mode)
886 ;; It's convenient to have execute-extended-command here.
887 (define-key term-raw-escape-map [?\M-x] 'execute-extended-command))
888
889 (let* ((map (make-keymap))
890 (esc-map (make-keymap))
891 (i 0))
892 (while (< i 128)
893 (define-key map (make-string 1 i) 'term-send-raw)
894 (define-key esc-map (make-string 1 i) 'term-send-raw-meta)
895 (setq i (1+ i)))
896 (define-key map "\e" esc-map)
897 (setq term-raw-map map)
898 (setq term-raw-escape-map
899 (copy-keymap (lookup-key (current-global-map) "\C-x")))
900
901 ;;; Added nearly all the 'grey keys' -mm
902
903 (progn
904 (term-if-xemacs
905 (define-key term-raw-map [button2] 'term-mouse-paste))
906 (term-ifnot-xemacs
907 (define-key term-raw-map [mouse-2] 'term-mouse-paste)
908 (define-key term-raw-map [menu-bar terminal] term-terminal-menu)
909 (define-key term-raw-map [menu-bar signals] term-signals-menu))
910 (define-key term-raw-map [up] 'term-send-up)
911 (define-key term-raw-map [down] 'term-send-down)
912 (define-key term-raw-map [right] 'term-send-right)
913 (define-key term-raw-map [left] 'term-send-left)
914 (define-key term-raw-map [delete] 'term-send-del)
915 (define-key term-raw-map [backspace] 'term-send-backspace)
916 (define-key term-raw-map [home] 'term-send-home)
917 (define-key term-raw-map [end] 'term-send-end)
918 (define-key term-raw-map [prior] 'term-send-prior)
919 (define-key term-raw-map [next] 'term-send-next)))
920
921 (term-set-escape-char ?\C-c)
922
923 (defun term-window-width ()
924 (if (featurep 'xemacs)
925 (1- (window-width))
926 (if window-system
927 (window-width)
928 (1- (window-width)))))
929
930 \f
931 (put 'term-mode 'mode-class 'special)
932
933 (defun term-mode ()
934 "Major mode for interacting with an inferior interpreter.
935 The interpreter name is same as buffer name, sans the asterisks.
936
937 There are two submodes: line mode and char mode. By default, you are
938 in char mode. In char sub-mode, each character (except
939 `term-escape-char') is set immediately.
940
941 In line mode, you send a line of input at a time; use
942 \\[term-send-input] to send.
943
944 In line mode, this maintains an input history of size
945 `term-input-ring-size', and you can access it with the commands
946 \\[term-next-input], \\[term-previous-input], and
947 \\[term-dynamic-list-input-ring]. Input ring history expansion can be
948 achieved with the commands \\[term-replace-by-expanded-history] or
949 \\[term-magic-space]. Input ring expansion is controlled by the
950 variable `term-input-autoexpand', and addition is controlled by the
951 variable `term-input-ignoredups'.
952
953 Input to, and output from, the subprocess can cause the window to scroll to
954 the end of the buffer. See variables `term-scroll-to-bottom-on-input',
955 and `term-scroll-to-bottom-on-output'.
956
957 If you accidentally suspend your process, use \\[term-continue-subjob]
958 to continue it.
959
960 This mode can be customised to create specific modes for running
961 particular subprocesses. This can be done by setting the hooks
962 `term-input-filter-functions', `term-input-filter',
963 `term-input-sender' and `term-get-old-input' to appropriate functions,
964 and the variable `term-prompt-regexp' to the appropriate regular
965 expression.
966
967 Commands in raw mode:
968
969 \\{term-raw-map}
970
971 Commands in line mode:
972
973 \\{term-mode-map}
974
975 Entry to this mode runs the hooks on `term-mode-hook'."
976 (interactive)
977 ;; Do not remove this. All major modes must do this.
978 (kill-all-local-variables)
979 (setq major-mode 'term-mode)
980 (setq mode-name "Term")
981 (use-local-map term-mode-map)
982 (make-local-variable 'term-home-marker)
983 (setq term-home-marker (copy-marker 0))
984 (make-local-variable 'term-saved-home-marker)
985 (make-local-variable 'term-height)
986 (make-local-variable 'term-width)
987 (setq term-width (term-window-width))
988 (setq term-height (1- (window-height)))
989 (term-ifnot-xemacs
990 (set (make-local-variable 'overflow-newline-into-fringe) nil))
991 (make-local-variable 'term-terminal-parameter)
992 (make-local-variable 'term-saved-cursor)
993 (make-local-variable 'term-last-input-start)
994 (setq term-last-input-start (make-marker))
995 (make-local-variable 'term-last-input-end)
996 (setq term-last-input-end (make-marker))
997 (make-local-variable 'term-last-input-match)
998 (setq term-last-input-match "")
999 (make-local-variable 'term-prompt-regexp) ; Don't set; default
1000 (make-local-variable 'term-input-ring-size) ; ...to global val.
1001 (make-local-variable 'term-input-ring)
1002 (make-local-variable 'term-input-ring-file-name)
1003 (or (and (boundp 'term-input-ring) term-input-ring)
1004 (setq term-input-ring (make-ring term-input-ring-size)))
1005 (make-local-variable 'term-input-ring-index)
1006 (or (and (boundp 'term-input-ring-index) term-input-ring-index)
1007 (setq term-input-ring-index nil))
1008
1009 (make-local-variable 'term-command-hook)
1010 (setq term-command-hook (symbol-function 'term-command-hook))
1011
1012 ;;; I'm not sure these saves are necessary but, since I
1013 ;;; haven't tested the whole thing on a net connected machine with
1014 ;;; a properly configured ange-ftp, I've decided to be conservative
1015 ;;; and put them in. -mm
1016
1017 (make-local-variable 'term-ansi-at-host)
1018 (setq term-ansi-at-host (system-name))
1019
1020 (make-local-variable 'term-ansi-at-dir)
1021 (setq term-ansi-at-dir default-directory)
1022
1023 (make-local-variable 'term-ansi-at-message)
1024 (setq term-ansi-at-message nil)
1025
1026 ;;; For user tracking purposes -mm
1027 (make-local-variable 'ange-ftp-default-user)
1028 (make-local-variable 'ange-ftp-default-password)
1029 (make-local-variable 'ange-ftp-generate-anonymous-password)
1030
1031 ;;; You may want to have different scroll-back sizes -mm
1032 (make-local-variable 'term-buffer-maximum-size)
1033
1034 ;;; Of course these have to be buffer-local -mm
1035 (make-local-variable 'term-ansi-current-bold)
1036 (make-local-variable 'term-ansi-current-color)
1037 (make-local-variable 'term-ansi-face-already-done)
1038 (make-local-variable 'term-ansi-current-bg-color)
1039 (make-local-variable 'term-ansi-current-underline)
1040 (make-local-variable 'term-ansi-current-highlight)
1041 (make-local-variable 'term-ansi-current-reverse)
1042 (make-local-variable 'term-ansi-current-invisible)
1043
1044 (make-local-variable 'term-terminal-state)
1045 (make-local-variable 'term-kill-echo-list)
1046 (make-local-variable 'term-start-line-column)
1047 (make-local-variable 'term-current-column)
1048 (make-local-variable 'term-current-row)
1049 (make-local-variable 'term-log-buffer)
1050 (make-local-variable 'term-scroll-start)
1051 (make-local-variable 'term-scroll-end)
1052 (setq term-scroll-end term-height)
1053 (make-local-variable 'term-scroll-with-delete)
1054 (make-local-variable 'term-pager-count)
1055 (make-local-variable 'term-pager-old-local-map)
1056 (make-local-variable 'term-old-mode-map)
1057 (make-local-variable 'term-insert-mode)
1058 (make-local-variable 'term-dynamic-complete-functions)
1059 (make-local-variable 'term-completion-fignore)
1060 (make-local-variable 'term-get-old-input)
1061 (make-local-variable 'term-matching-input-from-input-string)
1062 (make-local-variable 'term-input-autoexpand)
1063 (make-local-variable 'term-input-ignoredups)
1064 (make-local-variable 'term-delimiter-argument-list)
1065 (make-local-variable 'term-input-filter-functions)
1066 (make-local-variable 'term-input-filter)
1067 (make-local-variable 'term-input-sender)
1068 (make-local-variable 'term-eol-on-send)
1069 (make-local-variable 'term-scroll-to-bottom-on-output)
1070 (make-local-variable 'term-scroll-show-maximum-output)
1071 (make-local-variable 'term-ptyp)
1072 (make-local-variable 'term-exec-hook)
1073 (make-local-variable 'term-vertical-motion)
1074 (make-local-variable 'term-pending-delete-marker)
1075 (setq term-pending-delete-marker (make-marker))
1076 (make-local-variable 'term-current-face)
1077 (make-local-variable 'term-pending-frame)
1078 (setq term-pending-frame nil)
1079 (run-hooks 'term-mode-hook)
1080 (term-if-xemacs
1081 (set-buffer-menubar
1082 (append current-menubar (list term-terminal-menu))))
1083 (or term-input-ring
1084 (setq term-input-ring (make-ring term-input-ring-size)))
1085 (term-update-mode-line))
1086 \f
1087 (defun term-reset-size (height width)
1088 (setq term-height height)
1089 (setq term-width width)
1090 (setq term-start-line-column nil)
1091 (setq term-current-row nil)
1092 (setq term-current-column nil)
1093 (term-scroll-region 0 height))
1094
1095 ;; Recursive routine used to check if any string in term-kill-echo-list
1096 ;; matches part of the buffer before point.
1097 ;; If so, delete that matched part of the buffer - this suppresses echo.
1098 ;; Also, remove that string from the term-kill-echo-list.
1099 ;; We *also* remove any older string on the list, as a sanity measure,
1100 ;; in case something gets out of sync. (Except for type-ahead, there
1101 ;; should only be one element in the list.)
1102
1103 (defun term-check-kill-echo-list ()
1104 (let ((cur term-kill-echo-list) (found nil) (save-point (point)))
1105 (unwind-protect
1106 (progn
1107 (end-of-line)
1108 (while cur
1109 (let* ((str (car cur)) (len (length str)) (start (- (point) len)))
1110 (if (and (>= start (point-min))
1111 (string= str (buffer-substring start (point))))
1112 (progn (delete-backward-char len)
1113 (setq term-kill-echo-list (cdr cur))
1114 (setq term-current-column nil)
1115 (setq term-current-row nil)
1116 (setq term-start-line-column nil)
1117 (setq cur nil found t))
1118 (setq cur (cdr cur))))))
1119 (if (not found)
1120 (goto-char save-point)))
1121 found))
1122
1123 (defun term-check-size (process)
1124 (if (or (/= term-height (1- (window-height)))
1125 (/= term-width (term-window-width)))
1126 (progn
1127 (term-reset-size (1- (window-height)) (term-window-width))
1128 (set-process-window-size process term-height term-width))))
1129
1130 (defun term-send-raw-string (chars)
1131 (let ((proc (get-buffer-process (current-buffer))))
1132 (if (not proc)
1133 (error "Current buffer has no process")
1134 ;; Note that (term-current-row) must be called *after*
1135 ;; (point) has been updated to (process-mark proc).
1136 (goto-char (process-mark proc))
1137 (if (term-pager-enabled)
1138 (setq term-pager-count (term-current-row)))
1139 (process-send-string proc chars))))
1140
1141 (defun term-send-raw ()
1142 "Send the last character typed through the terminal-emulator
1143 without any interpretation."
1144 (interactive)
1145 ;; Convert `return' to C-m, etc.
1146 (if (and (symbolp last-input-char)
1147 (get last-input-char 'ascii-character))
1148 (setq last-input-char (get last-input-char 'ascii-character)))
1149 (term-send-raw-string (make-string 1 last-input-char)))
1150
1151 (defun term-send-raw-meta ()
1152 (interactive)
1153 (let ((char last-input-char))
1154 (when (symbolp last-input-char)
1155 ;; Convert `return' to C-m, etc.
1156 (let ((tmp (get char 'event-symbol-elements)))
1157 (when tmp
1158 (setq char (car tmp)))
1159 (when (symbolp char)
1160 (setq tmp (get char 'ascii-character))
1161 (when tmp
1162 (setq char tmp)))))
1163 (setq char (event-basic-type char))
1164 (term-send-raw-string (if (and (numberp char)
1165 (> char 127)
1166 (< char 256))
1167 (make-string 1 char)
1168 (format "\e%c" char)))))
1169
1170 (defun term-mouse-paste (click arg)
1171 "Insert the last stretch of killed text at the position clicked on."
1172 (interactive "e\nP")
1173 (term-if-xemacs
1174 (term-send-raw-string (or (condition-case () (x-get-selection) (error ()))
1175 (x-get-cutbuffer)
1176 (error "No selection or cut buffer available"))))
1177 (term-ifnot-xemacs
1178 ;; Give temporary modes such as isearch a chance to turn off.
1179 (run-hooks 'mouse-leave-buffer-hook)
1180 (setq this-command 'yank)
1181 (mouse-set-point click)
1182 (term-send-raw-string (current-kill (cond
1183 ((listp arg) 0)
1184 ((eq arg '-) -1)
1185 (t (1- arg)))))))
1186
1187 ;; Which would be better: "\e[A" or "\eOA"? readline accepts either.
1188 ;; For my configuration it's definitely better \eOA but YMMV. -mm
1189 ;; For example: vi works with \eOA while elm wants \e[A ...
1190 (defun term-send-up () (interactive) (term-send-raw-string "\eOA"))
1191 (defun term-send-down () (interactive) (term-send-raw-string "\eOB"))
1192 (defun term-send-right () (interactive) (term-send-raw-string "\eOC"))
1193 (defun term-send-left () (interactive) (term-send-raw-string "\eOD"))
1194 (defun term-send-home () (interactive) (term-send-raw-string "\e[1~"))
1195 (defun term-send-end () (interactive) (term-send-raw-string "\e[4~"))
1196 (defun term-send-prior () (interactive) (term-send-raw-string "\e[5~"))
1197 (defun term-send-next () (interactive) (term-send-raw-string "\e[6~"))
1198 (defun term-send-del () (interactive) (term-send-raw-string "\C-?"))
1199 (defun term-send-backspace () (interactive) (term-send-raw-string "\C-H"))
1200 \f
1201 (defun term-char-mode ()
1202 "Switch to char (\"raw\") sub-mode of term mode.
1203 Each character you type is sent directly to the inferior without
1204 intervention from Emacs, except for the escape character (usually C-c)."
1205 (interactive)
1206 ;; FIXME: Emit message? Cfr ilisp-raw-message
1207 (if (term-in-line-mode)
1208 (progn
1209 (setq term-old-mode-map (current-local-map))
1210 (use-local-map term-raw-map)
1211
1212 ;; Send existing partial line to inferior (without newline).
1213 (let ((pmark (process-mark (get-buffer-process (current-buffer))))
1214 (save-input-sender term-input-sender))
1215 (if (> (point) pmark)
1216 (unwind-protect
1217 (progn
1218 (setq term-input-sender
1219 (symbol-function 'term-send-string))
1220 (end-of-line)
1221 (term-send-input))
1222 (setq term-input-sender save-input-sender))))
1223 (term-update-mode-line))))
1224
1225 (defun term-line-mode ()
1226 "Switch to line (\"cooked\") sub-mode of term mode.
1227 This means that Emacs editing commands work as normally, until
1228 you type \\[term-send-input] which sends the current line to the inferior."
1229 (interactive)
1230 (if (term-in-char-mode)
1231 (progn
1232 (use-local-map term-old-mode-map)
1233 (term-update-mode-line))))
1234
1235 (defun term-update-mode-line ()
1236 (setq mode-line-process
1237 (if (term-in-char-mode)
1238 (if (term-pager-enabled) '(": char page %s") '(": char %s"))
1239 (if (term-pager-enabled) '(": line page %s") '(": line %s"))))
1240 (force-mode-line-update))
1241
1242 (defun term-check-proc (buffer)
1243 "True if there is a process associated w/buffer BUFFER, and
1244 it is alive (status RUN or STOP). BUFFER can be either a buffer or the
1245 name of one"
1246 (let ((proc (get-buffer-process buffer)))
1247 (and proc (memq (process-status proc) '(run stop)))))
1248
1249 ;;;###autoload
1250 (defun make-term (name program &optional startfile &rest switches)
1251 "Make a term process NAME in a buffer, running PROGRAM.
1252 The name of the buffer is made by surrounding NAME with `*'s.
1253 If there is already a running process in that buffer, it is not restarted.
1254 Optional third arg STARTFILE is the name of a file to send the contents of to
1255 the process. Any more args are arguments to PROGRAM."
1256 (let ((buffer (get-buffer-create (concat "*" name "*"))))
1257 ;; If no process, or nuked process, crank up a new one and put buffer in
1258 ;; term mode. Otherwise, leave buffer and existing process alone.
1259 (cond ((not (term-check-proc buffer))
1260 (save-excursion
1261 (set-buffer buffer)
1262 (term-mode)) ; Install local vars, mode, keymap, ...
1263 (term-exec buffer name program startfile switches)))
1264 buffer))
1265
1266 ;;;###autoload
1267 (defun term (program)
1268 "Start a terminal-emulator in a new buffer.
1269 The buffer is in Term mode; see `term-mode' for the
1270 commands to use in that buffer.
1271
1272 \\<term-raw-map>Type \\[switch-to-buffer] to switch to another buffer."
1273 (interactive (list (read-from-minibuffer "Run program: "
1274 (or explicit-shell-file-name
1275 (getenv "ESHELL")
1276 (getenv "SHELL")
1277 "/bin/sh"))))
1278 (set-buffer (make-term "terminal" program))
1279 (term-mode)
1280 (term-char-mode)
1281 (switch-to-buffer "*terminal*"))
1282
1283 (defun term-exec (buffer name command startfile switches)
1284 "Start up a process in buffer for term modes.
1285 Blasts any old process running in the buffer. Doesn't set the buffer mode.
1286 You can use this to cheaply run a series of processes in the same term
1287 buffer. The hook term-exec-hook is run after each exec."
1288 (save-excursion
1289 (set-buffer buffer)
1290 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
1291 (if proc (delete-process proc)))
1292 ;; Crank up a new process
1293 (let ((proc (term-exec-1 name buffer command switches)))
1294 (make-local-variable 'term-ptyp)
1295 (setq term-ptyp process-connection-type) ; t if pty, nil if pipe.
1296 ;; Jump to the end, and set the process mark.
1297 (goto-char (point-max))
1298 (set-marker (process-mark proc) (point))
1299 (set-process-filter proc 'term-emulate-terminal)
1300 (set-process-sentinel proc 'term-sentinel)
1301 ;; Feed it the startfile.
1302 (cond (startfile
1303 ;;This is guaranteed to wait long enough
1304 ;;but has bad results if the term does not prompt at all
1305 ;; (while (= size (buffer-size))
1306 ;; (sleep-for 1))
1307 ;;I hope 1 second is enough!
1308 (sleep-for 1)
1309 (goto-char (point-max))
1310 (insert-file-contents startfile)
1311 (setq startfile (buffer-substring (point) (point-max)))
1312 (delete-region (point) (point-max))
1313 (term-send-string proc startfile)))
1314 (run-hooks 'term-exec-hook)
1315 buffer)))
1316
1317 (defun term-sentinel (proc msg)
1318 "Sentinel for term buffers.
1319 The main purpose is to get rid of the local keymap."
1320 (let ((buffer (process-buffer proc)))
1321 (if (memq (process-status proc) '(signal exit))
1322 (progn
1323 (if (null (buffer-name buffer))
1324 ;; buffer killed
1325 (set-process-buffer proc nil)
1326 (let ((obuf (current-buffer)))
1327 ;; save-excursion isn't the right thing if
1328 ;; process-buffer is current-buffer
1329 (unwind-protect
1330 (progn
1331 ;; Write something in the compilation buffer
1332 ;; and hack its mode line.
1333 (set-buffer buffer)
1334 ;; Get rid of local keymap.
1335 (use-local-map nil)
1336 (term-handle-exit (process-name proc)
1337 msg)
1338 ;; Since the buffer and mode line will show that the
1339 ;; process is dead, we can delete it now. Otherwise it
1340 ;; will stay around until M-x list-processes.
1341 (delete-process proc))
1342 (set-buffer obuf))))
1343 ))))
1344
1345 (defun term-handle-exit (process-name msg)
1346 "Write process exit (or other change) message MSG in the current buffer."
1347 (let ((buffer-read-only nil)
1348 (omax (point-max))
1349 (opoint (point)))
1350 ;; Record where we put the message, so we can ignore it
1351 ;; later on.
1352 (goto-char omax)
1353 (insert ?\n "Process " process-name " " msg)
1354 ;; Force mode line redisplay soon.
1355 (force-mode-line-update)
1356 (if (and opoint (< opoint omax))
1357 (goto-char opoint))))
1358
1359
1360 ;;; Name to use for TERM.
1361 ;;; Using "emacs" loses, because bash disables editing if TERM == emacs.
1362 (defvar term-term-name "eterm")
1363 ; Format string, usage:
1364 ; (format term-termcap-string emacs-term-name "TERMCAP=" 24 80)
1365 (defvar term-termcap-format
1366 "%s%s:li#%d:co#%d:cl=\\E[H\\E[J:cd=\\E[J:bs:am:xn:cm=\\E[%%i%%d;%%dH\
1367 :nd=\\E[C:up=\\E[A:ce=\\E[K:ho=\\E[H:pt\
1368 :al=\\E[L:dl=\\E[M:DL=\\E[%%dM:AL=\\E[%%dL:cs=\\E[%%i%%d;%%dr:sf=\\n\
1369 :te=\\E[2J\\E[?47l\\E8:ti=\\E7\\E[?47h\
1370 :dc=\\E[P:DC=\\E[%%dP:IC=\\E[%%d@:im=\\E[4h:ei=\\E[4l:mi:\
1371 :so=\\E[7m:se=\\E[m:us=\\E[4m:ue=\\E[m:md=\\E[1m:mr=\\E[7m:me=\\E[m\
1372 :UP=\\E[%%dA:DO=\\E[%%dB:LE=\\E[%%dD:RI=\\E[%%dC"
1373 ;;; : -undefine ic
1374 "termcap capabilities supported")
1375
1376 ;;; This auxiliary function cranks up the process for term-exec in
1377 ;;; the appropriate environment.
1378
1379 (defun term-exec-1 (name buffer command switches)
1380 ;; We need to do an extra (fork-less) exec to run stty.
1381 ;; (This would not be needed if we had suitable Emacs primitives.)
1382 ;; The 'if ...; then shift; fi' hack is because Bourne shell
1383 ;; loses one arg when called with -c, and newer shells (bash, ksh) don't.
1384 ;; Thus we add an extra dummy argument "..", and then remove it.
1385 (let ((process-environment
1386 (nconc
1387 (list
1388 (format "TERM=%s" term-term-name)
1389 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
1390 (format "TERMINFO=%s" data-directory)
1391 (format term-termcap-format "TERMCAP="
1392 term-term-name term-height term-width))
1393 ;; Breaks `./configure' of w3 and url which try to run $EMACS.
1394 (format "EMACS=%s (term:%s)" emacs-version term-protocol-version)
1395 (format "LINES=%d" term-height)
1396 (format "COLUMNS=%d" term-width))
1397 process-environment))
1398 (process-connection-type t)
1399 ;; We should suppress conversion of end-of-line format.
1400 (inhibit-eol-conversion t)
1401 ;; inhibit-eol-conversion doesn't seem to do the job, but this does.
1402 (coding-system-for-read 'unknown-unix)
1403 )
1404 (apply 'start-process name buffer
1405 "/bin/sh" "-c"
1406 (format "stty -nl echo rows %d columns %d sane 2>/dev/null;\
1407 if [ $1 = .. ]; then shift; fi; exec \"$@\""
1408 term-height term-width)
1409 ".."
1410 command switches)))
1411
1412 ;;; This should be in Emacs, but it isn't.
1413 (defun term-mem (item list &optional elt=)
1414 "Test to see if ITEM is equal to an item in LIST.
1415 Option comparison function ELT= defaults to equal."
1416 (let ((elt= (or elt= (function equal)))
1417 (done nil))
1418 (while (and list (not done))
1419 (if (funcall elt= item (car list))
1420 (setq done list)
1421 (setq list (cdr list))))
1422 done))
1423
1424 \f
1425 ;;; Input history processing in a buffer
1426 ;;; ===========================================================================
1427 ;;; Useful input history functions, courtesy of the Ergo group.
1428
1429 ;;; Eleven commands:
1430 ;;; term-dynamic-list-input-ring List history in help buffer.
1431 ;;; term-previous-input Previous input...
1432 ;;; term-previous-matching-input ...matching a string.
1433 ;;; term-previous-matching-input-from-input ... matching the current input.
1434 ;;; term-next-input Next input...
1435 ;;; term-next-matching-input ...matching a string.
1436 ;;; term-next-matching-input-from-input ... matching the current input.
1437 ;;; term-backward-matching-input Backwards input...
1438 ;;; term-forward-matching-input ...matching a string.
1439 ;;; term-replace-by-expanded-history Expand history at point;
1440 ;;; replace with expanded history.
1441 ;;; term-magic-space Expand history and insert space.
1442 ;;;
1443 ;;; Three functions:
1444 ;;; term-read-input-ring Read into term-input-ring...
1445 ;;; term-write-input-ring Write to term-input-ring-file-name.
1446 ;;; term-replace-by-expanded-history-before-point Workhorse function.
1447
1448 (defun term-read-input-ring (&optional silent)
1449 "Sets the buffer's `term-input-ring' from a history file.
1450 The name of the file is given by the variable `term-input-ring-file-name'.
1451 The history ring is of size `term-input-ring-size', regardless of file size.
1452 If `term-input-ring-file-name' is nil this function does nothing.
1453
1454 If the optional argument SILENT is non-nil, we say nothing about a
1455 failure to read the history file.
1456
1457 This function is useful for major mode commands and mode hooks.
1458
1459 The structure of the history file should be one input command per line,
1460 with the most recent command last.
1461 See also `term-input-ignoredups' and `term-write-input-ring'."
1462 (cond ((or (null term-input-ring-file-name)
1463 (equal term-input-ring-file-name ""))
1464 nil)
1465 ((not (file-readable-p term-input-ring-file-name))
1466 (or silent
1467 (message "Cannot read history file %s"
1468 term-input-ring-file-name)))
1469 (t
1470 (let ((history-buf (get-buffer-create " *temp*"))
1471 (file term-input-ring-file-name)
1472 (count 0)
1473 (ring (make-ring term-input-ring-size)))
1474 (unwind-protect
1475 (save-excursion
1476 (set-buffer history-buf)
1477 (widen)
1478 (erase-buffer)
1479 (insert-file-contents file)
1480 ;; Save restriction in case file is already visited...
1481 ;; Watch for those date stamps in history files!
1482 (goto-char (point-max))
1483 (while (and (< count term-input-ring-size)
1484 (re-search-backward "^[ \t]*\\([^#\n].*\\)[ \t]*$"
1485 nil t))
1486 (let ((history (buffer-substring (match-beginning 1)
1487 (match-end 1))))
1488 (if (or (null term-input-ignoredups)
1489 (ring-empty-p ring)
1490 (not (string-equal (ring-ref ring 0) history)))
1491 (ring-insert-at-beginning ring history)))
1492 (setq count (1+ count))))
1493 (kill-buffer history-buf))
1494 (setq term-input-ring ring
1495 term-input-ring-index nil)))))
1496
1497 (defun term-write-input-ring ()
1498 "Writes the buffer's `term-input-ring' to a history file.
1499 The name of the file is given by the variable `term-input-ring-file-name'.
1500 The original contents of the file are lost if `term-input-ring' is not empty.
1501 If `term-input-ring-file-name' is nil this function does nothing.
1502
1503 Useful within process sentinels.
1504
1505 See also `term-read-input-ring'."
1506 (cond ((or (null term-input-ring-file-name)
1507 (equal term-input-ring-file-name "")
1508 (null term-input-ring) (ring-empty-p term-input-ring))
1509 nil)
1510 ((not (file-writable-p term-input-ring-file-name))
1511 (message "Cannot write history file %s" term-input-ring-file-name))
1512 (t
1513 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1514 (ring term-input-ring)
1515 (file term-input-ring-file-name)
1516 (index (ring-length ring)))
1517 ;; Write it all out into a buffer first. Much faster, but messier,
1518 ;; than writing it one line at a time.
1519 (save-excursion
1520 (set-buffer history-buf)
1521 (erase-buffer)
1522 (while (> index 0)
1523 (setq index (1- index))
1524 (insert (ring-ref ring index) ?\n))
1525 (write-region (buffer-string) nil file nil 'no-message)
1526 (kill-buffer nil))))))
1527
1528
1529 (defun term-dynamic-list-input-ring ()
1530 "List in help buffer the buffer's input history."
1531 (interactive)
1532 (if (or (not (ring-p term-input-ring))
1533 (ring-empty-p term-input-ring))
1534 (message "No history")
1535 (let ((history nil)
1536 (history-buffer " *Input History*")
1537 (index (1- (ring-length term-input-ring)))
1538 (conf (current-window-configuration)))
1539 ;; We have to build up a list ourselves from the ring vector.
1540 (while (>= index 0)
1541 (setq history (cons (ring-ref term-input-ring index) history)
1542 index (1- index)))
1543 ;; Change "completion" to "history reference"
1544 ;; to make the display accurate.
1545 (with-output-to-temp-buffer history-buffer
1546 (display-completion-list history)
1547 (set-buffer history-buffer)
1548 (forward-line 3)
1549 (while (search-backward "completion" nil 'move)
1550 (replace-match "history reference")))
1551 (sit-for 0)
1552 (message "Hit space to flush")
1553 (let ((ch (read-event)))
1554 (if (eq ch ?\ )
1555 (set-window-configuration conf)
1556 (setq unread-command-events (list ch)))))))
1557
1558
1559 (defun term-regexp-arg (prompt)
1560 ;; Return list of regexp and prefix arg using PROMPT.
1561 (let* (;; Don't clobber this.
1562 (last-command last-command)
1563 (regexp (read-from-minibuffer prompt nil nil nil
1564 'minibuffer-history-search-history)))
1565 (list (if (string-equal regexp "")
1566 (setcar minibuffer-history-search-history
1567 (nth 1 minibuffer-history-search-history))
1568 regexp)
1569 (prefix-numeric-value current-prefix-arg))))
1570
1571 (defun term-search-arg (arg)
1572 ;; First make sure there is a ring and that we are after the process mark
1573 (cond ((not (term-after-pmark-p))
1574 (error "Not at command line"))
1575 ((or (null term-input-ring)
1576 (ring-empty-p term-input-ring))
1577 (error "Empty input ring"))
1578 ((zerop arg)
1579 ;; arg of zero resets search from beginning, and uses arg of 1
1580 (setq term-input-ring-index nil)
1581 1)
1582 (t
1583 arg)))
1584
1585 (defun term-search-start (arg)
1586 ;; Index to start a directional search, starting at term-input-ring-index
1587 (if term-input-ring-index
1588 ;; If a search is running, offset by 1 in direction of arg
1589 (mod (+ term-input-ring-index (if (> arg 0) 1 -1))
1590 (ring-length term-input-ring))
1591 ;; For a new search, start from beginning or end, as appropriate
1592 (if (>= arg 0)
1593 0 ; First elt for forward search
1594 (1- (ring-length term-input-ring))))) ; Last elt for backward search
1595
1596 (defun term-previous-input-string (arg)
1597 "Return the string ARG places along the input ring.
1598 Moves relative to `term-input-ring-index'."
1599 (ring-ref term-input-ring (if term-input-ring-index
1600 (mod (+ arg term-input-ring-index)
1601 (ring-length term-input-ring))
1602 arg)))
1603
1604 (defun term-previous-input (arg)
1605 "Cycle backwards through input history."
1606 (interactive "*p")
1607 (term-previous-matching-input "." arg))
1608
1609 (defun term-next-input (arg)
1610 "Cycle forwards through input history."
1611 (interactive "*p")
1612 (term-previous-input (- arg)))
1613
1614 (defun term-previous-matching-input-string (regexp arg)
1615 "Return the string matching REGEXP ARG places along the input ring.
1616 Moves relative to `term-input-ring-index'."
1617 (let* ((pos (term-previous-matching-input-string-position regexp arg)))
1618 (if pos (ring-ref term-input-ring pos))))
1619
1620 (defun term-previous-matching-input-string-position
1621 (regexp arg &optional start)
1622 "Return the index matching REGEXP ARG places along the input ring.
1623 Moves relative to START, or `term-input-ring-index'."
1624 (if (or (not (ring-p term-input-ring))
1625 (ring-empty-p term-input-ring))
1626 (error "No history"))
1627 (let* ((len (ring-length term-input-ring))
1628 (motion (if (> arg 0) 1 -1))
1629 (n (mod (- (or start (term-search-start arg)) motion) len))
1630 (tried-each-ring-item nil)
1631 (prev nil))
1632 ;; Do the whole search as many times as the argument says.
1633 (while (and (/= arg 0) (not tried-each-ring-item))
1634 ;; Step once.
1635 (setq prev n
1636 n (mod (+ n motion) len))
1637 ;; If we haven't reached a match, step some more.
1638 (while (and (< n len) (not tried-each-ring-item)
1639 (not (string-match regexp (ring-ref term-input-ring n))))
1640 (setq n (mod (+ n motion) len)
1641 ;; If we have gone all the way around in this search.
1642 tried-each-ring-item (= n prev)))
1643 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1644 ;; Now that we know which ring element to use, if we found it, return that.
1645 (if (string-match regexp (ring-ref term-input-ring n))
1646 n)))
1647
1648 (defun term-previous-matching-input (regexp arg)
1649 "Search backwards through input history for match for REGEXP.
1650 \(Previous history elements are earlier commands.)
1651 With prefix argument N, search for Nth previous match.
1652 If N is negative, find the next or Nth next match."
1653 (interactive (term-regexp-arg "Previous input matching (regexp): "))
1654 (setq arg (term-search-arg arg))
1655 (let ((pos (term-previous-matching-input-string-position regexp arg)))
1656 ;; Has a match been found?
1657 (if (null pos)
1658 (error "Not found")
1659 (setq term-input-ring-index pos)
1660 (message "History item: %d" (1+ pos))
1661 (delete-region
1662 ;; Can't use kill-region as it sets this-command
1663 (process-mark (get-buffer-process (current-buffer))) (point))
1664 (insert (ring-ref term-input-ring pos)))))
1665
1666 (defun term-next-matching-input (regexp arg)
1667 "Search forwards through input history for match for REGEXP.
1668 \(Later history elements are more recent commands.)
1669 With prefix argument N, search for Nth following match.
1670 If N is negative, find the previous or Nth previous match."
1671 (interactive (term-regexp-arg "Next input matching (regexp): "))
1672 (term-previous-matching-input regexp (- arg)))
1673
1674 (defun term-previous-matching-input-from-input (arg)
1675 "Search backwards through input history for match for current input.
1676 \(Previous history elements are earlier commands.)
1677 With prefix argument N, search for Nth previous match.
1678 If N is negative, search forwards for the -Nth following match."
1679 (interactive "p")
1680 (if (not (memq last-command '(term-previous-matching-input-from-input
1681 term-next-matching-input-from-input)))
1682 ;; Starting a new search
1683 (setq term-matching-input-from-input-string
1684 (buffer-substring
1685 (process-mark (get-buffer-process (current-buffer)))
1686 (point))
1687 term-input-ring-index nil))
1688 (term-previous-matching-input
1689 (concat "^" (regexp-quote term-matching-input-from-input-string))
1690 arg))
1691
1692 (defun term-next-matching-input-from-input (arg)
1693 "Search forwards through input history for match for current input.
1694 \(Following history elements are more recent commands.)
1695 With prefix argument N, search for Nth following match.
1696 If N is negative, search backwards for the -Nth previous match."
1697 (interactive "p")
1698 (term-previous-matching-input-from-input (- arg)))
1699
1700
1701 (defun term-replace-by-expanded-history (&optional silent)
1702 "Expand input command history references before point.
1703 Expansion is dependent on the value of `term-input-autoexpand'.
1704
1705 This function depends on the buffer's idea of the input history, which may not
1706 match the command interpreter's idea, assuming it has one.
1707
1708 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1709 cannot know the interpreter's idea of input line numbers, assuming it has one,
1710 it cannot expand absolute input line number references.
1711
1712 If the optional argument SILENT is non-nil, never complain
1713 even if history reference seems erroneous.
1714
1715 See `term-magic-space' and `term-replace-by-expanded-history-before-point'.
1716
1717 Returns t if successful."
1718 (interactive)
1719 (if (and term-input-autoexpand
1720 (string-match "[!^]" (funcall term-get-old-input))
1721 (save-excursion (beginning-of-line)
1722 (looking-at term-prompt-regexp)))
1723 ;; Looks like there might be history references in the command.
1724 (let ((previous-modified-tick (buffer-modified-tick)))
1725 (message "Expanding history references...")
1726 (term-replace-by-expanded-history-before-point silent)
1727 (/= previous-modified-tick (buffer-modified-tick)))))
1728
1729
1730 (defun term-replace-by-expanded-history-before-point (silent)
1731 "Expand directory stack reference before point.
1732 See `term-replace-by-expanded-history'. Returns t if successful."
1733 (save-excursion
1734 (let ((toend (- (save-excursion (end-of-line nil) (point)) (point)))
1735 (start (progn (term-bol nil) (point))))
1736 (while (progn
1737 (skip-chars-forward "^!^"
1738 (save-excursion
1739 (end-of-line nil) (- (point) toend)))
1740 (< (point)
1741 (save-excursion
1742 (end-of-line nil) (- (point) toend))))
1743 ;; This seems a bit complex. We look for references such as !!, !-num,
1744 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1745 ;; If that wasn't enough, the plings can be suffixed with argument
1746 ;; range specifiers.
1747 ;; Argument ranges are complex too, so we hive off the input line,
1748 ;; referenced with plings, with the range string to `term-args'.
1749 (setq term-input-ring-index nil)
1750 (cond ((or (= (preceding-char) ?\\)
1751 (term-within-quotes start (point)))
1752 ;; The history is quoted, or we're in quotes.
1753 (goto-char (1+ (point))))
1754 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1755 ;; We cannot know the interpreter's idea of input line numbers.
1756 (goto-char (match-end 0))
1757 (message "Absolute reference cannot be expanded"))
1758 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1759 ;; Just a number of args from `number' lines backward.
1760 (let ((number (1- (string-to-number
1761 (buffer-substring (match-beginning 1)
1762 (match-end 1))))))
1763 (if (<= number (ring-length term-input-ring))
1764 (progn
1765 (replace-match
1766 (term-args (term-previous-input-string number)
1767 (match-beginning 2) (match-end 2))
1768 t t)
1769 (setq term-input-ring-index number)
1770 (message "History item: %d" (1+ number)))
1771 (goto-char (match-end 0))
1772 (message "Relative reference exceeds input history size"))))
1773 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1774 ;; Just a number of args from the previous input line.
1775 (replace-match
1776 (term-args (term-previous-input-string 0)
1777 (match-beginning 1) (match-end 1))
1778 t t)
1779 (message "History item: previous"))
1780 ((looking-at
1781 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1782 ;; Most recent input starting with or containing (possibly
1783 ;; protected) string, maybe just a number of args. Phew.
1784 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1785 (mb2 (match-beginning 2)) (me2 (match-end 2))
1786 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1787 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1788 (pos (save-match-data
1789 (term-previous-matching-input-string-position
1790 (concat pref (regexp-quote exp)) 1))))
1791 (if (null pos)
1792 (progn
1793 (goto-char (match-end 0))
1794 (or silent
1795 (progn (message "Not found")
1796 (ding))))
1797 (setq term-input-ring-index pos)
1798 (replace-match
1799 (term-args (ring-ref term-input-ring pos)
1800 (match-beginning 4) (match-end 4))
1801 t t)
1802 (message "History item: %d" (1+ pos)))))
1803 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1804 ;; Quick substitution on the previous input line.
1805 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1806 (new (buffer-substring (match-beginning 2) (match-end 2)))
1807 (pos nil))
1808 (replace-match (term-previous-input-string 0) t t)
1809 (setq pos (point))
1810 (goto-char (match-beginning 0))
1811 (if (not (search-forward old pos t))
1812 (or silent
1813 (error "Not found"))
1814 (replace-match new t t)
1815 (message "History item: substituted"))))
1816 (t
1817 (goto-char (match-end 0))))))))
1818
1819
1820 (defun term-magic-space (arg)
1821 "Expand input history references before point and insert ARG spaces.
1822 A useful command to bind to SPC. See `term-replace-by-expanded-history'."
1823 (interactive "p")
1824 (term-replace-by-expanded-history)
1825 (self-insert-command arg))
1826 \f
1827 (defun term-within-quotes (beg end)
1828 "Return t if the number of quotes between BEG and END is odd.
1829 Quotes are single and double."
1830 (let ((countsq (term-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1831 (countdq (term-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1832 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1833
1834 (defun term-how-many-region (regexp beg end)
1835 "Return number of matches for REGEXP from BEG to END."
1836 (let ((count 0))
1837 (save-excursion
1838 (save-match-data
1839 (goto-char beg)
1840 (while (re-search-forward regexp end t)
1841 (setq count (1+ count)))))
1842 count))
1843
1844 (defun term-args (string begin end)
1845 ;; From STRING, return the args depending on the range specified in the text
1846 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1847 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1848 (save-match-data
1849 (if (null begin)
1850 (term-arguments string 0 nil)
1851 (let* ((range (buffer-substring
1852 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1853 (nth (cond ((string-match "^[*^]" range) 1)
1854 ((string-match "^-" range) 0)
1855 ((string-equal range "$") nil)
1856 (t (string-to-number range))))
1857 (mth (cond ((string-match "[-*$]$" range) nil)
1858 ((string-match "-" range)
1859 (string-to-number (substring range (match-end 0))))
1860 (t nth))))
1861 (term-arguments string nth mth)))))
1862
1863 ;; Return a list of arguments from ARG. Break it up at the
1864 ;; delimiters in term-delimiter-argument-list. Returned list is backwards.
1865 (defun term-delim-arg (arg)
1866 (if (null term-delimiter-argument-list)
1867 (list arg)
1868 (let ((args nil)
1869 (pos 0)
1870 (len (length arg)))
1871 (while (< pos len)
1872 (let ((char (aref arg pos))
1873 (start pos))
1874 (if (memq char term-delimiter-argument-list)
1875 (while (and (< pos len) (eq (aref arg pos) char))
1876 (setq pos (1+ pos)))
1877 (while (and (< pos len)
1878 (not (memq (aref arg pos)
1879 term-delimiter-argument-list)))
1880 (setq pos (1+ pos))))
1881 (setq args (cons (substring arg start pos) args))))
1882 args)))
1883
1884 (defun term-arguments (string nth mth)
1885 "Return from STRING the NTH to MTH arguments.
1886 NTH and/or MTH can be nil, which means the last argument.
1887 Returned arguments are separated by single spaces.
1888 We assume whitespace separates arguments, except within quotes.
1889 Also, a run of one or more of a single character
1890 in `term-delimiter-argument-list' is a separate argument.
1891 Argument 0 is the command name."
1892 (let ((argpart "[^ \n\t\"'`]+\\|\\(\"[^\"]*\"\\|'[^']*'\\|`[^`]*`\\)")
1893 (args ()) (pos 0)
1894 (count 0)
1895 beg str quotes)
1896 ;; Build a list of all the args until we have as many as we want.
1897 (while (and (or (null mth) (<= count mth))
1898 (string-match argpart string pos))
1899 (if (and beg (= pos (match-beginning 0)))
1900 ;; It's contiguous, part of the same arg.
1901 (setq pos (match-end 0)
1902 quotes (or quotes (match-beginning 1)))
1903 ;; It's a new separate arg.
1904 (if beg
1905 ;; Put the previous arg, if there was one, onto ARGS.
1906 (setq str (substring string beg pos)
1907 args (if quotes (cons str args)
1908 (nconc (term-delim-arg str) args))
1909 count (1+ count)))
1910 (setq quotes (match-beginning 1))
1911 (setq beg (match-beginning 0))
1912 (setq pos (match-end 0))))
1913 (if beg
1914 (setq str (substring string beg pos)
1915 args (if quotes (cons str args)
1916 (nconc (term-delim-arg str) args))
1917 count (1+ count)))
1918 (let ((n (or nth (1- count)))
1919 (m (if mth (1- (- count mth)) 0)))
1920 (mapconcat
1921 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1922 \f
1923 ;;;
1924 ;;; Input processing stuff [line mode]
1925 ;;;
1926
1927 (defun term-send-input ()
1928 "Send input to process.
1929 After the process output mark, sends all text from the process mark to
1930 point as input to the process. Before the process output mark, calls value
1931 of variable term-get-old-input to retrieve old input, copies it to the
1932 process mark, and sends it. A terminal newline is also inserted into the
1933 buffer and sent to the process. The list of function names contained in the
1934 value of `term-input-filter-functions' is called on the input before sending
1935 it. The input is entered into the input history ring, if the value of variable
1936 term-input-filter returns non-nil when called on the input.
1937
1938 Any history reference may be expanded depending on the value of the variable
1939 `term-input-autoexpand'. The list of function names contained in the value
1940 of `term-input-filter-functions' is called on the input before sending it.
1941 The input is entered into the input history ring, if the value of variable
1942 `term-input-filter' returns non-nil when called on the input.
1943
1944 If variable `term-eol-on-send' is non-nil, then point is moved to the
1945 end of line before sending the input.
1946
1947 The values of `term-get-old-input', `term-input-filter-functions', and
1948 `term-input-filter' are chosen according to the command interpreter running
1949 in the buffer. E.g.,
1950
1951 If the interpreter is the csh,
1952 term-get-old-input is the default: take the current line, discard any
1953 initial string matching regexp term-prompt-regexp.
1954 term-input-filter-functions monitors input for \"cd\", \"pushd\", and
1955 \"popd\" commands. When it sees one, it cd's the buffer.
1956 term-input-filter is the default: returns t if the input isn't all white
1957 space.
1958
1959 If the term is Lucid Common Lisp,
1960 term-get-old-input snarfs the sexp ending at point.
1961 term-input-filter-functions does nothing.
1962 term-input-filter returns nil if the input matches input-filter-regexp,
1963 which matches (1) all whitespace (2) :a, :c, etc.
1964
1965 Similarly for Soar, Scheme, etc."
1966 (interactive)
1967 ;; Note that the input string does not include its terminal newline.
1968 (let ((proc (get-buffer-process (current-buffer))))
1969 (if (not proc) (error "Current buffer has no process")
1970 (let* ((pmark (process-mark proc))
1971 (pmark-val (marker-position pmark))
1972 (input-is-new (>= (point) pmark-val))
1973 (intxt (if input-is-new
1974 (progn (if term-eol-on-send (end-of-line))
1975 (buffer-substring pmark (point)))
1976 (funcall term-get-old-input)))
1977 (input (if (not (eq term-input-autoexpand 'input))
1978 ;; Just whatever's already there
1979 intxt
1980 ;; Expand and leave it visible in buffer
1981 (term-replace-by-expanded-history t)
1982 (buffer-substring pmark (point))))
1983 (history (if (not (eq term-input-autoexpand 'history))
1984 input
1985 ;; This is messy 'cos ultimately the original
1986 ;; functions used do insertion, rather than return
1987 ;; strings. We have to expand, then insert back.
1988 (term-replace-by-expanded-history t)
1989 (let ((copy (buffer-substring pmark (point))))
1990 (delete-region pmark (point))
1991 (insert input)
1992 copy))))
1993 (if (term-pager-enabled)
1994 (save-excursion
1995 (goto-char (process-mark proc))
1996 (setq term-pager-count (term-current-row))))
1997 (if (and (funcall term-input-filter history)
1998 (or (null term-input-ignoredups)
1999 (not (ring-p term-input-ring))
2000 (ring-empty-p term-input-ring)
2001 (not (string-equal (ring-ref term-input-ring 0)
2002 history))))
2003 (ring-insert term-input-ring history))
2004 (let ((functions term-input-filter-functions))
2005 (while functions
2006 (funcall (car functions) (concat input "\n"))
2007 (setq functions (cdr functions))))
2008 (setq term-input-ring-index nil)
2009
2010 ;; Update the markers before we send the input
2011 ;; in case we get output amidst sending the input.
2012 (set-marker term-last-input-start pmark)
2013 (set-marker term-last-input-end (point))
2014 (if input-is-new
2015 (progn
2016 ;; Set up to delete, because inferior should echo.
2017 (if (marker-buffer term-pending-delete-marker)
2018 (delete-region term-pending-delete-marker pmark))
2019 (set-marker term-pending-delete-marker pmark-val)
2020 (set-marker (process-mark proc) (point))))
2021 (goto-char pmark)
2022 (funcall term-input-sender proc input)))))
2023
2024 (defun term-get-old-input-default ()
2025 "Default for term-get-old-input.
2026 Take the current line, and discard any initial text matching
2027 term-prompt-regexp."
2028 (save-excursion
2029 (beginning-of-line)
2030 (term-skip-prompt)
2031 (let ((beg (point)))
2032 (end-of-line)
2033 (buffer-substring beg (point)))))
2034
2035 (defun term-copy-old-input ()
2036 "Insert after prompt old input at point as new input to be edited.
2037 Calls `term-get-old-input' to get old input."
2038 (interactive)
2039 (let ((input (funcall term-get-old-input))
2040 (process (get-buffer-process (current-buffer))))
2041 (if (not process)
2042 (error "Current buffer has no process")
2043 (goto-char (process-mark process))
2044 (insert input))))
2045
2046 (defun term-skip-prompt ()
2047 "Skip past the text matching regexp term-prompt-regexp.
2048 If this takes us past the end of the current line, don't skip at all."
2049 (let ((eol (save-excursion (end-of-line) (point))))
2050 (if (and (looking-at term-prompt-regexp)
2051 (<= (match-end 0) eol))
2052 (goto-char (match-end 0)))))
2053
2054
2055 (defun term-after-pmark-p ()
2056 "Is point after the process output marker?"
2057 ;; Since output could come into the buffer after we looked at the point
2058 ;; but before we looked at the process marker's value, we explicitly
2059 ;; serialise. This is just because I don't know whether or not Emacs
2060 ;; services input during execution of lisp commands.
2061 (let ((proc-pos (marker-position
2062 (process-mark (get-buffer-process (current-buffer))))))
2063 (<= proc-pos (point))))
2064
2065 (defun term-simple-send (proc string)
2066 "Default function for sending to PROC input STRING.
2067 This just sends STRING plus a newline. To override this,
2068 set the hook TERM-INPUT-SENDER."
2069 (term-send-string proc string)
2070 (term-send-string proc "\n"))
2071
2072 (defun term-bol (arg)
2073 "Goes to the beginning of line, then skips past the prompt, if any.
2074 If a prefix argument is given (\\[universal-argument]), then no prompt skip
2075 -- go straight to column 0.
2076
2077 The prompt skip is done by skipping text matching the regular expression
2078 term-prompt-regexp, a buffer local variable."
2079 (interactive "P")
2080 (beginning-of-line)
2081 (if (null arg) (term-skip-prompt)))
2082
2083 ;;; These two functions are for entering text you don't want echoed or
2084 ;;; saved -- typically passwords to ftp, telnet, or somesuch.
2085 ;;; Just enter m-x term-send-invisible and type in your line.
2086
2087 (defun term-read-noecho (prompt &optional stars)
2088 "Read a single line of text from user without echoing, and return it.
2089 Prompt with argument PROMPT, a string. Optional argument STARS causes
2090 input to be echoed with '*' characters on the prompt line. Input ends with
2091 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
2092 `inhibit-quit' is set because e.g. this function was called from a process
2093 filter and C-g is pressed, this function returns nil rather than a string).
2094
2095 Note that the keystrokes comprising the text can still be recovered
2096 \(temporarily) with \\[view-lossage]. This may be a security bug for some
2097 applications."
2098 (let ((ans "")
2099 (c 0)
2100 (echo-keystrokes 0)
2101 (cursor-in-echo-area t)
2102 (done nil))
2103 (while (not done)
2104 (if stars
2105 (message "%s%s" prompt (make-string (length ans) ?*))
2106 (message "%s" prompt))
2107 (setq c (read-char))
2108 (cond ((= c ?\C-g)
2109 ;; This function may get called from a process filter, where
2110 ;; inhibit-quit is set. In later versions of Emacs read-char
2111 ;; may clear quit-flag itself and return C-g. That would make
2112 ;; it impossible to quit this loop in a simple way, so
2113 ;; re-enable it here (for backward-compatibility the check for
2114 ;; quit-flag below would still be necessary, so this seems
2115 ;; like the simplest way to do things).
2116 (setq quit-flag t
2117 done t))
2118 ((or (= c ?\r) (= c ?\n) (= c ?\e))
2119 (setq done t))
2120 ((= c ?\C-u)
2121 (setq ans ""))
2122 ((and (/= c ?\b) (/= c ?\177))
2123 (setq ans (concat ans (char-to-string c))))
2124 ((> (length ans) 0)
2125 (setq ans (substring ans 0 -1)))))
2126 (if quit-flag
2127 ;; Emulate a true quit, except that we have to return a value.
2128 (prog1
2129 (setq quit-flag nil)
2130 (message "Quit")
2131 (beep t))
2132 (message "")
2133 ans)))
2134
2135 (defun term-send-invisible (str &optional proc)
2136 "Read a string without echoing.
2137 Then send it to the process running in the current buffer. A new-line
2138 is additionally sent. String is not saved on term input history list.
2139 Security bug: your string can still be temporarily recovered with
2140 \\[view-lossage]."
2141 (interactive "P") ; Defeat snooping via C-x esc
2142 (if (not (stringp str))
2143 (setq str (term-read-noecho "Non-echoed text: " t)))
2144 (if (not proc)
2145 (setq proc (get-buffer-process (current-buffer))))
2146 (if (not proc) (error "Current buffer has no process")
2147 (setq term-kill-echo-list (nconc term-kill-echo-list
2148 (cons str nil)))
2149 (term-send-string proc str)
2150 (term-send-string proc "\n")))
2151
2152 \f
2153 ;;; Low-level process communication
2154
2155 (defvar term-input-chunk-size 512
2156 "*Long inputs send to term processes are broken up into chunks of this size.
2157 If your process is choking on big inputs, try lowering the value.")
2158
2159 (defun term-send-string (proc str)
2160 "Send PROCESS the contents of STRING as input.
2161 This is equivalent to process-send-string, except that long input strings
2162 are broken up into chunks of size term-input-chunk-size. Processes
2163 are given a chance to output between chunks. This can help prevent processes
2164 from hanging when you send them long inputs on some OS's."
2165 (let* ((len (length str))
2166 (i (min len term-input-chunk-size)))
2167 (process-send-string proc (substring str 0 i))
2168 (while (< i len)
2169 (let ((next-i (+ i term-input-chunk-size)))
2170 (accept-process-output)
2171 (process-send-string proc (substring str i (min len next-i)))
2172 (setq i next-i)))))
2173
2174 (defun term-send-region (proc start end)
2175 "Sends to PROC the region delimited by START and END.
2176 This is a replacement for process-send-region that tries to keep
2177 your process from hanging on long inputs. See term-send-string."
2178 (term-send-string proc (buffer-substring start end)))
2179
2180 \f
2181 ;;; Random input hackage
2182
2183 (defun term-kill-output ()
2184 "Kill all output from interpreter since last input."
2185 (interactive)
2186 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2187 (kill-region term-last-input-end pmark)
2188 (goto-char pmark)
2189 (insert "*** output flushed ***\n")
2190 (set-marker pmark (point))))
2191
2192 (defun term-show-output ()
2193 "Display start of this batch of interpreter output at top of window.
2194 Sets mark to the value of point when this command is run."
2195 (interactive)
2196 (goto-char term-last-input-end)
2197 (backward-char)
2198 (beginning-of-line)
2199 (set-window-start (selected-window) (point))
2200 (end-of-line))
2201
2202 (defun term-interrupt-subjob ()
2203 "Interrupt the current subjob."
2204 (interactive)
2205 (interrupt-process nil term-ptyp))
2206
2207 (defun term-kill-subjob ()
2208 "Send kill signal to the current subjob."
2209 (interactive)
2210 (kill-process nil term-ptyp))
2211
2212 (defun term-quit-subjob ()
2213 "Send quit signal to the current subjob."
2214 (interactive)
2215 (quit-process nil term-ptyp))
2216
2217 (defun term-stop-subjob ()
2218 "Stop the current subjob.
2219 WARNING: if there is no current subjob, you can end up suspending
2220 the top-level process running in the buffer. If you accidentally do
2221 this, use \\[term-continue-subjob] to resume the process. (This
2222 is not a problem with most shells, since they ignore this signal.)"
2223 (interactive)
2224 (stop-process nil term-ptyp))
2225
2226 (defun term-continue-subjob ()
2227 "Send CONT signal to process buffer's process group.
2228 Useful if you accidentally suspend the top-level process."
2229 (interactive)
2230 (continue-process nil term-ptyp))
2231
2232 (defun term-kill-input ()
2233 "Kill all text from last stuff output by interpreter to point."
2234 (interactive)
2235 (let* ((pmark (process-mark (get-buffer-process (current-buffer))))
2236 (p-pos (marker-position pmark)))
2237 (if (> (point) p-pos)
2238 (kill-region pmark (point)))))
2239
2240 (defun term-delchar-or-maybe-eof (arg)
2241 "Delete ARG characters forward, or send an EOF to process if at end of
2242 buffer."
2243 (interactive "p")
2244 (if (eobp)
2245 (process-send-eof)
2246 (delete-char arg)))
2247
2248 (defun term-send-eof ()
2249 "Send an EOF to the current buffer's process."
2250 (interactive)
2251 (process-send-eof))
2252
2253 (defun term-backward-matching-input (regexp arg)
2254 "Search backward through buffer for match for REGEXP.
2255 Matches are searched for on lines that match `term-prompt-regexp'.
2256 With prefix argument N, search for Nth previous match.
2257 If N is negative, find the next or Nth next match."
2258 (interactive (term-regexp-arg "Backward input matching (regexp): "))
2259 (let* ((re (concat term-prompt-regexp ".*" regexp))
2260 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2261 (if (re-search-backward re nil t arg)
2262 (point)))))
2263 (if (null pos)
2264 (progn (message "Not found")
2265 (ding))
2266 (goto-char pos)
2267 (term-bol nil))))
2268
2269 (defun term-forward-matching-input (regexp arg)
2270 "Search forward through buffer for match for REGEXP.
2271 Matches are searched for on lines that match `term-prompt-regexp'.
2272 With prefix argument N, search for Nth following match.
2273 If N is negative, find the previous or Nth previous match."
2274 (interactive (term-regexp-arg "Forward input matching (regexp): "))
2275 (term-backward-matching-input regexp (- arg)))
2276
2277
2278 (defun term-next-prompt (n)
2279 "Move to end of Nth next prompt in the buffer.
2280 See `term-prompt-regexp'."
2281 (interactive "p")
2282 (let ((paragraph-start term-prompt-regexp))
2283 (end-of-line (if (> n 0) 1 0))
2284 (forward-paragraph n)
2285 (term-skip-prompt)))
2286
2287 (defun term-previous-prompt (n)
2288 "Move to end of Nth previous prompt in the buffer.
2289 See `term-prompt-regexp'."
2290 (interactive "p")
2291 (term-next-prompt (- n)))
2292 \f
2293 ;;; Support for source-file processing commands.
2294 ;;;============================================================================
2295 ;;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2296 ;;; commands that process files of source text (e.g. loading or compiling
2297 ;;; files). So the corresponding process-in-a-buffer modes have commands
2298 ;;; for doing this (e.g., lisp-load-file). The functions below are useful
2299 ;;; for defining these commands.
2300 ;;;
2301 ;;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2302 ;;; and Soar, in that they don't know anything about file extensions.
2303 ;;; So the compile/load interface gets the wrong default occasionally.
2304 ;;; The load-file/compile-file default mechanism could be smarter -- it
2305 ;;; doesn't know about the relationship between filename extensions and
2306 ;;; whether the file is source or executable. If you compile foo.lisp
2307 ;;; with compile-file, then the next load-file should use foo.bin for
2308 ;;; the default, not foo.lisp. This is tricky to do right, particularly
2309 ;;; because the extension for executable files varies so much (.o, .bin,
2310 ;;; .lbin, .mo, .vo, .ao, ...).
2311
2312
2313 ;;; TERM-SOURCE-DEFAULT -- determines defaults for source-file processing
2314 ;;; commands.
2315 ;;;
2316 ;;; TERM-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2317 ;;; want to save the buffer before issuing any process requests to the command
2318 ;;; interpreter.
2319 ;;;
2320 ;;; TERM-GET-SOURCE -- used by the source-file processing commands to prompt
2321 ;;; for the file to process.
2322
2323 ;;; (TERM-SOURCE-DEFAULT previous-dir/file source-modes)
2324 ;;;============================================================================
2325 ;;; This function computes the defaults for the load-file and compile-file
2326 ;;; commands for tea, soar, cmulisp, and cmuscheme modes.
2327 ;;;
2328 ;;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2329 ;;; source-file processing command, or nil if there hasn't been one yet.
2330 ;;; - SOURCE-MODES is a list used to determine what buffers contain source
2331 ;;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2332 ;;; Typically, (lisp-mode) or (scheme-mode).
2333 ;;;
2334 ;;; If the command is given while the cursor is inside a string, *and*
2335 ;;; the string is an existing filename, *and* the filename is not a directory,
2336 ;;; then the string is taken as default. This allows you to just position
2337 ;;; your cursor over a string that's a filename and have it taken as default.
2338 ;;;
2339 ;;; If the command is given in a file buffer whose major mode is in
2340 ;;; SOURCE-MODES, then the filename is the default file, and the
2341 ;;; file's directory is the default directory.
2342 ;;;
2343 ;;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2344 ;;; then the default directory & file are what was used in the last source-file
2345 ;;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2346 ;;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2347 ;;; is the cwd, with no default file. (\"no default file\" = nil)
2348 ;;;
2349 ;;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2350 ;;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2351 ;;; for Soar programs, etc.
2352 ;;;
2353 ;;; The function returns a pair: (default-directory . default-file).
2354
2355 (defun term-source-default (previous-dir/file source-modes)
2356 (cond ((and buffer-file-name (memq major-mode source-modes))
2357 (cons (file-name-directory buffer-file-name)
2358 (file-name-nondirectory buffer-file-name)))
2359 (previous-dir/file)
2360 (t
2361 (cons default-directory nil))))
2362
2363
2364 ;;; (TERM-CHECK-SOURCE fname)
2365 ;;;============================================================================
2366 ;;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2367 ;;; process-in-a-buffer modes), this function can be called on the filename.
2368 ;;; If the file is loaded into a buffer, and the buffer is modified, the user
2369 ;;; is queried to see if he wants to save the buffer before proceeding with
2370 ;;; the load or compile.
2371
2372 (defun term-check-source (fname)
2373 (let ((buff (get-file-buffer fname)))
2374 (if (and buff
2375 (buffer-modified-p buff)
2376 (y-or-n-p (format "Save buffer %s first? "
2377 (buffer-name buff))))
2378 ;; save BUFF.
2379 (let ((old-buffer (current-buffer)))
2380 (set-buffer buff)
2381 (save-buffer)
2382 (set-buffer old-buffer)))))
2383
2384
2385 ;;; (TERM-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2386 ;;;============================================================================
2387 ;;; TERM-GET-SOURCE is used to prompt for filenames in command-interpreter
2388 ;;; commands that process source files (like loading or compiling a file).
2389 ;;; It prompts for the filename, provides a default, if there is one,
2390 ;;; and returns the result filename.
2391 ;;;
2392 ;;; See TERM-SOURCE-DEFAULT for more on determining defaults.
2393 ;;;
2394 ;;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2395 ;;; from the last source processing command. SOURCE-MODES is a list of major
2396 ;;; modes used to determine what file buffers contain source files. (These
2397 ;;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2398 ;;; then the filename reader will only accept a file that exists.
2399 ;;;
2400 ;;; A typical use:
2401 ;;; (interactive (term-get-source "Compile file: " prev-lisp-dir/file
2402 ;;; '(lisp-mode) t))
2403
2404 ;;; This is pretty stupid about strings. It decides we're in a string
2405 ;;; if there's a quote on both sides of point on the current line.
2406 (defun term-extract-string ()
2407 "Returns string around POINT that starts the current line or nil."
2408 (save-excursion
2409 (let* ((point (point))
2410 (bol (progn (beginning-of-line) (point)))
2411 (eol (progn (end-of-line) (point)))
2412 (start (progn (goto-char point)
2413 (and (search-backward "\"" bol t)
2414 (1+ (point)))))
2415 (end (progn (goto-char point)
2416 (and (search-forward "\"" eol t)
2417 (1- (point))))))
2418 (and start end
2419 (buffer-substring start end)))))
2420
2421 (defun term-get-source (prompt prev-dir/file source-modes mustmatch-p)
2422 (let* ((def (term-source-default prev-dir/file source-modes))
2423 (stringfile (term-extract-string))
2424 (sfile-p (and stringfile
2425 (condition-case ()
2426 (file-exists-p stringfile)
2427 (error nil))
2428 (not (file-directory-p stringfile))))
2429 (defdir (if sfile-p (file-name-directory stringfile)
2430 (car def)))
2431 (deffile (if sfile-p (file-name-nondirectory stringfile)
2432 (cdr def)))
2433 (ans (read-file-name (if deffile (format "%s(default %s) "
2434 prompt deffile)
2435 prompt)
2436 defdir
2437 (concat defdir deffile)
2438 mustmatch-p)))
2439 (list (expand-file-name (substitute-in-file-name ans)))))
2440
2441 ;;; I am somewhat divided on this string-default feature. It seems
2442 ;;; to violate the principle-of-least-astonishment, in that it makes
2443 ;;; the default harder to predict, so you actually have to look and see
2444 ;;; what the default really is before choosing it. This can trip you up.
2445 ;;; On the other hand, it can be useful, I guess. I would appreciate feedback
2446 ;;; on this.
2447 ;;; -Olin
2448
2449 \f
2450 ;;; Simple process query facility.
2451 ;;; ===========================================================================
2452 ;;; This function is for commands that want to send a query to the process
2453 ;;; and show the response to the user. For example, a command to get the
2454 ;;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2455 ;;; to an inferior Common Lisp process.
2456 ;;;
2457 ;;; This simple facility just sends strings to the inferior process and pops
2458 ;;; up a window for the process buffer so you can see what the process
2459 ;;; responds with. We don't do anything fancy like try to intercept what the
2460 ;;; process responds with and put it in a pop-up window or on the message
2461 ;;; line. We just display the buffer. Low tech. Simple. Works good.
2462
2463 ;;; Send to the inferior process PROC the string STR. Pop-up but do not select
2464 ;;; a window for the inferior process so that its response can be seen.
2465 (defun term-proc-query (proc str)
2466 (let* ((proc-buf (process-buffer proc))
2467 (proc-mark (process-mark proc)))
2468 (display-buffer proc-buf)
2469 (set-buffer proc-buf) ; but it's not the selected *window*
2470 (let ((proc-win (get-buffer-window proc-buf))
2471 (proc-pt (marker-position proc-mark)))
2472 (term-send-string proc str) ; send the query
2473 (accept-process-output proc) ; wait for some output
2474 ;; Try to position the proc window so you can see the answer.
2475 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2476 ;; I don't know why. Wizards invited to improve it.
2477 (if (not (pos-visible-in-window-p proc-pt proc-win))
2478 (let ((opoint (window-point proc-win)))
2479 (set-window-point proc-win proc-mark) (sit-for 0)
2480 (if (not (pos-visible-in-window-p opoint proc-win))
2481 (push-mark opoint)
2482 (set-window-point proc-win opoint)))))))
2483 \f
2484 ;;; Returns the current column in the current screen line.
2485 ;;; Note: (current-column) yields column in buffer line.
2486
2487 (defun term-horizontal-column ()
2488 (- (term-current-column) (term-start-line-column)))
2489
2490 ;; Calls either vertical-motion or buffer-vertical-motion
2491 (defmacro term-vertical-motion (count)
2492 (list 'funcall 'term-vertical-motion count))
2493
2494 ;; An emulation of vertical-motion that is independent of having a window.
2495 ;; Instead, it uses the term-width variable as the logical window width.
2496
2497 (defun buffer-vertical-motion (count)
2498 (cond ((= count 0)
2499 (move-to-column (* term-width (/ (current-column) term-width)))
2500 0)
2501 ((> count 0)
2502 (let ((H)
2503 (todo (+ count (/ (current-column) term-width))))
2504 (end-of-line)
2505 ;; The loop iterates over buffer lines;
2506 ;; H is the number of screen lines in the current line, i.e.
2507 ;; the ceiling of dividing the buffer line width by term-width.
2508 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2509 term-width)
2510 1))
2511 todo)
2512 (not (eobp)))
2513 (setq todo (- todo H))
2514 (forward-char) ;; Move past the ?\n
2515 (end-of-line)) ;; and on to the end of the next line.
2516 (if (and (>= todo H) (> todo 0))
2517 (+ (- count todo) H -1) ;; Hit end of buffer.
2518 (move-to-column (* todo term-width))
2519 count)))
2520 (t ;; (< count 0) ;; Similar algorithm, but for upward motion.
2521 (let ((H)
2522 (todo (- count)))
2523 (while (and (<= (setq H (max (/ (+ (current-column) term-width -1)
2524 term-width)
2525 1))
2526 todo)
2527 (progn (beginning-of-line)
2528 (not (bobp))))
2529 (setq todo (- todo H))
2530 (backward-char)) ;; Move to end of previous line.
2531 (if (and (>= todo H) (> todo 0))
2532 (+ count todo (- 1 H)) ;; Hit beginning of buffer.
2533 (move-to-column (* (- H todo 1) term-width))
2534 count)))))
2535
2536 ;;; The term-start-line-column variable is used as a cache.
2537 (defun term-start-line-column ()
2538 (cond (term-start-line-column)
2539 ((let ((save-pos (point)))
2540 (term-vertical-motion 0)
2541 (setq term-start-line-column (current-column))
2542 (goto-char save-pos)
2543 term-start-line-column))))
2544
2545 ;;; Same as (current-column), but uses term-current-column as a cache.
2546 (defun term-current-column ()
2547 (cond (term-current-column)
2548 ((setq term-current-column (current-column)))))
2549
2550 ;;; Move DELTA column right (or left if delta < 0 limiting at column 0).
2551
2552 (defun term-move-columns (delta)
2553 (setq term-current-column (max 0 (+ (term-current-column) delta)))
2554 (move-to-column term-current-column t))
2555
2556 ;; Insert COUNT copies of CHAR in the default face.
2557 (defun term-insert-char (char count)
2558 (let ((old-point (point)))
2559 (insert-char char count)
2560 (put-text-property old-point (point) 'face 'default)))
2561
2562 (defun term-current-row ()
2563 (cond (term-current-row)
2564 ((setq term-current-row
2565 (save-restriction
2566 (save-excursion
2567 (narrow-to-region term-home-marker (point-max))
2568 (- (term-vertical-motion -9999))))))))
2569
2570 (defun term-adjust-current-row-cache (delta)
2571 (if term-current-row
2572 (setq term-current-row (+ term-current-row delta))))
2573
2574 (defun term-terminal-pos ()
2575 (save-excursion ; save-restriction
2576 (let ((save-col (term-current-column))
2577 x y)
2578 (term-vertical-motion 0)
2579 (setq x (- save-col (current-column)))
2580 (setq y (term-vertical-motion term-height))
2581 (cons x y))))
2582
2583 ;;;Function that handles term messages: code by rms ( and you can see the
2584 ;;;difference ;-) -mm
2585
2586 (defun term-handle-ansi-terminal-messages (message)
2587 ;; Is there a command here?
2588 (while (string-match "\eAnSiT.+\n" message)
2589 ;; Extract the command code and the argument.
2590 (let* ((start (match-beginning 0))
2591 (end (match-end 0))
2592 (command-code (aref message (+ start 6)))
2593 (argument
2594 (save-match-data
2595 (substring message
2596 (+ start 8)
2597 (string-match "\r?\n" message
2598 (+ start 8)))))
2599 ignore)
2600 ;; Delete this command from MESSAGE.
2601 (setq message (replace-match "" t t message))
2602
2603 ;; If we recognize the type of command, set the appropriate variable.
2604 (cond ((= command-code ?c)
2605 (setq term-ansi-at-dir argument))
2606 ((= command-code ?h)
2607 (setq term-ansi-at-host argument))
2608 ((= command-code ?u)
2609 (setq term-ansi-at-user argument))
2610 ;; Otherwise ignore this one.
2611 (t
2612 (setq ignore t)))
2613
2614 ;; Update default-directory based on the changes this command made.
2615 (if ignore
2616 nil
2617 (setq default-directory
2618 (file-name-as-directory
2619 (if (and (string= term-ansi-at-host (system-name))
2620 (string= term-ansi-at-user (user-real-login-name)))
2621 (expand-file-name term-ansi-at-dir)
2622 (if (string= term-ansi-at-user (user-real-login-name))
2623 (concat "/" term-ansi-at-host ":" term-ansi-at-dir)
2624 (concat "/" term-ansi-at-user "@" term-ansi-at-host ":"
2625 term-ansi-at-dir)))))
2626
2627 ;; I'm not sure this is necessary,
2628 ;; but it's best to be on the safe side.
2629 (if (string= term-ansi-at-host (system-name))
2630 (progn
2631 (setq ange-ftp-default-user term-ansi-at-save-user)
2632 (setq ange-ftp-default-password term-ansi-at-save-pwd)
2633 (setq ange-ftp-generate-anonymous-password term-ansi-at-save-anon))
2634 (setq term-ansi-at-save-user ange-ftp-default-user)
2635 (setq term-ansi-at-save-pwd ange-ftp-default-password)
2636 (setq term-ansi-at-save-anon ange-ftp-generate-anonymous-password)
2637 (setq ange-ftp-default-user nil)
2638 (setq ange-ftp-default-password nil)
2639 (setq ange-ftp-generate-anonymous-password nil)))))
2640 message)
2641
2642
2643 ;;; Terminal emulation
2644 ;;; This is the standard process filter for term buffers.
2645 ;;; It emulates (most of the features of) a VT100/ANSI-style terminal.
2646
2647 (defun term-emulate-terminal (proc str)
2648 (let* ((previous-buffer (current-buffer))
2649 (i 0) char funny count save-point save-marker old-point temp win
2650 (selected (selected-window))
2651 last-win
2652 (str-length (length str)))
2653 (unwind-protect
2654 (progn
2655 (set-buffer (process-buffer proc))
2656
2657 ;;; Let's handle the messages. -mm
2658
2659 (setq str (term-handle-ansi-terminal-messages str))
2660 (setq str-length (length str))
2661
2662 (if (marker-buffer term-pending-delete-marker)
2663 (progn
2664 ;; Delete text following term-pending-delete-marker.
2665 (delete-region term-pending-delete-marker (process-mark proc))
2666 (set-marker term-pending-delete-marker nil)))
2667
2668 (if (eq (window-buffer) (current-buffer))
2669 (progn
2670 (setq term-vertical-motion (symbol-function 'vertical-motion))
2671 (term-check-size proc))
2672 (setq term-vertical-motion
2673 (symbol-function 'buffer-vertical-motion)))
2674
2675 (setq save-marker (copy-marker (process-mark proc)))
2676
2677 (if (/= (point) (process-mark proc))
2678 (progn (setq save-point (point-marker))
2679 (goto-char (process-mark proc))))
2680
2681 (save-restriction
2682 ;; If the buffer is in line mode, and there is a partial
2683 ;; input line, save the line (by narrowing to leave it
2684 ;; outside the restriction ) until we're done with output.
2685 (if (and (> (point-max) (process-mark proc))
2686 (term-in-line-mode))
2687 (narrow-to-region (point-min) (process-mark proc)))
2688
2689 (if term-log-buffer
2690 (princ str term-log-buffer))
2691 (cond ((eq term-terminal-state 4) ;; Have saved pending output.
2692 (setq str (concat term-terminal-parameter str))
2693 (setq term-terminal-parameter nil)
2694 (setq str-length (length str))
2695 (setq term-terminal-state 0)))
2696
2697 (while (< i str-length)
2698 (setq char (aref str i))
2699 (cond ((< term-terminal-state 2)
2700 ;; Look for prefix of regular chars
2701 (setq funny
2702 (string-match "[\r\n\000\007\033\t\b\032\016\017]"
2703 str i))
2704 (if (not funny) (setq funny str-length))
2705 (cond ((> funny i)
2706 (cond ((eq term-terminal-state 1)
2707 (term-move-columns 1)
2708 (setq term-terminal-state 0)))
2709 (setq count (- funny i))
2710 (setq temp (- (+ (term-horizontal-column) count)
2711 term-width))
2712 (cond ((<= temp 0)) ;; All count chars fit in line.
2713 ((> count temp) ;; Some chars fit.
2714 ;; This iteration, handle only what fits.
2715 (setq count (- count temp))
2716 (setq funny (+ count i)))
2717 ((or (not (or term-pager-count
2718 term-scroll-with-delete))
2719 (> (term-handle-scroll 1) 0))
2720 (term-adjust-current-row-cache 1)
2721 (setq count (min count term-width))
2722 (setq funny (+ count i))
2723 (setq term-start-line-column
2724 term-current-column))
2725 (t ;; Doing PAGER processing.
2726 (setq count 0 funny i)
2727 (setq term-current-column nil)
2728 (setq term-start-line-column nil)))
2729 (setq old-point (point))
2730
2731 ;; Insert a string, check how many columns
2732 ;; we moved, then delete that many columns
2733 ;; following point if not eob nor insert-mode.
2734 (let ((old-column (current-column))
2735 columns pos)
2736 (insert (substring str i funny))
2737 (setq term-current-column (current-column)
2738 columns (- term-current-column old-column))
2739 (when (not (or (eobp) term-insert-mode))
2740 (setq pos (point))
2741 (term-move-columns columns)
2742 (delete-region pos (point))))
2743 (setq term-current-column nil)
2744
2745 (put-text-property old-point (point)
2746 'face term-current-face)
2747 ;; If the last char was written in last column,
2748 ;; back up one column, but remember we did so.
2749 ;; Thus we emulate xterm/vt100-style line-wrapping.
2750 (cond ((eq temp 0)
2751 (term-move-columns -1)
2752 (setq term-terminal-state 1)))
2753 (setq i (1- funny)))
2754 ((and (setq term-terminal-state 0)
2755 (eq char ?\^I)) ; TAB
2756 ;; FIXME: Does not handle line wrap!
2757 (setq count (term-current-column))
2758 (setq count (+ count 8 (- (mod count 8))))
2759 (if (< (move-to-column count nil) count)
2760 (term-insert-char char 1))
2761 (setq term-current-column count))
2762 ((eq char ?\r)
2763 ;; Optimize CRLF at end of buffer:
2764 (cond ((and (< (setq temp (1+ i)) str-length)
2765 (eq (aref str temp) ?\n)
2766 (= (point) (point-max))
2767 (not (or term-pager-count
2768 term-kill-echo-list
2769 term-scroll-with-delete)))
2770 (insert ?\n)
2771 (term-adjust-current-row-cache 1)
2772 (setq term-start-line-column 0)
2773 (setq term-current-column 0)
2774 (setq i temp))
2775 (t ;; Not followed by LF or can't optimize:
2776 (term-vertical-motion 0)
2777 (setq term-current-column term-start-line-column))))
2778 ((eq char ?\n)
2779 (if (not (and term-kill-echo-list
2780 (term-check-kill-echo-list)))
2781 (term-down 1 t)))
2782 ((eq char ?\b)
2783 (term-move-columns -1))
2784 ((eq char ?\033) ; Escape
2785 (setq term-terminal-state 2))
2786 ((eq char 0)) ; NUL: Do nothing
2787 ((eq char ?\016)) ; Shift Out - ignored
2788 ((eq char ?\017)) ; Shift In - ignored
2789 ((eq char ?\^G)
2790 (beep t)) ; Bell
2791 ((eq char ?\032)
2792 (let ((end (string-match "\r?$" str i)))
2793 (if end
2794 (funcall term-command-hook
2795 (prog1 (substring str (1+ i) end)
2796 (setq i (match-end 0))))
2797 (setq term-terminal-parameter
2798 (substring str i))
2799 (setq term-terminal-state 4)
2800 (setq i str-length))))
2801 (t ; insert char FIXME: Should never happen
2802 (term-move-columns 1)
2803 (backward-delete-char 1)
2804 (insert char))))
2805 ((eq term-terminal-state 2) ; Seen Esc
2806 (cond ((eq char ?\133) ;; ?\133 = ?[
2807
2808 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2809 ;;; Note that now the init value of term-terminal-previous-parameter has
2810 ;;; been changed to -1
2811
2812 (make-local-variable 'term-terminal-parameter)
2813 (make-local-variable 'term-terminal-previous-parameter)
2814 (make-local-variable 'term-terminal-previous-parameter-2)
2815 (make-local-variable 'term-terminal-previous-parameter-3)
2816 (make-local-variable 'term-terminal-previous-parameter-4)
2817 (make-local-variable 'term-terminal-more-parameters)
2818 (setq term-terminal-parameter 0)
2819 (setq term-terminal-previous-parameter -1)
2820 (setq term-terminal-previous-parameter-2 -1)
2821 (setq term-terminal-previous-parameter-3 -1)
2822 (setq term-terminal-previous-parameter-4 -1)
2823 (setq term-terminal-more-parameters 0)
2824 (setq term-terminal-state 3))
2825 ((eq char ?D) ;; scroll forward
2826 (term-handle-deferred-scroll)
2827 (term-down 1 t)
2828 (setq term-terminal-state 0))
2829 ((eq char ?M) ;; scroll reversed
2830 (term-insert-lines 1)
2831 (setq term-terminal-state 0))
2832 ((eq char ?7) ;; Save cursor
2833 (term-handle-deferred-scroll)
2834 (setq term-saved-cursor
2835 (cons (term-current-row)
2836 (term-horizontal-column)))
2837 (setq term-terminal-state 0))
2838 ((eq char ?8) ;; Restore cursor
2839 (if term-saved-cursor
2840 (term-goto (car term-saved-cursor)
2841 (cdr term-saved-cursor)))
2842 (setq term-terminal-state 0))
2843 ((setq term-terminal-state 0))))
2844 ((eq term-terminal-state 3) ; Seen Esc [
2845 (cond ((and (>= char ?0) (<= char ?9))
2846 (setq term-terminal-parameter
2847 (+ (* 10 term-terminal-parameter) (- char ?0))))
2848 ((eq char ?\;)
2849 ;;; Some modifications to cope with multiple settings like ^[[01;32;43m -mm
2850 (setq term-terminal-more-parameters 1)
2851 (setq term-terminal-previous-parameter-4
2852 term-terminal-previous-parameter-3)
2853 (setq term-terminal-previous-parameter-3
2854 term-terminal-previous-parameter-2)
2855 (setq term-terminal-previous-parameter-2
2856 term-terminal-previous-parameter)
2857 (setq term-terminal-previous-parameter
2858 term-terminal-parameter)
2859 (setq term-terminal-parameter 0))
2860 ((eq char ??)) ; Ignore ?
2861 (t
2862 (term-handle-ansi-escape proc char)
2863 (setq term-terminal-more-parameters 0)
2864 (setq term-terminal-previous-parameter-4 -1)
2865 (setq term-terminal-previous-parameter-3 -1)
2866 (setq term-terminal-previous-parameter-2 -1)
2867 (setq term-terminal-previous-parameter -1)
2868 (setq term-terminal-state 0)))))
2869 (if (term-handling-pager)
2870 ;; Finish stuff to get ready to handle PAGER.
2871 (progn
2872 (if (> (% (current-column) term-width) 0)
2873 (setq term-terminal-parameter
2874 (substring str i))
2875 ;; We're at column 0. Goto end of buffer; to compensate,
2876 ;; prepend a ?\r for later. This looks more consistent.
2877 (if (zerop i)
2878 (setq term-terminal-parameter
2879 (concat "\r" (substring str i)))
2880 (setq term-terminal-parameter (substring str (1- i)))
2881 (aset term-terminal-parameter 0 ?\r))
2882 (goto-char (point-max)))
2883 (setq term-terminal-state 4)
2884 (make-local-variable 'term-pager-old-filter)
2885 (setq term-pager-old-filter (process-filter proc))
2886 (set-process-filter proc term-pager-filter)
2887 (setq i str-length)))
2888 (setq i (1+ i))))
2889
2890 (if (>= (term-current-row) term-height)
2891 (term-handle-deferred-scroll))
2892
2893 (set-marker (process-mark proc) (point))
2894 (if save-point
2895 (progn (goto-char save-point)
2896 (set-marker save-point nil)))
2897
2898 ;; Check for a pending filename-and-line number to display.
2899 ;; We do this before scrolling, because we might create a new window.
2900 (if (and term-pending-frame
2901 (eq (window-buffer selected) (current-buffer)))
2902 (progn (term-display-line (car term-pending-frame)
2903 (cdr term-pending-frame))
2904 (setq term-pending-frame nil)
2905 ;; We have created a new window, so check the window size.
2906 (term-check-size proc)))
2907
2908 ;; Scroll each window displaying the buffer but (by default)
2909 ;; only if the point matches the process-mark we started with.
2910 (setq win selected)
2911 ;; Avoid infinite loop in strange case where minibuffer window
2912 ;; is selected but not active.
2913 (while (window-minibuffer-p win)
2914 (setq win (next-window win nil t)))
2915 (setq last-win win)
2916 (while (progn
2917 (setq win (next-window win nil t))
2918 (if (eq (window-buffer win) (process-buffer proc))
2919 (let ((scroll term-scroll-to-bottom-on-output))
2920 (select-window win)
2921 (if (or (= (point) save-marker)
2922 (eq scroll t) (eq scroll 'all)
2923 ;; Maybe user wants point to jump to the end.
2924 (and (eq selected win)
2925 (or (eq scroll 'this) (not save-point)))
2926 (and (eq scroll 'others)
2927 (not (eq selected win))))
2928 (progn
2929 (goto-char term-home-marker)
2930 (recenter 0)
2931 (goto-char (process-mark proc))
2932 (if (not (pos-visible-in-window-p (point) win))
2933 (recenter -1))))
2934 ;; Optionally scroll so that the text
2935 ;; ends at the bottom of the window.
2936 (if (and term-scroll-show-maximum-output
2937 (>= (point) (process-mark proc)))
2938 (save-excursion
2939 (goto-char (point-max))
2940 (recenter -1)))))
2941 (not (eq win last-win))))
2942
2943 ;;; Stolen from comint.el and adapted -mm
2944 (if (> term-buffer-maximum-size 0)
2945 (save-excursion
2946 (goto-char (process-mark (get-buffer-process (current-buffer))))
2947 (forward-line (- term-buffer-maximum-size))
2948 (beginning-of-line)
2949 (delete-region (point-min) (point))))
2950 ;;;
2951
2952 (set-marker save-marker nil))
2953 ;; unwind-protect cleanup-forms follow:
2954 (set-buffer previous-buffer)
2955 (select-window selected))))
2956
2957 (defun term-handle-deferred-scroll ()
2958 (let ((count (- (term-current-row) term-height)))
2959 (if (>= count 0)
2960 (save-excursion
2961 (goto-char term-home-marker)
2962 (term-vertical-motion (1+ count))
2963 (set-marker term-home-marker (point))
2964 (setq term-current-row (1- term-height))))))
2965
2966 ;;; New function to deal with ansi colorized output, as you can see you can
2967 ;;; have any bold/underline/fg/bg/reverse combination. -mm
2968
2969 (defun term-handle-colors-array (parameter)
2970 (cond
2971
2972 ;;; Bold
2973 ((eq parameter 1)
2974 (setq term-ansi-current-bold 1))
2975
2976 ;;; Underline
2977 ((eq parameter 4)
2978 (setq term-ansi-current-underline 1))
2979
2980 ;;; Blink (unsupported by Emacs), will be translated to bold.
2981 ;;; This may change in the future though.
2982 ((eq parameter 5)
2983 (setq term-ansi-current-bold 1))
2984
2985 ;;; Reverse
2986 ((eq parameter 7)
2987 (setq term-ansi-current-reverse 1))
2988
2989 ;;; Invisible
2990 ((eq parameter 8)
2991 (setq term-ansi-current-invisible 1))
2992
2993 ;;; Foreground
2994 ((and (>= parameter 30) (<= parameter 37))
2995 (setq term-ansi-current-color (- parameter 29)))
2996
2997 ;;; Reset foreground
2998 ((eq parameter 39)
2999 (setq term-ansi-current-color 0))
3000
3001 ;;; Background
3002 ((and (>= parameter 40) (<= parameter 47))
3003 (setq term-ansi-current-bg-color (- parameter 39)))
3004
3005 ;;; Reset background
3006 ((eq parameter 49)
3007 (setq term-ansi-current-bg-color 0))
3008
3009 ;;; 0 (Reset) or unknown (reset anyway)
3010 (t
3011 (setq term-current-face nil)
3012 (setq term-ansi-current-underline 0)
3013 (setq term-ansi-current-bold 0)
3014 (setq term-ansi-current-reverse 0)
3015 (setq term-ansi-current-color 0)
3016 (setq term-ansi-current-invisible 0)
3017 (setq term-ansi-face-already-done 1)
3018 (setq term-ansi-current-bg-color 0)))
3019
3020 ; (message "Debug: U-%d R-%d B-%d I-%d D-%d F-%d B-%d"
3021 ; term-ansi-current-underline
3022 ; term-ansi-current-reverse
3023 ; term-ansi-current-bold
3024 ; term-ansi-current-invisible
3025 ; term-ansi-face-already-done
3026 ; term-ansi-current-color
3027 ; term-ansi-current-bg-color)
3028
3029
3030 (if (= term-ansi-face-already-done 0)
3031 (if (= term-ansi-current-reverse 1)
3032 (if (= term-ansi-current-invisible 1)
3033 (setq term-current-face
3034 (if (= term-ansi-current-color 0)
3035 (list :background
3036 term-default-fg-color
3037 :foreground
3038 term-default-fg-color)
3039 (list :background
3040 (elt ansi-term-color-vector term-ansi-current-color)
3041 :foreground
3042 (elt ansi-term-color-vector term-ansi-current-color)))
3043 ;; No need to bother with anything else if it's invisible
3044 )
3045 (setq term-current-face
3046 (list :background
3047 (elt ansi-term-color-vector term-ansi-current-color)
3048 :foreground
3049 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3050 (if (= term-ansi-current-bold 1)
3051 (setq term-current-face
3052 (append '(:weight bold) term-current-face)))
3053 (if (= term-ansi-current-underline 1)
3054 (setq term-current-face
3055 (append '(:underline t) term-current-face))))
3056 (if (= term-ansi-current-invisible 1)
3057 (setq term-current-face
3058 (if (= term-ansi-current-bg-color 0)
3059 (list :background
3060 term-default-bg-color
3061 :foreground
3062 term-default-bg-color)
3063 (list :foreground
3064 (elt ansi-term-color-vector term-ansi-current-bg-color)
3065 :background
3066 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3067 ;; No need to bother with anything else if it's invisible
3068 )
3069 (setq term-current-face
3070 (list :foreground
3071 (elt ansi-term-color-vector term-ansi-current-color)
3072 :background
3073 (elt ansi-term-color-vector term-ansi-current-bg-color)))
3074 (if (= term-ansi-current-bold 1)
3075 (setq term-current-face
3076 (append '(:weight bold) term-current-face)))
3077 (if (= term-ansi-current-underline 1)
3078 (setq term-current-face
3079 (append '(:underline t) term-current-face))))))
3080
3081 ; (message "Debug %S" term-current-face)
3082
3083 (setq term-ansi-face-already-done 0))
3084
3085
3086 ;;; Handle a character assuming (eq terminal-state 2) -
3087 ;;; i.e. we have previously seen Escape followed by ?[.
3088
3089 (defun term-handle-ansi-escape (proc char)
3090 (cond
3091 ((eq char ?H) ; cursor motion
3092 (if (<= term-terminal-parameter 0)
3093 (setq term-terminal-parameter 1))
3094 (if (<= term-terminal-previous-parameter 0)
3095 (setq term-terminal-previous-parameter 1))
3096 (if (> term-terminal-previous-parameter term-height)
3097 (setq term-terminal-previous-parameter term-height))
3098 (if (> term-terminal-parameter term-width)
3099 (setq term-terminal-parameter term-width))
3100 (term-goto
3101 (1- term-terminal-previous-parameter)
3102 (1- term-terminal-parameter)))
3103 ;; \E[A - cursor up
3104 ((eq char ?A)
3105 (term-handle-deferred-scroll)
3106 (term-down (- (max 1 term-terminal-parameter)) t))
3107 ;; \E[B - cursor down
3108 ((eq char ?B)
3109 (term-down (max 1 term-terminal-parameter) t))
3110 ;; \E[C - cursor right
3111 ((eq char ?C)
3112 (term-move-columns (max 1 term-terminal-parameter)))
3113 ;; \E[D - cursor left
3114 ((eq char ?D)
3115 (term-move-columns (- (max 1 term-terminal-parameter))))
3116 ;; \E[J - clear to end of screen
3117 ((eq char ?J)
3118 (term-erase-in-display term-terminal-parameter))
3119 ;; \E[K - clear to end of line
3120 ((eq char ?K)
3121 (term-erase-in-line term-terminal-parameter))
3122 ;; \E[L - insert lines
3123 ((eq char ?L)
3124 (term-insert-lines (max 1 term-terminal-parameter)))
3125 ;; \E[M - delete lines
3126 ((eq char ?M)
3127 (term-delete-lines (max 1 term-terminal-parameter)))
3128 ;; \E[P - delete chars
3129 ((eq char ?P)
3130 (term-delete-chars (max 1 term-terminal-parameter)))
3131 ;; \E[@ - insert spaces
3132 ((eq char ?@)
3133 (term-insert-spaces (max 1 term-terminal-parameter)))
3134 ;; \E[?h - DEC Private Mode Set
3135 ((eq char ?h)
3136 (cond ((eq term-terminal-parameter 4)
3137 (setq term-insert-mode t))
3138 ((eq term-terminal-parameter 47)
3139 (term-switch-to-alternate-sub-buffer t))))
3140 ;; \E[?l - DEC Private Mode Reset
3141 ((eq char ?l)
3142 (cond ((eq term-terminal-parameter 4)
3143 (setq term-insert-mode nil))
3144 ((eq term-terminal-parameter 47)
3145 (term-switch-to-alternate-sub-buffer nil))))
3146
3147 ;;; Modified to allow ansi coloring -mm
3148 ;; \E[m - Set/reset standard mode
3149 ((eq char ?m)
3150 (when (= term-terminal-more-parameters 1)
3151 (if (>= term-terminal-previous-parameter-4 0)
3152 (term-handle-colors-array term-terminal-previous-parameter-4))
3153 (if (>= term-terminal-previous-parameter-3 0)
3154 (term-handle-colors-array term-terminal-previous-parameter-3))
3155 (if (>= term-terminal-previous-parameter-2 0)
3156 (term-handle-colors-array term-terminal-previous-parameter-2))
3157 (term-handle-colors-array term-terminal-previous-parameter))
3158 (term-handle-colors-array term-terminal-parameter))
3159
3160 ;; \E[6n - Report cursor position
3161 ((eq char ?n)
3162 (term-handle-deferred-scroll)
3163 (process-send-string proc
3164 (format "\e[%s;%sR"
3165 (1+ (term-current-row))
3166 (1+ (term-horizontal-column)))))
3167 ;; \E[r - Set scrolling region
3168 ((eq char ?r)
3169 (term-scroll-region
3170 (1- term-terminal-previous-parameter)
3171 term-terminal-parameter))
3172 (t)))
3173
3174 (defun term-scroll-region (top bottom)
3175 "Set scrolling region.
3176 TOP is the top-most line (inclusive) of the new scrolling region,
3177 while BOTTOM is the line following the new scrolling region (e.g. exclusive).
3178 The top-most line is line 0."
3179 (setq term-scroll-start
3180 (if (or (< top 0) (>= top term-height))
3181 0
3182 top))
3183 (setq term-scroll-end
3184 (if (or (<= bottom term-scroll-start) (> bottom term-height))
3185 term-height
3186 bottom))
3187 (setq term-scroll-with-delete
3188 (or (term-using-alternate-sub-buffer)
3189 (not (and (= term-scroll-start 0)
3190 (= term-scroll-end term-height))))))
3191
3192 (defun term-switch-to-alternate-sub-buffer (set)
3193 ;; If asked to switch to (from) the alternate sub-buffer, and already (not)
3194 ;; using it, do nothing. This test is needed for some programs (including
3195 ;; Emacs) that emit the ti termcap string twice, for unknown reason.
3196 (term-handle-deferred-scroll)
3197 (if (eq set (not (term-using-alternate-sub-buffer)))
3198 (let ((row (term-current-row))
3199 (col (term-horizontal-column)))
3200 (cond (set
3201 (goto-char (point-max))
3202 (if (not (eq (preceding-char) ?\n))
3203 (term-insert-char ?\n 1))
3204 (setq term-scroll-with-delete t)
3205 (setq term-saved-home-marker (copy-marker term-home-marker))
3206 (set-marker term-home-marker (point)))
3207 (t
3208 (setq term-scroll-with-delete
3209 (not (and (= term-scroll-start 0)
3210 (= term-scroll-end term-height))))
3211 (set-marker term-home-marker term-saved-home-marker)
3212 (set-marker term-saved-home-marker nil)
3213 (setq term-saved-home-marker nil)
3214 (goto-char term-home-marker)))
3215 (setq term-current-column nil)
3216 (setq term-current-row 0)
3217 (term-goto row col))))
3218
3219 ;; Default value for the symbol term-command-hook.
3220
3221 (defun term-command-hook (string)
3222 (cond ((equal string "")
3223 t)
3224 ((= (aref string 0) ?\032)
3225 ;; gdb (when invoked with -fullname) prints:
3226 ;; \032\032FULLFILENAME:LINENUMBER:CHARPOS:BEG_OR_MIDDLE:PC\n
3227 (let* ((first-colon (string-match ":" string 1))
3228 (second-colon
3229 (string-match ":" string (1+ first-colon)))
3230 (filename (substring string 1 first-colon))
3231 (fileline (string-to-int
3232 (substring string (1+ first-colon) second-colon))))
3233 (setq term-pending-frame (cons filename fileline))))
3234 ((= (aref string 0) ?/)
3235 (cd (substring string 1)))
3236 ;; Allowing the inferior to call functions in Emacs is
3237 ;; probably too big a security hole.
3238 ;; ((= (aref string 0) ?!)
3239 ;; (eval (car (read-from-string string 1))))
3240 (t)));; Otherwise ignore it
3241
3242 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
3243 ;; and that its line LINE is visible.
3244 ;; Put the overlay-arrow on the line LINE in that buffer.
3245 ;; This is mainly used by gdb.
3246
3247 (defun term-display-line (true-file line)
3248 (term-display-buffer-line (find-file-noselect true-file) line))
3249
3250 (defun term-display-buffer-line (buffer line)
3251 (let* ((window (display-buffer buffer t))
3252 (pos))
3253 (save-excursion
3254 (set-buffer buffer)
3255 (save-restriction
3256 (widen)
3257 (goto-line line)
3258 (setq pos (point))
3259 (setq overlay-arrow-string "=>")
3260 (or overlay-arrow-position
3261 (setq overlay-arrow-position (make-marker)))
3262 (set-marker overlay-arrow-position (point) (current-buffer)))
3263 (cond ((or (< pos (point-min)) (> pos (point-max)))
3264 (widen)
3265 (goto-char pos))))
3266 (set-window-point window overlay-arrow-position)))
3267
3268 ;;; The buffer-local marker term-home-marker defines the "home position"
3269 ;;; (in terms of cursor motion). However, we move the term-home-marker
3270 ;;; "down" as needed so that is no more that a window-full above (point-max).
3271
3272 (defun term-goto-home ()
3273 (term-handle-deferred-scroll)
3274 (goto-char term-home-marker)
3275 (setq term-current-row 0)
3276 (setq term-current-column (current-column))
3277 (setq term-start-line-column term-current-column))
3278
3279 (defun term-goto (row col)
3280 (term-handle-deferred-scroll)
3281 (cond ((and term-current-row (>= row term-current-row))
3282 ;; I assume this is a worthwhile optimization.
3283 (term-vertical-motion 0)
3284 (setq term-current-column term-start-line-column)
3285 (setq row (- row term-current-row)))
3286 (t
3287 (term-goto-home)))
3288 (term-down row)
3289 (term-move-columns col))
3290
3291 ; The page is full, so enter "pager" mode, and wait for input.
3292
3293 (defun term-process-pager ()
3294 (if (not term-pager-break-map)
3295 (let* ((map (make-keymap))
3296 (i 0) tmp)
3297 ; (while (< i 128)
3298 ; (define-key map (make-string 1 i) 'term-send-raw)
3299 ; (setq i (1+ i)))
3300 (define-key map "\e"
3301 (lookup-key (current-global-map) "\e"))
3302 (define-key map "\C-x"
3303 (lookup-key (current-global-map) "\C-x"))
3304 (define-key map "\C-u"
3305 (lookup-key (current-global-map) "\C-u"))
3306 (define-key map " " 'term-pager-page)
3307 (define-key map "\r" 'term-pager-line)
3308 (define-key map "?" 'term-pager-help)
3309 (define-key map "h" 'term-pager-help)
3310 (define-key map "b" 'term-pager-back-page)
3311 (define-key map "\177" 'term-pager-back-line)
3312 (define-key map "q" 'term-pager-discard)
3313 (define-key map "D" 'term-pager-disable)
3314 (define-key map "<" 'term-pager-bob)
3315 (define-key map ">" 'term-pager-eob)
3316
3317 ;; Add menu bar.
3318 (progn
3319 (term-ifnot-xemacs
3320 (define-key map [menu-bar terminal] term-terminal-menu)
3321 (define-key map [menu-bar signals] term-signals-menu)
3322 (setq tmp (make-sparse-keymap "More pages?"))
3323 (define-key tmp [help] '("Help" . term-pager-help))
3324 (define-key tmp [disable]
3325 '("Disable paging" . term-fake-pager-disable))
3326 (define-key tmp [discard]
3327 '("Discard remaining output" . term-pager-discard))
3328 (define-key tmp [eob] '("Goto to end" . term-pager-eob))
3329 (define-key tmp [bob] '("Goto to beginning" . term-pager-bob))
3330 (define-key tmp [line] '("1 line forwards" . term-pager-line))
3331 (define-key tmp [bline] '("1 line backwards" . term-pager-back-line))
3332 (define-key tmp [back] '("1 page backwards" . term-pager-back-page))
3333 (define-key tmp [page] '("1 page forwards" . term-pager-page))
3334 (define-key map [menu-bar page] (cons "More pages?" tmp))
3335 ))
3336
3337 (setq term-pager-break-map map)))
3338 ; (let ((process (get-buffer-process (current-buffer))))
3339 ; (stop-process process))
3340 (setq term-pager-old-local-map (current-local-map))
3341 (use-local-map term-pager-break-map)
3342 (make-local-variable 'term-old-mode-line-format)
3343 (setq term-old-mode-line-format mode-line-format)
3344 (setq mode-line-format
3345 (list "-- **MORE** "
3346 mode-line-buffer-identification
3347 " [Type ? for help] "
3348 "%-"))
3349 (force-mode-line-update))
3350
3351 (defun term-pager-line (lines)
3352 (interactive "p")
3353 (let* ((moved (vertical-motion (1+ lines)))
3354 (deficit (- lines moved)))
3355 (if (> moved lines)
3356 (backward-char))
3357 (cond ((<= deficit 0) ;; OK, had enough in the buffer for request.
3358 (recenter (1- term-height)))
3359 ((term-pager-continue deficit)))))
3360
3361 (defun term-pager-page (arg)
3362 "Proceed past the **MORE** break, allowing the next page of output to appear"
3363 (interactive "p")
3364 (term-pager-line (* arg term-height)))
3365
3366 ; Pager mode command to go to beginning of buffer
3367 (defun term-pager-bob ()
3368 (interactive)
3369 (goto-char (point-min))
3370 (if (= (vertical-motion term-height) term-height)
3371 (backward-char))
3372 (recenter (1- term-height)))
3373
3374 ; pager mode command to go to end of buffer
3375 (defun term-pager-eob ()
3376 (interactive)
3377 (goto-char term-home-marker)
3378 (recenter 0)
3379 (goto-char (process-mark (get-buffer-process (current-buffer)))))
3380
3381 (defun term-pager-back-line (lines)
3382 (interactive "p")
3383 (vertical-motion (- 1 lines))
3384 (if (not (bobp))
3385 (backward-char)
3386 (beep)
3387 ;; Move cursor to end of window.
3388 (vertical-motion term-height)
3389 (backward-char))
3390 (recenter (1- term-height)))
3391
3392 (defun term-pager-back-page (arg)
3393 (interactive "p")
3394 (term-pager-back-line (* arg term-height)))
3395
3396 (defun term-pager-discard ()
3397 (interactive)
3398 (setq term-terminal-parameter "")
3399 (interrupt-process nil t)
3400 (term-pager-continue term-height))
3401
3402 ; Disable pager processing.
3403 ; Only callable while in pager mode. (Contrast term-disable-pager.)
3404 (defun term-pager-disable ()
3405 (interactive)
3406 (if (term-handling-pager)
3407 (term-pager-continue nil)
3408 (setq term-pager-count nil))
3409 (term-update-mode-line))
3410
3411 ; Enable pager processing.
3412 (defun term-pager-enable ()
3413 (interactive)
3414 (or (term-pager-enabled)
3415 (setq term-pager-count 0)) ;; Or maybe set to (term-current-row) ??
3416 (term-update-mode-line))
3417
3418 (defun term-pager-toggle ()
3419 (interactive)
3420 (if (term-pager-enabled) (term-pager-disable) (term-pager-enable)))
3421
3422 (term-ifnot-xemacs
3423 (defalias 'term-fake-pager-enable 'term-pager-toggle)
3424 (defalias 'term-fake-pager-disable 'term-pager-toggle)
3425 (put 'term-char-mode 'menu-enable '(term-in-line-mode))
3426 (put 'term-line-mode 'menu-enable '(term-in-char-mode))
3427 (put 'term-fake-pager-enable 'menu-enable '(not term-pager-count))
3428 (put 'term-fake-pager-disable 'menu-enable 'term-pager-count))
3429
3430 (defun term-pager-help ()
3431 "Provide help on commands available in a terminal-emulator **MORE** break"
3432 (interactive)
3433 (message "Terminal-emulator pager break help...")
3434 (sit-for 0)
3435 (with-electric-help
3436 (function (lambda ()
3437 (princ (substitute-command-keys
3438 "\\<term-pager-break-map>\
3439 Terminal-emulator MORE break.\n\
3440 Type one of the following keys:\n\n\
3441 \\[term-pager-page]\t\tMove forward one page.\n\
3442 \\[term-pager-line]\t\tMove forward one line.\n\
3443 \\[universal-argument] N \\[term-pager-page]\tMove N pages forward.\n\
3444 \\[universal-argument] N \\[term-pager-line]\tMove N lines forward.\n\
3445 \\[universal-argument] N \\[term-pager-back-line]\tMove N lines back.\n\
3446 \\[universal-argument] N \\[term-pager-back-page]\t\tMove N pages back.\n\
3447 \\[term-pager-bob]\t\tMove to the beginning of the buffer.\n\
3448 \\[term-pager-eob]\t\tMove to the end of the buffer.\n\
3449 \\[term-pager-discard]\t\tKill pending output and kill process.\n\
3450 \\[term-pager-disable]\t\tDisable PAGER handling.\n\n\
3451 \\{term-pager-break-map}\n\
3452 Any other key is passed through to the program
3453 running under the terminal emulator and disables pager processing until
3454 all pending output has been dealt with."))
3455 nil))))
3456
3457 (defun term-pager-continue (new-count)
3458 (let ((process (get-buffer-process (current-buffer))))
3459 (use-local-map term-pager-old-local-map)
3460 (setq term-pager-old-local-map nil)
3461 (setq mode-line-format term-old-mode-line-format)
3462 (force-mode-line-update)
3463 (setq term-pager-count new-count)
3464 (set-process-filter process term-pager-old-filter)
3465 (funcall term-pager-old-filter process "")
3466 (continue-process process)))
3467
3468 ;; Make sure there are DOWN blank lines below the current one.
3469 ;; Return 0 if we're unable (because of PAGER handling), else return DOWN.
3470
3471 (defun term-handle-scroll (down)
3472 (let ((scroll-needed
3473 (- (+ (term-current-row) down 1) term-scroll-end)))
3474 (if (> scroll-needed 0)
3475 (let ((save-point (copy-marker (point))) (save-top))
3476 (goto-char term-home-marker)
3477 (cond (term-scroll-with-delete
3478 ;; delete scroll-needed lines at term-scroll-start
3479 (term-vertical-motion term-scroll-start)
3480 (setq save-top (point))
3481 (term-vertical-motion scroll-needed)
3482 (delete-region save-top (point))
3483 (goto-char save-point)
3484 (term-vertical-motion down)
3485 (term-adjust-current-row-cache (- scroll-needed))
3486 (setq term-current-column nil)
3487 (term-insert-char ?\n scroll-needed))
3488 ((and (numberp term-pager-count)
3489 (< (setq term-pager-count (- term-pager-count down))
3490 0))
3491 (setq down 0)
3492 (term-process-pager))
3493 (t
3494 (term-adjust-current-row-cache (- scroll-needed))
3495 (term-vertical-motion scroll-needed)
3496 (set-marker term-home-marker (point))))
3497 (goto-char save-point)
3498 (set-marker save-point nil))))
3499 down)
3500
3501 (defun term-down (down &optional check-for-scroll)
3502 "Move down DOWN screen lines vertically."
3503 (let ((start-column (term-horizontal-column)))
3504 (if (and check-for-scroll (or term-scroll-with-delete term-pager-count))
3505 (setq down (term-handle-scroll down)))
3506 (term-adjust-current-row-cache down)
3507 (if (/= (point) (point-max))
3508 (setq down (- down (term-vertical-motion down))))
3509 ;; Extend buffer with extra blank lines if needed.
3510 (cond ((> down 0)
3511 (term-insert-char ?\n down)
3512 (setq term-current-column 0)
3513 (setq term-start-line-column 0))
3514 (t
3515 (setq term-current-column nil)
3516 (setq term-start-line-column (current-column))))
3517 (if start-column
3518 (term-move-columns start-column))))
3519
3520 ;; Assuming point is at the beginning of a screen line,
3521 ;; if the line above point wraps around, add a ?\n to undo the wrapping.
3522 ;; FIXME: Probably should be called more than it is.
3523 (defun term-unwrap-line ()
3524 (if (not (bolp)) (insert-before-markers ?\n)))
3525
3526 (defun term-erase-in-line (kind)
3527 (if (> kind 1) ;; erase left of point
3528 (let ((cols (term-horizontal-column)) (saved-point (point)))
3529 (term-vertical-motion 0)
3530 (delete-region (point) saved-point)
3531 (term-insert-char ?\n cols)))
3532 (if (not (eq kind 1)) ;; erase right of point
3533 (let ((saved-point (point))
3534 (wrapped (and (zerop (term-horizontal-column))
3535 (not (zerop (term-current-column))))))
3536 (term-vertical-motion 1)
3537 (delete-region saved-point (point))
3538 ;; wrapped is true if we're at the beginning of screen line,
3539 ;; but not a buffer line. If we delete the current screen line
3540 ;; that will make the previous line no longer wrap, and (because
3541 ;; of the way Emacs display works) point will be at the end of
3542 ;; the previous screen line rather then the beginning of the
3543 ;; current one. To avoid that, we make sure that current line
3544 ;; contain a space, to force the previous line to continue to wrap.
3545 ;; We could do this always, but it seems preferable to not add the
3546 ;; extra space when wrapped is false.
3547 (if wrapped
3548 (insert ? ))
3549 (insert ?\n)
3550 (put-text-property saved-point (point) 'face 'default)
3551 (goto-char saved-point))))
3552
3553 (defun term-erase-in-display (kind)
3554 "Erases (that is blanks out) part of the window.
3555 If KIND is 0, erase from (point) to (point-max);
3556 if KIND is 1, erase from home to point; else erase from home to point-max.
3557 Should only be called when point is at the start of a screen line."
3558 (term-handle-deferred-scroll)
3559 (cond ((eq term-terminal-parameter 0)
3560 (delete-region (point) (point-max))
3561 (term-unwrap-line))
3562 ((let ((row (term-current-row))
3563 (col (term-horizontal-column))
3564 (start-region term-home-marker)
3565 (end-region (if (eq kind 1) (point) (point-max))))
3566 (delete-region start-region end-region)
3567 (term-unwrap-line)
3568 (if (eq kind 1)
3569 (term-insert-char ?\n row))
3570 (setq term-current-column nil)
3571 (setq term-current-row nil)
3572 (term-goto row col)))))
3573
3574 (defun term-delete-chars (count)
3575 (let ((save-point (point)))
3576 (term-vertical-motion 1)
3577 (term-unwrap-line)
3578 (goto-char save-point)
3579 (move-to-column (+ (term-current-column) count) t)
3580 (delete-region save-point (point))))
3581
3582 ;;; Insert COUNT spaces after point, but do not change any of
3583 ;;; following screen lines. Hence we may have to delete characters
3584 ;;; at teh end of this screen line to make room.
3585
3586 (defun term-insert-spaces (count)
3587 (let ((save-point (point)) (save-eol))
3588 (term-vertical-motion 1)
3589 (if (bolp)
3590 (backward-char))
3591 (setq save-eol (point))
3592 (move-to-column (+ (term-start-line-column) (- term-width count)) t)
3593 (if (> save-eol (point))
3594 (delete-region (point) save-eol))
3595 (goto-char save-point)
3596 (term-insert-char ? count)
3597 (goto-char save-point)))
3598
3599 (defun term-delete-lines (lines)
3600 (let ((start (point))
3601 (save-current-column term-current-column)
3602 (save-start-line-column term-start-line-column)
3603 (save-current-row (term-current-row)))
3604 (term-down lines)
3605 (delete-region start (point))
3606 (term-down (- term-scroll-end save-current-row lines))
3607 (term-insert-char ?\n lines)
3608 (setq term-current-column save-current-column)
3609 (setq term-start-line-column save-start-line-column)
3610 (setq term-current-row save-current-row)
3611 (goto-char start)))
3612
3613 (defun term-insert-lines (lines)
3614 (let ((start (point))
3615 (start-deleted)
3616 (save-current-column term-current-column)
3617 (save-start-line-column term-start-line-column)
3618 (save-current-row (term-current-row)))
3619 (term-down (- term-scroll-end save-current-row lines))
3620 (setq start-deleted (point))
3621 (term-down lines)
3622 (delete-region start-deleted (point))
3623 (goto-char start)
3624 (setq term-current-column save-current-column)
3625 (setq term-start-line-column save-start-line-column)
3626 (setq term-current-row save-current-row)
3627 (term-insert-char ?\n lines)
3628 (goto-char start)))
3629 \f
3630 (defun term-set-output-log (name)
3631 "Record raw inferior process output in a buffer."
3632 (interactive (list (if term-log-buffer
3633 nil
3634 (read-buffer "Record output in buffer: "
3635 (format "%s output-log"
3636 (buffer-name (current-buffer)))
3637 nil))))
3638 (if (or (null name) (equal name ""))
3639 (progn (setq term-log-buffer nil)
3640 (message "Output logging off."))
3641 (if (get-buffer name)
3642 nil
3643 (save-excursion
3644 (set-buffer (get-buffer-create name))
3645 (fundamental-mode)
3646 (buffer-disable-undo (current-buffer))
3647 (erase-buffer)))
3648 (setq term-log-buffer (get-buffer name))
3649 (message "Recording terminal emulator output into buffer \"%s\""
3650 (buffer-name term-log-buffer))))
3651
3652 (defun term-stop-photo ()
3653 "Discontinue raw inferior process logging."
3654 (interactive)
3655 (term-set-output-log nil))
3656
3657 (defun term-show-maximum-output ()
3658 "Put the end of the buffer at the bottom of the window."
3659 (interactive)
3660 (goto-char (point-max))
3661 (recenter -1))
3662 \f
3663 ;;; Do the user's customisation...
3664
3665 (defvar term-load-hook nil
3666 "This hook is run when term is loaded in.
3667 This is a good place to put keybindings.")
3668
3669 (run-hooks 'term-load-hook)
3670
3671 \f
3672 ;;; Filename/command/history completion in a buffer
3673 ;;; ===========================================================================
3674 ;;; Useful completion functions, courtesy of the Ergo group.
3675
3676 ;;; Six commands:
3677 ;;; term-dynamic-complete Complete or expand command, filename,
3678 ;;; history at point.
3679 ;;; term-dynamic-complete-filename Complete filename at point.
3680 ;;; term-dynamic-list-filename-completions List completions in help buffer.
3681 ;;; term-replace-by-expanded-filename Expand and complete filename at point;
3682 ;;; replace with expanded/completed name.
3683 ;;; term-dynamic-simple-complete Complete stub given candidates.
3684
3685 ;;; These are not installed in the term-mode keymap. But they are
3686 ;;; available for people who want them. Shell-mode installs them:
3687 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
3688 ;;; (define-key shell-mode-map "\M-?"
3689 ;;; 'term-dynamic-list-filename-completions)))
3690 ;;;
3691 ;;; Commands like this are fine things to put in load hooks if you
3692 ;;; want them present in specific modes.
3693
3694 (defvar term-completion-autolist nil
3695 "*If non-nil, automatically list possibilities on partial completion.
3696 This mirrors the optional behavior of tcsh.")
3697
3698 (defvar term-completion-addsuffix t
3699 "*If non-nil, add a `/' to completed directories, ` ' to file names.
3700 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
3701 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact
3702 completion. This mirrors the optional behavior of tcsh.")
3703
3704 (defvar term-completion-recexact nil
3705 "*If non-nil, use shortest completion if characters cannot be added.
3706 This mirrors the optional behavior of tcsh.
3707
3708 A non-nil value is useful if `term-completion-autolist' is non-nil too.")
3709
3710 (defvar term-completion-fignore nil
3711 "*List of suffixes to be disregarded during file completion.
3712 This mirrors the optional behavior of bash and tcsh.
3713
3714 Note that this applies to `term-dynamic-complete-filename' only.")
3715
3716 (defvar term-file-name-prefix ""
3717 "Prefix prepended to absolute file names taken from process input.
3718 This is used by term's and shell's completion functions, and by shell's
3719 directory tracking functions.")
3720
3721
3722 (defun term-directory (directory)
3723 ;; Return expanded DIRECTORY, with `term-file-name-prefix' if absolute.
3724 (expand-file-name (if (file-name-absolute-p directory)
3725 (concat term-file-name-prefix directory)
3726 directory)))
3727
3728
3729 (defun term-word (word-chars)
3730 "Return the word of WORD-CHARS at point, or nil if non is found.
3731 Word constituents are considered to be those in WORD-CHARS, which is like the
3732 inside of a \"[...]\" (see `skip-chars-forward')."
3733 (save-excursion
3734 (let ((limit (point))
3735 (word (concat "[" word-chars "]"))
3736 (non-word (concat "[^" word-chars "]")))
3737 (if (re-search-backward non-word nil 'move)
3738 (forward-char 1))
3739 ;; Anchor the search forwards.
3740 (if (or (eolp) (looking-at non-word))
3741 nil
3742 (re-search-forward (concat word "+") limit)
3743 (buffer-substring (match-beginning 0) (match-end 0))))))
3744
3745
3746 (defun term-match-partial-filename ()
3747 "Return the filename at point, or nil if non is found.
3748 Environment variables are substituted. See `term-word'."
3749 (let ((filename (term-word "~/A-Za-z0-9+@:_.$#,={}-")))
3750 (and filename (substitute-in-file-name filename))))
3751
3752
3753 (defun term-dynamic-complete ()
3754 "Dynamically perform completion at point.
3755 Calls the functions in `term-dynamic-complete-functions' to perform
3756 completion until a function returns non-nil, at which point completion is
3757 assumed to have occurred."
3758 (interactive)
3759 (let ((functions term-dynamic-complete-functions))
3760 (while (and functions (null (funcall (car functions))))
3761 (setq functions (cdr functions)))))
3762
3763
3764 (defun term-dynamic-complete-filename ()
3765 "Dynamically complete the filename at point.
3766 Completes if after a filename. See `term-match-partial-filename' and
3767 `term-dynamic-complete-as-filename'.
3768 This function is similar to `term-replace-by-expanded-filename', except that
3769 it won't change parts of the filename already entered in the buffer; it just
3770 adds completion characters to the end of the filename. A completions listing
3771 may be shown in a help buffer if completion is ambiguous.
3772
3773 Completion is dependent on the value of `term-completion-addsuffix',
3774 `term-completion-recexact' and `term-completion-fignore', and the timing of
3775 completions listing is dependent on the value of `term-completion-autolist'.
3776
3777 Returns t if successful."
3778 (interactive)
3779 (if (term-match-partial-filename)
3780 (prog2 (or (eq (selected-window) (minibuffer-window))
3781 (message "Completing file name..."))
3782 (term-dynamic-complete-as-filename))))
3783
3784 (defun term-dynamic-complete-as-filename ()
3785 "Dynamically complete at point as a filename.
3786 See `term-dynamic-complete-filename'. Returns t if successful."
3787 (let* ((completion-ignore-case nil)
3788 (completion-ignored-extensions term-completion-fignore)
3789 (success t)
3790 (dirsuffix (cond ((not term-completion-addsuffix) "")
3791 ((not (consp term-completion-addsuffix)) "/")
3792 (t (car term-completion-addsuffix))))
3793 (filesuffix (cond ((not term-completion-addsuffix) "")
3794 ((not (consp term-completion-addsuffix)) " ")
3795 (t (cdr term-completion-addsuffix))))
3796 (filename (or (term-match-partial-filename) ""))
3797 (pathdir (file-name-directory filename))
3798 (pathnondir (file-name-nondirectory filename))
3799 (directory (if pathdir (term-directory pathdir) default-directory))
3800 (completion (file-name-completion pathnondir directory))
3801 (mini-flag (eq (selected-window) (minibuffer-window))))
3802 (cond ((null completion)
3803 (message "No completions of %s" filename)
3804 (setq success nil))
3805 ((eq completion t) ; Means already completed "file".
3806 (if term-completion-addsuffix (insert " "))
3807 (or mini-flag (message "Sole completion")))
3808 ((string-equal completion "") ; Means completion on "directory/".
3809 (term-dynamic-list-filename-completions))
3810 (t ; Completion string returned.
3811 (let ((file (concat (file-name-as-directory directory) completion)))
3812 (insert (substring (directory-file-name completion)
3813 (length pathnondir)))
3814 (cond ((symbolp (file-name-completion completion directory))
3815 ;; We inserted a unique completion.
3816 (insert (if (file-directory-p file) dirsuffix filesuffix))
3817 (or mini-flag (message "Completed")))
3818 ((and term-completion-recexact term-completion-addsuffix
3819 (string-equal pathnondir completion)
3820 (file-exists-p file))
3821 ;; It's not unique, but user wants shortest match.
3822 (insert (if (file-directory-p file) dirsuffix filesuffix))
3823 (or mini-flag (message "Completed shortest")))
3824 ((or term-completion-autolist
3825 (string-equal pathnondir completion))
3826 ;; It's not unique, list possible completions.
3827 (term-dynamic-list-filename-completions))
3828 (t
3829 (or mini-flag (message "Partially completed")))))))
3830 success))
3831
3832
3833 (defun term-replace-by-expanded-filename ()
3834 "Dynamically expand and complete the filename at point.
3835 Replace the filename with an expanded, canonicalised and completed replacement.
3836 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
3837 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
3838 removed, and the filename is made absolute instead of relative. For expansion
3839 see `expand-file-name' and `substitute-in-file-name'. For completion see
3840 `term-dynamic-complete-filename'."
3841 (interactive)
3842 (replace-match (expand-file-name (term-match-partial-filename)) t t)
3843 (term-dynamic-complete-filename))
3844
3845
3846 (defun term-dynamic-simple-complete (stub candidates)
3847 "Dynamically complete STUB from CANDIDATES list.
3848 This function inserts completion characters at point by completing STUB from
3849 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3850 if completion is ambiguous.
3851
3852 Returns nil if no completion was inserted.
3853 Returns `sole' if completed with the only completion match.
3854 Returns `shortest' if completed with the shortest of the completion matches.
3855 Returns `partial' if completed as far as possible with the completion matches.
3856 Returns `listed' if a completion listing was shown.
3857
3858 See also `term-dynamic-complete-filename'."
3859 (let* ((completion-ignore-case nil)
3860 (candidates (mapcar (function (lambda (x) (list x))) candidates))
3861 (completions (all-completions stub candidates)))
3862 (cond ((null completions)
3863 (message "No completions of %s" stub)
3864 nil)
3865 ((= 1 (length completions)) ; Gotcha!
3866 (let ((completion (car completions)))
3867 (if (string-equal completion stub)
3868 (message "Sole completion")
3869 (insert (substring completion (length stub)))
3870 (message "Completed"))
3871 (if term-completion-addsuffix (insert " "))
3872 'sole))
3873 (t ; There's no unique completion.
3874 (let ((completion (try-completion stub candidates)))
3875 ;; Insert the longest substring.
3876 (insert (substring completion (length stub)))
3877 (cond ((and term-completion-recexact term-completion-addsuffix
3878 (string-equal stub completion)
3879 (member completion completions))
3880 ;; It's not unique, but user wants shortest match.
3881 (insert " ")
3882 (message "Completed shortest")
3883 'shortest)
3884 ((or term-completion-autolist
3885 (string-equal stub completion))
3886 ;; It's not unique, list possible completions.
3887 (term-dynamic-list-completions completions)
3888 'listed)
3889 (t
3890 (message "Partially completed")
3891 'partial)))))))
3892
3893
3894 (defun term-dynamic-list-filename-completions ()
3895 "List in help buffer possible completions of the filename at point."
3896 (interactive)
3897 (let* ((completion-ignore-case nil)
3898 (filename (or (term-match-partial-filename) ""))
3899 (pathdir (file-name-directory filename))
3900 (pathnondir (file-name-nondirectory filename))
3901 (directory (if pathdir (term-directory pathdir) default-directory))
3902 (completions (file-name-all-completions pathnondir directory)))
3903 (if completions
3904 (term-dynamic-list-completions completions)
3905 (message "No completions of %s" filename))))
3906
3907
3908 (defun term-dynamic-list-completions (completions)
3909 "List in help buffer sorted COMPLETIONS.
3910 Typing SPC flushes the help buffer."
3911 (let ((conf (current-window-configuration)))
3912 (with-output-to-temp-buffer "*Completions*"
3913 (display-completion-list (sort completions 'string-lessp)))
3914 (message "Hit space to flush")
3915 (let (key first)
3916 (if (save-excursion
3917 (set-buffer (get-buffer "*Completions*"))
3918 (setq key (read-key-sequence nil)
3919 first (aref key 0))
3920 (and (consp first)
3921 (eq (window-buffer (posn-window (event-start first)))
3922 (get-buffer "*Completions*"))
3923 (eq (key-binding key) 'mouse-choose-completion)))
3924 ;; If the user does mouse-choose-completion with the mouse,
3925 ;; execute the command, then delete the completion window.
3926 (progn
3927 (mouse-choose-completion first)
3928 (set-window-configuration conf))
3929 (if (eq first ?\ )
3930 (set-window-configuration conf)
3931 (setq unread-command-events (listify-key-sequence key)))))))
3932
3933 ;;; I need a make-term that doesn't surround with *s -mm
3934 (defun term-ansi-make-term (name program &optional startfile &rest switches)
3935 "Make a term process NAME in a buffer, running PROGRAM.
3936 The name of the buffer is NAME.
3937 If there is already a running process in that buffer, it is not restarted.
3938 Optional third arg STARTFILE is the name of a file to send the contents of to
3939 the process. Any more args are arguments to PROGRAM."
3940 (let ((buffer (get-buffer-create name )))
3941 ;; If no process, or nuked process, crank up a new one and put buffer in
3942 ;; term mode. Otherwise, leave buffer and existing process alone.
3943 (cond ((not (term-check-proc buffer))
3944 (save-excursion
3945 (set-buffer buffer)
3946 (term-mode)) ; Install local vars, mode, keymap, ...
3947 (term-exec buffer name program startfile switches)))
3948 buffer))
3949
3950 (defvar term-ansi-buffer-name nil)
3951 (defvar term-ansi-default-program nil)
3952 (defvar term-ansi-buffer-base-name nil)
3953
3954 ;;;###autoload
3955 (defun ansi-term (program &optional new-buffer-name)
3956 "Start a terminal-emulator in a new buffer."
3957 (interactive (list (read-from-minibuffer "Run program: "
3958 (or explicit-shell-file-name
3959 (getenv "ESHELL")
3960 (getenv "SHELL")
3961 "/bin/sh"))))
3962
3963 ;; Pick the name of the new buffer.
3964 (setq term-ansi-buffer-name
3965 (if new-buffer-name
3966 new-buffer-name
3967 (if term-ansi-buffer-base-name
3968 (if (eq term-ansi-buffer-base-name t)
3969 (file-name-nondirectory program)
3970 term-ansi-buffer-base-name)
3971 "ansi-term")))
3972
3973 (setq term-ansi-buffer-name (concat "*" term-ansi-buffer-name "*"))
3974
3975 ;; In order to have more than one term active at a time
3976 ;; I'd like to have the term names have the *term-ansi-term<?>* form,
3977 ;; for now they have the *term-ansi-term*<?> form but we'll see...
3978
3979 (setq term-ansi-buffer-name (generate-new-buffer-name term-ansi-buffer-name))
3980 (setq term-ansi-buffer-name (term-ansi-make-term term-ansi-buffer-name program))
3981
3982 (set-buffer term-ansi-buffer-name)
3983 (term-mode)
3984 (term-char-mode)
3985
3986 ;; I wanna have find-file on C-x C-f -mm
3987 ;; your mileage may definitely vary, maybe it's better to put this in your
3988 ;; .emacs ...
3989
3990 (term-set-escape-char ?\C-x)
3991
3992 (switch-to-buffer term-ansi-buffer-name))
3993
3994 \f
3995 ;;; Converting process modes to use term mode
3996 ;;; ===========================================================================
3997 ;;; Renaming variables
3998 ;;; Most of the work is renaming variables and functions. These are the common
3999 ;;; ones:
4000 ;;; Local variables:
4001 ;;; last-input-start term-last-input-start
4002 ;;; last-input-end term-last-input-end
4003 ;;; shell-prompt-pattern term-prompt-regexp
4004 ;;; shell-set-directory-error-hook <no equivalent>
4005 ;;; Miscellaneous:
4006 ;;; shell-set-directory <unnecessary>
4007 ;;; shell-mode-map term-mode-map
4008 ;;; Commands:
4009 ;;; shell-send-input term-send-input
4010 ;;; shell-send-eof term-delchar-or-maybe-eof
4011 ;;; kill-shell-input term-kill-input
4012 ;;; interrupt-shell-subjob term-interrupt-subjob
4013 ;;; stop-shell-subjob term-stop-subjob
4014 ;;; quit-shell-subjob term-quit-subjob
4015 ;;; kill-shell-subjob term-kill-subjob
4016 ;;; kill-output-from-shell term-kill-output
4017 ;;; show-output-from-shell term-show-output
4018 ;;; copy-last-shell-input Use term-previous-input/term-next-input
4019 ;;;
4020 ;;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
4021 ;;; SHELL-DIRECTORY-TRACKER, the shell mode's term-input-filter-functions.
4022 ;;; Term mode does not provide functionality equivalent to
4023 ;;; shell-set-directory-error-hook; it is gone.
4024 ;;;
4025 ;;; term-last-input-start is provided for modes which want to munge
4026 ;;; the buffer after input is sent, perhaps because the inferior
4027 ;;; insists on echoing the input. The LAST-INPUT-START variable in
4028 ;;; the old shell package was used to implement a history mechanism,
4029 ;;; but you should think twice before using term-last-input-start
4030 ;;; for this; the input history ring often does the job better.
4031 ;;;
4032 ;;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
4033 ;;; *not* create the term-mode local variables in your foo-mode function.
4034 ;;; This is not modular. Instead, call term-mode, and let *it* create the
4035 ;;; necessary term-specific local variables. Then create the
4036 ;;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
4037 ;;; be foo-mode-map, and its mode to be foo-mode. Set the term-mode hooks
4038 ;;; (term-{prompt-regexp, input-filter, input-filter-functions,
4039 ;;; get-old-input) that need to be different from the defaults. Call
4040 ;;; foo-mode-hook, and you're done. Don't run the term-mode hook yourself;
4041 ;;; term-mode will take care of it. The following example, from shell.el,
4042 ;;; is typical:
4043 ;;;
4044 ;;; (defvar shell-mode-map '())
4045 ;;; (cond ((not shell-mode-map)
4046 ;;; (setq shell-mode-map (copy-keymap term-mode-map))
4047 ;;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
4048 ;;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
4049 ;;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
4050 ;;; (define-key shell-mode-map "\M-?"
4051 ;;; 'term-dynamic-list-filename-completions)))
4052 ;;;
4053 ;;; (defun shell-mode ()
4054 ;;; (interactive)
4055 ;;; (term-mode)
4056 ;;; (setq term-prompt-regexp shell-prompt-pattern)
4057 ;;; (setq major-mode 'shell-mode)
4058 ;;; (setq mode-name "Shell")
4059 ;;; (use-local-map shell-mode-map)
4060 ;;; (make-local-variable 'shell-directory-stack)
4061 ;;; (setq shell-directory-stack nil)
4062 ;;; (add-hook 'term-input-filter-functions 'shell-directory-tracker)
4063 ;;; (run-hooks 'shell-mode-hook))
4064 ;;;
4065 ;;;
4066 ;;; Completion for term-mode users
4067 ;;;
4068 ;;; For modes that use term-mode, term-dynamic-complete-functions is the
4069 ;;; hook to add completion functions to. Functions on this list should return
4070 ;;; non-nil if completion occurs (i.e., further completion should not occur).
4071 ;;; You could use term-dynamic-simple-complete to do the bulk of the
4072 ;;; completion job.
4073 \f
4074 (provide 'term)
4075
4076 ;;; arch-tag: eee16bc8-2cd7-4147-9534-a5694752f716
4077 ;;; term.el ends here