lisp/gnus/gnus-win.el

   1 ;;; gnus-win.el --- window configuration functions for Gnus
   2 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30
  31 (require 'gnus)
  32
  33 (defgroup gnus-windows nil
  34   "Window configuration."
  35   :group 'gnus)
  36
  37 (defcustom gnus-use-full-window t
  38   "*If non-nil, use the entire Emacs screen."
  39   :group 'gnus-windows
  40   :type 'boolean)
  41
  42 (defvar gnus-window-configuration nil
  43   "Obsolete variable.  See `gnus-buffer-configuration'.")
  44
  45 (defcustom gnus-window-min-width 2
  46   "*Minimum width of Gnus buffers."
  47   :group 'gnus-windows
  48   :type 'integer)
  49
  50 (defcustom gnus-window-min-height 1
  51   "*Minimum height of Gnus buffers."
  52   :group 'gnus-windows
  53   :type 'integer)
  54
  55 (defcustom gnus-always-force-window-configuration nil
  56   "*If non-nil, always force the Gnus window configurations."
  57   :group 'gnus-windows
  58   :type 'boolean)
  59
  60 (defvar gnus-buffer-configuration
  61   '((group
  62      (vertical 1.0
  63                (group 1.0 point)
  64                (if gnus-carpal '(group-carpal 4))))
  65     (summary
  66      (vertical 1.0
  67                (summary 1.0 point)
  68                (if gnus-carpal '(summary-carpal 4))))
  69     (article
  70      (cond
  71       ((and gnus-use-picons
  72             (eq gnus-picons-display-where 'picons))
  73        '(frame 1.0
  74                (vertical 1.0
  75                          (summary 0.25 point)
  76                          (if gnus-carpal '(summary-carpal 4))
  77                          (article 1.0))
  78                (vertical ((height . 5) (width . 15)
  79                           (user-position . t)
  80                           (left . -1) (top . 1))
  81                          (picons 1.0))))
  82       (gnus-use-trees
  83        '(vertical 1.0
  84                   (summary 0.25 point)
  85                   (tree 0.25)
  86                   (article 1.0)))
  87       (t
  88        '(vertical 1.0
  89                   (summary 0.25 point)
  90                   (if gnus-carpal '(summary-carpal 4))
  91                   (article 1.0)))))
  92     (server
  93      (vertical 1.0
  94                (server 1.0 point)
  95                (if gnus-carpal '(server-carpal 2))))
  96     (browse
  97      (vertical 1.0
  98                (browse 1.0 point)
  99                (if gnus-carpal '(browse-carpal 2))))
 100     (message
 101      (vertical 1.0
 102                (message 1.0 point)))
 103     (pick
 104      (vertical 1.0
 105                (article 1.0 point)))
 106     (info
 107      (vertical 1.0
 108                (info 1.0 point)))
 109     (summary-faq
 110      (vertical 1.0
 111                (summary 0.25)
 112                (faq 1.0 point)))
 113     (edit-article
 114      (vertical 1.0
 115                (article 1.0 point)))
 116     (edit-form
 117      (vertical 1.0
 118                (group 0.5)
 119                (edit-form 1.0 point)))
 120     (edit-score
 121      (vertical 1.0
 122                (summary 0.25)
 123                (edit-score 1.0 point)))
 124     (post
 125      (vertical 1.0
 126                (post 1.0 point)))
 127     (reply
 128      (vertical 1.0
 129                (article-copy 0.5)
 130                (message 1.0 point)))
 131     (forward
 132      (vertical 1.0
 133                (message 1.0 point)))
 134     (reply-yank
 135      (vertical 1.0
 136                (message 1.0 point)))
 137     (mail-bounce
 138      (vertical 1.0
 139                (article 0.5)
 140                (message 1.0 point)))
 141     (pipe
 142      (vertical 1.0
 143                (summary 0.25 point)
 144                (if gnus-carpal '(summary-carpal 4))
 145                ("*Shell Command Output*" 1.0)))
 146     (bug
 147      (vertical 1.0
 148                (if gnus-bug-create-help-buffer '("*Gnus Help Bug*" 0.5))
 149                ("*Gnus Bug*" 1.0 point)))
 150     (score-trace
 151      (vertical 1.0
 152                (summary 0.5 point)
 153                ("*Score Trace*" 1.0)))
 154     (score-words
 155      (vertical 1.0
 156                (summary 0.5 point)
 157                ("*Score Words*" 1.0)))
 158     (split-trace
 159      (vertical 1.0
 160                (summary 0.5 point)
 161                ("*Split Trace*" 1.0)))
 162     (category
 163      (vertical 1.0
 164                (category 1.0)))
 165     (compose-bounce
 166      (vertical 1.0
 167                (article 0.5)
 168                (message 1.0 point))))
 169   "Window configuration for all possible Gnus buffers.
 170 See the Gnus manual for an explanation of the syntax used.")
 171
 172 (defvar gnus-window-to-buffer
 173   '((group . gnus-group-buffer)
 174     (summary . gnus-summary-buffer)
 175     (article . gnus-article-buffer)
 176     (server . gnus-server-buffer)
 177     (browse . "*Gnus Browse Server*")
 178     (edit-group . gnus-group-edit-buffer)
 179     (edit-form . gnus-edit-form-buffer)
 180     (edit-server . gnus-server-edit-buffer)
 181     (group-carpal . gnus-carpal-group-buffer)
 182     (summary-carpal . gnus-carpal-summary-buffer)
 183     (server-carpal . gnus-carpal-server-buffer)
 184     (browse-carpal . gnus-carpal-browse-buffer)
 185     (edit-score . gnus-score-edit-buffer)
 186     (message . gnus-message-buffer)
 187     (mail . gnus-message-buffer)
 188     (post-news . gnus-message-buffer)
 189     (faq . gnus-faq-buffer)
 190     (picons . gnus-picons-buffer-name)
 191     (tree . gnus-tree-buffer)
 192     (score-trace . "*Score Trace*")
 193     (split-trace . "*Split Trace*")
 194     (info . gnus-info-buffer)
 195     (category . gnus-category-buffer)
 196     (article-copy . gnus-article-copy)
 197     (draft . gnus-draft-buffer))
 198   "Mapping from short symbols to buffer names or buffer variables.")
 199
 200 ;;; Internal variables.
 201
 202 (defvar gnus-current-window-configuration nil
 203   "The most recently set window configuration.")
 204
 205 (defvar gnus-created-frames nil)
 206 (defvar gnus-window-frame-focus nil)
 207
 208 (defun gnus-kill-gnus-frames ()
 209   "Kill all frames Gnus has created."
 210   (while gnus-created-frames
 211     (when (frame-live-p (car gnus-created-frames))
 212       ;; We slap a condition-case around this `delete-frame' to ensure
 213       ;; against errors if we try do delete the single frame that's left.
 214       (ignore-errors
 215         (delete-frame (car gnus-created-frames))))
 216     (pop gnus-created-frames)))
 217
 218 (defun gnus-window-configuration-element (list)
 219   (while (and list
 220               (not (assq (car list) gnus-window-configuration)))
 221     (pop list))
 222   (cadr (assq (car list) gnus-window-configuration)))
 223
 224 (defun gnus-windows-old-to-new (setting)
 225   ;; First we take care of the really, really old Gnus 3 actions.
 226   (when (symbolp setting)
 227     (setq setting
 228           ;; Take care of ooold GNUS 3.x values.
 229           (cond ((eq setting 'SelectArticle) 'article)
 230                 ((memq setting '(SelectNewsgroup SelectSubject ExpandSubject))
 231                  'summary)
 232                 ((memq setting '(ExitNewsgroup)) 'group)
 233                 (t setting))))
 234   (if (or (listp setting)
 235           (not (and gnus-window-configuration
 236                     (memq setting '(group summary article)))))
 237       setting
 238     (let* ((elem
 239             (cond
 240              ((eq setting 'group)
 241               (gnus-window-configuration-element
 242                '(group newsgroups ExitNewsgroup)))
 243              ((eq setting 'summary)
 244               (gnus-window-configuration-element
 245                '(summary SelectNewsgroup SelectSubject ExpandSubject)))
 246              ((eq setting 'article)
 247               (gnus-window-configuration-element
 248                '(article SelectArticle)))))
 249            (total (apply '+ elem))
 250            (types '(group summary article))
 251            (pbuf (if (eq setting 'newsgroups) 'group 'summary))
 252            (i 0)
 253            perc out)
 254       (while (< i 3)
 255         (or (not (numberp (nth i elem)))
 256             (zerop (nth i elem))
 257             (progn
 258               (setq perc (if (= i 2)
 259                              1.0
 260                            (/ (float (nth i elem)) total)))
 261               (push (if (eq pbuf (nth i types))
 262                         (list (nth i types) perc 'point)
 263                       (list (nth i types) perc))
 264                     out)))
 265         (incf i))
 266       `(vertical 1.0 ,@(nreverse out)))))
 267
 268 ;;;###autoload
 269 (defun gnus-add-configuration (conf)
 270   "Add the window configuration CONF to `gnus-buffer-configuration'."
 271   (setq gnus-buffer-configuration
 272         (cons conf (delq (assq (car conf) gnus-buffer-configuration)
 273                          gnus-buffer-configuration))))
 274
 275 (defvar gnus-frame-list nil)
 276
 277 (defun gnus-window-to-buffer-helper (obj)
 278   (cond ((not (symbolp obj))
 279          obj)
 280         ((boundp obj)
 281          (symbol-value obj))
 282         ((fboundp obj)
 283          (funcall obj))
 284         (t
 285          nil)))
 286
 287 (defun gnus-configure-frame (split &optional window)
 288   "Split WINDOW according to SPLIT."
 289   (let ((current-window
 290          (or (get-buffer-window (current-buffer)) (selected-window))))
 291     (unless window
 292       (setq window current-window))
 293     (select-window window)
 294     ;; This might be an old-stylee buffer config.
 295     (when (vectorp split)
 296       (setq split (append split nil)))
 297     (when (or (consp (car split))
 298               (vectorp (car split)))
 299       (push 1.0 split)
 300       (push 'vertical split))
 301     ;; The SPLIT might be something that is to be evaled to
 302     ;; return a new SPLIT.
 303     (while (and (not (assq (car split) gnus-window-to-buffer))
 304                 (gnus-functionp (car split)))
 305       (setq split (eval split)))
 306     (let* ((type (car split))
 307            (subs (cddr split))
 308            (len (if (eq type 'horizontal) (window-width) (window-height)))
 309            (total 0)
 310            (window-min-width (or gnus-window-min-width window-min-width))
 311            (window-min-height (or gnus-window-min-height window-min-height))
 312            s result new-win rest comp-subs size sub)
 313       (cond
 314        ;; Nothing to do here.
 315        ((null split))
 316        ;; Don't switch buffers.
 317        ((null type)
 318         (and (memq 'point split) window))
 319        ;; This is a buffer to be selected.
 320        ((not (memq type '(frame horizontal vertical)))
 321         (let ((buffer (cond ((stringp type) type)
 322                             (t (cdr (assq type gnus-window-to-buffer))))))
 323           (unless buffer
 324             (error "Invalid buffer type: %s" type))
 325           (let ((buf (gnus-get-buffer-create
 326                       (gnus-window-to-buffer-helper buffer))))
 327             (if (eq buf (window-buffer (selected-window))) (set-buffer buf)
 328               (switch-to-buffer buf)))
 329           (when (memq 'frame-focus split)
 330             (setq gnus-window-frame-focus window))
 331           ;; We return the window if it has the `point' spec.
 332           (and (memq 'point split) window)))
 333        ;; This is a frame split.
 334        ((eq type 'frame)
 335         (unless gnus-frame-list
 336           (setq gnus-frame-list (list (window-frame current-window))))
 337         (let ((i 0)
 338               params frame fresult)
 339           (while (< i (length subs))
 340             ;; Frame parameter is gotten from the sub-split.
 341             (setq params (cadr (elt subs i)))
 342             ;; It should be a list.
 343             (unless (listp params)
 344               (setq params nil))
 345             ;; Create a new frame?
 346             (unless (setq frame (elt gnus-frame-list i))
 347               (nconc gnus-frame-list (list (setq frame (make-frame params))))
 348               (push frame gnus-created-frames))
 349             ;; Is the old frame still alive?
 350             (unless (frame-live-p frame)
 351               (setcar (nthcdr i gnus-frame-list)
 352                       (setq frame (make-frame params))))
 353             ;; Select the frame in question and do more splits there.
 354             (select-frame frame)
 355             (setq fresult (or (gnus-configure-frame (elt subs i)) fresult))
 356             (incf i))
 357           ;; Select the frame that has the selected buffer.
 358           (when fresult
 359             (select-frame (window-frame fresult)))))
 360        ;; This is a normal split.
 361        (t
 362         (when (> (length subs) 0)
 363           ;; First we have to compute the sizes of all new windows.
 364           (while subs
 365             (setq sub (append (pop subs) nil))
 366             (while (and (not (assq (car sub) gnus-window-to-buffer))
 367                         (gnus-functionp (car sub)))
 368               (setq sub (eval sub)))
 369             (when sub
 370               (push sub comp-subs)
 371               (setq size (cadar comp-subs))
 372               (cond ((equal size 1.0)
 373                      (setq rest (car comp-subs))
 374                      (setq s 0))
 375                     ((floatp size)
 376                      (setq s (floor (* size len))))
 377                     ((integerp size)
 378                      (setq s size))
 379                     (t
 380                      (error "Invalid size: %s" size)))
 381               ;; Try to make sure that we are inside the safe limits.
 382               (cond ((zerop s))
 383                     ((eq type 'horizontal)
 384                      (setq s (max s window-min-width)))
 385                     ((eq type 'vertical)
 386                      (setq s (max s window-min-height))))
 387               (setcar (cdar comp-subs) s)
 388               (incf total s)))
 389           ;; Take care of the "1.0" spec.
 390           (if rest
 391               (setcar (cdr rest) (- len total))
 392             (error "No 1.0 specs in %s" split))
 393           ;; The we do the actual splitting in a nice recursive
 394           ;; fashion.
 395           (setq comp-subs (nreverse comp-subs))
 396           (while comp-subs
 397             (if (null (cdr comp-subs))
 398                 (setq new-win window)
 399               (setq new-win
 400                     (split-window window (cadar comp-subs)
 401                                   (eq type 'horizontal))))
 402             (setq result (or (gnus-configure-frame
 403                               (car comp-subs) window)
 404                              result))
 405             (select-window new-win)
 406             (setq window new-win)
 407             (setq comp-subs (cdr comp-subs))))
 408         ;; Return the proper window, if any.
 409         (when result
 410           (select-window result)))))))
 411
 412 (defvar gnus-frame-split-p nil)
 413
 414 (defun gnus-configure-windows (setting &optional force)
 415   (if (window-configuration-p setting)
 416       (set-window-configuration setting)
 417     (setq gnus-current-window-configuration setting)
 418     (setq force (or force gnus-always-force-window-configuration))
 419     (setq setting (gnus-windows-old-to-new setting))
 420     (let ((split (if (symbolp setting)
 421                      (cadr (assq setting gnus-buffer-configuration))
 422                    setting))
 423           all-visible)
 424
 425       (setq gnus-frame-split-p nil)
 426
 427       (unless split
 428         (error "No such setting in `gnus-buffer-configuration': %s" setting))
 429
 430       (if (and (setq all-visible (gnus-all-windows-visible-p split))
 431                (not force))
 432           ;; All the windows mentioned are already visible, so we just
 433           ;; put point in the assigned buffer, and do not touch the
 434           ;; winconf.
 435           (select-window all-visible)
 436
 437         ;; Make sure "the other" buffer, nntp-server-buffer, is live.
 438         (unless (gnus-buffer-live-p nntp-server-buffer)
 439           (nnheader-init-server-buffer))
 440
 441         ;; Either remove all windows or just remove all Gnus windows.
 442         (let ((frame (selected-frame)))
 443           (unwind-protect
 444               (if gnus-use-full-window
 445                   ;; We want to remove all other windows.
 446                   (if (not gnus-frame-split-p)
 447                       ;; This is not a `frame' split, so we ignore the
 448                       ;; other frames.
 449                       (delete-other-windows)
 450                     ;; This is a `frame' split, so we delete all windows
 451                     ;; on all frames.
 452                     (gnus-delete-windows-in-gnusey-frames))
 453                 ;; Just remove some windows.
 454                 (gnus-remove-some-windows)
 455                 (if (featurep 'xemacs)
 456                     (switch-to-buffer nntp-server-buffer)
 457                   (set-buffer nntp-server-buffer)))
 458             (select-frame frame)))
 459
 460         (let (gnus-window-frame-focus)
 461           (if (featurep 'xemacs)
 462               (switch-to-buffer nntp-server-buffer)
 463             (set-buffer nntp-server-buffer))
 464           (gnus-configure-frame split)
 465           (when gnus-window-frame-focus
 466             (select-frame (window-frame gnus-window-frame-focus))))))))
 467
 468 (defun gnus-delete-windows-in-gnusey-frames ()
 469   "Do a `delete-other-windows' in all frames that have Gnus windows."
 470   (let ((buffers (gnus-buffers)))
 471     (mapcar
 472      (lambda (frame)
 473        (unless (eq (cdr (assq 'minibuffer
 474                               (frame-parameters frame)))
 475                    'only)
 476          (select-frame frame)
 477          (let (do-delete)
 478            (walk-windows
 479             (lambda (window)
 480               (when (memq (window-buffer window) buffers)
 481                 (setq do-delete t))))
 482            (when do-delete
 483              (delete-other-windows)))))
 484      (frame-list))))
 485
 486 (defun gnus-all-windows-visible-p (split)
 487   "Say whether all buffers in SPLIT are currently visible.
 488 In particular, the value returned will be the window that
 489 should have point."
 490   (let ((stack (list split))
 491         (all-visible t)
 492         type buffer win buf)
 493     (while (and (setq split (pop stack))
 494                 all-visible)
 495       ;; Be backwards compatible.
 496       (when (vectorp split)
 497         (setq split (append split nil)))
 498       (when (or (consp (car split))
 499                 (vectorp (car split)))
 500         (push 1.0 split)
 501         (push 'vertical split))
 502       ;; The SPLIT might be something that is to be evaled to
 503       ;; return a new SPLIT.
 504       (while (and (not (assq (car split) gnus-window-to-buffer))
 505                   (gnus-functionp (car split)))
 506         (setq split (eval split)))
 507
 508       (setq type (elt split 0))
 509       (cond
 510        ;; Nothing here.
 511        ((null split) t)
 512        ;; A buffer.
 513        ((not (memq type '(horizontal vertical frame)))
 514         (setq buffer (cond ((stringp type) type)
 515                            (t (cdr (assq type gnus-window-to-buffer)))))
 516         (unless buffer
 517           (error "Invalid buffer type: %s" type))
 518         (if (and (setq buf (get-buffer (gnus-window-to-buffer-helper buffer)))
 519                  (setq win (get-buffer-window buf t)))
 520             (if (memq 'point split)
 521                 (setq all-visible win))
 522           (setq all-visible nil)))
 523        (t
 524         (when (eq type 'frame)
 525           (setq gnus-frame-split-p t))
 526         (setq stack (append (cddr split) stack)))))
 527     (unless (eq all-visible t)
 528       all-visible)))
 529
 530 (defun gnus-window-top-edge (&optional window)
 531   (nth 1 (window-edges window)))
 532
 533 (defun gnus-remove-some-windows ()
 534   (let ((buffers (gnus-buffers))
 535         buf bufs lowest-buf lowest)
 536     (save-excursion
 537       ;; Remove windows on all known Gnus buffers.
 538       (while (setq buf (pop buffers))
 539         (when (get-buffer-window buf)
 540           (push buf bufs)
 541           (pop-to-buffer buf)
 542           (when (or (not lowest)
 543                     (< (gnus-window-top-edge) lowest))
 544             (setq lowest (gnus-window-top-edge)
 545                   lowest-buf buf))))
 546       (when lowest-buf
 547         (pop-to-buffer lowest-buf)
 548         (if (featurep 'xemacs)
 549             (switch-to-buffer nntp-server-buffer)
 550           (set-buffer nntp-server-buffer)))
 551       (mapcar (lambda (b) (delete-windows-on b t)) bufs))))
 552
 553 (provide 'gnus-win)
 554
 555 ;;; gnus-win.el ends here