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