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