| blob | fe9e477594c051ccc25c203cc71e09d84022640e |
1 ;;; em-smart.el --- smart display of output -*- lexical-binding:t -*-
3 ;; Copyright (C) 1999-2016 Free Software Foundation, Inc.
5 ;; Author: John Wiegley <johnw@gnu.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22 ;;; Commentary:
24 ;; The best way to get a sense of what this code is trying to do is by
25 ;; using it. Basically, the philosophy represents a blend between the
26 ;; ease of use of modern day shells, and the review-before-you-proceed
27 ;; mentality of Plan 9's 9term.
28 ;;
29 ;; @ When you invoke a command, it is assumed that you want to read
30 ;; the output of that command.
31 ;;
32 ;; @ If the output is not what you wanted, it is assumed that you will
33 ;; want to edit, and then resubmit a refined version of that
34 ;; command.
35 ;;
36 ;; @ If the output is valid, pressing any self-inserting character key
37 ;; will jump to end of the buffer and insert that character, in
38 ;; order to begin entry of a new command.
39 ;;
40 ;; @ If you show an intention to edit the previous command -- by
41 ;; moving around within it -- then the next self-inserting
42 ;; characters will insert *there*, instead of at the bottom of the
43 ;; buffer.
44 ;;
45 ;; @ If you show an intention to review old commands, such as M-p or
46 ;; M-r, point will jump to the bottom of the buffer before invoking
47 ;; that command.
48 ;;
49 ;; @ If none of the above has happened yet (i.e., your point is just
50 ;; sitting on the previous command), you can use SPACE and BACKSPACE
51 ;; (or DELETE) to page forward and backward *through the output of
52 ;; the last command only*. It will constrain the movement of the
53 ;; point and window so that the maximum amount of output is always
54 ;; displayed at all times.
55 ;;
56 ;; @ While output is being generated from a command, the window will
57 ;; be constantly reconfigured (until it would otherwise make no
58 ;; difference) in order to always show you the most output from the
59 ;; command possible. This happens if you change window sizes,
60 ;; scroll, etc.
61 ;;
62 ;; @ Like I said, it's not really comprehensible until you try it! ;)
63 ;;
64 ;; One disadvantage of this module is that it increases Eshell's
65 ;; memory consumption by a factor of two or more. With small commands
66 ;; (such as pwd), where the screen is mostly full, consumption can
67 ;; increase by orders of magnitude.
69 ;;; Code:
74 ;;;###autoload
77 "This module combines the facility of normal, modern shells with
78 some of the edit/review concepts inherent in the design of Plan 9's
79 9term. See the docs for more details.
81 Most likely you will have to turn this option on and play around with
82 it to get a real sense of how it works."
84 ;; :link '(info-link "(eshell)Smart display of output")
87 ;;; User Variables:
90 "A list of functions to call when loading `eshell-smart'."
101 "A hook that gets run when `eshell-smart' is unloaded."
106 "If t, always review commands.
107 Reviewing means keeping point on the text of the command that was just
108 invoked, to allow corrections to be made easily.
110 If set to nil, quick commands won't be reviewed. A quick command is a
111 command that produces no output, and exits successfully.
115 only if that output can be presented in its entirely in the Eshell window."
119 not-even-short-output))
124 mouse-yank-at-click
125 mouse-yank-primary
126 mouse-yank-secondary
127 yank-pop
128 yank-rectangle
129 yank)
130 "A list of commands which cause Eshell to jump to the end of buffer."
135 "If non-nil, space will go to end of buffer when point-max is visible.
136 That is, if a command is running and the user presses SPACE at a time
137 when the end of the buffer is visible, point will go to the end of the
138 buffer and smart-display will be turned off (that is, subsequently
139 pressing backspace will not cause the buffer to scroll down).
141 This feature is provided to make it very easy to watch the output of a
142 long-running command, such as make, where it's more desirable to see
143 the output go by than to review it afterward.
145 Setting this variable to nil means that space and backspace will
146 always have a consistent behavior, which is to move back and forth
147 through displayed output. But it also means that enabling output
148 tracking requires the user to manually move point to the end of the
154 "This variable indicates where point should jump to after a command.
155 The options are `begin', `after' or `end'."
161 ;;; Internal Variables:
167 ;;; Functions:
170 "Setup Eshell smart display."
172 ;; override a few variables, since they would interfere with the
173 ;; smart display functionality.
192 t t)
198 ;; This is called by window-scroll-functions with two arguments.
200 "Scroll the given Eshell window accordingly."
208 "Refresh all visible Eshell buffers."
224 "Set the point to somewhere in the beginning of the last command."
241 ;; Called from after-change-functions with 3 arguments.
243 "Disable smart display mode if the buffer changes in any way."
249 "Jump to the end of the input buffer.
250 This is done whenever a command exits successfully and both the command
251 and the end of the buffer are still visible."
262 "Display as much output as possible, smartly."
266 ;; trigger the redisplay now, so that we catch any attempted
267 ;; point motion; this is to cover for a redisplay bug
285 "Like `end-of-buffer', but do not push a mark."
290 "Handle self-inserting or movement commands intelligently."
301 eshell-current-command)
331 ;; Local Variables:
332 ;; generated-autoload-file: "esh-groups.el"
333 ;; End:
335 ;;; em-smart.el ends here