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