Commit | Line | Data |
---|---|---|
813f532d RS |
1 | ;;; rsz-mini.el --- dynamically resize minibuffer to display entire contents |
2 | ||
2ca4ad7e | 3 | ;; Copyright (C) 1990, 1993, 1994, 1995 Free Software Foundation, Inc. |
813f532d | 4 | |
2ca4ad7e NF |
5 | ;; Author: Noah Friedman <friedman@prep.ai.mit.edu> |
6 | ;; Roland McGrath <roland@prep.ai.mit.edu> | |
7 | ;; Maintainer: friedman@prep.ai.mit.edu | |
8 | ;; Keywords: minibuffer, window, frame, display | |
9 | ;; Status: Known to work in FSF GNU Emacs 19.26 and later. | |
04752ffb | 10 | ;; $Id: rsz-mini.el,v 1.8 1995/04/08 08:22:07 friedman Exp rms $ |
813f532d RS |
11 | |
12 | ;; This file is part of GNU Emacs. | |
13 | ||
14 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
15 | ;; it under the terms of the GNU General Public License as published by | |
16 | ;; the Free Software Foundation; either version 2, or (at your option) | |
17 | ;; any later version. | |
18 | ||
19 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | ;; GNU General Public License for more details. | |
23 | ||
24 | ;; You should have received a copy of the GNU General Public License | |
25 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
26 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
27 | ||
28 | ;;; Commentary: | |
29 | ||
2ca4ad7e NF |
30 | ;; This package allows the entire contents (or as much as possible) of the |
31 | ;; minibuffer to be visible at once when typing. As the end of a line is | |
32 | ;; reached, the minibuffer will resize itself. When the user is done | |
33 | ;; typing, the minibuffer will return to its original size. | |
34 | ||
35 | ;; In window systems where it is possible to have a frame in which the | |
36 | ;; minibuffer is the only window, the frame itself can be resized. In FSF | |
37 | ;; GNU Emacs 19.22 and earlier, the frame may not be properly returned to | |
38 | ;; its original size after it ceases to be active because | |
39 | ;; `minibuffer-exit-hook' didn't exist until version 19.23. | |
40 | ;; | |
41 | ;; Prior to Emacs 19.26, minibuffer-exit-hook wasn't called after exiting | |
42 | ;; from the minibuffer by hitting the quit char. That meant that the | |
43 | ;; frame size restoration function wasn't being called in that case. In | |
44 | ;; 19.26 or later, minibuffer-exit-hook should be called anyway. | |
45 | ||
46 | ;; Note that the minibuffer and echo area are not the same! They simply | |
47 | ;; happen to occupy roughly the same place on the frame. Messages put in | |
48 | ;; the echo area will not cause any resizing by this package. | |
49 | ||
50 | ;; This package is considered a minor mode but it doesn't put anything in | |
51 | ;; minor-mode-alist because this mode is specific to the minibuffer, which | |
52 | ;; has no mode line. | |
53 | ||
54 | ;; To use this package, put the following in your .emacs: | |
55 | ;; | |
56 | ;; (autoload 'resize-minibuffer-mode "rsz-mini" nil t) | |
57 | ;; | |
58 | ;; Invoking the command `resize-minibuffer-mode' will then enable this mode. | |
59 | ;; Simply loading this file will also enable it. | |
813f532d RS |
60 | |
61 | ;;; Code: | |
62 | ||
63 | \f | |
64 | ;;;###autoload | |
65 | (defvar resize-minibuffer-mode nil | |
66 | "*If non-`nil', resize the minibuffer so its entire contents are visible.") | |
67 | ||
68 | ;;;###autoload | |
69 | (defvar resize-minibuffer-window-max-height nil | |
70 | "*Maximum size the minibuffer window is allowed to become. | |
71 | If less than 1 or not a number, the limit is the height of the frame in | |
72 | which the active minibuffer window resides.") | |
73 | ||
74 | ;;;###autoload | |
75 | (defvar resize-minibuffer-window-exactly t | |
cb7217a7 NF |
76 | "*Allow making minibuffer exactly the size to display all its contents. |
77 | If `nil', the minibuffer window can temporarily increase in size but | |
78 | never get smaller while it is active. Any other value allows exact | |
79 | resizing.") | |
813f532d | 80 | |
813f532d RS |
81 | ;;;###autoload |
82 | (defvar resize-minibuffer-frame nil | |
cb7217a7 NF |
83 | "*Allow changing the frame height of minibuffer frames. |
84 | If non-`nil' and the active minibuffer is the sole window in its frame, | |
85 | allow changing the frame height.") | |
813f532d RS |
86 | |
87 | ;;;###autoload | |
88 | (defvar resize-minibuffer-frame-max-height nil | |
89 | "*Maximum size the minibuffer frame is allowed to become. | |
90 | If less than 1 or not a number, there is no limit.") | |
91 | ||
92 | ;;;###autoload | |
cb7217a7 NF |
93 | (defvar resize-minibuffer-frame-exactly t |
94 | "*Allow making minibuffer frame exactly the size to display all its contents. | |
95 | If `nil', the minibuffer frame can temporarily increase in size but | |
96 | never get smaller while it is active. Any other value allows exact | |
97 | resizing.") | |
98 | ||
99 | ;; Variable used to store the height of the minibuffer frame | |
100 | ;; on entry, so it can be restored on exit. It is made local before it is | |
101 | ;; modified. Do not use it yourself. | |
102 | (defvar resize-minibuffer-frame-original-height nil) | |
813f532d RS |
103 | |
104 | \f | |
105 | ;;;###autoload | |
106 | (defun resize-minibuffer-mode (&optional prefix) | |
107 | "Enable or disable resize-minibuffer mode. | |
108 | A negative prefix argument disables this mode. A positive argument or | |
109 | argument of 0 enables it. | |
110 | ||
111 | When this minor mode is enabled, the minibuffer is dynamically resized to | |
112 | contain the entire region of text put in it as you type. | |
113 | ||
114 | The variable `resize-minibuffer-mode' is set to t or nil depending on | |
115 | whether this mode is active or not. | |
116 | ||
117 | The maximum height to which the minibuffer can grow is controlled by the | |
118 | variable `resize-minibuffer-window-max-height'. | |
119 | ||
120 | The variable `resize-minibuffer-window-exactly' determines whether the | |
121 | minibuffer window should ever be shrunk to make it no larger than needed to | |
122 | display its contents. | |
123 | ||
54059149 | 124 | When using a window system, it is possible for a minibuffer to be the sole |
813f532d RS |
125 | window in a frame. Since that window is already its maximum size, the only |
126 | way to make more text visible at once is to increase the size of the frame. | |
127 | The variable `resize-minibuffer-frame' controls whether this should be | |
128 | done. The variables `resize-minibuffer-frame-max-height' and | |
129 | `resize-minibuffer-frame-exactly' are analogous to their window | |
130 | counterparts." | |
131 | (interactive "p") | |
132 | (or prefix (setq prefix 0)) | |
133 | (cond | |
134 | ((>= prefix 0) | |
135 | (setq resize-minibuffer-mode t)) | |
136 | (t | |
137 | (setq resize-minibuffer-mode nil)))) | |
138 | ||
139 | (defun resize-minibuffer-setup () | |
140 | (cond | |
141 | (resize-minibuffer-mode | |
142 | (cond | |
143 | ((and window-system | |
144 | (eq 'only (cdr (assq 'minibuffer (frame-parameters))))) | |
bab863c3 NF |
145 | ;; Checking for resize-minibuffer-frame is done outside the cond |
146 | ;; predicate because that should always be t if this is a minibuffer | |
147 | ;; frame; it just shouldn't do anything if this flag is nil. | |
813f532d RS |
148 | (and resize-minibuffer-frame |
149 | (progn | |
bab863c3 NF |
150 | ;; Can't trust the height stored in minibuffer-frame-alist |
151 | ;; since the frame can be resized by the window manager and | |
152 | ;; that variable isn't updated. | |
cb7217a7 NF |
153 | (make-local-variable 'resize-minibuffer-frame-original-height) |
154 | (setq resize-minibuffer-frame-original-height (frame-height)) | |
bab863c3 | 155 | |
04752ffb RS |
156 | (make-local-hook 'post-command-hook) |
157 | (add-hook 'post-command-hook 'resize-minibuffer-frame 'append t) | |
bab863c3 | 158 | |
04752ffb RS |
159 | (make-local-hook 'minibuffer-exit-hook) |
160 | (add-hook 'minibuffer-exit-hook 'resize-minibuffer-frame-restore | |
161 | nil t) | |
bab863c3 NF |
162 | |
163 | (resize-minibuffer-frame)))) | |
813f532d RS |
164 | (t |
165 | (make-local-variable 'post-command-hook) | |
bab863c3 NF |
166 | ;; Copy this because add-hook modifies the list structure. |
167 | (setq post-command-hook (copy-sequence post-command-hook)) | |
cb7217a7 | 168 | (add-hook 'post-command-hook 'resize-minibuffer-window 'append) |
bab863c3 | 169 | |
cb7217a7 | 170 | (make-local-variable 'minibuffer-exit-hook) |
bab863c3 NF |
171 | (add-hook 'minibuffer-exit-hook 'resize-minibuffer-window-restore) |
172 | ||
173 | (resize-minibuffer-window)))))) | |
813f532d RS |
174 | |
175 | (defun resize-minibuffer-count-window-lines (&optional start end) | |
176 | "Return number of window lines occupied by text in region. | |
177 | The number of window lines may be greater than the number of actual lines | |
178 | in the buffer if any wrap on the display due to their length. | |
179 | ||
180 | Optional arguments START and END default to point-min and point-max, | |
181 | respectively." | |
182 | (or start (setq start (point-min))) | |
183 | (or end (setq end (point-max))) | |
184 | (if (= start end) | |
185 | 0 | |
186 | (save-excursion | |
187 | (save-restriction | |
188 | (widen) | |
189 | (narrow-to-region start end) | |
190 | (goto-char start) | |
191 | (vertical-motion (buffer-size)))))) | |
192 | ||
193 | \f | |
194 | ;; Resize the minibuffer window to contain the minibuffer's contents. | |
813f532d | 195 | (defun resize-minibuffer-window () |
2ca4ad7e NF |
196 | (and (eq (selected-window) (minibuffer-window)) |
197 | (let ((height (window-height)) | |
198 | (lines (1+ (resize-minibuffer-count-window-lines)))) | |
199 | (and (numberp resize-minibuffer-window-max-height) | |
200 | (> resize-minibuffer-window-max-height 0) | |
201 | (setq lines (min lines resize-minibuffer-window-max-height))) | |
202 | (or (if resize-minibuffer-window-exactly | |
203 | (= lines height) | |
204 | (<= lines height)) | |
205 | (enlarge-window (- lines height)))))) | |
813f532d | 206 | |
cb7217a7 NF |
207 | ;; This resizes the minibuffer back to one line as soon as it is exited |
208 | ;; (e.g. when the user hits RET). This way, subsequent messages put in the | |
209 | ;; echo area aren't cluttered with leftover minibuffer text. | |
210 | ;; It should be called by minibuffer-exit-hook. | |
211 | ;; | |
212 | ;; Note that because it calls sit-for to force a screen update, strange | |
213 | ;; things may happen in the minibuffer, such as unexpanded partial | |
214 | ;; completions by complete.el showing their completion. | |
215 | ;; If this bothers you, just redefine this function to do nothing, in, say, | |
216 | ;; your after-load-alist. Perhaps there should be an option variable, | |
217 | ;; but I don't know if there's really any demand for it. | |
218 | ;; (Clobbering this definition is harmless because eventually emacs restores | |
219 | ;; its idea of the minibuffer window size when the minibuffer isn't in use | |
220 | ;; anyway; this is just a kludge because of the timing for that update). | |
221 | (defun resize-minibuffer-window-restore () | |
ee50a528 | 222 | (cond |
2ca4ad7e | 223 | ((not (eq (minibuffer-window) (selected-window)))) |
ee50a528 NF |
224 | ((> (window-height) 1) |
225 | (enlarge-window (- 1 (window-height))) | |
226 | (sit-for 0)))) | |
cb7217a7 | 227 | |
813f532d RS |
228 | \f |
229 | ;; Resize the minibuffer frame to contain the minibuffer's contents. | |
230 | ;; The minibuffer frame must be the current frame. | |
231 | (defun resize-minibuffer-frame () | |
232 | (let ((height (frame-height)) | |
233 | (lines (1+ (resize-minibuffer-count-window-lines)))) | |
234 | (and (numberp resize-minibuffer-frame-max-height) | |
235 | (> resize-minibuffer-frame-max-height 0) | |
236 | (setq lines (min lines resize-minibuffer-frame-max-height))) | |
237 | (cond | |
238 | ((> lines height) | |
239 | (set-frame-size (selected-frame) (frame-width) lines)) | |
240 | ((and resize-minibuffer-frame-exactly | |
cb7217a7 | 241 | (> height resize-minibuffer-frame-original-height) |
813f532d RS |
242 | (< lines height)) |
243 | (set-frame-size (selected-frame) (frame-width) lines))))) | |
244 | ||
245 | ;; Restore the original height of the frame. | |
cb7217a7 NF |
246 | ;; resize-minibuffer-frame-original-height is set in |
247 | ;; resize-minibuffer-setup. | |
813f532d RS |
248 | (defun resize-minibuffer-frame-restore () |
249 | (set-frame-size (selected-frame) | |
250 | (frame-width) | |
cb7217a7 | 251 | resize-minibuffer-frame-original-height)) |
813f532d RS |
252 | |
253 | \f | |
254 | (provide 'rsz-mini) | |
255 | ||
256 | (add-hook 'minibuffer-setup-hook 'resize-minibuffer-setup) | |
dfe893a0 | 257 | (resize-minibuffer-mode) |
813f532d RS |
258 | |
259 | ;; rsz-mini.el ends here |