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