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