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