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