lisp/frame.el

   1 ;;; frame.el --- multi-frame management independent of window systems
   2
   3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006 Free Software Foundation, Inc.
   5
   6 ;; Maintainer: FSF
   7 ;; Keywords: internal
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (defvar frame-creation-function-alist
  31   (list (cons nil
  32               (if (fboundp 'tty-create-frame-with-faces)
  33                   'tty-create-frame-with-faces
  34                 (function
  35                  (lambda (parameters)
  36                    (error "Can't create multiple frames without a window system"))))))
  37   "Alist of window-system dependent functions to call to create a new frame.
  38 The window system startup file should add its frame creation
  39 function to this list, which should take an alist of parameters
  40 as its argument.")
  41
  42 (defvar window-system-default-frame-alist nil
  43   "Alist of window-system dependent default frame parameters.
  44 You can set this in your `.emacs' file; for example,
  45
  46     ;; Disable menubar and toolbar on the console, but enable them under X.
  47     (setq window-system-default-frame-alist
  48           '((x (menu-bar-lines . 1) (tool-bar-lines . 1))
  49             (nil (menu-bar-lines . 0) (tool-bar-lines . 0))))
  50
  51 Parameters specified here supersede the values given in `default-frame-alist'.")
  52
  53 ;; The initial value given here used to ask for a minibuffer.
  54 ;; But that's not necessary, because the default is to have one.
  55 ;; By not specifying it here, we let an X resource specify it.
  56 (defcustom initial-frame-alist nil
  57   "*Alist of frame parameters for creating the initial X window frame.
  58 You can set this in your `.emacs' file; for example,
  59  (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
  60 Parameters specified here supersede the values given in `default-frame-alist'.
  61
  62 If the value calls for a frame without a minibuffer, and you have not created
  63 a minibuffer frame on your own, one is created according to
  64 `minibuffer-frame-alist'.
  65
  66 You can specify geometry-related options for just the initial frame
  67 by setting this variable in your `.emacs' file; however, they won't
  68 take effect until Emacs reads `.emacs', which happens after first creating
  69 the frame.  If you want the frame to have the proper geometry as soon
  70 as it appears, you need to use this three-step process:
  71 * Specify X resources to give the geometry you want.
  72 * Set `default-frame-alist' to override these options so that they
  73   don't affect subsequent frames.
  74 * Set `initial-frame-alist' in a way that matches the X resources,
  75   to override what you put in `default-frame-alist'."
  76   :type '(repeat (cons :format "%v"
  77                        (symbol :tag "Parameter")
  78                        (sexp :tag "Value")))
  79   :group 'frames)
  80
  81 (defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  82   "*Alist of frame parameters for initially creating a minibuffer frame.
  83 You can set this in your `.emacs' file; for example,
  84  (setq minibuffer-frame-alist
  85    '((top . 1) (left . 1) (width . 80) (height . 2)))
  86 Parameters specified here supersede the values given in
  87 `default-frame-alist', for a minibuffer frame."
  88   :type '(repeat (cons :format "%v"
  89                        (symbol :tag "Parameter")
  90                        (sexp :tag "Value")))
  91   :group 'frames)
  92
  93 (defcustom pop-up-frame-alist nil
  94   "*Alist of frame parameters used when creating pop-up frames.
  95 Pop-up frames are used for completions, help, and the like.
  96 This variable can be set in your init file, like this:
  97   (setq pop-up-frame-alist '((width . 80) (height . 20)))
  98 These supersede the values given in `default-frame-alist',
  99 for pop-up frames."
 100   :type '(repeat (cons :format "%v"
 101                        (symbol :tag "Parameter")
 102                        (sexp :tag "Value")))
 103   :group 'frames)
 104
 105 (setq pop-up-frame-function
 106       ;; Using `function' here caused some sort of problem.
 107       '(lambda ()
 108          (make-frame pop-up-frame-alist)))
 109
 110 (defcustom special-display-frame-alist
 111   '((height . 14) (width . 80) (unsplittable . t))
 112   "*Alist of frame parameters used when creating special frames.
 113 Special frames are used for buffers whose names are in
 114 `special-display-buffer-names' and for buffers whose names match
 115 one of the regular expressions in `special-display-regexps'.
 116 This variable can be set in your init file, like this:
 117   (setq special-display-frame-alist '((width . 80) (height . 20)))
 118 These supersede the values given in `default-frame-alist'."
 119   :type '(repeat (cons :format "%v"
 120                          (symbol :tag "Parameter")
 121                          (sexp :tag "Value")))
 122   :group 'frames)
 123
 124 (defun special-display-popup-frame (buffer &optional args)
 125   "Display BUFFER in its own frame, reusing an existing window if any.
 126 Return the window chosen.
 127 Currently we do not insist on selecting the window within its frame.
 128 If ARGS is an alist, use it as a list of frame parameter specs.
 129 If ARGS is a list whose car is a symbol,
 130 use (car ARGS) as a function to do the work.
 131 Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args."
 132   (if (and args (symbolp (car args)))
 133       (apply (car args) buffer (cdr args))
 134     (let ((window (get-buffer-window buffer 0)))
 135       (or
 136        ;; If we have a window already, make it visible.
 137        (when window
 138          (let ((frame (window-frame window)))
 139            (make-frame-visible frame)
 140            (raise-frame frame)
 141            window))
 142        ;; Reuse the current window if the user requested it.
 143        (when (cdr (assq 'same-window args))
 144          (condition-case nil
 145              (progn (switch-to-buffer buffer) (selected-window))
 146            (error nil)))
 147        ;; Stay on the same frame if requested.
 148        (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
 149          (let* ((pop-up-frames nil) (pop-up-windows t)
 150                 special-display-regexps special-display-buffer-names
 151                 (window (display-buffer buffer)))
 152            ;; Only do it if this is a new window:
 153            ;; (set-window-dedicated-p window t)
 154            window))
 155        ;; If no window yet, make one in a new frame.
 156        (let ((frame
 157               (with-current-buffer buffer
 158                 (make-frame (append args special-display-frame-alist)))))
 159          (set-window-buffer (frame-selected-window frame) buffer)
 160          (set-window-dedicated-p (frame-selected-window frame) t)
 161          (frame-selected-window frame))))))
 162
 163 (defun handle-delete-frame (event)
 164   "Handle delete-frame events from the X server."
 165   (interactive "e")
 166   (let ((frame (posn-window (event-start event)))
 167         (i 0)
 168         (tail (frame-list)))
 169     (while tail
 170       (and (frame-visible-p (car tail))
 171            (not (eq (car tail) frame))
 172           (setq i (1+ i)))
 173       (setq tail (cdr tail)))
 174     (if (> i 0)
 175         (delete-frame frame t)
 176       ;; Gildea@x.org says it is ok to ask questions before terminating.
 177       (save-buffers-kill-emacs))))
 178 \f
 179 ;;;; Arrangement of frames at startup
 180
 181 ;; 1) Load the window system startup file from the lisp library and read the
 182 ;; high-priority arguments (-q and the like).  The window system startup
 183 ;; file should create any frames specified in the window system defaults.
 184 ;;
 185 ;; 2) If no frames have been opened, we open an initial text frame.
 186 ;;
 187 ;; 3) Once the init file is done, we apply any newly set parameters
 188 ;; in initial-frame-alist to the frame.
 189
 190 ;; These are now called explicitly at the proper times,
 191 ;; since that is easier to understand.
 192 ;; Actually using hooks within Emacs is bad for future maintenance. --rms.
 193 ;; (add-hook 'before-init-hook 'frame-initialize)
 194 ;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
 195
 196 ;; If we create the initial frame, this is it.
 197 (defvar frame-initial-frame nil)
 198
 199 ;; Record the parameters used in frame-initialize to make the initial frame.
 200 (defvar frame-initial-frame-alist)
 201
 202 (defvar frame-initial-geometry-arguments nil)
 203
 204 ;; startup.el calls this function before loading the user's init
 205 ;; file - if there is no frame with a minibuffer open now, create
 206 ;; one to display messages while loading the init file.
 207 (defun frame-initialize ()
 208   "Create an initial frame if necessary."
 209   ;; Are we actually running under a window system at all?
 210   (if (and initial-window-system
 211            (not noninteractive)
 212            (not (eq initial-window-system 'pc)))
 213       (progn
 214         ;; Turn on special-display processing only if there's a window system.
 215         (setq special-display-function 'special-display-popup-frame)
 216
 217         ;; If there is no frame with a minibuffer besides the terminal
 218         ;; frame, then we need to create the opening frame.  Make sure
 219         ;; it has a minibuffer, but let initial-frame-alist omit the
 220         ;; minibuffer spec.
 221         (or (delq terminal-frame (minibuffer-frame-list))
 222             (progn
 223               (setq frame-initial-frame-alist
 224                     (append initial-frame-alist default-frame-alist nil))
 225               (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
 226                   (setq frame-initial-frame-alist
 227                         (cons '(horizontal-scroll-bars . t)
 228                               frame-initial-frame-alist)))
 229               (setq frame-initial-frame-alist
 230                     (cons (cons 'window-system initial-window-system)
 231                           frame-initial-frame-alist))
 232               (setq default-minibuffer-frame
 233                     (setq frame-initial-frame
 234                           (make-frame frame-initial-frame-alist)))
 235               ;; Delete any specifications for window geometry parameters
 236               ;; so that we won't reapply them in frame-notice-user-settings.
 237               ;; It would be wrong to reapply them then,
 238               ;; because that would override explicit user resizing.
 239               (setq initial-frame-alist
 240                     (frame-remove-geometry-params initial-frame-alist))))
 241         ;; At this point, we know that we have a frame open, so we
 242         ;; can delete the terminal frame.
 243         (delete-frame terminal-frame)
 244         (setq terminal-frame nil))))
 245
 246 (defvar frame-notice-user-settings t
 247   "Non-nil means function `frame-notice-user-settings' wasn't run yet.")
 248
 249 ;; startup.el calls this function after loading the user's init
 250 ;; file.  Now default-frame-alist and initial-frame-alist contain
 251 ;; information to which we must react; do what needs to be done.
 252 (defun frame-notice-user-settings ()
 253   "Act on user's init file settings of frame parameters.
 254 React to settings of `initial-frame-alist',
 255 `window-system-default-frame-alist' and `default-frame-alist'
 256 there (in decreasing order of priority)."
 257   ;; Make menu-bar-mode and default-frame-alist consistent.
 258   (when (boundp 'menu-bar-mode)
 259     (let ((default (assq 'menu-bar-lines default-frame-alist)))
 260       (if default
 261           (setq menu-bar-mode (not (eq (cdr default) 0)))
 262         (setq default-frame-alist
 263               (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
 264                     default-frame-alist)))))
 265
 266   ;; Make tool-bar-mode and default-frame-alist consistent.  Don't do
 267   ;; it in batch mode since that would leave a tool-bar-lines
 268   ;; parameter in default-frame-alist in a dumped Emacs, which is not
 269   ;; what we want.
 270   (when (and (boundp 'tool-bar-mode)
 271              (not noninteractive))
 272     (let ((default (assq 'tool-bar-lines default-frame-alist)))
 273       (if default
 274           (setq tool-bar-mode (not (eq (cdr default) 0)))
 275         ;; If Emacs was started on a tty, changing default-frame-alist
 276         ;; would disable the toolbar on X frames created later.  We
 277         ;; want to keep the default of showing a toolbar under X even
 278         ;; in this case.
 279         ;;
 280         ;; If the user explicitly called `tool-bar-mode' in .emacs,
 281         ;; then default-frame-alist is already changed anyway.
 282         (when initial-window-system
 283           (setq default-frame-alist
 284                 (cons (cons 'tool-bar-lines (if tool-bar-mode 1 0))
 285                       default-frame-alist))))))
 286
 287   ;; Creating and deleting frames may shift the selected frame around,
 288   ;; and thus the current buffer.  Protect against that.  We don't
 289   ;; want to use save-excursion here, because that may also try to set
 290   ;; the buffer of the selected window, which fails when the selected
 291   ;; window is the minibuffer.
 292   (let ((old-buffer (current-buffer))
 293         (window-system-frame-alist (cdr (assq initial-window-system
 294                                               window-system-default-frame-alist))))
 295
 296     (when (and frame-notice-user-settings
 297                (null frame-initial-frame))
 298       ;; This case happens when we don't have a window system, and
 299       ;; also for MS-DOS frames.
 300       (let ((parms (frame-parameters frame-initial-frame)))
 301         ;; Don't change the frame names.
 302         (setq parms (delq (assq 'name parms) parms))
 303         ;; Can't modify the minibuffer parameter, so don't try.
 304         (setq parms (delq (assq 'minibuffer parms) parms))
 305         (modify-frame-parameters nil
 306                                  (if (null initial-window-system)
 307                                      (append initial-frame-alist
 308                                              window-system-frame-alist
 309                                              default-frame-alist
 310                                              parms
 311                                              nil)
 312                                    ;; initial-frame-alist and
 313                                    ;; default-frame-alist were already
 314                                    ;; applied in pc-win.el.
 315                                    parms))
 316         (if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
 317             (let ((newparms (frame-parameters))
 318                   (frame (selected-frame)))
 319               (tty-handle-reverse-video frame newparms)
 320               ;; If we changed the background color, we need to update
 321               ;; the background-mode parameter, and maybe some faces,
 322               ;; too.
 323               (when (assq 'background-color newparms)
 324                 (unless (or (assq 'background-mode initial-frame-alist)
 325                             (assq 'background-mode default-frame-alist))
 326                   (frame-set-background-mode frame))
 327                 (face-set-after-frame-default frame))))))
 328
 329     ;; If the initial frame is still around, apply initial-frame-alist
 330     ;; and default-frame-alist to it.
 331     (when (frame-live-p frame-initial-frame)
 332
 333       ;; When tool-bar has been switched off, correct the frame size
 334       ;; by the lines added in x-create-frame for the tool-bar and
 335       ;; switch `tool-bar-mode' off.
 336       (when (display-graphic-p)
 337         (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
 338                                   (assq 'tool-bar-lines window-system-frame-alist)
 339                                   (assq 'tool-bar-lines default-frame-alist))))
 340           (when (and tool-bar-originally-present
 341                      (or (null tool-bar-lines)
 342                          (null (cdr tool-bar-lines))
 343                          (eq 0 (cdr tool-bar-lines))))
 344             (let* ((char-height (frame-char-height frame-initial-frame))
 345                    (image-height tool-bar-images-pixel-height)
 346                    (margin (cond ((and (consp tool-bar-button-margin)
 347                                        (integerp (cdr tool-bar-button-margin))
 348                                        (> tool-bar-button-margin 0))
 349                                   (cdr tool-bar-button-margin))
 350                                  ((and (integerp tool-bar-button-margin)
 351                                        (> tool-bar-button-margin 0))
 352                                   tool-bar-button-margin)
 353                                  (t 0)))
 354                    (relief (if (and (integerp tool-bar-button-relief)
 355                                     (> tool-bar-button-relief 0))
 356                                tool-bar-button-relief 3))
 357                    (lines (/ (+ image-height
 358                                 (* 2 margin)
 359                                 (* 2 relief)
 360                                 (1- char-height))
 361                              char-height))
 362                    (height (frame-parameter frame-initial-frame 'height))
 363                    (newparms (list (cons 'height (- height lines))))
 364                    (initial-top (cdr (assq 'top
 365                                            frame-initial-geometry-arguments)))
 366                    (top (frame-parameter frame-initial-frame 'top)))
 367               (when (and (consp initial-top) (eq '- (car initial-top)))
 368                 (let ((adjusted-top
 369                        (cond ((and (consp top)
 370                                    (eq '+ (car top)))
 371                               (list '+
 372                                     (+ (cadr top)
 373                                        (* lines char-height))))
 374                              ((and (consp top)
 375                                    (eq '- (car top)))
 376                               (list '-
 377                                     (- (cadr top)
 378                                        (* lines char-height))))
 379                              (t (+ top (* lines char-height))))))
 380                   (setq newparms
 381                         (append newparms
 382                                 `((top . ,adjusted-top))
 383                                 nil))))
 384               (modify-frame-parameters frame-initial-frame newparms)
 385               (tool-bar-mode -1)))))
 386
 387       ;; The initial frame we create above always has a minibuffer.
 388       ;; If the user wants to remove it, or make it a minibuffer-only
 389       ;; frame, then we'll have to delete the current frame and make a
 390       ;; new one; you can't remove or add a root window to/from an
 391       ;; existing frame.
 392       ;;
 393       ;; NOTE: default-frame-alist was nil when we created the
 394       ;; existing frame.  We need to explicitly include
 395       ;; default-frame-alist in the parameters of the screen we
 396       ;; create here, so that its new value, gleaned from the user's
 397       ;; .emacs file, will be applied to the existing screen.
 398       (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
 399                             (assq 'minibuffer window-system-frame-alist)
 400                             (assq 'minibuffer default-frame-alist)
 401                             '(minibuffer . t)))
 402                    t))
 403           ;; Create the new frame.
 404           (let (parms new)
 405             ;; If the frame isn't visible yet, wait till it is.
 406             ;; If the user has to position the window,
 407             ;; Emacs doesn't know its real position until
 408             ;; the frame is seen to be visible.
 409             (while (not (cdr (assq 'visibility
 410                                    (frame-parameters frame-initial-frame))))
 411               (sleep-for 1))
 412             (setq parms (frame-parameters frame-initial-frame))
 413
 414             ;; Get rid of `name' unless it was specified explicitly before.
 415             (or (assq 'name frame-initial-frame-alist)
 416                 (setq parms (delq (assq 'name parms) parms)))
 417
 418             (setq parms (append initial-frame-alist
 419                                 window-system-frame-alist
 420                                 default-frame-alist
 421                                 parms
 422                                 nil))
 423
 424             ;; Get rid of `reverse', because that was handled
 425             ;; when we first made the frame.
 426             (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
 427
 428             (if (assq 'height frame-initial-geometry-arguments)
 429                 (setq parms (assq-delete-all 'height parms)))
 430             (if (assq 'width frame-initial-geometry-arguments)
 431                 (setq parms (assq-delete-all 'width parms)))
 432             (if (assq 'left frame-initial-geometry-arguments)
 433                 (setq parms (assq-delete-all 'left parms)))
 434             (if (assq 'top frame-initial-geometry-arguments)
 435                 (setq parms (assq-delete-all 'top parms)))
 436             (setq new
 437                   (make-frame
 438                    ;; Use the geometry args that created the existing
 439                    ;; frame, rather than the parms we get for it.
 440                    (append frame-initial-geometry-arguments
 441                            '((user-size . t) (user-position . t))
 442                            parms)))
 443             ;; The initial frame, which we are about to delete, may be
 444             ;; the only frame with a minibuffer.  If it is, create a
 445             ;; new one.
 446             (or (delq frame-initial-frame (minibuffer-frame-list))
 447                 (make-initial-minibuffer-frame nil))
 448
 449             ;; If the initial frame is serving as a surrogate
 450             ;; minibuffer frame for any frames, we need to wean them
 451             ;; onto a new frame.  The default-minibuffer-frame
 452             ;; variable must be handled similarly.
 453             (let ((users-of-initial
 454                    (filtered-frame-list
 455                     (function (lambda (frame)
 456                                 (and (not (eq frame frame-initial-frame))
 457                                      (eq (window-frame
 458                                           (minibuffer-window frame))
 459                                          frame-initial-frame)))))))
 460               (if (or users-of-initial
 461                       (eq default-minibuffer-frame frame-initial-frame))
 462
 463                   ;; Choose an appropriate frame.  Prefer frames which
 464                   ;; are only minibuffers.
 465                   (let* ((new-surrogate
 466                           (car
 467                            (or (filtered-frame-list
 468                                 (function
 469                                  (lambda (frame)
 470                                    (eq (cdr (assq 'minibuffer
 471                                                   (frame-parameters frame)))
 472                                        'only))))
 473                                (minibuffer-frame-list))))
 474                          (new-minibuffer (minibuffer-window new-surrogate)))
 475
 476                     (if (eq default-minibuffer-frame frame-initial-frame)
 477                         (setq default-minibuffer-frame new-surrogate))
 478
 479                     ;; Wean the frames using frame-initial-frame as
 480                     ;; their minibuffer frame.
 481                     (mapcar
 482                      (function
 483                       (lambda (frame)
 484                         (modify-frame-parameters
 485                          frame (list (cons 'minibuffer new-minibuffer)))))
 486                      users-of-initial))))
 487
 488            ;; Redirect events enqueued at this frame to the new frame.
 489             ;; Is this a good idea?
 490             (redirect-frame-focus frame-initial-frame new)
 491
 492             ;; Finally, get rid of the old frame.
 493             (delete-frame frame-initial-frame t))
 494
 495         ;; Otherwise, we don't need all that rigamarole; just apply
 496         ;; the new parameters.
 497         (let (newparms allparms tail)
 498           (setq allparms (append initial-frame-alist
 499                                  window-system-frame-alist
 500                                  default-frame-alist nil))
 501           (if (assq 'height frame-initial-geometry-arguments)
 502               (setq allparms (assq-delete-all 'height allparms)))
 503           (if (assq 'width frame-initial-geometry-arguments)
 504               (setq allparms (assq-delete-all 'width allparms)))
 505           (if (assq 'left frame-initial-geometry-arguments)
 506               (setq allparms (assq-delete-all 'left allparms)))
 507           (if (assq 'top frame-initial-geometry-arguments)
 508               (setq allparms (assq-delete-all 'top allparms)))
 509           (setq tail allparms)
 510           ;; Find just the parms that have changed since we first
 511           ;; made this frame.  Those are the ones actually set by
 512           ;; the init file.  For those parms whose values we already knew
 513           ;; (such as those spec'd by command line options)
 514           ;; it is undesirable to specify the parm again
 515           ;; once the user has seen the frame and been able to alter it
 516           ;; manually.
 517           (while tail
 518             (let (newval oldval)
 519               (setq oldval (assq (car (car tail))
 520                                  frame-initial-frame-alist))
 521               (setq newval (cdr (assq (car (car tail)) allparms)))
 522               (or (and oldval (eq (cdr oldval) newval))
 523                   (setq newparms
 524                         (cons (cons (car (car tail)) newval) newparms))))
 525             (setq tail (cdr tail)))
 526           (setq newparms (nreverse newparms))
 527           (modify-frame-parameters frame-initial-frame
 528                                    newparms)
 529           ;; If we changed the background color,
 530           ;; we need to update the background-mode parameter
 531           ;; and maybe some faces too.
 532           (when (assq 'background-color newparms)
 533             (unless (assq 'background-mode newparms)
 534               (frame-set-background-mode frame-initial-frame))
 535             (face-set-after-frame-default frame-initial-frame)))))
 536
 537     ;; Restore the original buffer.
 538     (set-buffer old-buffer)
 539
 540     ;; Make sure the initial frame can be GC'd if it is ever deleted.
 541     ;; Make sure frame-notice-user-settings does nothing if called twice.
 542     (setq frame-notice-user-settings nil)
 543     (setq frame-initial-frame nil)))
 544
 545 (defun make-initial-minibuffer-frame (display)
 546   (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
 547     (if display
 548         (make-frame-on-display display parms)
 549       (make-frame parms))))
 550
 551 ;;;; Creation of additional frames, and other frame miscellanea
 552
 553 (defun modify-all-frames-parameters (alist)
 554   "Modify all current and future frames' parameters according to ALIST.
 555 This changes `default-frame-alist' and possibly `initial-frame-alist'.
 556 Furthermore, this function removes all parameters in ALIST from
 557 `window-system-default-frame-alist'.
 558 See help of `modify-frame-parameters' for more information."
 559   (dolist (frame (frame-list))
 560     (modify-frame-parameters frame alist))
 561
 562   (dolist (pair alist) ;; conses to add/replace
 563     ;; initial-frame-alist needs setting only when
 564     ;; frame-notice-user-settings is true.
 565     (and frame-notice-user-settings
 566          (setq initial-frame-alist
 567                (assq-delete-all (car pair) initial-frame-alist)))
 568     (setq default-frame-alist
 569           (assq-delete-all (car pair) default-frame-alist))
 570     ;; Remove any similar settings from the window-system specific
 571     ;; parameters---they would override default-frame-alist.
 572     (dolist (w window-system-default-frame-alist)
 573       (setcdr w (assq-delete-all (car pair) (cdr w)))))
 574
 575   (and frame-notice-user-settings
 576        (setq initial-frame-alist (append initial-frame-alist alist)))
 577   (setq default-frame-alist (append default-frame-alist alist)))
 578
 579 (defun get-other-frame ()
 580   "Return some frame other than the current frame.
 581 Create one if necessary.  Note that the minibuffer frame, if separate,
 582 is not considered (see `next-frame')."
 583   (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
 584                (make-frame)
 585              (next-frame (selected-frame)))))
 586     s))
 587
 588 (defun next-multiframe-window ()
 589   "Select the next window, regardless of which frame it is on."
 590   (interactive)
 591   (select-window (next-window (selected-window)
 592                               (> (minibuffer-depth) 0)
 593                               0))
 594   (select-frame-set-input-focus (selected-frame)))
 595
 596 (defun previous-multiframe-window ()
 597   "Select the previous window, regardless of which frame it is on."
 598   (interactive)
 599   (select-window (previous-window (selected-window)
 600                                   (> (minibuffer-depth) 0)
 601                                   0))
 602   (select-frame-set-input-focus (selected-frame)))
 603
 604 (defun make-frame-on-display (display &optional parameters)
 605   "Make a frame on X display DISPLAY.
 606 The optional second argument PARAMETERS specifies additional frame parameters."
 607   (interactive "sMake frame on display: ")
 608   (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
 609       (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
 610   (when (and (boundp 'x-initialized) (not x-initialized))
 611     (setq x-display-name display)
 612     (x-initialize-window-system))
 613   (make-frame `((window-system . x) (display . ,display) . ,parameters)))
 614
 615 (defun make-frame-on-tty (tty type &optional parameters)
 616   "Make a frame on terminal device TTY.
 617 TTY should be the file name of the tty device to use.  TYPE
 618 should be the terminal type string of TTY, for example \"xterm\"
 619 or \"vt100\".  The optional third argument PARAMETERS specifies
 620 additional frame parameters."
 621   (interactive "fOpen frame on tty device: \nsTerminal type of %s: ")
 622   (unless tty
 623     (error "Invalid terminal device"))
 624   (unless type
 625     (error "Invalid terminal type"))
 626   (make-frame `((window-system . nil) (tty . ,tty) (tty-type . ,type) . ,parameters)))
 627
 628 (defun make-frame-command ()
 629   "Make a new frame, and select it if the terminal displays only one frame."
 630   (interactive)
 631   (if (and window-system (not (eq window-system 'pc)))
 632       (make-frame)
 633     (select-frame (make-frame))))
 634
 635 (defvar before-make-frame-hook nil
 636   "Functions to run before a frame is created.")
 637
 638 (defvar after-make-frame-functions nil
 639   "Functions to run after a frame is created.
 640 The functions are run with one arg, the newly created frame.")
 641
 642 (defvar after-setting-font-hook nil
 643   "Functions to run after a frame's font has been changed.")
 644
 645 ;; Alias, kept temporarily.
 646 (define-obsolete-function-alias 'new-frame 'make-frame "22.1")
 647
 648 (defun make-frame (&optional parameters)
 649   "Return a newly created frame displaying the current buffer.
 650 Optional argument PARAMETERS is an alist of parameters for the new frame.
 651 Each element of PARAMETERS should have the form (NAME . VALUE), for example:
 652
 653  (name . STRING)        The frame should be named STRING.
 654
 655  (width . NUMBER)       The frame should be NUMBER characters in width.
 656  (height . NUMBER)      The frame should be NUMBER text lines high.
 657
 658 You cannot specify either `width' or `height', you must use neither or both.
 659
 660  (minibuffer . t)       The frame should have a minibuffer.
 661  (minibuffer . nil)     The frame should have no minibuffer.
 662  (minibuffer . only)    The frame should contain only a minibuffer.
 663  (minibuffer . WINDOW)  The frame should use WINDOW as its minibuffer window.
 664
 665  (window-system . nil)  The frame should be displayed on a terminal device.
 666  (window-system . x)    The frame should be displayed in an X window.
 667
 668  (terminal . ID)          The frame should use the terminal identified by ID.
 669
 670 Before the frame is created (via `frame-creation-function-alist'), functions on the
 671 hook `before-make-frame-hook' are run.  After the frame is created, functions
 672 on `after-make-frame-functions' are run with one arg, the newly created frame.
 673
 674 This function itself does not make the new frame the selected frame.
 675 The previously selected frame remains selected.  However, the
 676 window system may select the new frame for its own reasons, for
 677 instance if the frame appears under the mouse pointer and your
 678 setup is for focus to follow the pointer."
 679   (interactive)
 680   (let* ((w (cond
 681              ((assq 'terminal parameters)
 682               (let ((type (terminal-live-p (cdr (assq 'terminal parameters)))))
 683                 (cond
 684                  ((eq type t) nil)
 685                  ((eq type nil) (error "Terminal %s does not exist" (cdr (assq 'terminal parameters))))
 686                  (t type))))
 687              ((assq 'window-system parameters)
 688               (cdr (assq 'window-system parameters)))
 689              (t window-system)))
 690          (frame-creation-function (cdr (assq w frame-creation-function-alist)))
 691          (oldframe (selected-frame))
 692          frame)
 693     (unless frame-creation-function
 694       (error "Don't know how to create a frame on window system %s" w))
 695     (run-hooks 'before-make-frame-hook)
 696     (setq frame (funcall frame-creation-function (append parameters (cdr (assq w window-system-default-frame-alist)))))
 697     (normal-erase-is-backspace-setup-frame frame)
 698     ;; Inherit the 'environment and 'client parameters, if needed.
 699     (when (eq (frame-terminal frame) (frame-terminal oldframe))
 700       (let ((env (frame-parameter oldframe 'environment))
 701             (client (frame-parameter oldframe 'client)))
 702         (if (not (framep env))
 703             (setq env oldframe))
 704         (if (and env (not (assq 'environment parameters)))
 705             (set-frame-parameter frame 'environment env))
 706         (if (and client (not (assq 'client parameters)))
 707             (set-frame-parameter frame 'client client))))
 708     (run-hook-with-args 'after-make-frame-functions frame)
 709     frame))
 710
 711 (defun filtered-frame-list (predicate)
 712   "Return a list of all live frames which satisfy PREDICATE."
 713   (let* ((frames (frame-list))
 714          (list frames))
 715     (while (consp frames)
 716       (unless (funcall predicate (car frames))
 717         (setcar frames nil))
 718       (setq frames (cdr frames)))
 719     (delq nil list)))
 720
 721 (defun minibuffer-frame-list ()
 722   "Return a list of all frames with their own minibuffers."
 723   (filtered-frame-list
 724    (function (lambda (frame)
 725                (eq frame (window-frame (minibuffer-window frame)))))))
 726
 727 (defun frames-on-display-list (&optional terminal)
 728   "Return a list of all frames on TERMINAL.
 729
 730 TERMINAL should be a terminal identifier (an integer), a frame,
 731 or a name of an X display (a string of the form
 732 HOST:SERVER.SCREEN).
 733
 734 If TERMINAL is omitted or nil, it defaults to the selected
 735 frame's terminal device."
 736   (let* ((terminal (terminal-id terminal))
 737          (func #'(lambda (frame)
 738                    (eq (frame-terminal frame) terminal))))
 739     (filtered-frame-list func)))
 740
 741 (defun framep-on-display (&optional terminal)
 742   "Return the type of frames on TERMINAL.
 743 TERMINAL may be a terminal id, a display name or a frame.  If it
 744 is a frame, its type is returned.  If TERMINAL is omitted or nil,
 745 it defaults to the selected frame's terminal device.  All frames
 746 on a given display are of the same type."
 747   (or (terminal-live-p terminal)
 748       (framep terminal)
 749       (framep (car (frames-on-display-list terminal)))))
 750
 751 (defun frame-remove-geometry-params (param-list)
 752   "Return the parameter list PARAM-LIST, but with geometry specs removed.
 753 This deletes all bindings in PARAM-LIST for `top', `left', `width',
 754 `height', `user-size' and `user-position' parameters.
 755 Emacs uses this to avoid overriding explicit moves and resizings from
 756 the user during startup."
 757   (setq param-list (cons nil param-list))
 758   (let ((tail param-list))
 759     (while (consp (cdr tail))
 760       (if (and (consp (car (cdr tail)))
 761                (memq (car (car (cdr tail)))
 762                      '(height width top left user-position user-size)))
 763           (progn
 764             (setq frame-initial-geometry-arguments
 765                   (cons (car (cdr tail)) frame-initial-geometry-arguments))
 766             (setcdr tail (cdr (cdr tail))))
 767         (setq tail (cdr tail)))))
 768   (setq frame-initial-geometry-arguments
 769         (nreverse frame-initial-geometry-arguments))
 770   (cdr param-list))
 771
 772 (defcustom focus-follows-mouse t
 773   "*Non-nil if window system changes focus when you move the mouse.
 774 You should set this variable to tell Emacs how your window manager
 775 handles focus, since there is no way in general for Emacs to find out
 776 automatically."
 777   :type 'boolean
 778   :group 'frames
 779   :version "20.3")
 780
 781 (defun select-frame-set-input-focus (frame)
 782   "Select FRAME, raise it, and set input focus, if possible."
 783     (select-frame frame)
 784     (raise-frame frame)
 785     ;; Ensure, if possible, that frame gets input focus.
 786     (cond ((memq (window-system frame) '(x max))
 787            (x-focus-frame frame))
 788           ((eq (window-system frame) 'w32)
 789            (w32-focus-frame frame)))
 790     (cond (focus-follows-mouse
 791            (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
 792
 793 (defun other-frame (arg)
 794   "Select the ARG'th different visible frame on current display, and raise it.
 795 All frames are arranged in a cyclic order.
 796 This command selects the frame ARG steps away in that order.
 797 A negative ARG moves in the opposite order.
 798
 799 To make this command work properly, you must tell Emacs
 800 how the system (or the window manager) generally handles
 801 focus-switching between windows.  If moving the mouse onto a window
 802 selects it (gives it focus), set `focus-follows-mouse' to t.
 803 Otherwise, that variable should be nil."
 804   (interactive "p")
 805   (let ((frame (selected-frame)))
 806     (while (> arg 0)
 807       (setq frame (next-frame frame))
 808       (while (not (eq (frame-visible-p frame) t))
 809         (setq frame (next-frame frame)))
 810       (setq arg (1- arg)))
 811     (while (< arg 0)
 812       (setq frame (previous-frame frame))
 813       (while (not (eq (frame-visible-p frame) t))
 814         (setq frame (previous-frame frame)))
 815       (setq arg (1+ arg)))
 816     (select-frame-set-input-focus frame)))
 817
 818 (defun iconify-or-deiconify-frame ()
 819   "Iconify the selected frame, or deiconify if it's currently an icon."
 820   (interactive)
 821   (if (eq (cdr (assq 'visibility (frame-parameters))) t)
 822       (iconify-frame)
 823     (make-frame-visible)))
 824
 825 (defun suspend-frame ()
 826   "Do whatever is right to suspend the current frame.
 827 Calls `suspend-emacs' if invoked from the controlling tty device,
 828 `suspend-tty' from a secondary tty device, and
 829 `iconify-or-deiconify-frame' from an X frame."
 830   (interactive)
 831   (let ((type (framep (selected-frame))))
 832     (cond
 833      ((eq type 'x) (iconify-or-deiconify-frame))
 834      ((eq type t)
 835       (if (controlling-tty-p)
 836           (suspend-emacs)
 837         (suspend-tty)))
 838      (t (suspend-emacs)))))
 839
 840 (defun make-frame-names-alist ()
 841   (let* ((current-frame (selected-frame))
 842          (falist
 843           (cons
 844            (cons (frame-parameter current-frame 'name) current-frame) nil))
 845          (frame (next-frame nil t)))
 846     (while (not (eq frame current-frame))
 847       (progn
 848         (setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
 849         (setq frame (next-frame frame t))))
 850     falist))
 851
 852 (defvar frame-name-history nil)
 853 (defun select-frame-by-name (name)
 854   "Select the frame on the current terminal whose name is NAME and raise it.
 855 If there is no frame by that name, signal an error."
 856   (interactive
 857    (let* ((frame-names-alist (make-frame-names-alist))
 858            (default (car (car frame-names-alist)))
 859            (input (completing-read
 860                    (format "Select Frame (default %s): " default)
 861                    frame-names-alist nil t nil 'frame-name-history)))
 862      (if (= (length input) 0)
 863          (list default)
 864        (list input))))
 865   (let* ((frame-names-alist (make-frame-names-alist))
 866          (frame (cdr (assoc name frame-names-alist))))
 867     (or frame
 868         (error "There is no frame named `%s'" name))
 869     (make-frame-visible frame)
 870     (raise-frame frame)
 871     (select-frame frame)
 872     ;; Ensure, if possible, that frame gets input focus.
 873     (cond ((eq (window-system frame) 'x)
 874            (x-focus-frame frame))
 875           ((eq (window-system frame) 'w32)
 876            (w32-focus-frame frame)))
 877     (when focus-follows-mouse
 878       (set-mouse-position frame (1- (frame-width frame)) 0))))
 879 \f
 880 ;;;; Frame configurations
 881
 882 (defun current-frame-configuration ()
 883   "Return a list describing the positions and states of all frames.
 884 Its car is `frame-configuration'.
 885 Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
 886 where
 887   FRAME is a frame object,
 888   ALIST is an association list specifying some of FRAME's parameters, and
 889   WINDOW-CONFIG is a window configuration object for FRAME."
 890   (cons 'frame-configuration
 891         (mapcar (function
 892                  (lambda (frame)
 893                    (list frame
 894                          (frame-parameters frame)
 895                          (current-window-configuration frame))))
 896                 (frame-list))))
 897
 898 (defun set-frame-configuration (configuration &optional nodelete)
 899   "Restore the frames to the state described by CONFIGURATION.
 900 Each frame listed in CONFIGURATION has its position, size, window
 901 configuration, and other parameters set as specified in CONFIGURATION.
 902 However, this function does not restore deleted frames.
 903
 904 Ordinarily, this function deletes all existing frames not
 905 listed in CONFIGURATION.  But if optional second argument NODELETE
 906 is given and non-nil, the unwanted frames are iconified instead."
 907   (or (frame-configuration-p configuration)
 908       (signal 'wrong-type-argument
 909               (list 'frame-configuration-p configuration)))
 910   (let ((config-alist (cdr configuration))
 911         frames-to-delete)
 912     (mapcar (function
 913              (lambda (frame)
 914                (let ((parameters (assq frame config-alist)))
 915                  (if parameters
 916                      (progn
 917                        (modify-frame-parameters
 918                         frame
 919                         ;; Since we can't set a frame's minibuffer status,
 920                         ;; we might as well omit the parameter altogether.
 921                         (let* ((parms (nth 1 parameters))
 922                                (mini (assq 'minibuffer parms)))
 923                           (if mini (setq parms (delq mini parms)))
 924                           parms))
 925                        (set-window-configuration (nth 2 parameters)))
 926                    (setq frames-to-delete (cons frame frames-to-delete))))))
 927             (frame-list))
 928     (if nodelete
 929         ;; Note: making frames invisible here was tried
 930         ;; but led to some strange behavior--each time the frame
 931         ;; was made visible again, the window manager asked afresh
 932         ;; for where to put it.
 933         (mapcar 'iconify-frame frames-to-delete)
 934       (mapcar 'delete-frame frames-to-delete))))
 935 \f
 936 ;;;; Convenience functions for accessing and interactively changing
 937 ;;;; frame parameters.
 938
 939 (defun frame-height (&optional frame)
 940   "Return number of lines available for display on FRAME.
 941 If FRAME is omitted, describe the currently selected frame."
 942   (cdr (assq 'height (frame-parameters frame))))
 943
 944 (defun frame-width (&optional frame)
 945   "Return number of columns available for display on FRAME.
 946 If FRAME is omitted, describe the currently selected frame."
 947   (cdr (assq 'width (frame-parameters frame))))
 948
 949 (defalias 'set-default-font 'set-frame-font)
 950 (defun set-frame-font (font-name &optional keep-size)
 951   "Set the font of the selected frame to FONT-NAME.
 952 When called interactively, prompt for the name of the font to use.
 953 To get the frame's current default font, use `frame-parameters'.
 954
 955 The default behavior is to keep the numbers of lines and columns in
 956 the frame, thus may change its pixel size.  If optional KEEP-SIZE is
 957 non-nil (interactively, prefix argument) the current frame size (in
 958 pixels) is kept by adjusting the numbers of the lines and columns."
 959   (interactive
 960    (let* ((completion-ignore-case t)
 961           (font (completing-read "Font name: "
 962                          (mapcar #'list
 963                                  ;; x-list-fonts will fail with an error
 964                                  ;; if this frame doesn't support fonts.
 965                                  (x-list-fonts "*" nil (selected-frame)))
 966                          nil nil nil nil
 967                          (frame-parameter nil 'font))))
 968      (list font current-prefix-arg)))
 969   (let (fht fwd)
 970     (if keep-size
 971         (setq fht (* (frame-parameter nil 'height) (frame-char-height))
 972               fwd (* (frame-parameter nil 'width)  (frame-char-width))))
 973     (modify-frame-parameters (selected-frame)
 974                              (list (cons 'font font-name)))
 975     (if keep-size
 976         (modify-frame-parameters
 977          (selected-frame)
 978          (list (cons 'height (round fht (frame-char-height)))
 979                (cons 'width (round fwd (frame-char-width)))))))
 980   (run-hooks 'after-setting-font-hook 'after-setting-font-hooks))
 981
 982 (defun set-frame-parameter (frame parameter value)
 983   "Set frame parameter PARAMETER to VALUE on FRAME.
 984 If FRAME is nil, it defaults to the selected frame.
 985 See `modify-frame-parameters.'"
 986   (modify-frame-parameters frame (list (cons parameter value))))
 987
 988 (defun set-background-color (color-name)
 989   "Set the background color of the selected frame to COLOR-NAME.
 990 When called interactively, prompt for the name of the color to use.
 991 To get the frame's current background color, use `frame-parameters'."
 992   (interactive (list (facemenu-read-color "Background color: ")))
 993   (modify-frame-parameters (selected-frame)
 994                            (list (cons 'background-color color-name)))
 995   (or window-system
 996       (face-set-after-frame-default (selected-frame))))
 997
 998 (defun set-foreground-color (color-name)
 999   "Set the foreground color of the selected frame to COLOR-NAME.
1000 When called interactively, prompt for the name of the color to use.
1001 To get the frame's current foreground color, use `frame-parameters'."
1002   (interactive (list (facemenu-read-color "Foreground color: ")))
1003   (modify-frame-parameters (selected-frame)
1004                            (list (cons 'foreground-color color-name)))
1005   (or window-system
1006       (face-set-after-frame-default (selected-frame))))
1007
1008 (defun set-cursor-color (color-name)
1009   "Set the text cursor color of the selected frame to COLOR-NAME.
1010 When called interactively, prompt for the name of the color to use.
1011 To get the frame's current cursor color, use `frame-parameters'."
1012   (interactive (list (facemenu-read-color "Cursor color: ")))
1013   (modify-frame-parameters (selected-frame)
1014                            (list (cons 'cursor-color color-name))))
1015
1016 (defun set-mouse-color (color-name)
1017   "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
1018 When called interactively, prompt for the name of the color to use.
1019 To get the frame's current mouse color, use `frame-parameters'."
1020   (interactive (list (facemenu-read-color "Mouse color: ")))
1021   (modify-frame-parameters (selected-frame)
1022                            (list (cons 'mouse-color
1023                                        (or color-name
1024                                            (cdr (assq 'mouse-color
1025                                                       (frame-parameters))))))))
1026
1027 (defun set-border-color (color-name)
1028   "Set the color of the border of the selected frame to COLOR-NAME.
1029 When called interactively, prompt for the name of the color to use.
1030 To get the frame's current border color, use `frame-parameters'."
1031   (interactive (list (facemenu-read-color "Border color: ")))
1032   (modify-frame-parameters (selected-frame)
1033                            (list (cons 'border-color color-name))))
1034
1035 (defun auto-raise-mode (arg)
1036   "Toggle whether or not the selected frame should auto-raise.
1037 With arg, turn auto-raise mode on if and only if arg is positive.
1038 Note that this controls Emacs's own auto-raise feature.
1039 Some window managers allow you to enable auto-raise for certain windows.
1040 You can use that for Emacs windows if you wish, but if you do,
1041 that is beyond the control of Emacs and this command has no effect on it."
1042   (interactive "P")
1043   (if (null arg)
1044       (setq arg
1045             (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
1046                 -1 1)))
1047   (if (> arg 0)
1048       (raise-frame (selected-frame)))
1049   (modify-frame-parameters (selected-frame)
1050                            (list (cons 'auto-raise (> arg 0)))))
1051
1052 (defun auto-lower-mode (arg)
1053   "Toggle whether or not the selected frame should auto-lower.
1054 With arg, turn auto-lower mode on if and only if arg is positive.
1055 Note that this controls Emacs's own auto-lower feature.
1056 Some window managers allow you to enable auto-lower for certain windows.
1057 You can use that for Emacs windows if you wish, but if you do,
1058 that is beyond the control of Emacs and this command has no effect on it."
1059   (interactive "P")
1060   (if (null arg)
1061       (setq arg
1062             (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
1063                 -1 1)))
1064   (modify-frame-parameters (selected-frame)
1065                            (list (cons 'auto-lower (> arg 0)))))
1066 (defun set-frame-name (name)
1067   "Set the name of the selected frame to NAME.
1068 When called interactively, prompt for the name of the frame.
1069 The frame name is displayed on the modeline if the terminal displays only
1070 one frame, otherwise the name is displayed on the frame's caption bar."
1071   (interactive "sFrame name: ")
1072   (modify-frame-parameters (selected-frame)
1073                            (list (cons 'name name))))
1074
1075 (defun frame-current-scroll-bars (&optional frame)
1076   "Return the current scroll-bar settings in frame FRAME.
1077 Value is a cons (VERTICAL . HORIZ0NTAL) where VERTICAL specifies the
1078 current location of the vertical scroll-bars (left, right, or nil),
1079 and HORIZONTAL specifies the current location of the horizontal scroll
1080 bars (top, bottom, or nil)."
1081   (let ((vert (frame-parameter frame 'vertical-scroll-bars))
1082         (hor nil))
1083     (unless (memq vert '(left right nil))
1084       (setq vert default-frame-scroll-bars))
1085     (cons vert hor)))
1086 \f
1087 ;;;; Frame/display capabilities.
1088 (defun selected-terminal ()
1089   "Return the terminal that is now selected."
1090   (frame-terminal (selected-frame)))
1091
1092 (defun display-mouse-p (&optional display)
1093   "Return non-nil if DISPLAY has a mouse available.
1094 DISPLAY can be a display name, a frame, or nil (meaning the selected
1095 frame's display)."
1096   (let ((frame-type (framep-on-display display)))
1097     (cond
1098      ((eq frame-type 'pc)
1099       (msdos-mouse-p))
1100      ((eq system-type 'windows-nt)
1101       (with-no-warnings
1102        (> w32-num-mouse-buttons 0)))
1103      ((memq frame-type '(x mac))
1104       t)    ;; We assume X and Mac *always* have a pointing device
1105      (t
1106       (or (and (featurep 'xt-mouse)
1107                xterm-mouse-mode)
1108           ;; t-mouse is distributed with the GPM package.  It doesn't have
1109           ;; a toggle.
1110           (featurep 't-mouse))))))
1111
1112 (defun display-popup-menus-p (&optional display)
1113   "Return non-nil if popup menus are supported on DISPLAY.
1114 DISPLAY can be a display name, a frame, or nil (meaning the selected
1115 frame's display).
1116 Support for popup menus requires that the mouse be available."
1117   (and
1118    (let ((frame-type (framep-on-display display)))
1119      (memq frame-type '(x w32 pc mac)))
1120    (display-mouse-p display)))
1121
1122 (defun display-graphic-p (&optional display)
1123   "Return non-nil if DISPLAY is a graphic display.
1124 Graphical displays are those which are capable of displaying several
1125 frames and several different fonts at once.  This is true for displays
1126 that use a window system such as X, and false for text-only terminals.
1127 DISPLAY can be a display name, a frame, or nil (meaning the selected
1128 frame's display)."
1129   (not (null (memq (framep-on-display display) '(x w32 mac)))))
1130
1131 (defun display-images-p (&optional display)
1132   "Return non-nil if DISPLAY can display images.
1133
1134 DISPLAY can be a display name, a frame, or nil (meaning the selected
1135 frame's display)."
1136   (and (display-graphic-p display)
1137        (fboundp 'image-mask-p)
1138        (fboundp 'image-size)))
1139
1140 (defalias 'display-multi-frame-p 'display-graphic-p)
1141 (defalias 'display-multi-font-p 'display-graphic-p)
1142
1143 (defun display-selections-p (&optional display)
1144   "Return non-nil if DISPLAY supports selections.
1145 A selection is a way to transfer text or other data between programs
1146 via special system buffers called `selection' or `cut buffer' or
1147 `clipboard'.
1148 DISPLAY can be a display name, a frame, or nil (meaning the selected
1149 frame's display)."
1150   (let ((frame-type (framep-on-display display)))
1151     (cond
1152      ((eq frame-type 'pc)
1153       ;; MS-DOG frames support selections when Emacs runs inside
1154       ;; the Windows' DOS Box.
1155       (with-no-warnings
1156        (not (null dos-windows-version))))
1157      ((memq frame-type '(x w32 mac))
1158       t)    ;; FIXME?
1159      (t
1160       nil))))
1161
1162 (defun display-screens (&optional display)
1163   "Return the number of screens associated with DISPLAY."
1164   (let ((frame-type (framep-on-display display)))
1165     (cond
1166      ((memq frame-type '(x w32 mac))
1167       (x-display-screens display))
1168      (t
1169       1))))
1170
1171 (defun display-pixel-height (&optional display)
1172   "Return the height of DISPLAY's screen in pixels.
1173 For character terminals, each character counts as a single pixel."
1174   (let ((frame-type (framep-on-display display)))
1175     (cond
1176      ((memq frame-type '(x w32 mac))
1177       (x-display-pixel-height display))
1178      (t
1179       (frame-height (if (framep display) display (selected-frame)))))))
1180
1181 (defun display-pixel-width (&optional display)
1182   "Return the width of DISPLAY's screen in pixels.
1183 For character terminals, each character counts as a single pixel."
1184   (let ((frame-type (framep-on-display display)))
1185     (cond
1186      ((memq frame-type '(x w32 mac))
1187       (x-display-pixel-width display))
1188      (t
1189       (frame-width (if (framep display) display (selected-frame)))))))
1190
1191 (defun display-mm-height (&optional display)
1192   "Return the height of DISPLAY's screen in millimeters.
1193 If the information is unavailable, value is nil."
1194   (and (memq (framep-on-display display) '(x w32 mac))
1195        (x-display-mm-height display)))
1196
1197 (defun display-mm-width (&optional display)
1198   "Return the width of DISPLAY's screen in millimeters.
1199 If the information is unavailable, value is nil."
1200   (and (memq (framep-on-display display) '(x w32 mac))
1201        (x-display-mm-width display)))
1202
1203 (defun display-backing-store (&optional display)
1204   "Return the backing store capability of DISPLAY's screen.
1205 The value may be `always', `when-mapped', `not-useful', or nil if
1206 the question is inapplicable to a certain kind of display."
1207   (let ((frame-type (framep-on-display display)))
1208     (cond
1209      ((memq frame-type '(x w32 mac))
1210       (x-display-backing-store display))
1211      (t
1212       'not-useful))))
1213
1214 (defun display-save-under (&optional display)
1215   "Return non-nil if DISPLAY's screen supports the SaveUnder feature."
1216   (let ((frame-type (framep-on-display display)))
1217     (cond
1218      ((memq frame-type '(x w32 mac))
1219       (x-display-save-under display))
1220      (t
1221       'not-useful))))
1222
1223 (defun display-planes (&optional display)
1224   "Return the number of planes supported by DISPLAY."
1225   (let ((frame-type (framep-on-display display)))
1226     (cond
1227      ((memq frame-type '(x w32 mac))
1228       (x-display-planes display))
1229      ((eq frame-type 'pc)
1230       4)
1231      (t
1232       (truncate (log (length (tty-color-alist)) 2))))))
1233
1234 (defun display-color-cells (&optional display)
1235   "Return the number of color cells supported by DISPLAY."
1236   (let ((frame-type (framep-on-display display)))
1237     (cond
1238      ((memq frame-type '(x w32 mac))
1239       (x-display-color-cells display))
1240      ((eq frame-type 'pc)
1241       16)
1242      (t
1243       (tty-display-color-cells display)))))
1244
1245 (defun display-visual-class (&optional display)
1246   "Returns the visual class of DISPLAY.
1247 The value is one of the symbols `static-gray', `gray-scale',
1248 `static-color', `pseudo-color', `true-color', or `direct-color'."
1249   (let ((frame-type (framep-on-display display)))
1250     (cond
1251      ((memq frame-type '(x w32 mac))
1252       (x-display-visual-class display))
1253      ((and (memq frame-type '(pc t))
1254            (tty-display-color-p display))
1255       'static-color)
1256      (t
1257       'static-gray))))
1258
1259 \f
1260 ;;;; Aliases for backward compatibility with Emacs 18.
1261 (define-obsolete-function-alias 'screen-height 'frame-height) ;before 19.15
1262 (define-obsolete-function-alias 'screen-width 'frame-width) ;before 19.15
1263
1264 (defun set-screen-width (cols &optional pretend)
1265   "Change the size of the screen to COLS columns.
1266 Optional second arg non-nil means that redisplay should use COLS columns
1267 but that the idea of the actual width of the frame should not be changed.
1268 This function is provided only for compatibility with Emacs 18."
1269   (set-frame-width (selected-frame) cols pretend))
1270
1271 (defun set-screen-height (lines &optional pretend)
1272   "Change the height of the screen to LINES lines.
1273 Optional second arg non-nil means that redisplay should use LINES lines
1274 but that the idea of the actual height of the screen should not be changed.
1275 This function is provided only for compatibility with Emacs 18."
1276   (set-frame-height (selected-frame) lines pretend))
1277
1278 (defun delete-other-frames (&optional frame)
1279   "Delete all frames except FRAME.
1280 If FRAME uses another frame's minibuffer, the minibuffer frame is
1281 left untouched.  FRAME nil or omitted means use the selected frame."
1282   (interactive)
1283   (unless frame
1284     (setq frame (selected-frame)))
1285   (let* ((mini-frame (window-frame (minibuffer-window frame)))
1286          (frames (delq mini-frame (delq frame (frame-list)))))
1287     ;; Delete mon-minibuffer-only frames first, because `delete-frame'
1288     ;; signals an error when trying to delete a mini-frame that's
1289     ;; still in use by another frame.
1290     (dolist (frame frames)
1291       (unless (eq (frame-parameter frame 'minibuffer) 'only)
1292         (delete-frame frame)))
1293     ;; Delete minibuffer-only frames.
1294     (dolist (frame frames)
1295       (when (eq (frame-parameter frame 'minibuffer) 'only)
1296         (delete-frame frame)))))
1297
1298 (make-obsolete 'set-screen-width 'set-frame-width) ;before 19.15
1299 (make-obsolete 'set-screen-height 'set-frame-height) ;before 19.15
1300
1301 ;; miscellaneous obsolescence declarations
1302 (define-obsolete-variable-alias 'delete-frame-hook
1303     'delete-frame-functions "22.1")
1304
1305 \f
1306 ;; Highlighting trailing whitespace.
1307
1308 (make-variable-buffer-local 'show-trailing-whitespace)
1309
1310 (defcustom show-trailing-whitespace nil
1311   "*Non-nil means highlight trailing whitespace.
1312 This is done in the face `trailing-whitespace'."
1313   :type 'boolean
1314   :group 'whitespace-faces)
1315
1316
1317 \f
1318 ;; Scrolling
1319
1320 (defgroup scrolling nil
1321   "Scrolling windows."
1322   :version "21.1"
1323   :group 'frames)
1324
1325 (defcustom auto-hscroll-mode t
1326   "*Allow or disallow automatic scrolling windows horizontally.
1327 If non-nil, windows are automatically scrolled horizontally to make
1328 point visible."
1329   :version "21.1"
1330   :type 'boolean
1331   :group 'scrolling)
1332 (defvaralias 'automatic-hscrolling 'auto-hscroll-mode)
1333
1334 \f
1335 ;; Blinking cursor
1336
1337 (defgroup cursor nil
1338   "Displaying text cursors."
1339   :version "21.1"
1340   :group 'frames)
1341
1342 (defcustom blink-cursor-delay 0.5
1343   "*Seconds of idle time after which cursor starts to blink."
1344   :type 'number
1345   :group 'cursor)
1346
1347 (defcustom blink-cursor-interval 0.5
1348   "*Length of cursor blink interval in seconds."
1349   :type 'number
1350   :group 'cursor)
1351
1352 (defvar blink-cursor-idle-timer nil
1353   "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
1354 The function `blink-cursor-start' is called when the timer fires.")
1355
1356 (defvar blink-cursor-timer nil
1357   "Timer started from `blink-cursor-start'.
1358 This timer calls `blink-cursor-timer-function' every
1359 `blink-cursor-interval' seconds.")
1360
1361 (define-minor-mode blink-cursor-mode
1362   "Toggle blinking cursor mode.
1363 With a numeric argument, turn blinking cursor mode on iff ARG is positive.
1364 When blinking cursor mode is enabled, the cursor of the selected
1365 window blinks.
1366
1367 Note that this command is effective only when Emacs
1368 displays through a window system, because then Emacs does its own
1369 cursor display.  On a text-only terminal, this is not implemented."
1370   :init-value (not (or noninteractive
1371                        no-blinking-cursor
1372                        (eq system-type 'ms-dos)
1373                        (not (memq initial-window-system '(x w32 mac)))))
1374   :initialize 'custom-initialize-safe-default
1375   :group 'cursor
1376   :global t
1377   (if blink-cursor-idle-timer (cancel-timer blink-cursor-idle-timer))
1378   (if blink-cursor-timer (cancel-timer blink-cursor-timer))
1379   (setq blink-cursor-idle-timer nil
1380         blink-cursor-timer nil)
1381   (if blink-cursor-mode
1382       (progn
1383         ;; Hide the cursor.
1384         ;;(internal-show-cursor nil nil)
1385         (setq blink-cursor-idle-timer
1386               (run-with-idle-timer blink-cursor-delay
1387                                    blink-cursor-delay
1388                                    'blink-cursor-start)))
1389     (internal-show-cursor nil t)))
1390
1391 (define-obsolete-variable-alias 'blink-cursor 'blink-cursor-mode "22.1")
1392
1393 (defun blink-cursor-start ()
1394   "Timer function called from the timer `blink-cursor-idle-timer'.
1395 This starts the timer `blink-cursor-timer', which makes the cursor blink
1396 if appropriate.  It also arranges to cancel that timer when the next
1397 command starts, by installing a pre-command hook."
1398   (when (null blink-cursor-timer)
1399     (add-hook 'pre-command-hook 'blink-cursor-end)
1400     (internal-show-cursor nil nil)
1401     (setq blink-cursor-timer
1402           (run-with-timer blink-cursor-interval blink-cursor-interval
1403                           'blink-cursor-timer-function))))
1404
1405 (defun blink-cursor-timer-function ()
1406   "Timer function of timer `blink-cursor-timer'."
1407   (internal-show-cursor nil (not (internal-show-cursor-p))))
1408
1409 (defun blink-cursor-end ()
1410   "Stop cursor blinking.
1411 This is installed as a pre-command hook by `blink-cursor-start'.
1412 When run, it cancels the timer `blink-cursor-timer' and removes
1413 itself as a pre-command hook."
1414   (remove-hook 'pre-command-hook 'blink-cursor-end)
1415   (internal-show-cursor nil t)
1416   (cancel-timer blink-cursor-timer)
1417   (setq blink-cursor-timer nil))
1418
1419
1420 \f
1421 ;; Hourglass pointer
1422
1423 (defcustom display-hourglass t
1424   "*Non-nil means show an hourglass pointer, when Emacs is busy.
1425 This feature only works when on a window system that can change
1426 cursor shapes."
1427   :type 'boolean
1428   :group 'cursor)
1429
1430 (defcustom hourglass-delay 1
1431   "*Seconds to wait before displaying an hourglass pointer when Emacs is busy."
1432   :type 'number
1433   :group 'cursor)
1434
1435 \f
1436 (defcustom cursor-in-non-selected-windows t
1437   "*Non-nil means show a hollow box cursor in non-selected windows.
1438 If nil, don't show a cursor except in the selected window.
1439 Use Custom to set this variable to get the display updated."
1440   :tag "Cursor In Non-selected Windows"
1441   :type 'boolean
1442   :group 'cursor
1443   :set #'(lambda (symbol value)
1444            (set-default symbol value)
1445            (force-mode-line-update t)))
1446
1447 \f
1448 ;;;; Key bindings
1449
1450 (define-key ctl-x-5-map "2" 'make-frame-command)
1451 (define-key ctl-x-5-map "1" 'delete-other-frames)
1452 (define-key ctl-x-5-map "0" 'delete-frame)
1453 (define-key ctl-x-5-map "o" 'other-frame)
1454
1455 (provide 'frame)
1456
1457 ;; arch-tag: 82979c70-b8f2-4306-b2ad-ddbd6b328b56
1458 ;;; frame.el ends here