lisp/term.el

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