frame.el 107 KB
Newer Older
1
;;; frame.el --- multi-frame management independent of window systems  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1993-1994, 1996-1997, 2000-2019 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
;; Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Maintainer: emacs-devel@gnu.org
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Erik Naggum's avatar
Erik Naggum committed
10 11
;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Erik Naggum's avatar
Erik Naggum committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Erik Naggum's avatar
Erik Naggum committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
24

25 26
;;; Commentary:

Eric S. Raymond's avatar
Eric S. Raymond committed
27
;;; Code:
28 29
(eval-when-compile (require 'cl-lib))

30
(cl-defgeneric frame-creation-function (params)
Stefan Monnier's avatar
Stefan Monnier committed
31
  "Method for window-system dependent functions to create a new frame.
32
The window system startup file should add its frame creation
Stefan Monnier's avatar
Stefan Monnier committed
33
function to this method, which should take an alist of parameters
34
as its argument.")
35

36 37 38 39 40 41
(cl-generic-define-context-rewriter window-system (value)
  ;; If `value' is a `consp', it's probably an old-style specializer,
  ;; so just use it, and anyway `eql' isn't very useful on cons cells.
  `(window-system ,(if (consp value) value `(eql ,value))))

(cl-defmethod frame-creation-function (params &context (window-system nil))
42 43 44 45 46 47
  ;; It's tempting to get rid of tty-create-frame-with-faces and turn it into
  ;; this method (i.e. move this method to faces.el), but faces.el is loaded
  ;; much earlier from loadup.el (before cl-generic and even before
  ;; cl-preloaded), so we'd first have to reorder that part.
  (tty-create-frame-with-faces params))

48
(defvar window-system-default-frame-alist nil
49 50
  "Window-system dependent default frame parameters.
The value should be an alist of elements (WINDOW-SYSTEM . ALIST),
Stefan Monnier's avatar
Stefan Monnier committed
51
where WINDOW-SYSTEM is a window system symbol (as returned by `framep')
52 53 54
and ALIST is a frame parameter alist like `default-frame-alist'.
Then, for frames on WINDOW-SYSTEM, any parameters specified in
ALIST supersede the corresponding parameters specified in
55
`default-frame-alist'.")
56

57 58 59 60 61 62
(defvar display-format-alist nil
  "Alist of patterns to decode display names.
The car of each entry is a regular expression matching a display
name string.  The cdr is a symbol giving the window-system that
handles the corresponding kind of display.")

63 64 65
;; The initial value given here used to ask for a minibuffer.
;; But that's not necessary, because the default is to have one.
;; By not specifying it here, we let an X resource specify it.
Chong Yidong's avatar
Chong Yidong committed
66
(defcustom initial-frame-alist nil
67 68 69 70
  "Alist of parameters for the initial X window frame.
You can set this in your init file; for example,

 (setq initial-frame-alist
71
       \\='((top . 1) (left . 1) (width . 80) (height . 55)))
72 73 74 75 76 77 78 79 80 81 82 83 84 85

Parameters specified here supersede the values given in
`default-frame-alist'.

If the value calls for a frame without a minibuffer, and you have
not created a minibuffer frame on your own, a minibuffer frame is
created according to `minibuffer-frame-alist'.

You can specify geometry-related options for just the initial
frame by setting this variable in your init file; however, they
won't take effect until Emacs reads your init file, which happens
after creating the initial frame.  If you want the initial frame
to have the proper geometry as soon as it appears, you need to
use this three-step process:
86 87 88 89
* Specify X resources to give the geometry you want.
* Set `default-frame-alist' to override these options so that they
  don't affect subsequent frames.
* Set `initial-frame-alist' in a way that matches the X resources,
90 91 92 93 94
  to override what you put in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
95

96
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
97 98 99 100 101 102
  "Alist of parameters for the initial minibuffer frame.
This is the minibuffer frame created if `initial-frame-alist'
calls for a frame without a minibuffer.  The parameters specified
here supersede those given in `default-frame-alist', for the
initial minibuffer frame.

103 104
You can set this in your init file; for example,

Jim Blandy's avatar
Jim Blandy committed
105
 (setq minibuffer-frame-alist
106
       \\='((top . 1) (left . 1) (width . 80) (height . 2)))
107

108 109
It is not necessary to include (minibuffer . only); that is
appended when the minibuffer frame is created."
110 111 112 113
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
114

115
(defun handle-delete-frame (event)
116
  "Handle delete-frame events from the X server."
117
  (interactive "e")
118 119 120
  (let* ((frame (posn-window (event-start event))))
    (if (catch 'other-frame
          (dolist (frame-1 (frame-list))
121 122
            ;; A valid "other" frame is visible, has its `delete-before'
            ;; parameter unset and is not a child frame.
123 124 125 126 127
            (when (and (not (eq frame-1 frame))
                       (frame-visible-p frame-1)
                       (not (frame-parent frame-1))
                       (not (frame-parameter frame-1 'delete-before)))
              (throw 'other-frame t))))
128
	(delete-frame frame t)
129 130
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
131

132 133
(defun frame-focus-state (&optional frame)
  "Return FRAME's last known focus state.
134 135
If nil or omitted, FRAME defaults to the selected frame.

136
Return nil if the frame is definitely known not be focused, t if
137
the frame is known to be focused, and `unknown' if we don't know."
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
  (let* ((frame (or frame (selected-frame)))
         (tty-top-frame (tty-top-frame frame)))
    (if (not tty-top-frame)
        (frame-parameter frame 'last-focus-update)
      ;; All tty frames are frame-visible-p if the terminal is
      ;; visible, so check whether the frame is the top tty frame
      ;; before checking visibility.
      (cond ((not (eq tty-top-frame frame)) nil)
            ((not (frame-visible-p frame)) nil)
            (t (let ((tty-focus-state
                      (terminal-parameter frame 'tty-focus-state)))
                 (cond ((eq tty-focus-state 'focused) t)
                       ((eq tty-focus-state 'defocused) nil)
                       (t 'unknown))))))))

(defvar after-focus-change-function #'ignore
  "Function called after frame focus may have changed.

This function is called with no arguments when Emacs notices that
the set of focused frames may have changed.  Code wanting to do
something when frame focus changes should use `add-function' to
add a function to this one, and in this added function, re-scan
the set of focused frames, calling `frame-focus-state' to
retrieve the last known focus state of each frame.  Focus events
are delivered asynchronously, and frame input focus according to
an external system may not correspond to the notion of the Emacs
selected frame.  Multiple frames may appear to have input focus
simultaneously due to focus event delivery differences, the
presence of multiple Emacs terminals, and other factors, and code
should be robust in the face of this situation.

Depending on window system, focus events may also be delivered
repeatedly and with different focus states before settling to the
expected values.  Code relying on focus notifications should
\"debounce\" any user-visible updates arising from focus changes,
perhaps by deferring work until redisplay.

This function may be called in arbitrary contexts, including from
inside `read-event', so take the same care as you might when
writing a process filter.")

(defvar focus-in-hook nil
  "Normal hook run when a frame gains focus.
The frame gaining focus is selected at the time this hook is run.

This hook is obsolete.  Despite its name, this hook may be run in
situations other than when a frame obtains input focus: for
example, we also run this hook when switching the selected frame
internally to handle certain input events (like mouse wheel
scrolling) even when the user's notion of input focus
hasn't changed.

Prefer using `after-focus-change-function'.")
(make-obsolete-variable
 'focus-in-hook "after-focus-change-function" "27.1" 'set)

(defvar focus-out-hook nil
  "Normal hook run when all frames lost input focus.

This hook is obsolete; see `focus-in-hook'.  Depending on timing,
this hook may be delivered when a frame does in fact have focus.
Prefer `after-focus-change-function'.")
(make-obsolete-variable
 'focus-out-hook "after-focus-change-function" "27.1" 'set)

(defun handle-focus-in (event)
204
  "Handle a focus-in event.
205 206 207 208
Focus-in events are bound to this function; do not change this
binding.  Focus-in events occur when a frame receives focus from
the window system."
  ;; N.B. tty focus goes down a different path; see xterm.el.
209
  (interactive "e")
210 211 212
  (unless (eq (car-safe event) 'focus-in)
    (error "handle-focus-in should handle focus-in events"))
  (let ((frame (nth 1 event)))
213 214 215 216 217
    (when (frame-live-p frame)
      (internal-handle-focus-in event)
      (setf (frame-parameter frame 'last-focus-update) t)
      (run-hooks 'focus-in-hook)))
  (funcall after-focus-change-function))
218 219

(defun handle-focus-out (event)
220
  "Handle a focus-out event.
221 222 223 224
Focus-out events are bound to this function; do not change this
binding.  Focus-out events occur when a frame loses focus, but
that's not the whole story: see `after-focus-change-function'."
  ;; N.B. tty focus goes down a different path; see xterm.el.
225
  (interactive "e")
226 227 228
  (unless (eq (car event) 'focus-out)
    (error "handle-focus-out should handle focus-out events"))
  (let ((frame (nth 1 event)))
229 230 231 232
    (when (frame-live-p frame)
      (setf (frame-parameter frame 'last-focus-update) nil)
      (run-hooks 'focus-out-hook)))
  (funcall after-focus-change-function))
233 234 235 236 237 238 239

(defun handle-move-frame (event)
  "Handle a move-frame event.
This function runs the abnormal hook `move-frame-functions'."
  (interactive "e")
  (let ((frame (posn-window (event-start event))))
    (run-hook-with-args 'move-frame-functions frame)))
Jim Blandy's avatar
Jim Blandy committed
240

Jim Blandy's avatar
Jim Blandy committed
241
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
242

243 244 245 246 247 248 249 250
;; 1) Load the window system startup file from the lisp library and read the
;; high-priority arguments (-q and the like).  The window system startup
;; file should create any frames specified in the window system defaults.
;;
;; 2) If no frames have been opened, we open an initial text frame.
;;
;; 3) Once the init file is done, we apply any newly set parameters
;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
251

252
;; If we create the initial frame, this is it.
Jim Blandy's avatar
Jim Blandy committed
253
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
254

255 256 257
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

258 259
(defvar frame-initial-geometry-arguments nil)

260 261 262
;; startup.el calls this function before loading the user's init
;; file - if there is no frame with a minibuffer open now, create
;; one to display messages while loading the init file.
Jim Blandy's avatar
Jim Blandy committed
263
(defun frame-initialize ()
Eli Zaretskii's avatar
Eli Zaretskii committed
264
  "Create an initial frame if necessary."
Jim Blandy's avatar
Jim Blandy committed
265
  ;; Are we actually running under a window system at all?
266 267 268
  (if (and initial-window-system
	   (not noninteractive)
	   (not (eq initial-window-system 'pc)))
269 270 271 272 273 274
      (progn
	;; If there is no frame with a minibuffer besides the terminal
	;; frame, then we need to create the opening frame.  Make sure
	;; it has a minibuffer, but let initial-frame-alist omit the
	;; minibuffer spec.
	(or (delq terminal-frame (minibuffer-frame-list))
275
	    (progn
276
	      (setq frame-initial-frame-alist
277
		    (append initial-frame-alist default-frame-alist nil))
278 279 280
	      (setq frame-initial-frame-alist
		    (cons (cons 'window-system initial-window-system)
			  frame-initial-frame-alist))
281 282
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
283
			  (make-frame frame-initial-frame-alist)))
284 285 286 287
	      ;; Delete any specifications for window geometry parameters
	      ;; so that we won't reapply them in frame-notice-user-settings.
	      ;; It would be wrong to reapply them then,
	      ;; because that would override explicit user resizing.
288
	      (setq initial-frame-alist
289
		    (frame-remove-geometry-params initial-frame-alist))))
290 291 292
	;; Copy the environment of the Emacs process into the new frame.
	(set-frame-parameter frame-initial-frame 'environment
			     (frame-parameter terminal-frame 'environment))
Karl Heuer's avatar
Karl Heuer committed
293
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
294 295
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
296
	(setq terminal-frame nil))))
Karl Heuer's avatar
Karl Heuer committed
297

298 299 300
(defvar frame-notice-user-settings t
  "Non-nil means function `frame-notice-user-settings' wasn't run yet.")

301
(declare-function tool-bar-mode "tool-bar" (&optional arg))
302
(declare-function tool-bar-height "xdisp.c" (&optional frame pixelwise))
303

304 305
(defalias 'tool-bar-lines-needed 'tool-bar-height)

306 307 308
;; startup.el calls this function after loading the user's init
;; file.  Now default-frame-alist and initial-frame-alist contain
;; information to which we must react; do what needs to be done.
Jim Blandy's avatar
Jim Blandy committed
309
(defun frame-notice-user-settings ()
310
  "Act on user's init file settings of frame parameters.
311 312 313
React to settings of `initial-frame-alist',
`window-system-default-frame-alist' and `default-frame-alist'
there (in decreasing order of priority)."
314 315 316 317 318
  ;; Creating and deleting frames may shift the selected frame around,
  ;; and thus the current buffer.  Protect against that.  We don't
  ;; want to use save-excursion here, because that may also try to set
  ;; the buffer of the selected window, which fails when the selected
  ;; window is the minibuffer.
319 320 321 322 323 324 325 326 327
  (let* ((old-buffer (current-buffer))
	 (window-system-frame-alist
          (cdr (assq initial-window-system
                     window-system-default-frame-alist)))
         (minibuffer
          (cdr (or (assq 'minibuffer initial-frame-alist)
		   (assq 'minibuffer window-system-frame-alist)
		   (assq 'minibuffer default-frame-alist)
		   '(minibuffer . t)))))
328

329 330
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
331 332
      ;; This case happens when we don't have a window system, and
      ;; also for MS-DOS frames.
333
      (let ((parms (frame-parameters)))
334 335 336 337
	;; Don't change the frame names.
	(setq parms (delq (assq 'name parms) parms))
	;; Can't modify the minibuffer parameter, so don't try.
	(setq parms (delq (assq 'minibuffer parms) parms))
338 339 340 341 342 343 344 345
	(modify-frame-parameters
	 nil
	 (if initial-window-system
	     parms
	   ;; initial-frame-alist and default-frame-alist were already
	   ;; applied in pc-win.el.
	   (append initial-frame-alist window-system-frame-alist
		   default-frame-alist parms nil)))
346
	(if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
347 348 349
	    (let ((newparms (frame-parameters))
		  (frame (selected-frame)))
	      (tty-handle-reverse-video frame newparms)
350 351 352 353
	      ;; tty-handle-reverse-video might change the frame's
	      ;; color parameters, and we need to use the updated
	      ;; value below.
	      (setq newparms (frame-parameters))
354 355 356 357 358 359 360
	      ;; If we changed the background color, we need to update
	      ;; the background-mode parameter, and maybe some faces,
	      ;; too.
	      (when (assq 'background-color newparms)
		(unless (or (assq 'background-mode initial-frame-alist)
			    (assq 'background-mode default-frame-alist))
		  (frame-set-background-mode frame))
361
		(face-set-after-frame-default frame newparms))))))
362

363 364
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
365 366 367 368
    (when (frame-live-p frame-initial-frame)
      ;; When tool-bar has been switched off, correct the frame size
      ;; by the lines added in x-create-frame for the tool-bar and
      ;; switch `tool-bar-mode' off.
369
      (when (display-graphic-p)
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
	(let* ((init-lines
		(assq 'tool-bar-lines initial-frame-alist))
	       (other-lines
		(or (assq 'tool-bar-lines window-system-frame-alist)
		    (assq 'tool-bar-lines default-frame-alist)))
	       (lines (or init-lines other-lines))
	       (height (tool-bar-height frame-initial-frame t)))
	  ;; Adjust frame top if either zero (nil) tool bar lines have
	  ;; been requested in the most relevant of the frame's alists
	  ;; or tool bar mode has been explicitly turned off in the
	  ;; user's init file.
	  (when (and (> height 0)
		     (or (and lines
			      (or (null (cdr lines))
				  (eq 0 (cdr lines))))
			 (not tool-bar-mode)))
386 387
	    (let* ((initial-top
		    (cdr (assq 'top frame-initial-geometry-arguments)))
388 389
		   (top (frame-parameter frame-initial-frame 'top)))
	      (when (and (consp initial-top) (eq '- (car initial-top)))
390
		(let ((adjusted-top
391 392
		       (cond
			((and (consp top) (eq '+ (car top)))
393
			 (list '+ (+ (cadr top) height)))
394
			((and (consp top) (eq '- (car top)))
395 396
			 (list '- (- (cadr top) height)))
			(t (+ top height)))))
397
		  (modify-frame-parameters
398
		   frame-initial-frame `((top . ,adjusted-top))))))
399 400 401 402 403 404 405
	    ;; Reset `tool-bar-mode' when zero tool bar lines have been
	    ;; requested for the window-system or default frame alists.
	    (when (and tool-bar-mode
		       (and other-lines
			    (or (null (cdr other-lines))
				(eq 0 (cdr other-lines)))))
	      (tool-bar-mode -1)))))
406 407 408 409 410 411 412 413 414 415 416

      ;; The initial frame we create above always has a minibuffer.
      ;; If the user wants to remove it, or make it a minibuffer-only
      ;; frame, then we'll have to delete the current frame and make a
      ;; new one; you can't remove or add a root window to/from an
      ;; existing frame.
      ;;
      ;; NOTE: default-frame-alist was nil when we created the
      ;; existing frame.  We need to explicitly include
      ;; default-frame-alist in the parameters of the screen we
      ;; create here, so that its new value, gleaned from the user's
417
      ;; init file, will be applied to the existing screen.
418
      (if (not (eq minibuffer t))
419 420
	  ;; Create the new frame.
	  (let (parms new)
421 422 423
	    ;; MS-Windows needs this to avoid inflooping below.
	    (if (eq system-type 'windows-nt)
		(sit-for 0 t))
424 425 426 427 428 429 430 431
	    ;; If the frame isn't visible yet, wait till it is.
	    ;; If the user has to position the window,
	    ;; Emacs doesn't know its real position until
	    ;; the frame is seen to be visible.
	    (while (not (cdr (assq 'visibility
				   (frame-parameters frame-initial-frame))))
	      (sleep-for 1))
	    (setq parms (frame-parameters frame-initial-frame))
432

Sam Steingold's avatar
Sam Steingold committed
433
            ;; Get rid of `name' unless it was specified explicitly before.
434 435
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))
436 437 438
	    ;; An explicit parent-id is a request to XEmbed the frame.
	    (or (assq 'parent-id frame-initial-frame-alist)
                (setq parms (delq (assq 'parent-id parms) parms)))
439 440

	    (setq parms (append initial-frame-alist
441
				window-system-frame-alist
442 443 444 445
				default-frame-alist
				parms
				nil))

446 447 448 449 450 451 452 453 454
	    (when (eq minibuffer 'child-frame)
              ;; When the minibuffer shall be shown in a child frame,
              ;; remove the 'minibuffer' parameter from PARMS.  It
              ;; will get assigned by the usual routines to the child
              ;; frame's root window below.
              (setq parms (cons '(minibuffer)
				(delq (assq 'minibuffer parms) parms))))

            ;; Get rid of `reverse', because that was handled
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
	    ;; when we first made the frame.
	    (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))

	    (if (assq 'height frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'height parms)))
	    (if (assq 'width frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'width parms)))
	    (if (assq 'left frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'left parms)))
	    (if (assq 'top frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'top parms)))
	    (setq new
		  (make-frame
		   ;; Use the geometry args that created the existing
		   ;; frame, rather than the parms we get for it.
		   (append frame-initial-geometry-arguments
			   '((user-size . t) (user-position . t))
			   parms)))
	    ;; The initial frame, which we are about to delete, may be
	    ;; the only frame with a minibuffer.  If it is, create a
	    ;; new one.
	    (or (delq frame-initial-frame (minibuffer-frame-list))
477 478 479 480 481 482 483 484 485 486 487 488
                (and (eq minibuffer 'child-frame)
                     ;; Create a minibuffer child frame and parent it
                     ;; immediately.  Take any other parameters for
                     ;; the child frame from 'minibuffer-frame-list'.
                     (let* ((minibuffer-frame-alist
                             (cons `(parent-frame . ,new) minibuffer-frame-alist)))
                       (make-initial-minibuffer-frame nil)
                       ;; With a minibuffer child frame we do not want
                       ;; to select the minibuffer frame initially as
                       ;; we do for standard minibuffer-only frames.
                       (select-frame new)))
                (make-initial-minibuffer-frame nil))
489 490 491 492 493 494 495

	    ;; If the initial frame is serving as a surrogate
	    ;; minibuffer frame for any frames, we need to wean them
	    ;; onto a new frame.  The default-minibuffer-frame
	    ;; variable must be handled similarly.
	    (let ((users-of-initial
		   (filtered-frame-list
496 497 498 499 500 501
                    (lambda (frame)
                      (and (not (eq frame frame-initial-frame))
                           (eq (window-frame
                                (minibuffer-window frame))
                               frame-initial-frame))))))
              (if (or users-of-initial
502 503 504 505 506 507 508
		      (eq default-minibuffer-frame frame-initial-frame))

		  ;; Choose an appropriate frame.  Prefer frames which
		  ;; are only minibuffers.
		  (let* ((new-surrogate
			  (car
			   (or (filtered-frame-list
509 510 511 512
                                (lambda (frame)
                                  (eq (cdr (assq 'minibuffer
                                                 (frame-parameters frame)))
                                      'only)))
513 514 515 516 517 518 519 520
			       (minibuffer-frame-list))))
			 (new-minibuffer (minibuffer-window new-surrogate)))

		    (if (eq default-minibuffer-frame frame-initial-frame)
			(setq default-minibuffer-frame new-surrogate))

		    ;; Wean the frames using frame-initial-frame as
		    ;; their minibuffer frame.
521 522 523 524 525
		    (dolist (frame users-of-initial)
                      (modify-frame-parameters
                       frame (list (cons 'minibuffer new-minibuffer)))))))

            ;; Redirect events enqueued at this frame to the new frame.
526 527 528 529 530
	    ;; Is this a good idea?
	    (redirect-frame-focus frame-initial-frame new)

	    ;; Finally, get rid of the old frame.
	    (delete-frame frame-initial-frame t))
531

Paul Eggert's avatar
Paul Eggert committed
532
	;; Otherwise, we don't need all that rigmarole; just apply
533 534 535
	;; the new parameters.
	(let (newparms allparms tail)
	  (setq allparms (append initial-frame-alist
536
				 window-system-frame-alist
537 538 539 540 541 542 543 544 545 546 547 548
				 default-frame-alist nil))
	  (if (assq 'height frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'height allparms)))
	  (if (assq 'width frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'width allparms)))
	  (if (assq 'left frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'left allparms)))
	  (if (assq 'top frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'top allparms)))
	  (setq tail allparms)
	  ;; Find just the parms that have changed since we first
	  ;; made this frame.  Those are the ones actually set by
Sam Steingold's avatar
Sam Steingold committed
549
          ;; the init file.  For those parms whose values we already knew
550 551
	  ;; (such as those spec'd by command line options)
	  ;; it is undesirable to specify the parm again
Sam Steingold's avatar
Sam Steingold committed
552
          ;; once the user has seen the frame and been able to alter it
553
	  ;; manually.
554 555 556 557
	  (let (newval oldval)
	    (dolist (entry tail)
	      (setq oldval (assq (car entry) frame-initial-frame-alist))
	      (setq newval (cdr (assq (car entry) allparms)))
558 559
	      (or (and oldval (eq (cdr oldval) newval))
		  (setq newparms
560
			(cons (cons (car entry) newval) newparms)))))
561
	  (setq newparms (nreverse newparms))
562 563 564 565 566 567 568 569 570 571 572 573 574

	  (let ((new-bg (assq 'background-color newparms)))
	    ;; If the `background-color' parameter is changed, apply
	    ;; it first, then make sure that the `background-mode'
	    ;; parameter and other faces are updated, before applying
	    ;; the other parameters.
	    (when new-bg
	      (modify-frame-parameters frame-initial-frame
				       (list new-bg))
	      (unless (assq 'background-mode newparms)
		(frame-set-background-mode frame-initial-frame))
	      (face-set-after-frame-default frame-initial-frame)
	      (setq newparms (delq new-bg newparms)))
575 576 577 578 579 580

	    (when (numberp (car frame-size-history))
	      (setq frame-size-history
		    (cons (1- (car frame-size-history))
			  (cons
			   (list frame-initial-frame
581
				 "FRAME-NOTICE-USER"
582 583 584
				 nil newparms)
			   (cdr frame-size-history)))))

585
	    (modify-frame-parameters frame-initial-frame newparms)))))
Jim Blandy's avatar
Jim Blandy committed
586

587 588 589 590
    ;; Restore the original buffer.
    (set-buffer old-buffer)

    ;; Make sure the initial frame can be GC'd if it is ever deleted.
591
    ;; Make sure frame-notice-user-settings does nothing if called twice.
592
    (setq frame-notice-user-settings nil)
593
    (setq frame-initial-frame nil)))
Jim Blandy's avatar
Jim Blandy committed
594

595 596 597 598 599 600
(defun make-initial-minibuffer-frame (display)
  (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
    (if display
	(make-frame-on-display display parms)
      (make-frame parms))))

601
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
602

603
(defun modify-all-frames-parameters (alist)
604
  "Modify all current and future frames' parameters according to ALIST.
605
This changes `default-frame-alist' and possibly `initial-frame-alist'.
606 607
Furthermore, this function removes all parameters in ALIST from
`window-system-default-frame-alist'.
608
See help of `modify-frame-parameters' for more information."
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  (dolist (frame (frame-list))
    (modify-frame-parameters frame alist))

  (dolist (pair alist) ;; conses to add/replace
    ;; initial-frame-alist needs setting only when
    ;; frame-notice-user-settings is true.
    (and frame-notice-user-settings
	 (setq initial-frame-alist
	       (assq-delete-all (car pair) initial-frame-alist)))
    (setq default-frame-alist
	  (assq-delete-all (car pair) default-frame-alist))
    ;; Remove any similar settings from the window-system specific
    ;; parameters---they would override default-frame-alist.
    (dolist (w window-system-default-frame-alist)
      (setcdr w (assq-delete-all (car pair) (cdr w)))))

625 626 627 628
  (and frame-notice-user-settings
       (setq initial-frame-alist (append initial-frame-alist alist)))
  (setq default-frame-alist (append default-frame-alist alist)))

Jim Blandy's avatar
Jim Blandy committed
629
(defun get-other-frame ()
630 631 632
  "Return some frame other than the current frame.
Create one if necessary.  Note that the minibuffer frame, if separate,
is not considered (see `next-frame')."
633
  (if (equal (next-frame) (selected-frame)) (make-frame) (next-frame)))
Jim Blandy's avatar
Jim Blandy committed
634

Jim Blandy's avatar
Jim Blandy committed
635 636
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
637 638 639
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
640
			      0))
641
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
642

Jim Blandy's avatar
Jim Blandy committed
643 644
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
645 646 647
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
648
				  0))
649
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
650

651 652 653
(defun window-system-for-display (display)
  "Return the window system for DISPLAY.
Return nil if we don't know how to interpret DISPLAY."
654 655
  ;; MS-Windows doesn't know how to create a GUI frame in a -nw session.
  (if (and (eq system-type 'windows-nt)
656 657
	   (null (window-system))
	   (not (daemonp)))
658 659 660 661 662
      nil
    (cl-loop for descriptor in display-format-alist
	     for pattern = (car descriptor)
	     for system = (cdr descriptor)
	     when (string-match-p pattern display) return system)))
663

664
(defun make-frame-on-display (display &optional parameters)
665 666
  "Make a frame on display DISPLAY.
The optional argument PARAMETERS specifies additional frame parameters."
667 668 669 670 671 672
  (interactive (list (completing-read
                      (format "Make frame on display: ")
                      (delete-dups
                       (mapcar (lambda (frame)
                                 (frame-parameter frame 'display))
                               (frame-list))))))
673
  (make-frame (cons (cons 'display display) parameters)))
674

675 676 677 678
(defun make-frame-on-monitor (monitor &optional display parameters)
  "Make a frame on monitor MONITOR.
The optional argument DISPLAY can be a display name, and the optional
argument PARAMETERS specifies additional frame parameters."
679 680 681 682 683 684 685 686 687 688
  (interactive
   (list
    (let* ((default (cdr (assq 'name (frame-monitor-attributes)))))
      (completing-read
       (format "Make frame on monitor (default %s): " default)
       (or (delq nil (mapcar (lambda (a)
                               (cdr (assq 'name a)))
                             (display-monitor-attributes-list)))
           '(""))
       nil nil nil nil default))))
689 690 691 692 693 694 695 696 697 698
  (let* ((monitor-workarea
          (catch 'done
            (dolist (a (display-monitor-attributes-list display))
              (when (equal (cdr (assq 'name a)) monitor)
                (throw 'done (cdr (assq 'workarea a)))))))
         (geometry-parameters
          (when monitor-workarea
            `((top . ,(nth 1 monitor-workarea))
              (left . ,(nth 0 monitor-workarea))))))
    (make-frame (append geometry-parameters parameters))))
699

700 701
(declare-function x-close-connection "xfns.c" (terminal))

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
(defun close-display-connection (display)
  "Close the connection to a display, deleting all its associated frames.
For DISPLAY, specify either a frame or a display name (a string).
If DISPLAY is nil, that stands for the selected frame's display."
  (interactive
   (list
    (let* ((default (frame-parameter nil 'display))
           (display (completing-read
                     (format "Close display (default %s): " default)
                     (delete-dups
                      (mapcar (lambda (frame)
                                (frame-parameter frame 'display))
                              (frame-list)))
                     nil t nil nil
                     default)))
      (if (zerop (length display)) default display))))
  (let ((frames (delq nil
                      (mapcar (lambda (frame)
                                (if (equal display
                                           (frame-parameter frame 'display))
                                    frame))
                              (frame-list)))))
    (if (and (consp frames)
             (not (y-or-n-p (if (cdr frames)
                                (format "Delete %s frames? " (length frames))
                              (format "Delete %s ? " (car frames))))))
        (error "Abort!")
      (mapc 'delete-frame frames)
      (x-close-connection display))))

732
(defun make-frame-command ()
733 734
  "Make a new frame, on the same terminal as the selected frame.
If the terminal is a text-only terminal, this also selects the
735 736 737
new frame.

When called from Lisp, returns the new frame."
738
  (interactive)
739
  (if (display-graphic-p)
740 741 742
      (make-frame)
    (select-frame (make-frame))))

743
(defvar before-make-frame-hook nil
744
  "Functions to run before `make-frame' creates a new frame.")
745 746

(defvar after-make-frame-functions nil
747 748 749
  "Functions to run after `make-frame' created a new frame.
The functions are run with one argument, the newly created
frame.")
750

751
(defvar after-setting-font-hook nil
752 753
  "Functions to run after a frame's font has been changed.")

754
(defvar frame-inherited-parameters '()
755
  "Parameters `make-frame' copies from the selected to the new frame.")
756

757 758
(defvar x-display-name)

759 760
(defun make-frame (&optional parameters)
  "Return a newly created frame displaying the current buffer.
761 762 763
Optional argument PARAMETERS is an alist of frame parameters for
the new frame.  Each element of PARAMETERS should have the
form (NAME . VALUE), for example:
Richard M. Stallman's avatar
Richard M. Stallman committed
764

765
 (name . STRING)	The frame should be named STRING.
Jim Blandy's avatar
Jim Blandy committed
766

767 768
 (width . NUMBER)	The frame should be NUMBER characters in width.
 (height . NUMBER)	The frame should be NUMBER text lines high.
Jim Blandy's avatar
Jim Blandy committed
769

770 771 772 773
 (minibuffer . t)	The frame should have a minibuffer.
 (minibuffer . nil)	The frame should have no minibuffer.
 (minibuffer . only)	The frame should contain only a minibuffer.
 (minibuffer . WINDOW)	The frame should use WINDOW as its minibuffer window.
Jim Blandy's avatar
Jim Blandy committed
774

775 776 777
 (window-system . nil)	The frame should be displayed on a terminal device.
 (window-system . x)	The frame should be displayed in an X window.

778 779
 (display . \":0\")     The frame should appear on display :0.

780
 (terminal . TERMINAL)  The frame should use the terminal object TERMINAL.
781

782 783
In addition, any parameter specified in `default-frame-alist',
but not present in PARAMETERS, is applied.
Luc Teirlinck's avatar
Luc Teirlinck committed
784

785 786 787 788
Before creating the frame (via `frame-creation-function'), this
function runs the hook `before-make-frame-hook'.  After creating
the frame, it runs the hook `after-make-frame-functions' with one
argument, the newly created frame.
789

790 791 792
If a display parameter is supplied and a window-system is not,
guess the window-system from the display.

793 794 795
On graphical displays, this function does not itself make the new
frame the selected frame.  However, the window system may select
the new frame according to its own rules."
Jim Blandy's avatar
Jim Blandy committed
796
  (interactive)
797
  (let* ((display (cdr (assq 'display parameters)))
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
         (w (cond
             ((assq 'terminal parameters)
              (let ((type (terminal-live-p
                           (cdr (assq 'terminal parameters)))))
                (cond
                 ((eq t type) nil)
                 ((null type) (error "Terminal %s does not exist"
                                     (cdr (assq 'terminal parameters))))
                 (t type))))
             ((assq 'window-system parameters)
              (cdr (assq 'window-system parameters)))
             (display
              (or (window-system-for-display display)
                  (error "Don't know how to interpret display %S"
                         display)))
             (t window-system)))
814
	 (oldframe (selected-frame))
815
	 (params parameters)
816
	 frame child-frame)
817 818

    (unless (get w 'window-system-initialized)
819 820
      (let ((window-system w))          ;Hack attack!
        (window-system-initialization display))
821
      (setq x-display-name display)
822 823
      (put w 'window-system-initialized t))

824 825
    ;; Add parameters from `window-system-default-frame-alist'.
    (dolist (p (cdr (assq w window-system-default-frame-alist)))
826
      (unless (assq (car p) params)
827 828 829
	(push p params)))
    ;; Add parameters from `default-frame-alist'.
    (dolist (p default-frame-alist)
830
      (unless (assq (car p) params)
831
	(push p params)))
832

833
;;     (setq frame-size-history '(1000))
834

835 836 837 838 839 840 841 842 843 844 845 846 847
    (when (eq (cdr (or (assq 'minibuffer params) '(minibuffer . t)))
              'child-frame)
      ;; If the 'minibuffer' parameter equals 'child-frame' make a
      ;; frame without minibuffer first using the root window of
      ;; 'default-minibuffer-frame' as its minibuffer window
      (setq child-frame t)
      (setq params (cons '(minibuffer)
                         (delq (assq 'minibuffer params) params))))

    ;; Now make the frame.
    (run-hooks 'before-make-frame-hook)

    (setq frame (let ((window-system w)) ; Hack attack!
848
                  (frame-creation-function params)))
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

    (when child-frame
      ;; When we want to equip the new frame with a minibuffer-only
      ;; child frame, make that frame and reparent it immediately.
      (setq child-frame
            (make-frame
             (append
              `((display . ,display) (minibuffer . only)
                (parent-frame . ,frame))
              minibuffer-frame-alist)))
      (when (frame-live-p child-frame)
        ;; Have the 'minibuffer' parameter of our new frame refer to
        ;; its child frame's root window.
        (set-frame-parameter
         frame 'minibuffer (frame-root-window child-frame))))

865
    (normal-erase-is-backspace-setup-frame frame)
866 867
    ;; Inherit original frame's parameters unless they are overridden
    ;; by explicit parameters.
868
    (dolist (param frame-inherited-parameters)
869
      (unless (assq param parameters)
870 871
        (let ((val (frame-parameter oldframe param)))
          (when val (set-frame-parameter frame param val)))))
872

873 874 875
    (when (numberp (car frame-size-history))
      (setq frame-size-history
	    (cons (1- (car frame-size-history))
876
		  (cons (list frame "MAKE-FRAME")
877
			(cdr frame-size-history)))))
878

879 880
    ;; We can run `window-configuration-change-hook' for this frame now.
    (frame-after-make-frame frame t)
881 882
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
883

884 885
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
886 887
  (let* ((frames (frame-list))
	 (list frames))
888
    (while (consp frames)
889 890
      (unless (funcall predicate (car frames))
	(setcar frames nil))
891
      (setq frames (cdr frames)))
892
    (delq nil list)))
893 894 895 896

(defun minibuffer-frame-list ()
  "Return a list of all frames with their own minibuffers."
  (filtered-frame-list
897 898
   (lambda (frame)
     (eq frame (window-frame (minibuffer-window frame))))))
899

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
;; Used to be called `terminal-id' in termdev.el.
(defun get-device-terminal (device)
  "Return the terminal corresponding to DEVICE.
DEVICE can be a terminal, a frame, nil (meaning the selected frame's terminal),
the name of an X display device (HOST.SERVER.SCREEN) or a tty device file."
  (cond
   ((or (null device) (framep device))
    (frame-terminal device))
   ((stringp device)
    (let ((f (car (filtered-frame-list
                   (lambda (frame)
                     (or (equal (frame-parameter frame 'display) device)
                         (equal (frame-parameter frame 'tty) device)))))))
      (or f (error "Display %s does not exist" device))
      (frame-terminal f)))
   ((terminal-live-p device) device)
   (t
917
    (error "Invalid argument %s in `get-device-terminal'" device))))
918 919 920 921 922 923

(defun frames-on-display-list (&optional device)
  "Return a list of all frames on DEVICE.

DEVICE should be a terminal, a frame,
or a name of an X display or tty (a string of the form
924
HOST:SERVER.SCREEN).
925

926
If DEVICE is omitted or nil, it defaults to the selected
927
frame's terminal device."
928
  (let* ((terminal (get-device-terminal device))
929
	 (func #'(lambda (frame)
930
		   (eq (frame-terminal frame) terminal))))
931 932
    (filtered-frame-list func)))

933 934 935 936 937 938
(defun framep-on-display (&optional terminal)
  "Return the type of frames on TERMINAL.
TERMINAL may be a terminal id, a display name or a frame.  If it
is a frame, its type is returned.  If TERMINAL is omitted or nil,
it defaults to the selected frame's terminal device.  All frames
on a given display are of the same type."
939
  (or (terminal-live-p terminal)
940 941
      (framep terminal)
      (framep (car (frames-on-display-list terminal)))))
942

943 944 945
(defun frame-remove-geometry-params (param-list)
  "Return the parameter list PARAM-LIST, but with geometry specs removed.
This deletes all bindings in PARAM-LIST for `top', `left', `width',
946
`height', `user-size' and `user-position' parameters.
947 948 949 950 951 952
Emacs uses this to avoid overriding explicit moves and resizings from
the user during startup."
  (setq param-list (cons nil param-list))
  (let ((tail param-list))
    (while (consp (cdr tail))
      (if (and (consp (car (cdr tail)))
953 954 955 956 957 958
	       (memq (car (car (cdr tail)))
		     '(height width top left user-position user-size)))
	  (progn
	    (setq frame-initial-geometry-arguments
		  (cons (car (cdr tail)) frame-initial-geometry-arguments))
	    (setcdr tail (cdr (cdr tail))))
959
	(setq tail (cdr tail)))))
960 961
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
962 963
  (cdr param-list))

964
(declare-function x-focus-frame "frame.c" (frame &optional noactivate))
965

966
(defun select-frame-set-input-focus (frame &optional norecord)
967
  "Select FRAME, raise it, and set input focus, if possible.
968
If `mouse-autoselect-window' is non-nil, also move mouse pointer
969
to FRAME's selected window.  Otherwise, if `focus-follows-mouse'
970 971 972 973 974
is non-nil, move mouse cursor to FRAME.

Optional argument NORECORD means to neither change the order of
recently selected windows nor the buffer list."
  (select-frame frame norecord)
975
  (raise-frame frame)
976
  ;; Ensure, if possible, that FRAME gets input focus.
977
  (when (display-multi-frame-p frame)
978
    (x-focus-frame frame))
979 980 981 982 983 984 985 986 987 988 989
  ;; Move mouse cursor if necessary.
  (cond
   (mouse-autoselect-window
    (let ((edges (window-inside-edges (frame-selected-window frame))))
      ;; Move mouse cursor into FRAME's selected window to avoid that
      ;; Emacs mouse-autoselects another window.
      (set-mouse-position frame (nth 2 edges) (nth 1 edges))))
   (focus-follows-mouse
    ;; Move mouse cursor into FRAME to avoid that another frame gets
    ;; selected by the window manager.
    (set-mouse-position frame (1- (frame-width frame)) 0))))
990

991
(defun other-frame (arg)
Juanma Barranquero's avatar
Juanma Barranquero committed
992
  "Select the ARGth different visible frame on current display, and raise it.
993 994
All frames are arranged in a cyclic order.
This command selects the frame ARG steps away in that order.
Richard M. Stallman's avatar
Richard M. Stallman committed
995 996
A negative ARG moves in the opposite order.

997 998 999 1000 1001
To make this command work properly, you must tell Emacs how the
system (or the window manager) generally handles focus-switching
between windows.  If moving the mouse onto a window selects
it (gives it focus), set `focus-follows-mouse' to t.  Otherwise,
that variable should be nil."
1002
  (interactive "p")
1003 1004
  (let ((sframe (selected-frame))
        (frame (selected-frame)))
1005
    (while (> arg 0)
1006
      (setq frame (next-frame frame))
1007 1008
      (while (and (not (eq frame sframe))
                  (not (eq (frame-visible-p frame) t)))
1009 1010
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
1011
    (while (< arg 0)
1012
      (setq frame (previous-frame frame))
1013 1014
      (while (and (not (eq frame sframe))
                  (not (eq (frame-visible-p frame) t)))
1015
	(setq frame (previous-frame frame)))
1016
      (setq arg (1+ arg)))
1017
    (select-frame-set-input-focus frame)))
1018

1019 1020 1021 1022 1023 1024 1025
(defun iconify-or-deiconify-frame ()
  "Iconify the selected frame, or deiconify if it's currently an icon."
  (interactive)
  (if (eq (cdr (assq 'visibility (frame-parameters))) t)
      (iconify-frame)
    (make-frame-visible)))

1026 1027
(defun suspend-frame ()
  "Do whatever is right to suspend the current frame.
1028 1029
Calls `suspend-emacs' if invoked from the controlling tty device,
`suspend-tty' from a secondary tty device, and
1030
`iconify-or-deiconify-frame' from a graphical frame."
1031
  (interactive)
1032 1033 1034 1035 1036 1037 1038
  (cond
   ((display-multi-frame-p) (iconify-or-deiconify-frame))
   ((eq (framep (selected-frame)) t)
    (if (controlling-tty-p)
        (suspend-emacs)
      (suspend-tty)))
   (t (suspend-emacs))))
1039

1040
(defun make-frame-names-alist ()
1041
  ;; Only consider the frames on the same display.
1042 1043 1044 1045
  (let* ((current-frame (selected-frame))
	 (falist
	  (cons
	   (cons (frame-parameter current-frame 'name) current-frame) nil))
1046
	 (frame (next-frame nil 0)))
1047 1048
    (while (not (eq frame current-frame))
      (progn
1049 1050
	(push (cons (frame-parameter frame 'name) frame) falist)
	(setq frame (next-frame frame 0))))
1051 1052 1053 1054
    falist))

(defvar frame-name-history nil)
(defun select-frame-by-name (name)
1055 1056
  "Select the frame whose name is NAME and raise it.
Frames on the current terminal are checked first.
1057 1058
If there is no frame by that name, signal an error."
  (interactive
1059 1060 1061 1062 1063
   (let* ((frame-names-alist (make-frame-names-alist))
	   (default (car (car frame-names-alist)))
	   (input (completing-read
		   (format "Select Frame (default %s): " default)
		   frame-names-alist nil t nil 'frame-name-history)))
1064 1065 1066
     (if (= (length input) 0)
	 (list default)
       (list input))))
1067