| blob | d7db23a0f9b684c1dbc37868428ad7d62a26adb6 |
1 ;;; em-smart --- smart display of output
3 ;; Copyright (C) 1999, 2000 Free Software Foundation
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
10 ;; any later version.
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
27 "This module combines the facility of normal, modern shells with
28 some of the edit/review concepts inherent in the design of Plan 9's
29 9term. See the docs for more details.
31 Most likely you will have to turn this option on and play around with
32 it to get a real sense of how it works."
37 ;;; Commentary:
39 ;; The best way to get a sense of what this code is trying to do is by
40 ;; using it. Basically, the philosophy represents a blend between the
41 ;; ease of use of modern day shells, and the review-before-you-proceed
42 ;; mentality of Plan 9's 9term.
43 ;;
44 ;; @ When you invoke a command, it is assumed that you want to read
45 ;; the output of that command.
46 ;;
47 ;; @ If the output is not what you wanted, it is assumed that you will
48 ;; want to edit, and then resubmit a refined version of that
49 ;; command.
50 ;;
51 ;; @ If the output is valid, pressing any self-inserting character key
52 ;; will jump to end of the buffer and insert that character, in
53 ;; order to begin entry of a new command.
54 ;;
55 ;; @ If you show an intention to edit the previous command -- by
56 ;; moving around within it -- then the next self-inserting
57 ;; characters will insert *there*, instead of at the bottom of the
58 ;; buffer.
59 ;;
60 ;; @ If you show an intention to review old commands, such as M-p or
61 ;; M-r, point will jump to the bottom of the buffer before invoking
62 ;; that command.
63 ;;
64 ;; @ If none of the above has happened yet (i.e., your point is just
65 ;; sitting on the previous command), you can use SPACE and BACKSPACE
66 ;; (or DELETE) to page forward and backward *through the output of
67 ;; the last command only*. It will constrain the movement of the
68 ;; point and window so that the maximum amount of output is always
69 ;; displayed at all times.
70 ;;
71 ;; @ While output is being generated from a command, the window will
72 ;; be constantly reconfigured (until it would otherwise make no
73 ;; difference) in order to always show you the most output from the
74 ;; command possible. This happens if you change window sizes,
75 ;; scroll, etc.
76 ;;
77 ;; @ Like I said, it's not really comprehensible until you try it! ;)
79 ;;; User Variables:
82 "*A list of functions to call when loading `eshell-smart'."
92 "*A hook that gets run when `eshell-smart' is unloaded."
97 "*If t, always review commands.
98 Reviewing means keeping point on the text of the command that was just
99 invoked, to allow corrections to be made easily.
101 If set to nil, quick commands won't be reviewed. A quick command is a
102 command that produces no output, and exits successfully.
106 that output can be presented in its entirely in the Eshell window."
110 not-even-short-output))
115 mouse-yank-at-click
116 mouse-yank-secondary
117 yank-pop
118 yank-rectangle
119 yank)
120 "*A list of commands which cause Eshell to jump to the end of buffer."
125 "*If non-nil, space will go to end of buffer when point-max is visible.
126 That is, if a command is running and the user presses SPACE at a time
127 when the end of the buffer is visible, point will go to the end of the
128 buffer and smart-display will be turned off (that is, subsequently
129 pressing backspace will not cause the buffer to scroll down).
131 This feature is provided to make it very easy to watch the output of a
132 long-running command, such as make, where it's more desirable to see
133 the output go by than to review it afterward.
135 Setting this variable to nil means that space and backspace will
136 always have a consistent behavior, which is to move back and forth
137 through displayed output. But it also means that enabling output
138 tracking requires the user to manually move point to the end of the
144 "*This variable indicates where point should jump to after a command.
145 The options are `begin', `after' or `end'."
151 ;;; Internal Variables:
156 ;;; Functions:
159 "Setup Eshell smart display."
161 ;; override a few variables, since they would interfere with the
162 ;; smart display functionality.
195 "Scroll the given Eshell window accordingly."
205 "Refresh all visible Eshell buffers."
221 "Set the point to somewhere in the beginning of the last command."
239 "Disable smart display mode if the buffer changes in any way."
245 "Jump to the end of the input buffer.
246 This is done whenever a command exits sucessfully and both the command
247 and the end of the buffer are still visible."
258 "Display as much output as possible, smartly."
277 "Like `end-of-buffer', but do not push a mark."
282 "Handle self-inserting or movement commands intelligently."
293 eshell-current-command)
321 ;;; Code:
323 ;;; em-smart.el ends here