window.el 15.3 KB
Newer Older
1
;;; window.el --- GNU Emacs window commands aside from those written in C.
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3 4
;; Copyright (C) 1985, 1989, 1992, 1993, 1994, 2000
;;  Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6 7
;; Maintainer: FSF

Joseph Arceneaux's avatar
Joseph Arceneaux committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
26

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
;;;; Window tree functions.

(defun one-window-p (&optional nomini all-frames)
  "Returns non-nil if the selected window is the only window (in its frame).
Optional arg NOMINI non-nil means don't count the minibuffer
even if it is active.

The optional arg ALL-FRAMES t means count windows on all frames.
If it is `visible', count windows on all visible frames.
ALL-FRAMES nil or omitted means count only the selected frame, 
plus the minibuffer it uses (which may be on another frame).
If ALL-FRAMES is neither nil nor t, count only the selected frame."
  (let ((base-window (selected-window)))
    (if (and nomini (eq base-window (minibuffer-window)))
	(setq base-window (next-window base-window)))
    (eq base-window
	(next-window base-window (if nomini 'arg) all-frames))))

(defun walk-windows (proc &optional minibuf all-frames)
  "Cycle through all visible windows, calling PROC for each one.
PROC is called with a window as argument.

Optional second arg MINIBUF t means count the minibuffer window even
if not active.  MINIBUF nil or omitted means count the minibuffer iff
it is active.  MINIBUF neither t nor nil means not to count the
minibuffer even if it is active.

Several frames may share a single minibuffer; if the minibuffer
counts, all windows on all frames that share that minibuffer count
Richard M. Stallman's avatar
Richard M. Stallman committed
56 57
too.  Therefore, if you are using a separate minibuffer frame
and the minibuffer is active and MINIBUF says it counts,
58
`walk-windows' includes the windows in the frame from which you
Richard M. Stallman's avatar
Richard M. Stallman committed
59
entered the minibuffer, as well as the minibuffer window.
60

Richard M. Stallman's avatar
Richard M. Stallman committed
61 62 63
ALL-FRAMES is the optional third argument.
ALL-FRAMES nil or omitted means cycle within the frames as specified above.
ALL-FRAMES = `visible' means include windows on all visible frames.
64
ALL-FRAMES = 0 means include windows on all visible and iconified frames.
Richard M. Stallman's avatar
Richard M. Stallman committed
65
ALL-FRAMES = t means include windows on all frames including invisible frames.
66
If ALL-FRAMES is a frame, it means include windows on that frame.
Richard M. Stallman's avatar
Richard M. Stallman committed
67
Anything else means restrict to the selected frame."
68 69 70
  ;; If we start from the minibuffer window, don't fail to come back to it.
  (if (window-minibuffer-p (selected-window))
      (setq minibuf t))
71 72 73 74 75 76 77 78 79 80
  (save-selected-window
    (if (framep all-frames)
	(select-window (frame-first-window all-frames)))
    (let* ((walk-windows-start (selected-window))
	   (walk-windows-current walk-windows-start))
      (while (progn
	       (setq walk-windows-current
		     (next-window walk-windows-current minibuf all-frames))
	       (funcall proc walk-windows-current)
	       (not (eq walk-windows-current walk-windows-start)))))))
81 82 83

(defun minibuffer-window-active-p (window)
  "Return t if WINDOW (a minibuffer window) is now active."
84
  (eq window (active-minibuffer-window)))
85 86 87 88 89 90 91 92

(defmacro save-selected-window (&rest body)
  "Execute BODY, then select the window that was selected before BODY."
  (list 'let
	'((save-selected-window-window (selected-window)))
	(list 'unwind-protect
	      (cons 'progn body)
	      (list 'select-window 'save-selected-window-window)))) 
93

Joseph Arceneaux's avatar
Joseph Arceneaux committed
94 95
(defun count-windows (&optional minibuf)
   "Returns the number of visible windows.
96 97 98
This counts the windows in the selected frame and (if the minibuffer is
to be counted) its minibuffer frame (if that's not the same frame).
The optional arg MINIBUF non-nil means count the minibuffer
Karl Heuer's avatar
Karl Heuer committed
99
even if it is inactive."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
100
   (let ((count 0))
101
     (walk-windows (function (lambda (w)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
102 103 104 105 106
			       (setq count (+ count 1))))
		   minibuf)
     count))

(defun balance-windows ()
107
  "Makes all visible windows the same height (approximately)."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
108
  (interactive)
109 110 111 112
  (let ((count -1) levels newsizes size
	;; Don't count the lines that are above the uppermost windows.
	;; (These are the menu bar lines, if any.)
	(mbl (nth 1 (window-edges (frame-first-window (selected-frame))))))
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
    ;; Find all the different vpos's at which windows start,
    ;; then count them.  But ignore levels that differ by only 1.
    (save-window-excursion
      (let (tops (prev-top -2))
	(walk-windows (function (lambda (w)
				  (setq tops (cons (nth 1 (window-edges w))
						   tops))))
		      'nomini)
	(setq tops (sort tops '<))
	(while tops
	  (if (> (car tops) (1+ prev-top))
	      (setq prev-top (car tops)
		    count (1+ count)))
	  (setq levels (cons (cons (car tops) count) levels))
	  (setq tops (cdr tops)))
	(setq count (1+ count))))
    ;; Subdivide the frame into that many vertical levels.
130
    (setq size (/ (- (frame-height) mbl) count))
131 132 133 134 135 136 137 138 139 140 141
    (walk-windows (function
		   (lambda (w)
		     (select-window w)
		     (let ((newtop (cdr (assq (nth 1 (window-edges))
					      levels)))
			   (newbot (or (cdr (assq (+ (window-height)
						     (nth 1 (window-edges)))
						  levels))
				       count)))
		       (setq newsizes
			     (cons (cons w (* size (- newbot newtop)))
142 143
				   newsizes)))))
		  'nomini)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
144
    (walk-windows (function (lambda (w)
145 146 147 148 149
			      (select-window w)
			      (let ((newsize (cdr (assq w newsizes))))
				(enlarge-window (- newsize
						   (window-height))))))
		  'nomini)))
150

151
;;; I think this should be the default; I think people will prefer it--rms.
Richard M. Stallman's avatar
Richard M. Stallman committed
152
(defcustom split-window-keep-point t
153 154 155
  "*If non-nil, split windows keeps the original point in both children.
This is often more convenient for editing.
If nil, adjust point in each of the two windows to minimize redisplay.
Richard M. Stallman's avatar
Richard M. Stallman committed
156 157 158
This is convenient on slow terminals, but point can move strangely."
  :type 'boolean
  :group 'windows)
Jim Blandy's avatar
Jim Blandy committed
159

Joseph Arceneaux's avatar
Joseph Arceneaux committed
160 161
(defun split-window-vertically (&optional arg)
  "Split current window into two windows, one above the other.
162
The uppermost window gets ARG lines and the other gets the rest.
163
Negative arg means select the size of the lowermost window instead.
164 165 166
With no argument, split equally or close to it.
Both windows display the same buffer now current.

167
If the variable `split-window-keep-point' is non-nil, both new windows
Jim Blandy's avatar
Jim Blandy committed
168 169 170 171 172 173 174 175
will get the same value of point as the current window.  This is often
more convenient for editing.

Otherwise, we chose window starts so as to minimize the amount of
redisplay; this is convenient on slow terminals.  The new selected
window is the one that the current value of point appears in.  The
value of point can change if the text around point is hidden by the
new mode line."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
176 177
  (interactive "P")
  (let ((old-w (selected-window))
178
	(old-point (point))
179
	(size (and arg (prefix-numeric-value arg)))
180 181
        (window-full-p nil)
	new-w bottom switch moved)
182 183
    (and size (< size 0) (setq size (+ (window-height) size)))
    (setq new-w (split-window nil size))
Jim Blandy's avatar
Jim Blandy committed
184
    (or split-window-keep-point
185
	(progn
Jim Blandy's avatar
Jim Blandy committed
186 187 188
	  (save-excursion
	    (set-buffer (window-buffer))
	    (goto-char (window-start))
189
            (setq moved (vertical-motion (window-height)))
Jim Blandy's avatar
Jim Blandy committed
190 191 192
	    (set-window-start new-w (point))
	    (if (> (point) (window-point new-w))
		(set-window-point new-w (point)))
193 194 195 196 197 198 199 200 201 202 203 204 205
            (and (= moved (window-height))
                 (progn
                   (setq window-full-p t)
                   (vertical-motion -1)))
            (setq bottom (point)))
          (and window-full-p
               (<= bottom (point))
               (set-window-point old-w (1- bottom)))
	  (and window-full-p
               (<= (window-start new-w) old-point)
               (progn
                 (set-window-point new-w old-point)
                 (select-window new-w)))))
206 207
    (split-window-save-restore-data new-w old-w)))

208 209 210
;; This is to avoid compiler warnings.
(defvar view-return-to-alist)

211 212 213 214 215 216 217 218
(defun split-window-save-restore-data (new-w old-w)
  (save-excursion
    (set-buffer (window-buffer))
    (if view-mode
	(let ((old-info (assq old-w view-return-to-alist)))
	  (setq view-return-to-alist
		(cons (cons new-w (cons (and old-info (car (cdr old-info))) t))
		      view-return-to-alist))))
219
    new-w))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
220 221 222

(defun split-window-horizontally (&optional arg)
  "Split current window into two windows side by side.
223 224
This window becomes the leftmost of the two, and gets ARG columns.
Negative arg means select the size of the rightmost window instead.
225 226 227
The argument includes the width of the window's scroll bar; if there
are no scroll bars, it includes the width of the divider column
to the window's right, if any.  No arg means split equally."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
228
  (interactive "P")
229 230
  (let ((old-w (selected-window))
	(size (and arg (prefix-numeric-value arg))))
231 232
    (and size (< size 0)
	 (setq size (+ (window-width) size)))
233
    (split-window-save-restore-data (split-window nil size t) old-w)))
234

Joseph Arceneaux's avatar
Joseph Arceneaux committed
235 236 237 238 239 240 241 242 243 244
(defun enlarge-window-horizontally (arg)
  "Make current window ARG columns wider."
  (interactive "p")
  (enlarge-window arg t))

(defun shrink-window-horizontally (arg)
  "Make current window ARG columns narrower."
  (interactive "p")
  (shrink-window arg t))

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
(defun window-buffer-height (window)
  "Return the height (in screen lines) of the buffer that WINDOW is displaying."
  (save-excursion
    (set-buffer (window-buffer window))
    (goto-char (point-min))
    (let ((ignore-final-newline
           ;; If buffer ends with a newline, ignore it when counting height
           ;; unless point is after it.
           (and (not (eobp)) (eq ?\n (char-after (1- (point-max)))))))
      (+ 1 (nth 2 (compute-motion (point-min)
                                  '(0 . 0)
                                  (- (point-max) (if ignore-final-newline 1 0))
                                  (cons 0 100000000)
                                  (window-width window)
                                  nil
                                  window))))))

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
(defun count-screen-lines (&optional beg end count-final-newline window)
  "Return the number of screen lines in the region.
The number of screen lines may be different from the number of actual lines,
due to line breaking, display table, etc.

Optional arguments BEG and END default to `point-min' and `point-max'
respectively.

If region ends with a newline, ignore it unless optinal third argument
COUNT-FINAL-NEWLINE is non-nil.

The optional fourth argument WINDOW specifies the window used for obtaining
parameters such as width, horizontal scrolling, and so on. The default is
to use the selected window's parameters.

Like `vertical-motion', `count-screen-lines' always uses the current buffer,
regardless of which buffer is displayed in WINDOW. This makes possible to use
`count-screen-lines' in any buffer, whether or not it is currently displayed
in some window."
  (unless beg
    (setq beg (point-min)))
  (unless end
    (setq end (point-max)))
  (if (= beg end)
      0
    (save-excursion
      (save-restriction
        (widen)
        (narrow-to-region (min beg end)
                          (if (and (not count-final-newline)
                                   (= ?\n (char-before (max beg end))))
                              (1- (max beg end))
                            (max beg end)))
        (goto-char (point-min))
        (1+ (vertical-motion (buffer-size) window))))))

298
(defun shrink-window-if-larger-than-buffer (&optional window)
299
  "Shrink the WINDOW to be as small as possible to display its contents.
300
Do not shrink to less than `window-min-height' lines.
301
Do nothing if the buffer contains more lines than the present window height,
302
or if some of the window's contents are scrolled out of view,
303
or if the window is not the full width of the frame,
304
or if the window is the only window of its frame."
305
  (interactive)
306 307 308 309
  (save-selected-window
    (if window
	(select-window window)
      (setq window (selected-window)))
310 311 312 313 314 315 316 317 318 319
    (let* ((params (frame-parameters))
           (mini (cdr (assq 'minibuffer params)))
           (edges (window-edges)))
      (if (and (< 1 (count-windows))
               (= (window-width) (frame-width))
               (pos-visible-in-window-p (point-min) window)
               (not (eq mini 'only))
               (or (not mini)
                   (< (nth 3 edges) (nth 1 (window-edges mini)))
                   (> (nth 1 edges) (cdr (assq 'menu-bar-lines params)))))
320 321 322 323
          ;; `count-screen-lines' always works on the current buffer, so
          ;; make sure it is the buffer displayed by WINDOW.
          (let ((text-height (with-current-buffer (window-buffer window)
                               (count-screen-lines)))
324
                (window-height (window-height)))
325 326
	    ;; Don't try to redisplay with the cursor at the end
	    ;; on its own line--that would force a scroll and spoil things.
327
	    (when (and (eobp) (bolp) (not (bobp)))
328
	      (forward-char -1))
329 330 331
            (when (> window-height (1+ text-height))
              (shrink-window
               (- window-height (max (1+ text-height) window-min-height)))))))))
332 333 334 335 336 337 338 339 340 341

(defun kill-buffer-and-window ()
  "Kill the current buffer and delete the selected window."
  (interactive)
  (if (yes-or-no-p (format "Kill buffer `%s'? " (buffer-name)))
      (let ((buffer (current-buffer)))
	(delete-window (selected-window))
	(kill-buffer buffer))
    (error "Aborted")))

342 343 344 345 346 347 348 349 350 351 352 353
(defun quit-window (&optional kill window)
  "Quit the current buffer.  Bury it, and maybe delete the selected frame.
\(The frame is deleted if it is contains a dedicated window for the buffer.)
With a prefix argument, kill the buffer instead.

Noninteractively, if KILL is non-nil, then kill the current buffer,
otherwise bury it.

If WINDOW is non-nil, it specifies a window; we delete that window,
and the buffer that is killed or buried is the one in that window."
  (interactive "P")
  (let ((buffer (window-buffer window))
354
	(frame (window-frame (or window (selected-window))))
355 356 357 358 359 360 361 362 363 364
	(window-solitary
	 (save-selected-window
	   (if window
	       (select-window window))
	   (one-window-p t)))
	window-handled)

    (save-selected-window
      (if window
	  (select-window window))
365 366 367
      (or (window-minibuffer-p)
	  (window-dedicated-p (selected-window))
	  (switch-to-buffer (other-buffer))))
368 369 370

    ;; Get rid of the frame, if it has just one dedicated window
    ;; and other visible frames exist.
371
    (and (or (window-minibuffer-p) (window-dedicated-p window))
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
	 (delq frame (visible-frame-list))
	 window-solitary
	 (if (and (eq default-minibuffer-frame frame)
		  (= 1 (length (minibuffer-frame-list))))
	     (setq window nil)
	   (delete-frame frame)
	   (setq window-handled t)))

    ;; Deal with the buffer.
    (if kill
	(kill-buffer buffer)
      (bury-buffer buffer))

    ;; Maybe get rid of the window.
    (and window (not window-handled) (not window-solitary)
	 (delete-window window))))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
389
(define-key ctl-x-map "2" 'split-window-vertically)
Jim Blandy's avatar
Jim Blandy committed
390
(define-key ctl-x-map "3" 'split-window-horizontally)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
391 392
(define-key ctl-x-map "}" 'enlarge-window-horizontally)
(define-key ctl-x-map "{" 'shrink-window-horizontally)
393 394
(define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
(define-key ctl-x-map "+" 'balance-windows)
395
(define-key ctl-x-4-map "0" 'kill-buffer-and-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
396 397

;;; windows.el ends here