]> code.delx.au - gnu-emacs/blobdiff - lisp/window.el
Add arch taglines
[gnu-emacs] / lisp / window.el
index 59c946ee6854004c366237d18376816375f00981..0dadd4195c603e3b54415ed13dbdc142cb6669de 100644 (file)
@@ -1,9 +1,10 @@
-;;; window.el --- GNU Emacs window commands aside from those written in C.
+;;; window.el --- GNU Emacs window commands aside from those written in C
 
-;; Copyright (C) 1985, 1989, 1992, 1993, 1994, 2000
+;; Copyright (C) 1985, 1989, 1992, 1993, 1994, 2000, 2001, 2002
 ;;  Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
+;; Keywords: internal
 
 ;; This file is part of GNU Emacs.
 
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 
+;;; Commentary:
+
+;; Window tree functions.
+
 ;;; Code:
 
-;;;; Window tree functions.
+(defmacro save-selected-window (&rest body)
+  "Execute BODY, then select the window that was selected before BODY.
+Also restore the selected window of each frame as it was at the start
+of this construct.
+However, if a window has become dead, don't get an error,
+just refrain from reselecting it."
+  `(let ((save-selected-window-window (selected-window))
+        (save-selected-window-alist
+         (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
+                 (frame-list))))
+     (unwind-protect
+        (progn ,@body)
+       (dolist (elt save-selected-window-alist)
+        (and (frame-live-p (car elt))
+             (window-live-p (cadr elt))
+             (set-frame-selected-window (car elt) (cadr elt))))
+       (if (window-live-p save-selected-window-window)
+          (select-window save-selected-window-window)))))
+
+(defun window-body-height (&optional window)
+  "Return number of lines in window WINDOW for actual buffer text.
+This does not include the mode line (if any) or the header line (if any)."
+  (or window (setq window (selected-window)))
+  (if (window-minibuffer-p window)
+      (window-height window)
+    (with-current-buffer (window-buffer window)
+      (max 1 (- (window-height window)
+               (if mode-line-format 1 0)
+               (if header-line-format 1 0))))))
 
 (defun one-window-p (&optional nomini all-frames)
-  "Returns non-nil if the selected window is the only window (in its frame).
+  "Return 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, 
+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)))
@@ -81,7 +114,8 @@ Anything else means restrict to the selected frame."
              (cons walk-windows-current walk-windows-already-seen))
        (funcall proc walk-windows-current)))))
 
-(defun some-window (predicate &optional minibuf all-frames default)
+(defun get-window-with-predicate (predicate &optional minibuf
+                                           all-frames default)
   "Return a window satisfying PREDICATE.
 
 This function cycles through all visible windows using `walk-windows',
@@ -110,26 +144,20 @@ ALL-FRAMES = t means include windows on all frames including invisible frames.
 If ALL-FRAMES is a frame, it means include windows on that frame.
 Anything else means restrict to the selected frame."
   (catch 'found
-    (walk-windows #'(lambda (window) 
+    (walk-windows #'(lambda (window)
                      (when (funcall predicate window)
                        (throw 'found window)))
                  minibuf all-frames)
     default))
 
+(defalias 'some-window 'get-window-with-predicate)
+
 (defun minibuffer-window-active-p (window)
   "Return t if WINDOW (a minibuffer window) is now active."
   (eq window (active-minibuffer-window)))
-
-(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)))) 
 \f
 (defun count-windows (&optional minibuf)
-   "Returns the number of visible windows.
+   "Return the number of visible windows.
 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
@@ -140,52 +168,87 @@ even if it is inactive."
                   minibuf)
      count))
 
+(defun window-safely-shrinkable-p (&optional window)
+  "Non-nil if the WINDOW can be shrunk without shrinking other windows.
+If WINDOW is nil or omitted, it defaults to the currently selected window."
+  (save-selected-window
+    (when window (select-window window))
+    (or (and (not (eq window (frame-first-window)))
+            (= (car (window-edges))
+               (car (window-edges (previous-window)))))
+       (= (car (window-edges))
+          (car (window-edges (next-window)))))))
+
 (defun balance-windows ()
-  "Makes all visible windows the same height (approximately)."
+  "Make all visible windows the same height (approximately)."
   (interactive)
-  (let ((count -1) levels newsizes size
+  (let ((count -1) levels newsizes level-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))))))
+       (mbl (nth 1 (window-edges (frame-first-window (selected-frame)))))
+       (last-window (previous-window (frame-first-window (selected-frame))))
+       ;; Don't count the lines that are past the lowest main window.
+       total)
+    ;; Bottom edge of last window determines what size we have to work with.
+    (setq total
+         (+ (window-height last-window)
+            (nth 1 (window-edges last-window))))
+
     ;; 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) mbl) 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)))
-                                  newsizes)))))
-                 'nomini)
-    (walk-windows (function (lambda (w)
-                             (select-window w)
-                             (let ((newsize (cdr (assq w newsizes))))
-                               (enlarge-window (- newsize
-                                                  (window-height))))))
-                 'nomini)))
+    (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 desired number of vertical levels.
+    (setq level-size (/ (- total mbl) count))
+    (save-selected-window
+      ;; Set up NEWSIZES to map windows to their desired sizes.
+      ;; If a window ends at the bottom level, don't include
+      ;; it in NEWSIZES.  Those windows get the right sizes
+      ;; by adjusting the ones above them.
+      (walk-windows (function
+                    (lambda (w)
+                      (let ((newtop (cdr (assq (nth 1 (window-edges w))
+                                               levels)))
+                            (newbot (cdr (assq (+ (window-height w)
+                                                  (nth 1 (window-edges w)))
+                                               levels))))
+                        (if newbot
+                            (setq newsizes
+                                  (cons (cons w (* level-size (- newbot newtop)))
+                                        newsizes))))))
+                   'nomini)
+      ;; Make walk-windows start with the topmost window.
+      (select-window (previous-window (frame-first-window (selected-frame))))
+      (let (done (count 0))
+       ;; Give each window its precomputed size, or at least try.
+       ;; Keep trying until they all get the intended sizes,
+       ;; but not more than 3 times (to prevent infinite loop).
+       (while (and (not done) (< count 3))
+         (setq done t)
+         (setq count (1+ count))
+         (walk-windows (function (lambda (w)
+                                   (select-window w)
+                                   (let ((newsize (cdr (assq w newsizes))))
+                                     (when newsize
+                                       (enlarge-window (- newsize
+                                                          (window-height))
+                                                       nil t)
+                                       (unless (= (window-height) newsize)
+                                         (setq done nil))))))
+                       'nomini))))))
 \f
-;;; I think this should be the default; I think people will prefer it--rms.
+;; I think this should be the default; I think people will prefer it--rms.
 (defcustom split-window-keep-point t
   "*If non-nil, split windows keeps the original point in both children.
 This is often more convenient for editing.
@@ -246,13 +309,11 @@ new mode line."
 (defvar view-return-to-alist)
 
 (defun split-window-save-restore-data (new-w old-w)
-  (save-excursion
-    (set-buffer (window-buffer))
+  (with-current-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))))
+         (push (cons new-w (cons (and old-info (car (cdr old-info))) t))
+               view-return-to-alist)))
     new-w))
 
 (defun split-window-horizontally (&optional arg)
@@ -268,84 +329,8 @@ to the window's right, if any.  No arg means split equally."
     (and size (< size 0)
         (setq size (+ (window-width) size)))
     (split-window-save-restore-data (split-window nil size t) old-w)))
-\f
-(defcustom mode-line-window-height-fudge nil
-  "*Fudge factor returned by `mode-line-window-height-fudge' on graphic displays.
-If non-nil, it should be the number of lines to add to the sizes of
-windows to compensate for the extra height of the mode-line, so it
-doesn't't obscure the last line of text.
-
-If nil, an attempt is made to calculate reasonable value.
-
-This is a kluge."
-  :type '(choice (const :tag "Guess" nil)
-                (integer :tag "Extra lines" :value 1))
-  :group 'windows)
-
-;; List of face attributes that might change a face's height
-(defconst height-affecting-face-attributes
-  '(:family :height :box :font :inherit))
-
-(defsubst mode-line-window-height-fudge (&optional face)
-  "Return a fudge factor to compensate for the extra height of graphic mode-lines.
-On a non-graphic display, return 0.
-
-FACE is the face used to display the mode-line; it defaults to `mode-line'.
-
-If the variable `mode-line-window-height-fudge' has a non-nil value, it
-is returned.  Otherwise, the `mode-line' face is checked to see if it
-contains any attributes that might affect its height; if it does, 1 is
-returned, otherwise 0.
-
-\[Because mode-lines on a graphics capable display may have a height
-larger than a normal text line, a window who's size is calculated to
-exactly show some text, including 1 line for the mode-line, may be
-displayed with the last text line obscured by the mode-line.
-
-To work-around this problem, call `mode-line-window-height-fudge', and
-add the return value to the requested window size.]
-
-This is a kluge."
-  (if (display-graphic-p)
-      (or
-       ;; Return user-specified value
-       mode-line-window-height-fudge
-       ;; Try and detect whether mode-line face has any attributes that
-       ;; could make it bigger than a default text line, and return a
-       ;; fudge factor of 1 if so.
-       (let ((attrs height-affecting-face-attributes)
-            (fudge 0))
-        (while attrs
-          (let ((val (face-attribute (or face 'mode-line) (pop attrs))))
-            (unless (or (null val) (eq val 'unspecified))
-              (setq fudge 1 attrs nil))))
-        fudge))
-    0))
 
 \f
-;;; These functions should eventually be replaced with versions that
-;;; really do the job (instead of using the kludgey mode-line face
-;;; hacking junk).
-
-(defun window-text-height (&optional window)
-  "Return the height in lines of the text display area of WINDOW.
-This doesn't include the mode-line (or header-line if any) or any
-partial-height lines in the text display area.
-
-Note that the current implementation of this function may sometimes
-return an inaccurate value, but attempts to be conservative, by
-returning fewer lines than actually exist in the case where the real
-value cannot be determined."
-  (with-current-buffer (window-buffer window)
-    (- (window-height window)
-       (if (and (not (window-minibuffer-p window))
-               mode-line-format)
-          (1+ (mode-line-window-height-fudge))
-        0)
-       (if header-line-format
-          (1+ (mode-line-window-height-fudge 'header-line))
-        0))))
-
 (defun set-window-text-height (window height)
   "Sets the height in lines of the text display area of WINDOW to HEIGHT.
 This doesn't include the mode-line (or header-line if any) or any
@@ -401,15 +386,15 @@ 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
+If region ends with a newline, ignore it unless optional 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
+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
+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
@@ -431,6 +416,7 @@ in some window."
 
 (defun fit-window-to-buffer (&optional window max-height min-height)
   "Make WINDOW the right size to display its contents exactly.
+If WINDOW is omitted or nil, it defaults to the selected window.
 If the optional argument MAX-HEIGHT is supplied, it is the maximum height
   the window is allowed to be, defaulting to the frame height.
 If the optional argument MIN-HEIGHT is supplied, it is the minimum
@@ -496,25 +482,33 @@ header-line."
       (let ((end (with-current-buffer buf
                   (save-excursion
                     (goto-char (point-max))
-                    (if (and (bolp) (not (bobp)))
-                        (1- (point))
-                      (point))))))
+                    (when (and (bolp) (not (bobp)))
+                      ;; Don't include final newline
+                      (backward-char 1))
+                    (when truncate-lines
+                      ;; If line-wrapping is turned off, test the
+                      ;; beginning of the last line for visibility
+                      ;; instead of the end, as the end of the line
+                      ;; could be invisible by virtue of extending past
+                      ;; the edge of the window.
+                      (forward-line 0))
+                    (point)))))
        (set-window-vscroll window 0)
-       (prog1
-        (list desired-height max-height)
        (while (and (< desired-height max-height)
                    (= desired-height (window-height window))
-                   (not (pos-visible-in-window-p end window t)))
+                   (not (pos-visible-in-window-p end window)))
          (enlarge-window 1)
-         (setq desired-height (1+ desired-height))))))))
+         (setq desired-height (1+ desired-height)))))))
 
 (defun shrink-window-if-larger-than-buffer (&optional window)
   "Shrink the WINDOW to be as small as possible to display its contents.
+If WINDOW is omitted or nil, it defaults to the selected window.
 Do not shrink to less than `window-min-height' lines.
 Do nothing if the buffer contains more lines than the present window height,
 or if some of the window's contents are scrolled out of view,
-or if the window is not the full width of the frame,
-or if the window is the only window of its frame."
+or if shrinking this window would also shrink another window.
+or if the window is the only window of its frame.
+Return non-nil if the window was shrunk."
   (interactive)
   (when (null window)
     (setq window (selected-window)))
@@ -522,12 +516,17 @@ or if the window is the only window of its frame."
         (mini (frame-parameter frame 'minibuffer))
         (edges (window-edges window)))
     (if (and (not (eq window (frame-root-window frame)))
-            (= (window-width) (frame-width))
+            (window-safely-shrinkable-p)
             (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) (frame-parameter frame 'menu-bar-lines))))
+                (let ((mini-window (minibuffer-window frame)))
+                  (or (null mini-window)
+                      (not (eq frame (window-frame mini-window)))
+                      (< (nth 3 edges)
+                         (nth 1 (window-edges mini-window)))
+                      (> (nth 1 edges)
+                         (frame-parameter frame 'menu-bar-lines))))))
        (fit-window-to-buffer window (window-height window)))))
 
 (defun kill-buffer-and-window ()
@@ -586,6 +585,15 @@ and the buffer that is killed or buried is the one in that window."
     (and window (not window-handled) (not window-solitary)
         (delete-window window))))
 
+(defun handle-select-window (event)
+  "Handle select-window events."
+  (interactive "e")
+  (let ((window (posn-window (event-start event))))
+    (if (and (window-live-p window)
+            (or (not (window-minibuffer-p window))
+                (minibuffer-window-active-p window)))
+       (select-window window))))
+
 (define-key ctl-x-map "2" 'split-window-vertically)
 (define-key ctl-x-map "3" 'split-window-horizontally)
 (define-key ctl-x-map "}" 'enlarge-window-horizontally)
@@ -594,4 +602,5 @@ and the buffer that is killed or buried is the one in that window."
 (define-key ctl-x-map "+" 'balance-windows)
 (define-key ctl-x-4-map "0" 'kill-buffer-and-window)
 
-;;; windows.el ends here
+;;; arch-tag: b508dfcc-c353-4c37-89fa-e773fe10cea9
+;;; window.el ends here