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