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