frame.el 61.4 KB
Newer Older
1
;;; frame.el --- multi-frame management independent of window systems
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2002, 2003,
4
;;   2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
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 <http://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
(eval-when-compile (require 'cl))
Eric S. Raymond's avatar
Eric S. Raymond committed
29

30 31 32 33
(defvar frame-creation-function-alist
  (list (cons nil
	      (if (fboundp 'tty-create-frame-with-faces)
		  'tty-create-frame-with-faces
34 35
                (lambda (parameters)
                  (error "Can't create multiple frames without a window system")))))
36 37 38 39
  "Alist of window-system dependent functions to call to create a new frame.
The window system startup file should add its frame creation
function to this list, which should take an alist of parameters
as its argument.")
40

41 42
(defvar window-system-default-frame-alist nil
  "Alist of window-system dependent default frame parameters.
43 44
Parameters specified here supersede the values given in
`default-frame-alist'.")
45

46 47 48
;; 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
49
(defcustom initial-frame-alist nil
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
  "Alist of parameters for the initial X window frame.
You can set this in your init file; for example,

 (setq initial-frame-alist
       '((top . 1) (left . 1) (width . 80) (height . 55)))

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:
69 70 71 72
* 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,
73 74 75 76 77
  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
78

79
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
80 81 82 83 84 85
  "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.

86 87
You can set this in your init file; for example,

Jim Blandy's avatar
Jim Blandy committed
88
 (setq minibuffer-frame-alist
89 90
       '((top . 1) (left . 1) (width . 80) (height . 2)))

91 92
It is not necessary to include (minibuffer . only); that is
appended when the minibuffer frame is created."
93 94 95 96
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
97

98
(defcustom pop-up-frame-alist nil
99 100 101
  "Alist of parameters for automatically generated new frames.
You can set this in your init file; for example,

Jim Blandy's avatar
Jim Blandy committed
102
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
103 104 105 106 107

If non-nil, the value you specify here is used by the default
`pop-up-frame-function' for the creation of new frames.

Since `pop-up-frame-function' is used by `display-buffer' for
108
making new frames, any value specified here by default affects
109 110 111
the automatic generation of new frames via `display-buffer' and
all functions based on it.  The behavior of `make-frame' is not
affected by this variable."
112 113 114 115
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
116

117 118
(defcustom pop-up-frame-function
  (lambda () (make-frame pop-up-frame-alist))
119 120 121 122
  "Function used by `display-buffer' for creating a new frame.
This function is called with no arguments and should return a new
frame.  The default value calls `make-frame' with the argument
`pop-up-frame-alist'."
123
  :type 'function
124
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
125

Richard M. Stallman's avatar
Richard M. Stallman committed
126
(defcustom special-display-frame-alist
127
  '((height . 14) (width . 80) (unsplittable . t))
128
  "Alist of parameters for special frames.
129
Special frames are used for buffers whose names are listed in
130 131
`special-display-buffer-names' and for buffers whose names match
one of the regular expressions in `special-display-regexps'.
132

133
This variable can be set in your init file, like this:
134

135
  (setq special-display-frame-alist '((width . 80) (height . 20)))
136

Richard M. Stallman's avatar
Richard M. Stallman committed
137 138 139 140 141
These supersede the values given in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
			 (symbol :tag "Parameter")
			 (sexp :tag "Value")))
  :group 'frames)
142

143
(defun special-display-popup-frame (buffer &optional args)
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
  "Display BUFFER and return the window chosen.
If BUFFER is already displayed in a visible or iconified frame,
raise that frame.  Otherwise, display BUFFER in a new frame.

Optional argument ARGS is a list specifying additional
information.

If ARGS is an alist, use it as a list of frame parameters.  If
these parameters contain \(same-window . t), display BUFFER in
the selected window.  If they contain \(same-frame . t), display
BUFFER in a window of the selected frame.

If ARGS is a list whose car is a symbol, use (car ARGS) as a
function to do the work.  Pass it BUFFER as first argument,
and (cdr ARGS) as second."
159 160
  (if (and args (symbolp (car args)))
      (apply (car args) buffer (cdr args))
161
    (let ((window (get-buffer-window buffer 0)))
162 163 164 165 166 167 168 169 170 171 172 173 174 175
      (or
       ;; If we have a window already, make it visible.
       (when window
	 (let ((frame (window-frame window)))
	   (make-frame-visible frame)
	   (raise-frame frame)
	   window))
       ;; Reuse the current window if the user requested it.
       (when (cdr (assq 'same-window args))
	 (condition-case nil
	     (progn (switch-to-buffer buffer) (selected-window))
	   (error nil)))
       ;; Stay on the same frame if requested.
       (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
176 177 178 179
	 (let* ((pop-up-windows t)
		pop-up-frames
		special-display-buffer-names special-display-regexps)
	   (display-buffer buffer)))
180
       ;; If no window yet, make one in a new frame.
181
       (let ((frame
182 183
	      (with-current-buffer buffer
		(make-frame (append args special-display-frame-alist)))))
184 185 186
	 (set-window-buffer (frame-selected-window frame) buffer)
	 (set-window-dedicated-p (frame-selected-window frame) t)
	 (frame-selected-window frame))))))
187

188
(defun handle-delete-frame (event)
189
  "Handle delete-frame events from the X server."
190 191 192 193 194 195 196 197 198 199 200
  (interactive "e")
  (let ((frame (posn-window (event-start event)))
	(i 0)
	(tail (frame-list)))
    (while tail
      (and (frame-visible-p (car tail))
	   (not (eq (car tail) frame))
	  (setq i (1+ i)))
      (setq tail (cdr tail)))
    (if (> i 0)
	(delete-frame frame t)
201 202
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
203

Jim Blandy's avatar
Jim Blandy committed
204
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
205

206 207 208 209 210 211 212 213
;; 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
214

Karl Heuer's avatar
Karl Heuer committed
215
;; These are now called explicitly at the proper times,
216 217 218 219
;; since that is easier to understand.
;; Actually using hooks within Emacs is bad for future maintenance. --rms.
;; (add-hook 'before-init-hook 'frame-initialize)
;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
Jim Blandy's avatar
Jim Blandy committed
220

221
;; If we create the initial frame, this is it.
Jim Blandy's avatar
Jim Blandy committed
222
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
223

224 225 226
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

227 228
(defvar frame-initial-geometry-arguments nil)

229 230 231
;; 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
232
(defun frame-initialize ()
Eli Zaretskii's avatar
Eli Zaretskii committed
233
  "Create an initial frame if necessary."
Jim Blandy's avatar
Jim Blandy committed
234
  ;; Are we actually running under a window system at all?
235 236 237
  (if (and initial-window-system
	   (not noninteractive)
	   (not (eq initial-window-system 'pc)))
238 239 240 241 242 243
      (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))
244
	    (progn
245
	      (setq frame-initial-frame-alist
246
		    (append initial-frame-alist default-frame-alist nil))
247 248 249 250
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
251 252 253
	      (setq frame-initial-frame-alist
		    (cons (cons 'window-system initial-window-system)
			  frame-initial-frame-alist))
254 255
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
256
			  (make-frame frame-initial-frame-alist)))
257 258 259 260
	      ;; 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.
261
	      (setq initial-frame-alist
262
		    (frame-remove-geometry-params initial-frame-alist))))
263 264 265
	;; 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
266
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
267 268
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
269
	(setq terminal-frame nil))))
Karl Heuer's avatar
Karl Heuer committed
270

271 272 273
(defvar frame-notice-user-settings t
  "Non-nil means function `frame-notice-user-settings' wasn't run yet.")

274 275
(declare-function tool-bar-mode "tool-bar" (&optional arg))

276 277 278
;; 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
279
(defun frame-notice-user-settings ()
280
  "Act on user's init file settings of frame parameters.
281 282 283
React to settings of `initial-frame-alist',
`window-system-default-frame-alist' and `default-frame-alist'
there (in decreasing order of priority)."
284 285 286 287 288
  ;; 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.
289
  (let ((old-buffer (current-buffer))
Stefan Monnier's avatar
Stefan Monnier committed
290 291 292
	(window-system-frame-alist
         (cdr (assq initial-window-system
                    window-system-default-frame-alist))))
293

294 295
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
296 297
      ;; This case happens when we don't have a window system, and
      ;; also for MS-DOS frames.
298
      (let ((parms (frame-parameters)))
299 300 301 302
	;; 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))
303 304 305 306 307 308 309 310
	(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)))
311
	(if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
312 313 314 315 316 317 318 319 320 321 322
	    (let ((newparms (frame-parameters))
		  (frame (selected-frame)))
	      (tty-handle-reverse-video frame newparms)
	      ;; 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))
		(face-set-after-frame-default frame))))))
323

324 325
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
326 327 328 329 330
    (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.
331 332
      (when (display-graphic-p)
	(let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
333
				  (assq 'tool-bar-lines window-system-frame-alist)
334
				  (assq 'tool-bar-lines default-frame-alist))))
335 336 337 338
	  (when (and tool-bar-originally-present
                     (or (null tool-bar-lines)
                         (null (cdr tool-bar-lines))
                         (eq 0 (cdr tool-bar-lines))))
339
	    (let* ((char-height (frame-char-height frame-initial-frame))
340
		   (image-height tool-bar-images-pixel-height)
341 342 343 344 345 346 347 348 349 350 351
		   (margin (cond ((and (consp tool-bar-button-margin)
				       (integerp (cdr tool-bar-button-margin))
				       (> tool-bar-button-margin 0))
				  (cdr tool-bar-button-margin))
				 ((and (integerp tool-bar-button-margin)
				       (> tool-bar-button-margin 0))
				  tool-bar-button-margin)
				 (t 0)))
		   (relief (if (and (integerp tool-bar-button-relief)
				    (> tool-bar-button-relief 0))
			       tool-bar-button-relief 3))
Sam Steingold's avatar
Sam Steingold committed
352
		   (lines (/ (+ image-height
353 354 355 356 357 358
				(* 2 margin)
				(* 2 relief)
				(1- char-height))
			     char-height))
		   (height (frame-parameter frame-initial-frame 'height))
		   (newparms (list (cons 'height (- height lines))))
Sam Steingold's avatar
Sam Steingold committed
359
		   (initial-top (cdr (assq 'top
360 361 362
					   frame-initial-geometry-arguments)))
		   (top (frame-parameter frame-initial-frame 'top)))
	      (when (and (consp initial-top) (eq '- (car initial-top)))
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
		(let ((adjusted-top
		       (cond ((and (consp top)
				   (eq '+ (car top)))
			      (list '+
				    (+ (cadr top)
				       (* lines char-height))))
			     ((and (consp top)
				   (eq '- (car top)))
			      (list '-
				    (- (cadr top)
				       (* lines char-height))))
			     (t (+ top (* lines char-height))))))
		  (setq newparms
			(append newparms
				`((top . ,adjusted-top))
				nil))))
379 380
	      (modify-frame-parameters frame-initial-frame newparms)
	      (tool-bar-mode -1)))))
381 382 383 384 385 386 387 388 389 390 391 392

      ;; 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
      ;; .emacs file, will be applied to the existing screen.
393
      (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
394
			    (assq 'minibuffer window-system-frame-alist)
395 396 397 398 399 400 401 402 403 404 405 406 407
			    (assq 'minibuffer default-frame-alist)
			    '(minibuffer . t)))
		   t))
	  ;; Create the new frame.
	  (let (parms new)
	    ;; 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))
408

Sam Steingold's avatar
Sam Steingold committed
409
            ;; Get rid of `name' unless it was specified explicitly before.
410 411
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))
412 413 414
	    ;; 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)))
415 416

	    (setq parms (append initial-frame-alist
417
				window-system-frame-alist
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
				default-frame-alist
				parms
				nil))

	    ;; Get rid of `reverse', because that was handled
	    ;; 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))
		(make-initial-minibuffer-frame nil))

	    ;; 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
453 454 455 456 457 458
                    (lambda (frame)
                      (and (not (eq frame frame-initial-frame))
                           (eq (window-frame
                                (minibuffer-window frame))
                               frame-initial-frame))))))
              (if (or users-of-initial
459 460 461 462 463 464 465
		      (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
466 467 468 469
                                (lambda (frame)
                                  (eq (cdr (assq 'minibuffer
                                                 (frame-parameters frame)))
                                      'only)))
470 471 472 473 474 475 476 477
			       (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.
478 479 480 481 482
		    (dolist (frame users-of-initial)
                      (modify-frame-parameters
                       frame (list (cons 'minibuffer new-minibuffer)))))))

            ;; Redirect events enqueued at this frame to the new frame.
483 484 485 486 487
	    ;; 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))
488 489 490 491 492

	;; Otherwise, we don't need all that rigamarole; just apply
	;; the new parameters.
	(let (newparms allparms tail)
	  (setq allparms (append initial-frame-alist
493
				 window-system-frame-alist
494 495 496 497 498 499 500 501 502 503 504 505
				 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
506
          ;; the init file.  For those parms whose values we already knew
507 508
	  ;; (such as those spec'd by command line options)
	  ;; it is undesirable to specify the parm again
Sam Steingold's avatar
Sam Steingold committed
509
          ;; once the user has seen the frame and been able to alter it
510
	  ;; manually.
511 512 513 514
	  (let (newval oldval)
	    (dolist (entry tail)
	      (setq oldval (assq (car entry) frame-initial-frame-alist))
	      (setq newval (cdr (assq (car entry) allparms)))
515 516
	      (or (and oldval (eq (cdr oldval) newval))
		  (setq newparms
517
			(cons (cons (car entry) newval) newparms)))))
518
	  (setq newparms (nreverse newparms))
519 520 521 522 523 524 525 526 527 528 529 530 531 532

	  (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)))
	    (modify-frame-parameters frame-initial-frame newparms)))))
Jim Blandy's avatar
Jim Blandy committed
533

534 535 536 537
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

542 543 544 545 546 547
(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))))

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

550
(defun modify-all-frames-parameters (alist)
551
  "Modify all current and future frames' parameters according to ALIST.
552
This changes `default-frame-alist' and possibly `initial-frame-alist'.
553 554
Furthermore, this function removes all parameters in ALIST from
`window-system-default-frame-alist'.
555
See help of `modify-frame-parameters' for more information."
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
  (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)))))

572 573 574 575
  (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
576
(defun get-other-frame ()
577 578 579
  "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')."
Jim Blandy's avatar
Jim Blandy committed
580
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
581
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
582
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
583 584
    s))

Jim Blandy's avatar
Jim Blandy committed
585 586
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
587 588 589
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
590
			      0))
591
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
592

Jim Blandy's avatar
Jim Blandy committed
593 594
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
595 596 597
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
598
				  0))
599
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
600

601
(declare-function x-initialize-window-system "term/x-win" ())
602
(declare-function ns-initialize-window-system "term/ns-win" ())
603
(defvar x-display-name)                 ; term/x-win
604

605
(defun make-frame-on-display (display &optional parameters)
606 607
  "Make a frame on display DISPLAY.
The optional argument PARAMETERS specifies additional frame parameters."
608
  (interactive "sMake frame on display: ")
609 610 611 612 613 614 615 616 617 618
  (cond ((featurep 'ns)
	 (when (and (boundp 'ns-initialized) (not ns-initialized))
	   (setq x-display-name display)
	   (ns-initialize-window-system))
	 (make-frame `((window-system . ns)
		       (display . ,display) . ,parameters)))
	((eq system-type 'windows-nt)
	 ;; On Windows, ignore DISPLAY.
	 (make-frame parameters))
	(t
619
	 (unless (string-match-p "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
620 621 622 623 624 625
	   (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
	 (when (and (boundp 'x-initialized) (not x-initialized))
	   (setq x-display-name display)
	   (x-initialize-window-system))
	 (make-frame `((window-system . x)
		       (display . ,display) . ,parameters)))))
626

627 628
(declare-function x-close-connection "xfns.c" (terminal))

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
(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))))

659
(defun make-frame-command ()
660 661 662
  "Make a new frame, on the same terminal as the selected frame.
If the terminal is a text-only terminal, this also selects the
new frame."
663
  (interactive)
664
  (if (display-graphic-p)
665 666 667
      (make-frame)
    (select-frame (make-frame))))

668 669 670 671 672 673 674
(defvar before-make-frame-hook nil
  "Functions to run before a frame is created.")

(defvar after-make-frame-functions nil
  "Functions to run after a frame is created.
The functions are run with one arg, the newly created frame.")

675
(defvar after-setting-font-hook nil
676 677
  "Functions to run after a frame's font has been changed.")

678
;; Alias, kept temporarily.
679
(define-obsolete-function-alias 'new-frame 'make-frame "22.1")
Jim Blandy's avatar
Jim Blandy committed
680

681
(defvar frame-inherited-parameters '()
682 683 684
  ;; FIXME: Shouldn't we add `font' here as well?
  "Parameters `make-frame' copies from the `selected-frame' to the new frame.")

685 686
(defun make-frame (&optional parameters)
  "Return a newly created frame displaying the current buffer.
687 688 689
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
690

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

693 694
 (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
695

696 697
You cannot specify either `width' or `height', you must specify
neither or both.
Jim Blandy's avatar
Jim Blandy committed
698

699 700 701 702
 (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
703

704 705 706
 (window-system . nil)	The frame should be displayed on a terminal device.
 (window-system . x)	The frame should be displayed in an X window.

707
 (terminal . TERMINAL)  The frame should use the terminal object TERMINAL.
708

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

712 713 714 715 716 717 718 719
Before creating the frame (via `frame-creation-function-alist'),
this function runs the hook `before-make-frame-hook'.  After
creating the frame, it runs the hook `after-make-frame-functions'
with one arg, the newly created frame.

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
720
  (interactive)
721
  (let* ((w (cond
722 723
	     ((assq 'terminal parameters)
	      (let ((type (terminal-live-p (cdr (assq 'terminal parameters)))))
724 725
		(cond
		 ((eq type t) nil)
Stefan Monnier's avatar
Stefan Monnier committed
726 727
		 ((eq type nil) (error "Terminal %s does not exist"
                                       (cdr (assq 'terminal parameters))))
728 729 730 731
		 (t type))))
	     ((assq 'window-system parameters)
	      (cdr (assq 'window-system parameters)))
	     (t window-system)))
732
	 (frame-creation-function (cdr (assq w frame-creation-function-alist)))
733
	 (oldframe (selected-frame))
734
	 (params parameters)
735 736 737
	 frame)
    (unless frame-creation-function
      (error "Don't know how to create a frame on window system %s" w))
738 739
    ;; Add parameters from `window-system-default-frame-alist'.
    (dolist (p (cdr (assq w window-system-default-frame-alist)))
740
      (unless (assq (car p) params)
741 742 743
	(push p params)))
    ;; Add parameters from `default-frame-alist'.
    (dolist (p default-frame-alist)
744
      (unless (assq (car p) params)
745 746
	(push p params)))
    ;; Now make the frame.
747
    (run-hooks 'before-make-frame-hook)
748
    (setq frame (funcall frame-creation-function params))
749
    (normal-erase-is-backspace-setup-frame frame)
750 751 752 753 754
    ;; Inherit the original frame's parameters.
    (dolist (param frame-inherited-parameters)
      (unless (assq param parameters)   ;Overridden by explicit parameters.
        (let ((val (frame-parameter oldframe param)))
          (when val (set-frame-parameter frame param val)))))
755 756
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
757

758 759
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
760 761
  (let* ((frames (frame-list))
	 (list frames))
762
    (while (consp frames)
763 764
      (unless (funcall predicate (car frames))
	(setcar frames nil))
765
      (setq frames (cdr frames)))
766
    (delq nil list)))
767 768 769 770

(defun minibuffer-frame-list ()
  "Return a list of all frames with their own minibuffers."
  (filtered-frame-list
771 772
   (lambda (frame)
     (eq frame (window-frame (minibuffer-window frame))))))
773

774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
;; 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
    (error "Invalid argument %s in `get-device-terminal'" device))))

(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
798
HOST:SERVER.SCREEN).
799

800
If DEVICE is omitted or nil, it defaults to the selected
801
frame's terminal device."
802
  (let* ((terminal (get-device-terminal device))
803
	 (func #'(lambda (frame)
804
		   (eq (frame-terminal frame) terminal))))
805 806
    (filtered-frame-list func)))

807 808 809 810 811 812
(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."
813
  (or (terminal-live-p terminal)
814 815
      (framep terminal)
      (framep (car (frames-on-display-list terminal)))))
816

817 818 819
(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',
820
`height', `user-size' and `user-position' parameters.
821 822 823 824 825 826
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)))
827 828 829 830 831 832
	       (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))))
833
	(setq tail (cdr tail)))))
834 835
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
836 837
  (cdr param-list))

838 839
(declare-function x-focus-frame "xfns.c" (frame))

840
(defun select-frame-set-input-focus (frame)
841
  "Select FRAME, raise it, and set input focus, if possible.
842
If `mouse-autoselect-window' is non-nil, also move mouse pointer
843 844
to FRAME's selected window.  Otherwise, if `focus-follows-mouse'
is non-nil, move mouse cursor to FRAME."
845 846
  (select-frame frame)
  (raise-frame frame)
847
  ;; Ensure, if possible, that FRAME gets input focus.
848 849
  (when (memq (window-system frame) '(x w32 ns))
    (x-focus-frame frame))
850 851 852 853 854 855 856 857 858 859 860
  ;; 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))))
861

862
(defun other-frame (arg)
Juanma Barranquero's avatar
Juanma Barranquero committed
863
  "Select the ARGth different visible frame on current display, and raise it.
864 865
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
866 867 868 869 870 871 872
A negative ARG moves in the opposite order.

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."
873 874 875
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
876 877 878 879
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
880
    (while (< arg 0)
881 882 883
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
884
      (setq arg (1+ arg)))
885
    (select-frame-set-input-focus frame)))
886

887 888 889 890 891 892 893
(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)))

894 895
(defun suspend-frame ()
  "Do whatever is right to suspend the current frame.
896 897
Calls `suspend-emacs' if invoked from the controlling tty device,
`suspend-tty' from a secondary tty device, and
898 899 900 901
`iconify-or-deiconify-frame' from an X frame."
  (interactive)
  (let ((type (framep (selected-frame))))
    (cond
902
     ((memq type '(x ns w32)) (iconify-or-deiconify-frame))
903
     ((eq type t)
904
      (if (controlling-tty-p)
905 906
	  (suspend-emacs)
	(suspend-tty)))
907 908
     (t (suspend-emacs)))))

909
(defun make-frame-names-alist ()
910
  ;; Only consider the frames on the same display.
911 912 913 914
  (let* ((current-frame (selected-frame))
	 (falist
	  (cons
	   (cons (frame-parameter current-frame 'name) current-frame) nil))
915
	 (frame (next-frame nil 0)))
916 917
    (while (not (eq frame current-frame))
      (progn
918 919
	(push (cons (frame-parameter frame 'name) frame) falist)
	(setq frame (next-frame frame 0))))
920 921 922 923
    falist))

(defvar frame-name-history nil)
(defun select-frame-by-name (name)
924
  "Select the frame on the current terminal whose name is NAME and raise it.
925 926
If there is no frame by that name, signal an error."
  (interactive
927 928 929 930 931
   (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)))
932 933 934
     (if (= (length input) 0)
	 (list default)
       (list input))))
935 936
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
937 938 939
    (if frame
	(select-frame-set-input-focus frame)
      (error "There is no frame named `%s'" name))))
Jim Blandy's avatar
Jim Blandy committed
940

Jim Blandy's avatar
Jim Blandy committed
941 942 943 944
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
945 946 947 948 949 950 951
Its car is `frame-configuration'.
Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
where
  FRAME is a frame object,
  ALIST is an association list specifying some of FRAME's parameters, and
  WINDOW-CONFIG is a window configuration object for FRAME."
  (cons 'frame-configuration
952 953 954 955
	(mapcar (lambda (frame)
                  (list frame
                        (frame-parameters frame)
                        (current-window-configuration frame)))
956
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
957

958
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
959 960
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
961
configuration, and other parameters set as specified in CONFIGURATION.
962 963
However, this function does not restore deleted frames.

964 965
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
966
is given and non-nil, the unwanted frames are iconified instead."
967 968 969 970 971
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
972 973 974 975 976 977 978 979 980