window.el 12.9 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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
7 8 9 10
;; 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
11
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
12 13 14 15 16 17 18 19
;; 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
20 21 22
;; 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
23

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

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
;;;; 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
55 56
too.  Therefore, if you are using a separate minibuffer frame
and the minibuffer is active and MINIBUF says it counts,
57
`walk-windows' includes the windows in the frame from which you
Richard M. Stallman's avatar
Richard M. Stallman committed
58
entered the minibuffer, as well as the minibuffer window.
59

Richard M. Stallman's avatar
Richard M. Stallman committed
60 61 62
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.
63
ALL-FRAMES = 0 means include windows on all visible and iconified frames.
Richard M. Stallman's avatar
Richard M. Stallman committed
64
ALL-FRAMES = t means include windows on all frames including invisible frames.
Richard M. Stallman's avatar
Richard M. Stallman committed
65
Anything else means restrict to the selected frame."
66 67 68 69 70 71 72 73 74 75 76 77 78
  ;; If we start from the minibuffer window, don't fail to come back to it.
  (if (window-minibuffer-p (selected-window))
      (setq minibuf t))
  (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))))))

(defun minibuffer-window-active-p (window)
  "Return t if WINDOW (a minibuffer window) is now active."
79
  (eq window (active-minibuffer-window)))
80 81 82 83 84 85 86 87

(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)))) 
88

Joseph Arceneaux's avatar
Joseph Arceneaux committed
89 90
(defun count-windows (&optional minibuf)
   "Returns the number of visible windows.
Karl Heuer's avatar
Karl Heuer committed
91 92
Optional arg MINIBUF non-nil means count the minibuffer
even if it is inactive."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
93
   (let ((count 0))
94
     (walk-windows (function (lambda (w)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
95 96 97 98 99
			       (setq count (+ count 1))))
		   minibuf)
     count))

(defun balance-windows ()
100
  "Makes all visible windows the same height (approximately)."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
101
  (interactive)
102 103 104 105
  (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))))))
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
    ;; 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.
123
    (setq size (/ (- (frame-height) mbl) count))
124 125 126 127 128 129 130 131 132 133 134
    (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)))
135 136
				   newsizes)))))
		  'nomini)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
137
    (walk-windows (function (lambda (w)
138 139 140 141 142
			      (select-window w)
			      (let ((newsize (cdr (assq w newsizes))))
				(enlarge-window (- newsize
						   (window-height))))))
		  'nomini)))
143

144
;;; I think this should be the default; I think people will prefer it--rms.
Richard M. Stallman's avatar
Richard M. Stallman committed
145
(defcustom split-window-keep-point t
146 147 148
  "*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
149 150 151
This is convenient on slow terminals, but point can move strangely."
  :type 'boolean
  :group 'windows)
Jim Blandy's avatar
Jim Blandy committed
152

Joseph Arceneaux's avatar
Joseph Arceneaux committed
153 154
(defun split-window-vertically (&optional arg)
  "Split current window into two windows, one above the other.
155
The uppermost window gets ARG lines and the other gets the rest.
156
Negative arg means select the size of the lowermost window instead.
157 158 159
With no argument, split equally or close to it.
Both windows display the same buffer now current.

Jim Blandy's avatar
Jim Blandy committed
160 161 162 163 164 165 166 167 168
If the variable split-window-keep-point is non-nil, both new windows
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
169 170
  (interactive "P")
  (let ((old-w (selected-window))
171
	(old-point (point))
172
	(size (and arg (prefix-numeric-value arg)))
173 174
        (window-full-p nil)
	new-w bottom switch moved)
175 176
    (and size (< size 0) (setq size (+ (window-height) size)))
    (setq new-w (split-window nil size))
Jim Blandy's avatar
Jim Blandy committed
177
    (or split-window-keep-point
178
	(progn
Jim Blandy's avatar
Jim Blandy committed
179 180 181
	  (save-excursion
	    (set-buffer (window-buffer))
	    (goto-char (window-start))
182
            (setq moved (vertical-motion (window-height)))
Jim Blandy's avatar
Jim Blandy committed
183 184 185
	    (set-window-start new-w (point))
	    (if (> (point) (window-point new-w))
		(set-window-point new-w (point)))
186 187 188 189 190 191 192 193 194 195 196 197 198
            (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)))))
199 200
    (split-window-save-restore-data new-w old-w)))

201 202 203
;; This is to avoid compiler warnings.
(defvar view-return-to-alist)

204 205 206 207 208 209 210 211
(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))))
212
    new-w))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
213 214 215

(defun split-window-horizontally (&optional arg)
  "Split current window into two windows side by side.
216 217 218
This window becomes the leftmost of the two, and gets ARG columns.
Negative arg means select the size of the rightmost window instead.
No arg means split equally."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
219
  (interactive "P")
220 221
  (let ((old-w (selected-window))
	(size (and arg (prefix-numeric-value arg))))
222 223
    (and size (< size 0)
	 (setq size (+ (window-width) size)))
224
    (split-window-save-restore-data (split-window nil size t) old-w)))
225

Joseph Arceneaux's avatar
Joseph Arceneaux committed
226 227 228 229 230 231 232 233 234 235
(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))

236
(defun shrink-window-if-larger-than-buffer (&optional window)
237
  "Shrink the WINDOW to be as small as possible to display its contents.
238
Do not shrink to less than `window-min-height' lines.
239
Do nothing if the buffer contains more lines than the present window height,
240
or if some of the window's contents are scrolled out of view,
241
or if the window is not the full width of the frame,
242
or if the window is the only window of its frame."
243
  (interactive)
244
  (or window (setq window (selected-window)))
245 246 247 248 249 250 251
  (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))))))
	 (params (frame-parameters (window-frame window)))
	 (mini (cdr (assq 'minibuffer params)))
252 253
	 (edges (window-edges (selected-window)))
	 text-height)
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
    (if (and (< 1 (save-selected-window
		    (select-window window)
		    (count-windows)))
	     (= (window-width window) (frame-width (window-frame window)))
	     (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)))))
	(save-selected-window
	  (select-window window)
	  (let (result height)
	    (save-excursion
	      (set-buffer (window-buffer window))
	      (goto-char (point-min))
	      (setq result
		    (compute-motion (point-min) '(0 . 0)
				    (- (point-max)
				       (if ignore-final-newline 1 0))
				    (cons 0 (window-height))
				    (window-width) nil
				    window))
	      ;; Get number of screen lines that the text needs.
	      (setq text-height (+ 1 (nth 2 result)))
	      ;; Shrink down to that, or as far as we can go.
	      (if (> (window-height) (1+ text-height))
		  (shrink-window (- (window-height)
				    (max (1+ text-height) window-min-height))))))))))
284 285 286 287 288 289 290 291 292 293

(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")))

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
(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))
	(frame (if window (window-frame window) (selected-window)))
	(window-solitary
	 (save-selected-window
	   (if window
	       (select-window window))
	   (one-window-p t)))
	window-handled)

    (save-selected-window
      (if window
	  (select-window window))
317 318 319
      (or (window-minibuffer-p)
	  (window-dedicated-p (selected-window))
	  (switch-to-buffer (other-buffer))))
320 321 322

    ;; Get rid of the frame, if it has just one dedicated window
    ;; and other visible frames exist.
323
    (and (or (window-minibuffer-p) (window-dedicated-p window))
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
	 (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
341
(define-key ctl-x-map "2" 'split-window-vertically)
Jim Blandy's avatar
Jim Blandy committed
342
(define-key ctl-x-map "3" 'split-window-horizontally)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
343 344
(define-key ctl-x-map "}" 'enlarge-window-horizontally)
(define-key ctl-x-map "{" 'shrink-window-horizontally)
345 346
(define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
(define-key ctl-x-map "+" 'balance-windows)
347
(define-key ctl-x-4-map "0" 'kill-buffer-and-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
348 349

;;; windows.el ends here