frame.el 56.6 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, 2003, 2004, 2005
4
;;   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
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Erik Naggum's avatar
Erik Naggum committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
25

26 27
;;; Commentary:

Eric S. Raymond's avatar
Eric S. Raymond committed
28 29
;;; Code:

30 31 32 33 34 35 36 37 38 39 40
(defvar frame-creation-function-alist
  (list (cons nil
	      (if (fboundp 'tty-create-frame-with-faces)
		  'tty-create-frame-with-faces
		(function
		 (lambda (parameters)
		   (error "Can't create multiple frames without a window system"))))))
  "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.")
41

42 43 44 45 46 47 48 49 50 51 52
(defvar window-system-default-frame-alist nil
  "Alist of window-system dependent default frame parameters.
These may be set in your init file, like this:

    ;; Disable menubar and toolbar on the console, but enable them under X.
    (setq window-system-default-frame-alist
          '((x (menu-bar-lines . 1) (tool-bar-lines . 1))
            (nil (menu-bar-lines . 0) (tool-bar-lines . 0))))

Also see `default-frame-alist'.")

53 54 55
;; 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.
56
(defcustom initial-frame-alist nil
57
  "*Alist of frame parameters for creating the initial X window frame.
58
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
59
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
60 61 62 63
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, one is created according to
64
`minibuffer-frame-alist'.
65 66 67

You can specify geometry-related options for just the initial frame
by setting this variable in your `.emacs' file; however, they won't
Karl Heuer's avatar
Karl Heuer committed
68
take effect until Emacs reads `.emacs', which happens after first creating
69 70 71 72 73 74
the frame.  If you want the frame to have the proper geometry as soon
as it appears, you need to use this three-step process:
* 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,
75 76 77 78 79
  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
80

81 82
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  "*Alist of frame parameters for initially creating a minibuffer frame.
83
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
84
 (setq minibuffer-frame-alist
85
   '((top . 1) (left . 1) (width . 80) (height . 2)))
86
Parameters specified here supersede the values given in
87 88 89 90 91
`default-frame-alist', for a minibuffer frame."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
92

93 94
(defcustom pop-up-frame-alist nil
  "*Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
95
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
96
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
97
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
98 99 100 101 102 103
These supersede the values given in `default-frame-alist',
for pop-up frames."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
104

Jim Blandy's avatar
Jim Blandy committed
105
(setq pop-up-frame-function
106 107 108
      ;; Using `function' here caused some sort of problem.
      '(lambda ()
	 (make-frame pop-up-frame-alist)))
Jim Blandy's avatar
Jim Blandy committed
109

Richard M. Stallman's avatar
Richard M. Stallman committed
110
(defcustom special-display-frame-alist
111 112 113 114 115 116 117
  '((height . 14) (width . 80) (unsplittable . t))
  "*Alist of frame parameters used when creating special frames.
Special frames are used for buffers whose names are in
`special-display-buffer-names' and for buffers whose names match
one of the regular expressions in `special-display-regexps'.
This variable can be set in your init file, like this:
  (setq special-display-frame-alist '((width . 80) (height . 20)))
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119 120 121 122
These supersede the values given in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
			 (symbol :tag "Parameter")
			 (sexp :tag "Value")))
  :group 'frames)
123

124
(defun special-display-popup-frame (buffer &optional args)
125 126 127 128 129 130 131
  "Display BUFFER in its own frame, reusing an existing window if any.
Return the window chosen.
Currently we do not insist on selecting the window within its frame.
If ARGS is an alist, use it as a list of frame parameter specs.
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 arg, and (cdr ARGS) gives the rest of the args."
132 133
  (if (and args (symbolp (car args)))
      (apply (car args) buffer (cdr args))
134
    (let ((window (get-buffer-window buffer 0)))
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
      (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)))
	 (let* ((pop-up-frames nil) (pop-up-windows t)
		special-display-regexps special-display-buffer-names
		(window (display-buffer buffer)))
152
	   ;; Only do it if this is a new window:
153 154 155
	   ;; (set-window-dedicated-p window t)
	   window))
       ;; If no window yet, make one in a new frame.
156
       (let ((frame
157 158
	      (with-current-buffer buffer
		(make-frame (append args special-display-frame-alist)))))
159 160 161
	 (set-window-buffer (frame-selected-window frame) buffer)
	 (set-window-dedicated-p (frame-selected-window frame) t)
	 (frame-selected-window frame))))))
162

163
(defun handle-delete-frame (event)
164
  "Handle delete-frame events from the X server."
165 166 167 168 169 170 171 172 173 174 175
  (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)
176 177
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
178

Jim Blandy's avatar
Jim Blandy committed
179
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
180

181 182 183 184 185 186 187 188
;; 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
189

Karl Heuer's avatar
Karl Heuer committed
190
;; These are now called explicitly at the proper times,
191 192 193 194
;; 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
195

196
;; If we create the initial frame, this is it.
Jim Blandy's avatar
Jim Blandy committed
197
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
198

199 200 201
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

202 203
(defvar frame-initial-geometry-arguments nil)

204 205 206
;; 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
207
(defun frame-initialize ()
Eli Zaretskii's avatar
Eli Zaretskii committed
208
  "Create an initial frame if necessary."
Jim Blandy's avatar
Jim Blandy committed
209
  ;; Are we actually running under a window system at all?
210 211 212
  (if (and initial-window-system
	   (not noninteractive)
	   (not (eq initial-window-system 'pc)))
213
      (progn
214 215 216
	;; Turn on special-display processing only if there's a window system.
	(setq special-display-function 'special-display-popup-frame)

217 218 219 220 221
	;; 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))
222
	    (progn
223
	      (setq frame-initial-frame-alist
224
		    (append initial-frame-alist default-frame-alist nil))
225 226 227 228
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
229 230 231
	      (setq frame-initial-frame-alist
		    (cons (cons 'window-system initial-window-system)
			  frame-initial-frame-alist))
232 233
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
234
			  (make-frame frame-initial-frame-alist)))
235 236 237 238
	      ;; 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.
239
	      (setq initial-frame-alist
240
		    (frame-remove-geometry-params initial-frame-alist))))
Karl Heuer's avatar
Karl Heuer committed
241
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
242 243
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
244
	(setq terminal-frame nil))))
Karl Heuer's avatar
Karl Heuer committed
245

246 247 248
(defvar frame-notice-user-settings t
  "Non-nil means function `frame-notice-user-settings' wasn't run yet.")

249 250 251
;; 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
252
(defun frame-notice-user-settings ()
253 254
  "Act on user's init file settings of frame parameters.
React to settings of `default-frame-alist', `initial-frame-alist' there."
255
  ;; Make menu-bar-mode and default-frame-alist consistent.
256 257 258 259 260 261 262
  (when (boundp 'menu-bar-mode)
    (let ((default (assq 'menu-bar-lines default-frame-alist)))
      (if default
	  (setq menu-bar-mode (not (eq (cdr default) 0)))
	(setq default-frame-alist
	      (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
		    default-frame-alist)))))
Sam Steingold's avatar
Sam Steingold committed
263

264 265 266
  ;; Make tool-bar-mode and default-frame-alist consistent.  Don't do
  ;; it in batch mode since that would leave a tool-bar-lines
  ;; parameter in default-frame-alist in a dumped Emacs, which is not
267
  ;; what we want.
268 269
  (when (and (boundp 'tool-bar-mode)
	     (not noninteractive))
270 271 272 273 274 275
    (let ((default (assq 'tool-bar-lines default-frame-alist)))
      (if default
	  (setq tool-bar-mode (not (eq (cdr default) 0)))
	(setq default-frame-alist
	      (cons (cons 'tool-bar-lines (if tool-bar-mode 1 0))
		    default-frame-alist)))))
276

277 278 279 280 281 282 283
  ;; 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.
  (let ((old-buffer (current-buffer)))

284 285
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
286 287
      ;; This case happens when we don't have a window system, and
      ;; also for MS-DOS frames.
288 289 290 291 292 293
      (let ((parms (frame-parameters frame-initial-frame)))
	;; 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))
	(modify-frame-parameters nil
294
				 (if (null initial-window-system)
295 296 297 298 299 300 301 302
				     (append initial-frame-alist
					     default-frame-alist
					     parms
					     nil)
				   ;; initial-frame-alist and
				   ;; default-frame-alist were already
				   ;; applied in pc-win.el.
				   parms))
303
	(if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
304 305 306 307 308 309 310 311 312 313 314
	    (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))))))
315

316 317
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
318 319 320 321 322
    (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.
323 324 325
      (when (display-graphic-p)
	(let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
				  (assq 'tool-bar-lines default-frame-alist))))
326 327 328 329
	  (when (and tool-bar-originally-present
                     (or (null tool-bar-lines)
                         (null (cdr tool-bar-lines))
                         (eq 0 (cdr tool-bar-lines))))
330
	    (let* ((char-height (frame-char-height frame-initial-frame))
331
		   (image-height tool-bar-images-pixel-height)
332 333 334 335 336 337 338 339 340 341 342
		   (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
343
		   (lines (/ (+ image-height
344 345 346 347 348 349
				(* 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
350
		   (initial-top (cdr (assq 'top
351 352 353
					   frame-initial-geometry-arguments)))
		   (top (frame-parameter frame-initial-frame 'top)))
	      (when (and (consp initial-top) (eq '- (car initial-top)))
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
		(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))))
370 371
	      (modify-frame-parameters frame-initial-frame newparms)
	      (tool-bar-mode -1)))))
372 373 374 375 376 377 378 379 380 381 382 383

      ;; 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.
384 385 386 387 388 389 390 391 392 393 394 395 396 397
      (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			    (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))
398

Sam Steingold's avatar
Sam Steingold committed
399
            ;; Get rid of `name' unless it was specified explicitly before.
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 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 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))

	    (setq parms (append initial-frame-alist
				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
		    (function (lambda (frame)
				(and (not (eq frame frame-initial-frame))
				     (eq (window-frame
					  (minibuffer-window frame))
					 frame-initial-frame)))))))
	      (if (or users-of-initial
		      (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
				(function
				 (lambda (frame)
				   (eq (cdr (assq 'minibuffer
						  (frame-parameters frame)))
				       'only))))
			       (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.
		    (mapcar
		     (function
		      (lambda (frame)
			(modify-frame-parameters
			 frame (list (cons 'minibuffer new-minibuffer)))))
		     users-of-initial))))

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

	;; Otherwise, we don't need all that rigamarole; just apply
	;; the new parameters.
	(let (newparms allparms tail)
	  (setq allparms (append initial-frame-alist
				 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
495
          ;; the init file.  For those parms whose values we already knew
496 497
	  ;; (such as those spec'd by command line options)
	  ;; it is undesirable to specify the parm again
Sam Steingold's avatar
Sam Steingold committed
498
          ;; once the user has seen the frame and been able to alter it
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
	  ;; manually.
	  (while tail
	    (let (newval oldval)
	      (setq oldval (assq (car (car tail))
				 frame-initial-frame-alist))
	      (setq newval (cdr (assq (car (car tail)) allparms)))
	      (or (and oldval (eq (cdr oldval) newval))
		  (setq newparms
			(cons (cons (car (car tail)) newval) newparms))))
	    (setq tail (cdr tail)))
	  (setq newparms (nreverse newparms))
	  (modify-frame-parameters frame-initial-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 (assq 'background-mode newparms)
	      (frame-set-background-mode frame-initial-frame))
	    (face-set-after-frame-default frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
519

520 521 522 523
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

528 529 530 531 532 533
(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))))

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

536
(defun modify-all-frames-parameters (alist)
537
  "Modify all current and future frames' parameters according to ALIST.
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
This changes `default-frame-alist' and possibly `initial-frame-alist'.
See help of `modify-frame-parameters' for more information."
  (let (element)			;; temp
    (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 element (assoc (car pair) initial-frame-alist))
	   (setq initial-frame-alist (delq element initial-frame-alist)))
      (and (setq element (assoc (car pair) default-frame-alist))
	   (setq default-frame-alist (delq element default-frame-alist)))))
  (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
556
(defun get-other-frame ()
557 558 559
  "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
560
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
561
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
562
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
563 564
    s))

Jim Blandy's avatar
Jim Blandy committed
565 566
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
567 568 569
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
570
			      0))
571
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
572

Jim Blandy's avatar
Jim Blandy committed
573 574
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
575 576 577
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
578
				  0))
579
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
580

581
(defun make-frame-on-display (display &optional parameters)
582
  "Make a frame on X display DISPLAY.
583 584
The optional second argument PARAMETERS specifies additional frame parameters."
  (interactive "sMake frame on display: ")
585 586
  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
587
  (when (and (boundp 'x-initialized) (not x-initialized))
588 589
    (setq x-display-name display)
    (x-initialize-window-system))
590
  (make-frame `((window-system . x) (display . ,display) . ,parameters)))
591

592 593
(defun make-frame-on-tty (device type &optional parameters)
  "Make a frame on terminal DEVICE which is of type TYPE (e.g., \"xterm\").
594
The optional third argument PARAMETERS specifies additional frame parameters."
595
  (interactive "fOpen frame on tty device: \nsTerminal type of %s: ")
596 597 598 599
  (unless device
    (error "Invalid terminal device"))
  (unless type
    (error "Invalid terminal type"))
600
  (make-frame `((window-system . nil) (tty . ,device) (tty-type . ,type) . ,parameters)))
601

602 603 604
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
605
  (if (and window-system (not (eq window-system 'pc)))
606 607 608
      (make-frame)
    (select-frame (make-frame))))

609 610 611 612 613 614 615
(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.")

616
(defvar after-setting-font-hook nil
617 618
  "Functions to run after a frame's font has been changed.")

619
;; Alias, kept temporarily.
620
(defalias 'new-frame 'make-frame)
621
(make-obsolete 'new-frame 'make-frame "22.1")
Jim Blandy's avatar
Jim Blandy committed
622

623 624 625 626
(defun make-frame (&optional parameters)
  "Return a newly created frame displaying the current buffer.
Optional argument PARAMETERS is an alist of 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
627

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

630 631
 (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
632

633
You cannot specify either `width' or `height', you must use neither or both.
Jim Blandy's avatar
Jim Blandy committed
634

635 636 637 638
 (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
639

640 641 642
 (window-system . nil)	The frame should be displayed on a terminal device.
 (window-system . x)	The frame should be displayed in an X window.

643
 (device . ID)          The frame should use the display device identified by ID.
644

645
Before the frame is created (via `frame-creation-function-alist'), functions on the
646
hook `before-make-frame-hook' are run.  After the frame is created, functions
Luc Teirlinck's avatar
Luc Teirlinck committed
647 648 649 650 651 652 653
on `after-make-frame-functions' are run with one arg, the newly created frame.

This function itself does not make the new frame the selected frame.
The previously selected frame remains selected.  However, the
window system may select the new frame for its own reasons, for
instance if the frame appears under the mouse pointer and your
setup is for focus to follow the pointer."
Jim Blandy's avatar
Jim Blandy committed
654
  (interactive)
655
  (let* ((w (cond
656 657
	     ((assq 'device parameters)
	      (let ((type (display-live-p (cdr (assq 'device parameters)))))
658 659
		(cond
		 ((eq type t) nil)
660
		 ((eq type nil) (error "Display %s does not exist" (cdr (assq 'device parameters))))
661 662 663 664
		 (t type))))
	     ((assq 'window-system parameters)
	      (cdr (assq 'window-system parameters)))
	     (t window-system)))
665 666 667 668 669
	 (frame-creation-function (cdr (assq w frame-creation-function-alist)))
	 frame)
    (unless frame-creation-function
      (error "Don't know how to create a frame on window system %s" w))
    (run-hooks 'before-make-frame-hook)
670
    (setq frame (funcall frame-creation-function parameters))
671 672
    (modify-frame-parameters frame
			     (cdr (assq w window-system-default-frame-alist)))
673 674
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
675

676 677
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
678 679
  (let* ((frames (frame-list))
	 (list frames))
680
    (while (consp frames)
681 682
      (unless (funcall predicate (car frames))
	(setcar frames nil))
683
      (setq frames (cdr frames)))
684
    (delq nil list)))
685 686 687 688 689 690 691

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

692 693
(defun frames-on-display-list (&optional display)
  "Return a list of all frames on DISPLAY.
694 695 696 697

DISPLAY should be a display identifier (an integer), but it may
also be a name of a display, a string of the form HOST:SERVER.SCREEN.

698
If DISPLAY is omitted or nil, it defaults to the selected frame's display."
699
  (let* ((display (or display (frame-display)))
700
	 (func #'(lambda (frame)
701 702
		   (or (eq (frame-display frame) display)
		       (equal (frame-parameter frame 'display) display)))))
703 704 705 706
    (filtered-frame-list func)))

(defun framep-on-display (&optional display)
  "Return the type of frames on DISPLAY.
707 708
DISPLAY may be a display id, a display name or a frame.  If it is
a frame, its type is returned.
709 710
If DISPLAY is omitted or nil, it defaults to the selected frame's display.
All frames on a given display are of the same type."
711 712
  (or (display-live-p display)
      (framep display)
713 714
      (framep (car (frames-on-display-list display)))))

715 716 717
(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',
718
`height', `user-size' and `user-position' parameters.
719 720 721 722 723 724
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)))
725 726 727 728 729 730
	       (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))))
731
	(setq tail (cdr tail)))))
732 733
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
734 735
  (cdr param-list))

736
(defcustom focus-follows-mouse t
737 738 739 740
  "*Non-nil if window system changes focus when you move the mouse.
You should set this variable to tell Emacs how your window manager
handles focus, since there is no way in general for Emacs to find out
automatically."
741
  :type 'boolean
Dan Nicolaescu's avatar
Dan Nicolaescu committed
742 743
  :group 'frames
  :version "20.3")
744

745 746 747 748 749
(defun select-frame-set-input-focus (frame)
  "Select FRAME, raise it, and set input focus, if possible."
    (select-frame frame)
    (raise-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
750
    (cond ((eq (window-system frame) 'x)
751
	   (x-focus-frame frame))
752
	  ((eq (window-system frame) 'w32)
753
	   (w32-focus-frame frame)))
754
    (cond (focus-follows-mouse
755
	   (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
756

757
(defun other-frame (arg)
758
  "Select the ARG'th different visible frame on current display, and raise it.
759 760
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
761 762 763 764 765 766 767
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."
768 769 770
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
771 772 773 774
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
775
    (while (< arg 0)
776 777 778
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
779
      (setq arg (1+ arg)))
780
    (select-frame-set-input-focus frame)))
781

782 783 784 785 786 787 788
(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)))

789 790 791 792 793 794 795 796 797 798
(defun suspend-frame ()
  "Do whatever is right to suspend the current frame.
Calls `suspend-emacs' if invoked from the controlling terminal,
`suspend-tty' from a secondary terminal, and
`iconify-or-deiconify-frame' from an X frame."
  (interactive)
  (let ((type (framep (selected-frame))))
    (cond
     ((eq type 'x) (iconify-or-deiconify-frame))
     ((eq type t)
799 800 801
      (if (display-controlling-tty-p)
	  (suspend-emacs)
	(suspend-tty)))
802 803 804
     (t (suspend-emacs)))))


805 806 807 808 809 810 811 812 813 814 815 816 817 818
(defun make-frame-names-alist ()
  (let* ((current-frame (selected-frame))
	 (falist
	  (cons
	   (cons (frame-parameter current-frame 'name) current-frame) nil))
	 (frame (next-frame nil t)))
    (while (not (eq frame current-frame))
      (progn
	(setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
	(setq frame (next-frame frame t))))
    falist))

(defvar frame-name-history nil)
(defun select-frame-by-name (name)
819
  "Select the frame on the current terminal whose name is NAME and raise it.
820 821
If there is no frame by that name, signal an error."
  (interactive
822 823 824 825 826
   (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)))
827 828 829
     (if (= (length input) 0)
	 (list default)
       (list input))))
830 831
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
832 833 834 835
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
836 837
    (select-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
838
    (cond ((eq (window-system frame) 'x)
839
	   (x-focus-frame frame))
840
	  ((eq (window-system frame) 'w32)
841 842 843
	   (w32-focus-frame frame)))
    (when focus-follows-mouse
      (set-mouse-position frame (1- (frame-width frame)) 0))))
Jim Blandy's avatar
Jim Blandy committed
844

Jim Blandy's avatar
Jim Blandy committed
845 846 847 848
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
849 850 851 852 853 854 855 856 857 858 859 860 861
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
	(mapcar (function
		 (lambda (frame)
		   (list frame
			 (frame-parameters frame)
			 (current-window-configuration frame))))
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
862

863
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
864 865
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
866
configuration, and other parameters set as specified in CONFIGURATION.
867 868
However, this function does not restore deleted frames.

869 870
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
871
is given and non-nil, the unwanted frames are iconified instead."
872 873 874 875 876
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
Jim Blandy's avatar
Jim Blandy committed
877
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
878
	     (lambda (frame)
879
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
880 881
		 (if parameters
		     (progn
882 883
		       (modify-frame-parameters
			frame
Karl Heuer's avatar
Karl Heuer committed
884
			;; Since we can't set a frame's minibuffer status,
885 886 887 888 889
			;; we might as well omit the parameter altogether.
			(let* ((parms (nth 1 parameters))
			       (mini (assq 'minibuffer parms)))
			  (if mini (setq parms (delq mini parms)))
			  parms))
Jim Blandy's avatar
Jim Blandy committed
890
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
891 892
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
893
    (if nodelete
894 895 896 897 898
	;; Note: making frames invisible here was tried
	;; but led to some strange behavior--each time the frame
	;; was made visible again, the window manager asked afresh
	;; for where to put it.
	(mapcar 'iconify-frame frames-to-delete)
899
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
900

Jim Blandy's avatar
Jim Blandy committed
901 902
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
903

Jim Blandy's avatar
Jim Blandy committed
904
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
905 906
  "Return number of lines available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
Jim Blandy's avatar
Jim Blandy committed
907
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
908 909 910 911

(defun frame-width (&optional frame)
  "Return number of columns available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
Jim Blandy's avatar
Jim Blandy committed
912
  (cdr (assq 'width (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
913

914
(defalias 'set-default-font 'set-frame-font)
915
(defun set-frame-font (font-name &optional keep-size)
916
  "Set the font of the selected frame to FONT-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
917
When called interactively, prompt for the name of the font to use.
918 919 920 921 922 923
To get the frame's current default font, use `frame-parameters'.

The default behavior is to keep the numbers of lines and columns in
the frame, thus may change its pixel size. If optional KEEP-SIZE is
non-nil (interactively, prefix argument) the current frame size (in
pixels) is kept by adjusting the numbers of the lines and columns."
Sam Steingold's avatar
Sam Steingold committed
924
  (interactive
925 926 927 928 929
   (let* ((completion-ignore-case t)
	  (font (completing-read "Font name: "
			 (mapcar #'list
				 ;; x-list-fonts will fail with an error
				 ;; if this frame doesn't support fonts.
930 931 932
				 (x-list-fonts "*" nil (selected-frame)))
			 nil nil nil nil
			 (frame-parameter nil 'font))))
933 934 935 936 937 938 939 940 941 942 943 944
     (list font current-prefix-arg)))
  (let (fht fwd)
    (if keep-size
	(setq fht (* (frame-parameter nil 'height) (frame-char-height))
	      fwd (* (frame-parameter nil 'width)  (frame-char-width))))
    (modify-frame-parameters (selected-frame)
			     (list (cons 'font font-name)))
    (if keep-size
	(modify-frame-parameters
	 (selected-frame)
	 (list (cons 'height (round fht (frame-char-height)))
	       (cons 'width (round fwd (frame-char-width)))))))
945
  (run-hooks 'after-setting-font-hook 'after-setting-font-hooks))
Jim Blandy's avatar
Jim Blandy committed
946

947 948 949
(defun set-frame-parameter (frame parameter value)
  (modify-frame-parameters frame (list (cons parameter value))))

950
(defun set-background-color (color-name)
951
  "Set the background color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
952 953
When called interactively, prompt for the name of the color to use.
To get the frame's current background color, use `frame-parameters'."
954
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
955
  (modify-frame-parameters (selected-frame)
956 957 958
			   (list (cons 'background-color color-name)))
  (or window-system
      (face-set-after-frame-default (selected-frame))))
Jim Blandy's avatar
Jim Blandy committed
959

960
(defun set-foreground-color (color-name)
961
  "Set the foreground color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
962 963
When called interactively, prompt for the name of the color to use.
To get the frame's current foreground color, use `frame-parameters'."
964
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
965
  (modify-frame-parameters (selected-frame)
966 967 968
			   (list (cons 'foreground-color color-name)))
  (or window-system
      (face-set-after-frame-default (selected-frame))))
Jim Blandy's avatar
Jim Blandy committed
969 970

(defun set-cursor-color (color-name)
971
  "Set the text cursor color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
972 973
When called interactively, prompt for the name of the color to use.
To get the frame's current cursor color, use `frame-parameters'."
974
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
975
  (modify-frame-parameters (selected-frame)
976
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
977

978
(defun set-mouse-color (color-name)
979
  "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
980 981
When called interactively, prompt for the name of the color to use.
To get the frame's current mouse color, use `frame-parameters'."
982
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
983
  (modify-frame-parameters (selected-frame)
984 985 986 987
			   (list (cons 'mouse-color
				       (or color-name
					   (cdr (assq 'mouse-color
						      (frame-parameters))))))))