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