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