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

Karl Heuer's avatar
Karl Heuer 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 20 21 22
;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

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

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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
;;;; 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
too.  Therefore, when a separate minibuffer frame is active,
`walk-windows' includes the windows in the frame from which you
entered the minibuffer, as well as the minibuffer window.  But if the
minibuffer does not count, only windows from WINDOW's frame count.

Optional third arg ALL-FRAMES t means include windows on all frames.
ALL-FRAMES nil or omitted means cycle within the frames as specified
above.  ALL-FRAMES = `visible' means include windows on all visible frames.
ALL-FRAMES = 0 means include windows on all visible and iconified frames.
Anything else means restrict to WINDOW's frame."
  ;; 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."
77
  (eq window (active-minibuffer-window)))
78

Joseph Arceneaux's avatar
Joseph Arceneaux committed
79 80 81 82 83
(defun count-windows (&optional minibuf)
   "Returns the number of visible windows.
Optional arg NO-MINI non-nil means don't count the minibuffer
even if it is active."
   (let ((count 0))
84
     (walk-windows (function (lambda (w)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
85 86 87 88 89
			       (setq count (+ count 1))))
		   minibuf)
     count))

(defun balance-windows ()
90
  "Makes all visible windows the same height (approximately)."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
91
  (interactive)
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
  (let ((count -1) levels newsizes size)
    ;; 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.
    (setq size (/ (frame-height) count))
    (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)))
122 123
				   newsizes)))))
		  'nomini)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
124
    (walk-windows (function (lambda (w)
125 126 127 128 129
			      (select-window w)
			      (let ((newsize (cdr (assq w newsizes))))
				(enlarge-window (- newsize
						   (window-height))))))
		  'nomini)))
130

131 132
;;; I think this should be the default; I think people will prefer it--rms.
(defvar split-window-keep-point t
133 134 135 136
  "*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.
This is convenient on slow terminals, but point can move strangely.")
Jim Blandy's avatar
Jim Blandy committed
137

Joseph Arceneaux's avatar
Joseph Arceneaux committed
138 139
(defun split-window-vertically (&optional arg)
  "Split current window into two windows, one above the other.
140
The uppermost window gets ARG lines and the other gets the rest.
141
Negative arg means select the size of the lowermost window instead.
142 143 144
With no argument, split equally or close to it.
Both windows display the same buffer now current.

Jim Blandy's avatar
Jim Blandy committed
145 146 147 148 149 150 151 152 153
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
154 155
  (interactive "P")
  (let ((old-w (selected-window))
156
	(old-point (point))
157
	(size (and arg (prefix-numeric-value arg)))
158
	new-w bottom switch)
159 160
    (and size (< size 0) (setq size (+ (window-height) size)))
    (setq new-w (split-window nil size))
Jim Blandy's avatar
Jim Blandy committed
161
    (or split-window-keep-point
162
	(progn
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176
	  (save-excursion
	    (set-buffer (window-buffer))
	    (goto-char (window-start))
	    (vertical-motion (window-height))
	    (set-window-start new-w (point))
	    (if (> (point) (window-point new-w))
		(set-window-point new-w (point)))
	    (vertical-motion -1)
	    (setq bottom (point)))
	  (if (<= bottom (point))
	      (set-window-point old-w (1- bottom)))
	  (if (< (window-start new-w) old-point)
	      (progn
		(set-window-point new-w old-point)
177 178
		(select-window new-w)))))
    new-w))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
179 180 181

(defun split-window-horizontally (&optional arg)
  "Split current window into two windows side by side.
182 183 184
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
185
  (interactive "P")
186 187 188 189
  (let ((size (and arg (prefix-numeric-value arg))))
    (and size (< size 0)
	 (setq size (+ (window-width) size)))
    (split-window nil size t)))
190

Joseph Arceneaux's avatar
Joseph Arceneaux committed
191 192 193 194 195 196 197 198 199 200
(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))

201
(defun shrink-window-if-larger-than-buffer (&optional window)
202
  "Shrink the WINDOW to be as small as possible to display its contents.
203
Do not shrink to less than `window-min-height' lines.
204
Do nothing if the buffer contains more lines than the present window height,
205
or if some of the window's contents are scrolled out of view,
206
or if the window is not the full width of the frame,
207
or if the window is the only window of its frame."
208
  (interactive)
209
  (or window (setq window (selected-window)))
210 211
  (save-excursion
    (set-buffer (window-buffer window))
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    (let* ((w (selected-window))	;save-window-excursion can't win
	   (buffer-file-name buffer-file-name)
	   (p (point))
	   (n 0)
	   (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))))))
	   (buffer-read-only nil)
	   (modified (buffer-modified-p))
	   (buffer (current-buffer))
	   (params (frame-parameters (window-frame window)))
	   (mini (cdr (assq 'minibuffer params)))
	   (edges (window-edges (selected-window))))
      (if (and (< 1 (let ((frame (selected-frame)))
		      (select-frame (window-frame window))
		      (unwind-protect
			  (count-windows)
			(select-frame frame))))
	       (= (window-width window) (frame-width (window-frame window)))
233
	       (pos-visible-in-window-p (point-min) window)
234
	       (not (eq mini 'only))
235 236 237 238
	       (or (not mini)
		   (< (nth 3 edges)
		      (nth 1 (window-edges mini)))
		   (> (nth 1 edges)
239
		      (cdr (assq 'menu-bar-lines params)))))
240 241 242 243
	  (unwind-protect
	      (progn
		(select-window (or window w))
		(goto-char (point-min))
244 245 246
		(while (pos-visible-in-window-p
			(- (point-max)
			   (if ignore-final-newline 1 0)))
247 248 249
		  ;; defeat file locking... don't try this at home, kids!
		  (setq buffer-file-name nil)
		  (insert ?\n) (setq n (1+ n)))
250 251 252 253
		(if (> n 0)
		    (shrink-window (min (1- n)
					(- (window-height)
					   window-min-height)))))
254 255 256 257 258 259 260
	    (delete-region (point-min) (point))
	    (set-buffer-modified-p modified)
	    (goto-char p)
	    (select-window w)
	    ;; Make sure we unbind buffer-read-only
	    ;; with the proper current buffer.
	    (set-buffer buffer))))))
261
      
Joseph Arceneaux's avatar
Joseph Arceneaux committed
262
(define-key ctl-x-map "2" 'split-window-vertically)
Jim Blandy's avatar
Jim Blandy committed
263
(define-key ctl-x-map "3" 'split-window-horizontally)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
264 265
(define-key ctl-x-map "}" 'enlarge-window-horizontally)
(define-key ctl-x-map "{" 'shrink-window-horizontally)
266 267
(define-key ctl-x-map "-" 'shrink-window-if-larger-than-buffer)
(define-key ctl-x-map "+" 'balance-windows)
Eric S. Raymond's avatar
Eric S. Raymond committed
268 269

;;; windows.el ends here