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