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