lisp/frame.el

   1 ;;; frame.el --- multi-frame management independent of window systems.
   2
   3 ;; Copyright (C) 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: internal
   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 ;;; Code:
  26
  27 (defvar frame-creation-function nil
  28   "Window-system dependent function to call to create a new frame.
  29 The window system startup file should set this to its frame creation
  30 function, which should take an alist of parameters as its argument.")
  31
  32 ;;; The initial value given here for used to ask for a minibuffer.
  33 ;;; But that's not necessary, because the default is to have one.
  34 ;;; By not specifying it here, we let an X resource specify it.
  35 (defcustom initial-frame-alist nil
  36   "*Alist of frame parameters for creating the initial X window frame.
  37 You can set this in your `.emacs' file; for example,
  38  (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
  39 Parameters specified here supersede the values given in `default-frame-alist'.
  40
  41 If the value calls for a frame without a minibuffer, and you have not created
  42 a minibuffer frame on your own, one is created according to
  43 `minibuffer-frame-alist'.
  44
  45 You can specify geometry-related options for just the initial frame
  46 by setting this variable in your `.emacs' file; however, they won't
  47 take effect until Emacs reads `.emacs', which happens after first creating
  48 the frame.  If you want the frame to have the proper geometry as soon
  49 as it appears, you need to use this three-step process:
  50 * Specify X resources to give the geometry you want.
  51 * Set `default-frame-alist' to override these options so that they
  52   don't affect subsequent frames.
  53 * Set `initial-frame-alist' in a way that matches the X resources,
  54   to override what you put in `default-frame-alist'."
  55   :type '(repeat (cons :format "%v"
  56                        (symbol :tag "Parameter")
  57                        (sexp :tag "Value")))
  58   :group 'frames)
  59
  60 (defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  61   "*Alist of frame parameters for initially creating a minibuffer frame.
  62 You can set this in your `.emacs' file; for example,
  63  (setq minibuffer-frame-alist
  64    '((top . 1) (left . 1) (width . 80) (height . 2)))
  65 Parameters specified here supersede the values given in
  66 `default-frame-alist', for a minibuffer frame."
  67   :type '(repeat (cons :format "%v"
  68                        (symbol :tag "Parameter")
  69                        (sexp :tag "Value")))
  70   :group 'frames)
  71
  72 (defcustom pop-up-frame-alist nil
  73   "*Alist of frame parameters used when creating pop-up frames.
  74 Pop-up frames are used for completions, help, and the like.
  75 This variable can be set in your init file, like this:
  76   (setq pop-up-frame-alist '((width . 80) (height . 20)))
  77 These supersede the values given in `default-frame-alist',
  78 for pop-up frames."
  79   :type '(repeat (cons :format "%v"
  80                        (symbol :tag "Parameter")
  81                        (sexp :tag "Value")))
  82   :group 'frames)
  83
  84 (setq pop-up-frame-function
  85       (function (lambda ()
  86                   (make-frame pop-up-frame-alist))))
  87
  88 (defcustom special-display-frame-alist
  89   '((height . 14) (width . 80) (unsplittable . t))
  90   "*Alist of frame parameters used when creating special frames.
  91 Special frames are used for buffers whose names are in
  92 `special-display-buffer-names' and for buffers whose names match
  93 one of the regular expressions in `special-display-regexps'.
  94 This variable can be set in your init file, like this:
  95   (setq special-display-frame-alist '((width . 80) (height . 20)))
  96 These supersede the values given in `default-frame-alist'."
  97   :type '(repeat (cons :format "%v"
  98                          (symbol :tag "Parameter")
  99                          (sexp :tag "Value")))
 100   :group 'frames)
 101
 102 (defun special-display-popup-frame (buffer &optional args)
 103   "Display BUFFER in its own frame, reusing an existing window if any.
 104 Return the window chosen.
 105 Currently we do not insist on selecting the window within its frame.
 106 If ARGS is an alist, use it as a list of frame parameter specs.
 107 If ARGS is a list whose car is a symbol,
 108 use (car ARGS) as a function to do the work.
 109 Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args."
 110   (if (and args (symbolp (car args)))
 111       (apply (car args) buffer (cdr args))
 112     (let ((window (get-buffer-window buffer t)))
 113       (if window
 114           ;; If we have a window already, make it visible.
 115           (let ((frame (window-frame window)))
 116             (make-frame-visible frame)
 117             (raise-frame frame)
 118             window)
 119         ;; If no window yet, make one in a new frame.
 120         (let ((frame (make-frame (append args special-display-frame-alist))))
 121           (set-window-buffer (frame-selected-window frame) buffer)
 122           (set-window-dedicated-p (frame-selected-window frame) t)
 123           (frame-selected-window frame))))))
 124
 125 (defun handle-delete-frame (event)
 126   "Handle delete-frame events from the X server."
 127   (interactive "e")
 128   (let ((frame (posn-window (event-start event)))
 129         (i 0)
 130         (tail (frame-list)))
 131     (while tail
 132       (and (frame-visible-p (car tail))
 133            (not (eq (car tail) frame))
 134           (setq i (1+ i)))
 135       (setq tail (cdr tail)))
 136     (if (> i 0)
 137         (delete-frame frame t)
 138       ;; Gildea@x.org says it is ok to ask questions before terminating.
 139       (save-buffers-kill-emacs))))
 140 \f
 141 ;;;; Arrangement of frames at startup
 142
 143 ;;; 1) Load the window system startup file from the lisp library and read the
 144 ;;; high-priority arguments (-q and the like).  The window system startup
 145 ;;; file should create any frames specified in the window system defaults.
 146 ;;;
 147 ;;; 2) If no frames have been opened, we open an initial text frame.
 148 ;;;
 149 ;;; 3) Once the init file is done, we apply any newly set parameters
 150 ;;; in initial-frame-alist to the frame.
 151
 152 ;; These are now called explicitly at the proper times,
 153 ;; since that is easier to understand.
 154 ;; Actually using hooks within Emacs is bad for future maintenance. --rms.
 155 ;; (add-hook 'before-init-hook 'frame-initialize)
 156 ;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
 157
 158 ;;; If we create the initial frame, this is it.
 159 (defvar frame-initial-frame nil)
 160
 161 ;; Record the parameters used in frame-initialize to make the initial frame.
 162 (defvar frame-initial-frame-alist)
 163
 164 (defvar frame-initial-geometry-arguments nil)
 165
 166 ;;; startup.el calls this function before loading the user's init
 167 ;;; file - if there is no frame with a minibuffer open now, create
 168 ;;; one to display messages while loading the init file.
 169 (defun frame-initialize ()
 170   "Create an in initial frame if necessary."
 171   ;; Are we actually running under a window system at all?
 172   (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
 173       (progn
 174         ;; Turn on special-display processing only if there's a window system.
 175         (setq special-display-function 'special-display-popup-frame)
 176
 177         ;; If there is no frame with a minibuffer besides the terminal
 178         ;; frame, then we need to create the opening frame.  Make sure
 179         ;; it has a minibuffer, but let initial-frame-alist omit the
 180         ;; minibuffer spec.
 181         (or (delq terminal-frame (minibuffer-frame-list))
 182             (progn
 183               (setq frame-initial-frame-alist
 184                     (append initial-frame-alist default-frame-alist nil))
 185               (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
 186                   (setq frame-initial-frame-alist
 187                         (cons '(horizontal-scroll-bars . t)
 188                               frame-initial-frame-alist)))
 189               (setq default-minibuffer-frame
 190                     (setq frame-initial-frame
 191                           (make-frame frame-initial-frame-alist)))
 192               ;; Delete any specifications for window geometry parameters
 193               ;; so that we won't reapply them in frame-notice-user-settings.
 194               ;; It would be wrong to reapply them then,
 195               ;; because that would override explicit user resizing.
 196               (setq initial-frame-alist
 197                     (frame-remove-geometry-params initial-frame-alist))))
 198         ;; At this point, we know that we have a frame open, so we
 199         ;; can delete the terminal frame.
 200         (delete-frame terminal-frame)
 201         (setq terminal-frame nil))
 202
 203     ;; No, we're not running a window system.  Use make-terminal-frame if
 204     ;; we support that feature, otherwise arrange to cause errors.
 205     (or (eq window-system 'pc)
 206         (setq frame-creation-function
 207               (if (fboundp 'tty-create-frame-with-faces)
 208                   'tty-create-frame-with-faces
 209                 (function
 210                  (lambda (parameters)
 211                    (error
 212                     "Can't create multiple frames without a window system"))))))))
 213
 214 (defvar frame-notice-user-settings t
 215   "Non-nil means function `frame-notice-user-settings' wasn't run yet.")
 216
 217 ;;; startup.el calls this function after loading the user's init
 218 ;;; file.  Now default-frame-alist and initial-frame-alist contain
 219 ;;; information to which we must react; do what needs to be done.
 220 (defun frame-notice-user-settings ()
 221   "Act on user's init file settings of frame parameters.
 222 React to settings of `default-frame-alist', `initial-frame-alist' there."
 223   ;; Make menu-bar-mode and default-frame-alist consistent.
 224   (if (boundp 'menu-bar-mode)
 225       (let ((default (assq 'menu-bar-lines default-frame-alist)))
 226         (if default
 227             (setq menu-bar-mode (not (eq (cdr default) 0)))
 228           (setq default-frame-alist
 229                 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
 230                       default-frame-alist)))))
 231
 232   ;; Creating and deleting frames may shift the selected frame around,
 233   ;; and thus the current buffer.  Protect against that.  We don't
 234   ;; want to use save-excursion here, because that may also try to set
 235   ;; the buffer of the selected window, which fails when the selected
 236   ;; window is the minibuffer.
 237   (let ((old-buffer (current-buffer)))
 238
 239     (when (and frame-notice-user-settings
 240                (null frame-initial-frame))
 241       ;; This case happens when we don't have a window system.
 242       (let ((parms (frame-parameters frame-initial-frame)))
 243         ;; Don't change the frame names.
 244         (setq parms (delq (assq 'name parms) parms))
 245         ;; Can't modify the minibuffer parameter, so don't try.
 246         (setq parms (delq (assq 'minibuffer parms) parms))
 247         (modify-frame-parameters nil
 248                                  (append initial-frame-alist
 249                                          default-frame-alist
 250                                          parms
 251                                          nil))))
 252
 253     ;; If the initial frame is still around, apply initial-frame-alist
 254     ;; and default-frame-alist to it.
 255     (if (frame-live-p frame-initial-frame)
 256
 257         ;; The initial frame we create above always has a minibuffer.
 258         ;; If the user wants to remove it, or make it a minibuffer-only
 259         ;; frame, then we'll have to delete the current frame and make a
 260         ;; new one; you can't remove or add a root window to/from an
 261         ;; existing frame.
 262         ;;
 263         ;; NOTE: default-frame-alist was nil when we created the
 264         ;; existing frame.  We need to explicitly include
 265         ;; default-frame-alist in the parameters of the screen we
 266         ;; create here, so that its new value, gleaned from the user's
 267         ;; .emacs file, will be applied to the existing screen.
 268         (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
 269                               (assq 'minibuffer default-frame-alist)
 270                               '(minibuffer . t)))
 271                      t))
 272             ;; Create the new frame.
 273             (let (parms new)
 274               ;; If the frame isn't visible yet, wait till it is.
 275               ;; If the user has to position the window,
 276               ;; Emacs doesn't know its real position until
 277               ;; the frame is seen to be visible.
 278               (while (not (cdr (assq 'visibility
 279                                      (frame-parameters frame-initial-frame))))
 280                 (sleep-for 1))
 281               (setq parms (frame-parameters frame-initial-frame))
 282               ;; Get rid of `name' unless it was specified explicitly before.
 283               (or (assq 'name frame-initial-frame-alist)
 284                   (setq parms (delq (assq 'name parms) parms)))
 285               (setq parms (append initial-frame-alist
 286                                   default-frame-alist
 287                                   parms
 288                                   nil))
 289               ;; Get rid of `reverse', because that was handled
 290               ;; when we first made the frame.
 291               (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
 292               (if (assq 'height frame-initial-geometry-arguments)
 293                   (setq parms (assoc-delete-all 'height parms)))
 294               (if (assq 'width frame-initial-geometry-arguments)
 295                   (setq parms (assoc-delete-all 'width parms)))
 296               (if (assq 'left frame-initial-geometry-arguments)
 297                   (setq parms (assoc-delete-all 'left parms)))
 298               (if (assq 'top frame-initial-geometry-arguments)
 299                   (setq parms (assoc-delete-all 'top parms)))
 300               (setq new
 301                     (make-frame
 302                      ;; Use the geometry args that created the existing
 303                      ;; frame, rather than the parms we get for it.
 304                      (append frame-initial-geometry-arguments
 305                              '((user-size . t) (user-position . t))
 306                              parms)))
 307               ;; The initial frame, which we are about to delete, may be
 308               ;; the only frame with a minibuffer.  If it is, create a
 309               ;; new one.
 310               (or (delq frame-initial-frame (minibuffer-frame-list))
 311                   (make-initial-minibuffer-frame nil))
 312
 313               ;; If the initial frame is serving as a surrogate
 314               ;; minibuffer frame for any frames, we need to wean them
 315               ;; onto a new frame.  The default-minibuffer-frame
 316               ;; variable must be handled similarly.
 317               (let ((users-of-initial
 318                      (filtered-frame-list
 319                       (function (lambda (frame)
 320                                   (and (not (eq frame frame-initial-frame))
 321                                        (eq (window-frame
 322                                             (minibuffer-window frame))
 323                                            frame-initial-frame)))))))
 324                 (if (or users-of-initial
 325                         (eq default-minibuffer-frame frame-initial-frame))
 326
 327                     ;; Choose an appropriate frame.  Prefer frames which
 328                     ;; are only minibuffers.
 329                     (let* ((new-surrogate
 330                             (car
 331                              (or (filtered-frame-list
 332                                   (function
 333                                    (lambda (frame)
 334                                      (eq (cdr (assq 'minibuffer
 335                                                     (frame-parameters frame)))
 336                                          'only))))
 337                                  (minibuffer-frame-list))))
 338                            (new-minibuffer (minibuffer-window new-surrogate)))
 339
 340                       (if (eq default-minibuffer-frame frame-initial-frame)
 341                           (setq default-minibuffer-frame new-surrogate))
 342
 343                       ;; Wean the frames using frame-initial-frame as
 344                       ;; their minibuffer frame.
 345                       (mapcar
 346                        (function
 347                         (lambda (frame)
 348                           (modify-frame-parameters
 349                            frame (list (cons 'minibuffer new-minibuffer)))))
 350                        users-of-initial))))
 351
 352               ;; Redirect events enqueued at this frame to the new frame.
 353               ;; Is this a good idea?
 354               (redirect-frame-focus frame-initial-frame new)
 355
 356               ;; Finally, get rid of the old frame.
 357               (delete-frame frame-initial-frame t))
 358
 359           ;; Otherwise, we don't need all that rigamarole; just apply
 360           ;; the new parameters.
 361           (let (newparms allparms tail)
 362             (setq allparms (append initial-frame-alist
 363                                    default-frame-alist))
 364             (if (assq 'height frame-initial-geometry-arguments)
 365                 (setq allparms (assoc-delete-all 'height allparms)))
 366             (if (assq 'width frame-initial-geometry-arguments)
 367                 (setq allparms (assoc-delete-all 'width allparms)))
 368             (if (assq 'left frame-initial-geometry-arguments)
 369                 (setq allparms (assoc-delete-all 'left allparms)))
 370             (if (assq 'top frame-initial-geometry-arguments)
 371                 (setq allparms (assoc-delete-all 'top allparms)))
 372             (setq tail allparms)
 373             ;; Find just the parms that have changed since we first
 374             ;; made this frame.  Those are the ones actually set by
 375             ;; the init file.  For those parms whose values we already knew
 376             ;; (such as those spec'd by command line options)
 377             ;; it is undesirable to specify the parm again
 378             ;; once the user has seen the frame and been able to alter it
 379             ;; manually.
 380             (while tail
 381               (let (newval oldval)
 382                 (setq oldval (assq (car (car tail))
 383                                    frame-initial-frame-alist))
 384                 (setq newval (cdr (assq (car (car tail)) allparms)))
 385                 (or (and oldval (eq (cdr oldval) newval))
 386                     (setq newparms
 387                           (cons (cons (car (car tail)) newval) newparms))))
 388               (setq tail (cdr tail)))
 389             (setq newparms (nreverse newparms))
 390             (modify-frame-parameters frame-initial-frame
 391                                      newparms)
 392             ;; If we changed the background color,
 393             ;; we need to update the background-mode parameter
 394             ;; and maybe some faces too.
 395             (when (assq 'background-color newparms)
 396               (unless (assq 'background-mode newparms)
 397                 (frame-set-background-mode frame-initial-frame))
 398               (face-set-after-frame-default frame-initial-frame))
 399             (if (assq 'font newparms)
 400                 (frame-update-faces frame-initial-frame)))))
 401
 402     ;; Restore the original buffer.
 403     (set-buffer old-buffer)
 404
 405     ;; Make sure the initial frame can be GC'd if it is ever deleted.
 406     ;; Make sure frame-notice-user-settings does nothing if called twice.
 407     (setq frame-notice-user-settings nil)
 408     (setq frame-initial-frame nil)))
 409
 410 (defun make-initial-minibuffer-frame (display)
 411   (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
 412     (if display
 413         (make-frame-on-display display parms)
 414       (make-frame parms))))
 415
 416 ;;;; Creation of additional frames, and other frame miscellanea
 417
 418 (defun get-other-frame ()
 419   "Return some frame other than the current frame.
 420 Create one if necessary.  Note that the minibuffer frame, if separate,
 421 is not considered (see `next-frame')."
 422   (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
 423                (make-frame)
 424              (next-frame (selected-frame)))))
 425     s))
 426
 427 (defun next-multiframe-window ()
 428   "Select the next window, regardless of which frame it is on."
 429   (interactive)
 430   (select-window (next-window (selected-window)
 431                               (> (minibuffer-depth) 0)
 432                               t)))
 433
 434 (defun previous-multiframe-window ()
 435   "Select the previous window, regardless of which frame it is on."
 436   (interactive)
 437   (select-window (previous-window (selected-window)
 438                                   (> (minibuffer-depth) 0)
 439                                   t)))
 440
 441 (defun make-frame-on-display (display &optional parameters)
 442   "Make a frame on display DISPLAY.
 443 The optional second argument PARAMETERS specifies additional frame parameters."
 444   (interactive "sMake frame on display: ")
 445   (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
 446       (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
 447   (make-frame (cons (cons 'display display) parameters)))
 448
 449 (defun make-frame-command ()
 450   "Make a new frame, and select it if the terminal displays only one frame."
 451   (interactive)
 452   (if (and window-system (not (eq window-system 'pc)))
 453       (make-frame)
 454     (select-frame (make-frame))))
 455
 456 (defvar before-make-frame-hook nil
 457   "Functions to run before a frame is created.")
 458
 459 (defvar after-make-frame-functions nil
 460   "Functions to run after a frame is created.
 461 The functions are run with one arg, the newly created frame.")
 462
 463 (defvar after-setting-font-hooks nil
 464   "Functions to run after a frame's font has been changed.")
 465
 466 ;; Alias, kept temporarily.
 467 (defalias 'new-frame 'make-frame)
 468
 469 (defun make-frame (&optional parameters)
 470   "Return a newly created frame displaying the current buffer.
 471 Optional argument PARAMETERS is an alist of parameters for the new frame.
 472 Each element of PARAMETERS should have the form (NAME . VALUE), for example:
 473
 474  (name . STRING)        The frame should be named STRING.
 475
 476  (width . NUMBER)       The frame should be NUMBER characters in width.
 477  (height . NUMBER)      The frame should be NUMBER text lines high.
 478
 479 You cannot specify either `width' or `height', you must use neither or both.
 480
 481  (minibuffer . t)       The frame should have a minibuffer.
 482  (minibuffer . nil)     The frame should have no minibuffer.
 483  (minibuffer . only)    The frame should contain only a minibuffer.
 484  (minibuffer . WINDOW)  The frame should use WINDOW as its minibuffer window.
 485
 486 Before the frame is created (via `frame-creation-function'), functions on the
 487 hook `before-make-frame-hook' are run.  After the frame is created, functions
 488 on `after-make-frame-functions' are run with one arg, the newly created frame."
 489   (interactive)
 490   (run-hooks 'before-make-frame-hook)
 491   (let ((frame (funcall frame-creation-function parameters)))
 492     (run-hook-with-args 'after-make-frame-functions frame)
 493     frame))
 494
 495 (defun filtered-frame-list (predicate)
 496   "Return a list of all live frames which satisfy PREDICATE."
 497   (let ((frames (frame-list))
 498         good-frames)
 499     (while (consp frames)
 500       (if (funcall predicate (car frames))
 501           (setq good-frames (cons (car frames) good-frames)))
 502       (setq frames (cdr frames)))
 503     good-frames))
 504
 505 (defun minibuffer-frame-list ()
 506   "Return a list of all frames with their own minibuffers."
 507   (filtered-frame-list
 508    (function (lambda (frame)
 509                (eq frame (window-frame (minibuffer-window frame)))))))
 510
 511 (defun frames-on-display-list (&optional display)
 512   "Return a list of all frames on DISPLAY.
 513 DISPLAY is a name of a display, a string of the form HOST:SERVER.SCREEN.
 514 If DISPLAY is omitted or nil, it defaults to the selected frame's display."
 515   (let* ((display (or display
 516                       (cdr (assoc 'display (frame-parameters)))))
 517          (func
 518           (function (lambda (frame)
 519                       (eq (cdr (assoc 'display (frame-parameters frame)))
 520                           display)))))
 521     (filtered-frame-list func)))
 522
 523 (defun framep-on-display (&optional display)
 524   "Return the type of frames on DISPLAY.
 525 DISPLAY may be a display name or a frame.  If it is a frame, its type is
 526 returned.
 527 If DISPLAY is omitted or nil, it defaults to the selected frame's display.
 528 All frames on a given display are of the same type."
 529   (or (framep display)
 530       (framep (car (frames-on-display-list display)))))
 531
 532 (defun frame-remove-geometry-params (param-list)
 533   "Return the parameter list PARAM-LIST, but with geometry specs removed.
 534 This deletes all bindings in PARAM-LIST for `top', `left', `width',
 535 `height', `user-size' and `user-position' parameters.
 536 Emacs uses this to avoid overriding explicit moves and resizings from
 537 the user during startup."
 538   (setq param-list (cons nil param-list))
 539   (let ((tail param-list))
 540     (while (consp (cdr tail))
 541       (if (and (consp (car (cdr tail)))
 542                (memq (car (car (cdr tail)))
 543                      '(height width top left user-position user-size)))
 544           (progn
 545             (setq frame-initial-geometry-arguments
 546                   (cons (car (cdr tail)) frame-initial-geometry-arguments))
 547             (setcdr tail (cdr (cdr tail))))
 548         (setq tail (cdr tail)))))
 549   (setq frame-initial-geometry-arguments
 550         (nreverse frame-initial-geometry-arguments))
 551   (cdr param-list))
 552
 553
 554 (defcustom focus-follows-mouse t
 555   "*Non-nil if window system changes focus when you move the mouse."
 556   :type 'boolean
 557   :group 'frames
 558   :version "20.3")
 559
 560 (defun other-frame (arg)
 561   "Select the ARG'th different visible frame, and raise it.
 562 All frames are arranged in a cyclic order.
 563 This command selects the frame ARG steps away in that order.
 564 A negative ARG moves in the opposite order."
 565   (interactive "p")
 566   (let ((frame (selected-frame)))
 567     (while (> arg 0)
 568       (setq frame (next-frame frame))
 569       (while (not (eq (frame-visible-p frame) t))
 570         (setq frame (next-frame frame)))
 571       (setq arg (1- arg)))
 572     (while (< arg 0)
 573       (setq frame (previous-frame frame))
 574       (while (not (eq (frame-visible-p frame) t))
 575         (setq frame (previous-frame frame)))
 576       (setq arg (1+ arg)))
 577     (raise-frame frame)
 578     (select-frame frame)
 579     ;; Ensure, if possible, that frame gets input focus.
 580     (if (eq window-system 'w32)
 581         (w32-focus-frame frame)
 582       (when focus-follows-mouse
 583         (set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
 584
 585 (defun make-frame-names-alist ()
 586   (let* ((current-frame (selected-frame))
 587          (falist
 588           (cons
 589            (cons (frame-parameter current-frame 'name) current-frame) nil))
 590          (frame (next-frame nil t)))
 591     (while (not (eq frame current-frame))
 592       (progn
 593         (setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
 594         (setq frame (next-frame frame t))))
 595     falist))
 596
 597 (defvar frame-name-history nil)
 598 (defun select-frame-by-name (name)
 599   "Select the frame whose name is NAME and raise it.
 600 If there is no frame by that name, signal an error."
 601   (interactive
 602    (let* ((frame-names-alist (make-frame-names-alist))
 603            (default (car (car frame-names-alist)))
 604            (input (completing-read
 605                    (format "Select Frame (default %s): " default)
 606                    frame-names-alist nil t nil 'frame-name-history)))
 607      (if (= (length input) 0)
 608          (list default)
 609        (list input))))
 610   (let* ((frame-names-alist (make-frame-names-alist))
 611          (frame (cdr (assoc name frame-names-alist))))
 612     (or frame
 613         (error "There is no frame named `%s'" name))
 614     (make-frame-visible frame)
 615     (raise-frame frame)
 616     (select-frame frame)
 617     ;; Ensure, if possible, that frame gets input focus.
 618     (if (eq window-system 'w32)
 619         (w32-focus-frame frame)
 620       (when focus-follows-mouse
 621         (set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
 622 \f
 623 ;;;; Frame configurations
 624
 625 (defun current-frame-configuration ()
 626   "Return a list describing the positions and states of all frames.
 627 Its car is `frame-configuration'.
 628 Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
 629 where
 630   FRAME is a frame object,
 631   ALIST is an association list specifying some of FRAME's parameters, and
 632   WINDOW-CONFIG is a window configuration object for FRAME."
 633   (cons 'frame-configuration
 634         (mapcar (function
 635                  (lambda (frame)
 636                    (list frame
 637                          (frame-parameters frame)
 638                          (current-window-configuration frame))))
 639                 (frame-list))))
 640
 641 (defun set-frame-configuration (configuration &optional nodelete)
 642   "Restore the frames to the state described by CONFIGURATION.
 643 Each frame listed in CONFIGURATION has its position, size, window
 644 configuration, and other parameters set as specified in CONFIGURATION.
 645 Ordinarily, this function deletes all existing frames not
 646 listed in CONFIGURATION.  But if optional second argument NODELETE
 647 is given and non-nil, the unwanted frames are iconified instead."
 648   (or (frame-configuration-p configuration)
 649       (signal 'wrong-type-argument
 650               (list 'frame-configuration-p configuration)))
 651   (let ((config-alist (cdr configuration))
 652         frames-to-delete)
 653     (mapcar (function
 654              (lambda (frame)
 655                (let ((parameters (assq frame config-alist)))
 656                  (if parameters
 657                      (progn
 658                        (modify-frame-parameters
 659                         frame
 660                         ;; Since we can't set a frame's minibuffer status,
 661                         ;; we might as well omit the parameter altogether.
 662                         (let* ((parms (nth 1 parameters))
 663                                (mini (assq 'minibuffer parms)))
 664                           (if mini (setq parms (delq mini parms)))
 665                           parms))
 666                        (set-window-configuration (nth 2 parameters)))
 667                    (setq frames-to-delete (cons frame frames-to-delete))))))
 668             (frame-list))
 669     (if nodelete
 670         ;; Note: making frames invisible here was tried
 671         ;; but led to some strange behavior--each time the frame
 672         ;; was made visible again, the window manager asked afresh
 673         ;; for where to put it.
 674         (mapcar 'iconify-frame frames-to-delete)
 675       (mapcar 'delete-frame frames-to-delete))))
 676 \f
 677 ;;;; Convenience functions for accessing and interactively changing
 678 ;;;; frame parameters.
 679
 680 (defun frame-parameter (frame parameter)
 681   "Return FRAME's value for parameter PARAMETER.
 682 If FRAME is nil, describe the currently selected frame."
 683   (cdr (assq parameter (frame-parameters frame))))
 684
 685 (defun frame-height (&optional frame)
 686   "Return number of lines available for display on FRAME.
 687 If FRAME is omitted, describe the currently selected frame."
 688   (cdr (assq 'height (frame-parameters frame))))
 689
 690 (defun frame-width (&optional frame)
 691   "Return number of columns available for display on FRAME.
 692 If FRAME is omitted, describe the currently selected frame."
 693   (cdr (assq 'width (frame-parameters frame))))
 694
 695 (defalias 'set-default-font 'set-frame-font)
 696 (defun set-frame-font (font-name)
 697   "Set the font of the selected frame to FONT-NAME.
 698 When called interactively, prompt for the name of the font to use.
 699 To get the frame's current default font, use `frame-parameters'."
 700   (interactive "sFont name: ")
 701   (modify-frame-parameters (selected-frame)
 702                            (list (cons 'font font-name)))
 703   ;; Update faces that want a bold or italic version of the default font.
 704   (frame-update-faces (selected-frame))
 705   (run-hooks 'after-setting-font-hooks))
 706
 707 (defun set-background-color (color-name)
 708   "Set the background color of the selected frame to COLOR-NAME.
 709 When called interactively, prompt for the name of the color to use.
 710 To get the frame's current background color, use `frame-parameters'."
 711   (interactive (list (facemenu-read-color)))
 712   (modify-frame-parameters (selected-frame)
 713                            (list (cons 'background-color color-name)))
 714   (frame-update-face-colors (selected-frame)))
 715
 716 (defun set-foreground-color (color-name)
 717   "Set the foreground color of the selected frame to COLOR-NAME.
 718 When called interactively, prompt for the name of the color to use.
 719 To get the frame's current foreground color, use `frame-parameters'."
 720   (interactive (list (facemenu-read-color)))
 721   (modify-frame-parameters (selected-frame)
 722                            (list (cons 'foreground-color color-name)))
 723   (frame-update-face-colors (selected-frame)))
 724
 725 (defun set-cursor-color (color-name)
 726   "Set the text cursor color of the selected frame to COLOR-NAME.
 727 When called interactively, prompt for the name of the color to use.
 728 To get the frame's current cursor color, use `frame-parameters'."
 729   (interactive (list (facemenu-read-color)))
 730   (modify-frame-parameters (selected-frame)
 731                            (list (cons 'cursor-color color-name))))
 732
 733 (defun set-mouse-color (color-name)
 734   "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
 735 When called interactively, prompt for the name of the color to use.
 736 To get the frame's current mouse color, use `frame-parameters'."
 737   (interactive (list (facemenu-read-color)))
 738   (modify-frame-parameters (selected-frame)
 739                            (list (cons 'mouse-color
 740                                        (or color-name
 741                                            (cdr (assq 'mouse-color
 742                                                       (frame-parameters))))))))
 743
 744 (defun set-border-color (color-name)
 745   "Set the color of the border of the selected frame to COLOR-NAME.
 746 When called interactively, prompt for the name of the color to use.
 747 To get the frame's current border color, use `frame-parameters'."
 748   (interactive (list (facemenu-read-color)))
 749   (modify-frame-parameters (selected-frame)
 750                            (list (cons 'border-color color-name))))
 751
 752 (defun auto-raise-mode (arg)
 753   "Toggle whether or not the selected frame should auto-raise.
 754 With arg, turn auto-raise mode on if and only if arg is positive.
 755 Note that this controls Emacs's own auto-raise feature.
 756 Some window managers allow you to enable auto-raise for certain windows.
 757 You can use that for Emacs windows if you wish, but if you do,
 758 that is beyond the control of Emacs and this command has no effect on it."
 759   (interactive "P")
 760   (if (null arg)
 761       (setq arg
 762             (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
 763                 -1 1)))
 764   (if (> arg 0)
 765       (raise-frame (selected-frame)))
 766   (modify-frame-parameters (selected-frame)
 767                            (list (cons 'auto-raise (> arg 0)))))
 768
 769 (defun auto-lower-mode (arg)
 770   "Toggle whether or not the selected frame should auto-lower.
 771 With arg, turn auto-lower mode on if and only if arg is positive.
 772 Note that this controls Emacs's own auto-lower feature.
 773 Some window managers allow you to enable auto-lower for certain windows.
 774 You can use that for Emacs windows if you wish, but if you do,
 775 that is beyond the control of Emacs and this command has no effect on it."
 776   (interactive "P")
 777   (if (null arg)
 778       (setq arg
 779             (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
 780                 -1 1)))
 781   (modify-frame-parameters (selected-frame)
 782                            (list (cons 'auto-lower (> arg 0)))))
 783 (defun set-frame-name (name)
 784   "Set the name of the selected frame to NAME.
 785 When called interactively, prompt for the name of the frame.
 786 The frame name is displayed on the modeline if the terminal displays only
 787 one frame, otherwise the name is displayed on the frame's caption bar."
 788   (interactive "sFrame name: ")
 789   (modify-frame-parameters (selected-frame)
 790                            (list (cons 'name name))))
 791 \f
 792 ;;;; Frame/display capabilities.
 793 (defun display-mouse-p (&optional display)
 794   "Return non-nil if DISPLAY has a mouse available.
 795 DISPLAY can be a display name, a frame, or nil (meaning the selected
 796 frame's display)."
 797   (let ((frame-type (framep-on-display display)))
 798     (cond
 799      ((eq frame-type 'pc)
 800       (msdos-mouse-p))
 801      ((eq system-type 'windows-nt)
 802       (> w32-num-mouse-buttons 0))
 803      ((memq frame-type '(x mac))
 804       t)    ;; We assume X and Mac *always* have a pointing device
 805      (t
 806       (featurep 'xt-mouse)))))
 807
 808 (defun display-popup-menus-p (&optional display)
 809   "Return non-nil if popup menus are supported on DISPLAY.
 810 DISPLAY can be a display name, a frame, or nil (meaning the selected
 811 frame's display).
 812 Support for popup menus requires that the mouse be available."
 813   (and
 814    (let ((frame-type (framep-on-display display)))
 815      (memq frame-type '(x w32 pc mac)))
 816    (display-mouse-p display)))
 817
 818 (defun display-graphic-p (&optional display)
 819   "Return non-nil if DISPLAY is a graphic display.
 820 Graphical displays are those which are capable of displaying several
 821 frames and several different fonts at once.  This is true for displays
 822 that use a window system such as X, and false for text-only terminals.
 823 DISPLAY can be a display name, a frame, or nil (meaning the selected
 824 frame's display)."
 825   (not (null (memq (framep-on-display display) '(x w32 mac)))))
 826
 827 (defun display-selections-p (&optional display)
 828   "Return non-nil if DISPLAY supports selections.
 829 A selection is a way to transfer text or other data between programs
 830 via special system buffers called `selection' or `cut buffer' or
 831 `clipboard'.
 832 DISPLAY can be a display name, a frame, or nil (meaning the selected
 833 frame's display)."
 834   (let ((frame-type (framep-on-display display)))
 835     (cond
 836      ((eq frame-type 'pc)
 837       ;; MS-DOG frames support selections when Emacs runs inside
 838       ;; the Windows' DOS Box.
 839       (not (null dos-windows-version)))
 840      ((memq frame-type '(x w32 mac))
 841       t)    ;; FIXME?
 842      (t
 843       nil))))
 844
 845 (defun display-screens (&optional display)
 846   "Return the number of screens associated with DISPLAY."
 847   (let ((frame-type (framep-on-display display)))
 848     (cond
 849      ((memq frame-type '(x w32))
 850       (x-display-screens display))
 851      (t ;; FIXME: is this correct for the Mac?
 852       1))))
 853
 854 (defun display-pixel-height (&optional display)
 855   "Return the height of DISPLAY's screen in pixels.
 856 For character terminals, each character counts as a single pixel."
 857   (let ((frame-type (framep-on-display display)))
 858     (cond
 859      ((memq frame-type '(x w32 mac))
 860       (x-display-pixel-height display))
 861      (t
 862       (frame-height (if (framep display) display (selected-frame)))))))
 863
 864 (defun display-pixel-width (&optional display)
 865   "Return the width of DISPLAY's screen in pixels.
 866 For character terminals, each character counts as a single pixel."
 867   (let ((frame-type (framep-on-display display)))
 868     (cond
 869      ((memq frame-type '(x w32 mac))
 870       (x-display-pixel-width display))
 871      (t
 872       (frame-width (if (framep display) display (selected-frame)))))))
 873
 874 (defun display-mm-height (&optional display)
 875   "Return the height of DISPLAY's screen in millimeters.
 876 If the information is unavailable, value is nil."
 877   (and (memq (framep-on-display display) '(x w32 mac))
 878        (x-display-mm-height display)))
 879
 880 (defun display-mm-width (&optional display)
 881   "Return the width of DISPLAY's screen in millimeters.
 882 If the information is unavailable, value is nil."
 883   (and (memq (framep-on-display display) '(x w32 mac))
 884        (x-display-mm-width display)))
 885
 886 (defun display-backing-store (&optional display)
 887   "Return the backing store capability of DISPLAY's screen.
 888 The value may be `always', `when-mapped', `not-useful', or nil if
 889 the question is inapplicable to a certain kind of display."
 890   (let ((frame-type (framep-on-display display)))
 891     (cond
 892      ((memq frame-type '(x w32 mac))
 893       (x-display-backing-store display))
 894      (t
 895       'not-useful))))
 896
 897 (defun display-save-under (&optional display)
 898   "Return non-nil if DISPLAY's screen supports the SaveUnder feature."
 899   (let ((frame-type (framep-on-display display)))
 900     (cond
 901      ((memq frame-type '(x w32 mac))
 902       (x-display-save-under display))
 903      (t
 904       'not-useful))))
 905
 906 (defun display-planes (&optional display)
 907   "Return the number of planes supported by DISPLAY."
 908   (let ((frame-type (framep-on-display display)))
 909     (cond
 910      ((memq frame-type '(x w32 mac))
 911       (x-display-planes display))
 912      ((eq frame-type 'pc)
 913       4)
 914      (t
 915       (truncate (log (length (tty-color-alist)) 2))))))
 916
 917 (defun display-color-cells (&optional display)
 918   "Return the number of color cells supported by DISPLAY."
 919   (let ((frame-type (framep-on-display display)))
 920     (cond
 921      ((memq frame-type '(x w32 mac))
 922       (x-display-color-cells display))
 923      ((eq frame-type 'pc)
 924       16)
 925      (t
 926       (length (tty-color-alist))))))
 927
 928 (defun display-visual-class (&optional display)
 929   "Returns the visual class of DISPLAY.
 930 The value is one of the symbols `static-gray', `gray-scale',
 931 `static-color', `pseudo-color', `true-color', or `direct-color'."
 932   (let ((frame-type (framep-on-display display)))
 933     (cond
 934      ((memq frame-type '(x w32 mac))
 935       (x-display-visual-class display))
 936      ((and (memq frame-type '(pc t))
 937            (tty-display-color-p display))
 938       'static-color)
 939      (t
 940       'static-gray))))
 941
 942 \f
 943 ;;;; Aliases for backward compatibility with Emacs 18.
 944 (defalias 'screen-height 'frame-height)
 945 (defalias 'screen-width 'frame-width)
 946
 947 (defun set-screen-width (cols &optional pretend)
 948   "Obsolete function to change the size of the screen to COLS columns.
 949 Optional second arg non-nil means that redisplay should use COLS columns
 950 but that the idea of the actual width of the frame should not be changed.
 951 This function is provided only for compatibility with Emacs 18; new code
 952 should use `set-frame-width instead'."
 953   (set-frame-width (selected-frame) cols pretend))
 954
 955 (defun set-screen-height (lines &optional pretend)
 956   "Obsolete function to change the height of the screen to LINES lines.
 957 Optional second arg non-nil means that redisplay should use LINES lines
 958 but that the idea of the actual height of the screen should not be changed.
 959 This function is provided only for compatibility with Emacs 18; new code
 960 should use `set-frame-height' instead."
 961   (set-frame-height (selected-frame) lines pretend))
 962
 963 (defun delete-other-frames (&optional frame)
 964   "Delete all frames except FRAME.
 965 FRAME nil or omitted means delete all frames except the selected frame."
 966   (interactive)
 967   (unless frame
 968     (setq frame (selected-frame)))
 969   (mapcar 'delete-frame (delq frame (frame-list))))
 970
 971
 972 (make-obsolete 'screen-height 'frame-height)
 973 (make-obsolete 'screen-width  'frame-width)
 974 (make-obsolete 'set-screen-width 'set-frame-width)
 975 (make-obsolete 'set-screen-height 'set-frame-height)
 976
 977 \f
 978 ;;; Highlighting trailing whitespace.
 979
 980 (make-variable-buffer-local 'show-trailing-whitespace)
 981
 982 (defcustom show-trailing-whitespace nil
 983   "*Non-nil means highlight trailing whitespace in face `trailing-whitespace'."
 984   :tag "Highlight trailing whitespace."
 985   :set #'(lambda (symbol value) (set-default symbol value))
 986   :type 'boolean
 987   :group 'font-lock)
 988
 989
 990 \f
 991 ;;; Blinking cursor
 992
 993 (defgroup cursor nil
 994   "Displaying text cursors."
 995   :version "21.1"
 996   :group 'frames)
 997
 998 (defcustom blink-cursor-delay 0.5
 999   "*Seconds of idle time after which cursor starts to blink."
1000   :tag "Delay in seconds."
1001   :type 'number
1002   :group 'cursor)
1003
1004 (defcustom blink-cursor-interval 0.5
1005   "*Length of cursor blink interval in seconds."
1006   :tag "Blink interval in seconds."
1007   :type 'number
1008   :group 'cursor)
1009
1010 (defvar blink-cursor-idle-timer nil
1011   "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
1012 The function `blink-cursor-start' is called when the timer fires.")
1013
1014 (defvar blink-cursor-timer nil
1015   "Timer started from `blink-cursor-start'.
1016 This timer calls `blink-cursor' every `blink-cursor-interval' seconds.")
1017
1018 (defvar blink-cursor-mode nil
1019   "Non-nil means blinking cursor is active.")
1020
1021 (defun blink-cursor-mode (arg)
1022   "Toggle blinking cursor mode.
1023 With arg, turn blinking cursor mode on iff arg is positive.
1024 When blinking cursor mode is enabled, the cursor of the selected
1025 window blinks."
1026   (interactive "P")
1027   (let ((on-p (if (null arg)
1028                   (not blink-cursor-mode)
1029                 (> (prefix-numeric-value arg) 0))))
1030     (if blink-cursor-idle-timer
1031         (cancel-timer blink-cursor-idle-timer))
1032     (if blink-cursor-timer
1033         (cancel-timer blink-cursor-timer))
1034     (setq blink-cursor-idle-timer nil
1035           blink-cursor-timer nil
1036           blink-cursor-mode nil)
1037     (if on-p
1038         (progn
1039           ;; Hide the cursor.
1040           (internal-show-cursor nil nil)
1041           (setq blink-cursor-idle-timer
1042                 (run-with-idle-timer blink-cursor-delay
1043                                      blink-cursor-delay
1044                                      'blink-cursor-start))
1045           (setq blink-cursor-mode t)))))
1046
1047 (defcustom blink-cursor (not (eq system-type 'ms-dos))
1048   "*Non-nil means blinking cursor mode is active."
1049   :tag "Blinking cursor"
1050   :type 'boolean
1051   :group 'cursor
1052   :set #'(lambda (symbol value)
1053            (set-default symbol value)
1054            (blink-cursor-mode (or value 0))))
1055
1056 (defun blink-cursor-start ()
1057   "Timer function called from the timer `blink-cursor-idle-timer'.
1058 This starts the timer `blink-cursor-timer', which makes the cursor blink
1059 if appropriate.  It also arranges to cancel that timer when the next
1060 command starts, by installing a pre-command hook."
1061   (when (null blink-cursor-timer)
1062     (add-hook 'pre-command-hook 'blink-cursor-end)
1063     (setq blink-cursor-timer
1064           (run-with-timer blink-cursor-interval blink-cursor-interval
1065                           'blink-cursor-timer-function))))
1066
1067 (defun blink-cursor-timer-function ()
1068   "Timer function of timer `blink-cursor-timer'."
1069   (internal-show-cursor nil (not (internal-show-cursor-p))))
1070
1071 (defun blink-cursor-end ()
1072   "Stop cursor blinking.
1073 This is installed as a pre-command hook by `blink-cursor-start'.
1074 When run, it cancels the timer `blink-cursor-timer' and removes
1075 itself as a pre-command hook."
1076   (remove-hook 'pre-command-hook 'blink-cursor-end)
1077   (internal-show-cursor nil t)
1078   (cancel-timer blink-cursor-timer)
1079   (setq blink-cursor-timer nil))
1080
1081
1082 \f
1083 ;;; Busy-cursor.
1084
1085 (defcustom busy-cursor t
1086   "*Non-nil means show a busy-cursor when running under a window system."
1087   :tag "Busy-cursor"
1088   :type 'boolean
1089   :group 'cursor
1090   :get #'(lambda (symbol) display-busy-cursor)
1091   :set #'(lambda (symbol value)
1092            (set-default symbol value)
1093            (setq display-busy-cursor value)))
1094
1095
1096 \f
1097 ;;;; Key bindings
1098
1099 (define-key ctl-x-5-map "2" 'make-frame-command)
1100 (define-key ctl-x-5-map "1" 'delete-other-frames)
1101 (define-key ctl-x-5-map "0" 'delete-frame)
1102 (define-key ctl-x-5-map "o" 'other-frame)
1103
1104 (provide 'frame)
1105
1106 ;;; frame.el ends here
1107 (frame-notice-user-settings):