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