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