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