frame.el 63.7 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,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007, 2008 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
;; This file is part of GNU Emacs.

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

;; 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
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
23

24 25
;;; Commentary:

Eric S. Raymond's avatar
Eric S. Raymond committed
26 27
;;; Code:

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

39 40
(defvar window-system-default-frame-alist nil
  "Alist of window-system dependent default frame parameters.
41
You can set this in your `.emacs' file; for example,
42 43 44 45 46 47

    ;; 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))))

48
Parameters specified here supersede the values given in `default-frame-alist'.")
49

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

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
65
take effect until Emacs reads `.emacs', which happens after first creating
66 67 68 69 70 71
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,
72 73 74 75 76
  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
77

78 79
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  "*Alist of frame parameters for initially creating a minibuffer frame.
80
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
81
 (setq minibuffer-frame-alist
82
   '((top . 1) (left . 1) (width . 80) (height . 2)))
83
Parameters specified here supersede the values given in
84 85 86 87 88
`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
89

90 91
(defcustom pop-up-frame-alist nil
  "*Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
92
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
93
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
94
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
95 96 97 98 99 100
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
101

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

Richard M. Stallman's avatar
Richard M. Stallman committed
107
(defcustom special-display-frame-alist
108 109 110 111 112 113 114
  '((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
115 116 117 118 119
These supersede the values given in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
			 (symbol :tag "Parameter")
			 (sexp :tag "Value")))
  :group 'frames)
120

121
(defun special-display-popup-frame (buffer &optional args)
122 123 124 125 126 127 128
  "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."
129 130
  (if (and args (symbolp (car args)))
      (apply (car args) buffer (cdr args))
131
    (let ((window (get-buffer-window buffer 0)))
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
      (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)))
149
	   ;; Only do it if this is a new window:
150 151 152
	   ;; (set-window-dedicated-p window t)
	   window))
       ;; If no window yet, make one in a new frame.
153
       (let ((frame
154 155
	      (with-current-buffer buffer
		(make-frame (append args special-display-frame-alist)))))
156 157 158
	 (set-window-buffer (frame-selected-window frame) buffer)
	 (set-window-dedicated-p (frame-selected-window frame) t)
	 (frame-selected-window frame))))))
159

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

178 179 180 181 182 183 184 185
;; 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
186

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

193
;; If we create the initial frame, this is it.
Jim Blandy's avatar
Jim Blandy committed
194
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
195

196 197 198
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

199 200
(defvar frame-initial-geometry-arguments nil)

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

214 215 216 217 218
	;; 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))
219
	    (progn
220
	      (setq frame-initial-frame-alist
221
		    (append initial-frame-alist default-frame-alist nil))
222 223 224 225
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
226 227 228
	      (setq frame-initial-frame-alist
		    (cons (cons 'window-system initial-window-system)
			  frame-initial-frame-alist))
229 230
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
231
			  (make-frame frame-initial-frame-alist)))
232 233 234 235
	      ;; 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.
236
	      (setq initial-frame-alist
237
		    (frame-remove-geometry-params initial-frame-alist))))
238 239 240
	;; 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
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
(declare-function tool-bar-mode "tool-bar" (&optional arg))

251 252 253
;; 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
254
(defun frame-notice-user-settings ()
255
  "Act on user's init file settings of frame parameters.
256 257 258
React to settings of `initial-frame-alist',
`window-system-default-frame-alist' and `default-frame-alist'
there (in decreasing order of priority)."
259
  ;; Make menu-bar-mode and default-frame-alist consistent.
260 261 262 263 264 265 266
  (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
267

268 269 270
  ;; 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
271
  ;; what we want.
272
  (when (and (boundp 'tool-bar-mode)
273
 	     (not noninteractive))
274 275
    (let ((default (assq 'tool-bar-lines default-frame-alist)))
      (if default
276 277 278 279 280 281 282 283 284 285 286 287
 	  (setq tool-bar-mode (not (eq (cdr default) 0)))
	;; If Emacs was started on a tty, changing default-frame-alist
	;; would disable the toolbar on X frames created later.  We
	;; want to keep the default of showing a toolbar under X even
	;; in this case.
	;;
	;; If the user explicitly called `tool-bar-mode' in .emacs,
	;; then default-frame-alist is already changed anyway.
	(when initial-window-system
	  (setq default-frame-alist
		(cons (cons 'tool-bar-lines (if tool-bar-mode 1 0))
		      default-frame-alist))))))
288

289 290 291 292 293
  ;; 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.
294
  (let ((old-buffer (current-buffer))
Stefan Monnier's avatar
Stefan Monnier committed
295 296 297
	(window-system-frame-alist
         (cdr (assq initial-window-system
                    window-system-default-frame-alist))))
298

299 300
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
301 302
      ;; This case happens when we don't have a window system, and
      ;; also for MS-DOS frames.
303 304 305 306 307 308
      (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
309
				 (if (null initial-window-system)
310
				     (append initial-frame-alist
311
					     window-system-frame-alist
312 313 314 315 316 317 318
					     default-frame-alist
					     parms
					     nil)
				   ;; initial-frame-alist and
				   ;; default-frame-alist were already
				   ;; applied in pc-win.el.
				   parms))
319
	(if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
320 321 322 323 324 325 326 327 328 329 330
	    (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))))))
331

332 333
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
334 335 336 337 338
    (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.
339 340
      (when (display-graphic-p)
	(let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
341
				  (assq 'tool-bar-lines window-system-frame-alist)
342
				  (assq 'tool-bar-lines default-frame-alist))))
343 344 345 346
	  (when (and tool-bar-originally-present
                     (or (null tool-bar-lines)
                         (null (cdr tool-bar-lines))
                         (eq 0 (cdr tool-bar-lines))))
347
	    (let* ((char-height (frame-char-height frame-initial-frame))
348
		   (image-height tool-bar-images-pixel-height)
349 350 351 352 353 354 355 356 357 358 359
		   (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
360
		   (lines (/ (+ image-height
361 362 363 364 365 366
				(* 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
367
		   (initial-top (cdr (assq 'top
368 369 370
					   frame-initial-geometry-arguments)))
		   (top (frame-parameter frame-initial-frame 'top)))
	      (when (and (consp initial-top) (eq '- (car initial-top)))
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
		(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))))
387 388
	      (modify-frame-parameters frame-initial-frame newparms)
	      (tool-bar-mode -1)))))
389 390 391 392 393 394 395 396 397 398 399 400

      ;; 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.
401
      (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
402
			    (assq 'minibuffer window-system-frame-alist)
403 404 405 406 407 408 409 410 411 412 413 414 415
			    (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))
416

Sam Steingold's avatar
Sam Steingold committed
417
            ;; Get rid of `name' unless it was specified explicitly before.
418 419
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))
420 421 422
	    ;; 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)))
423 424

	    (setq parms (append initial-frame-alist
425
				window-system-frame-alist
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
				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
461 462 463 464 465 466
                    (lambda (frame)
                      (and (not (eq frame frame-initial-frame))
                           (eq (window-frame
                                (minibuffer-window frame))
                               frame-initial-frame))))))
              (if (or users-of-initial
467 468 469 470 471 472 473
		      (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
474 475 476 477
                                (lambda (frame)
                                  (eq (cdr (assq 'minibuffer
                                                 (frame-parameters frame)))
                                      'only)))
478 479 480 481 482 483 484 485
			       (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.
486 487 488 489 490
		    (dolist (frame users-of-initial)
                      (modify-frame-parameters
                       frame (list (cons 'minibuffer new-minibuffer)))))))

            ;; Redirect events enqueued at this frame to the new frame.
491 492 493 494 495
	    ;; 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))
496 497 498 499 500

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

539 540 541 542
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

547 548 549 550 551 552
(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))))

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

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

577 578 579 580
  (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
581
(defun get-other-frame ()
582 583 584
  "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
585
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
586
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
587
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
588 589
    s))

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

Jim Blandy's avatar
Jim Blandy committed
598 599
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
600 601 602
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
603
				  0))
604
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
605

606
(declare-function x-initialize-window-system "term/x-win" ())
607
(defvar x-display-name)
608

609
(defun make-frame-on-display (display &optional parameters)
610
  "Make a frame on X display DISPLAY.
611 612
The optional second argument PARAMETERS specifies additional frame parameters."
  (interactive "sMake frame on display: ")
613 614
  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
615
  (when (and (boundp 'x-initialized) (not x-initialized))
616 617
    (setq x-display-name display)
    (x-initialize-window-system))
618
  (make-frame `((window-system . x) (display . ,display) . ,parameters)))
619

620 621 622 623 624 625
(defun make-frame-on-tty (tty type &optional parameters)
  "Make a frame on terminal device TTY.
TTY should be the file name of the tty device to use.  TYPE
should be the terminal type string of TTY, for example \"xterm\"
or \"vt100\".  The optional third argument PARAMETERS specifies
additional frame parameters."
626
  (interactive "fOpen frame on tty device: \nsTerminal type of %s: ")
627
  (unless tty
628 629 630
    (error "Invalid terminal device"))
  (unless type
    (error "Invalid terminal type"))
631
  (make-frame `((window-system . nil) (tty . ,tty) (tty-type . ,type) . ,parameters)))
632

633 634
(declare-function x-close-connection "xfns.c" (terminal))

635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
(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))))

665 666 667
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
668
  (if (and window-system (not (eq window-system 'pc)))
669 670 671
      (make-frame)
    (select-frame (make-frame))))

672 673 674 675 676 677 678
(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.")

679
(defvar after-setting-font-hook nil
680 681
  "Functions to run after a frame's font has been changed.")

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

685
(defvar frame-inherited-parameters '()
686 687 688
  ;; FIXME: Shouldn't we add `font' here as well?
  "Parameters `make-frame' copies from the `selected-frame' to the new frame.")

689 690 691 692
(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
693

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

696 697
 (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
698

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

701 702 703 704
 (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
705

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

709
 (terminal . ID)          The frame should use the terminal identified by ID.
710

711
Before the frame is created (via `frame-creation-function-alist'), functions on the
712
hook `before-make-frame-hook' are run.  After the frame is created, functions
Luc Teirlinck's avatar
Luc Teirlinck committed
713 714 715 716 717 718 719
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
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 735 736 737
	 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)
Stefan Monnier's avatar
Stefan Monnier committed
738 739 740 741
    (setq frame
          (funcall frame-creation-function
                   (append parameters
                           (cdr (assq w window-system-default-frame-alist)))))
742
    (normal-erase-is-backspace-setup-frame frame)
743 744 745 746 747
    ;; 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)))))
748 749
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
750

751 752
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
753 754
  (let* ((frames (frame-list))
	 (list frames))
755
    (while (consp frames)
756 757
      (unless (funcall predicate (car frames))
	(setcar frames nil))
758
      (setq frames (cdr frames)))
759
    (delq nil list)))
760 761 762 763

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

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
;; 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
791
HOST:SERVER.SCREEN).
792

793
If DEVICE is omitted or nil, it defaults to the selected
794
frame's terminal device."
795
  (let* ((terminal (get-device-terminal device))
796
	 (func #'(lambda (frame)
797
		   (eq (frame-terminal frame) terminal))))
798 799
    (filtered-frame-list func)))

800 801 802 803 804 805
(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."
806
  (or (terminal-live-p terminal)
807 808
      (framep terminal)
      (framep (car (frames-on-display-list terminal)))))
809

810 811 812
(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',
813
`height', `user-size' and `user-position' parameters.
814 815 816 817 818 819
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)))
820 821 822 823 824 825
	       (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))))
826
	(setq tail (cdr tail)))))
827 828
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
829 830
  (cdr param-list))

831 832
(declare-function x-focus-frame "xfns.c" (frame))

833 834 835 836 837
(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.
838
    (when (memq (window-system frame) '(x mac w32))
839 840 841
      (x-focus-frame frame))
    (when focus-follows-mouse
      (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
842

843
(defun other-frame (arg)
Juanma Barranquero's avatar
Juanma Barranquero committed
844
  "Select the ARGth different visible frame on current display, and raise it.
845 846
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
847 848 849 850 851 852 853
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."
854 855 856
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
857 858 859 860
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
861
    (while (< arg 0)
862 863 864
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
865
      (setq arg (1+ arg)))
866
    (select-frame-set-input-focus frame)))
867

868 869 870 871 872 873 874
(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)))

875 876
(defun suspend-frame ()
  "Do whatever is right to suspend the current frame.
877 878
Calls `suspend-emacs' if invoked from the controlling tty device,
`suspend-tty' from a secondary tty device, and
879 880 881 882
`iconify-or-deiconify-frame' from an X frame."
  (interactive)
  (let ((type (framep (selected-frame))))
    (cond
883
     ((memq type '(x w32)) (iconify-or-deiconify-frame))
884
     ((eq type t)
885
      (if (controlling-tty-p)
886 887
	  (suspend-emacs)
	(suspend-tty)))
888 889
     (t (suspend-emacs)))))

890 891 892 893 894 895 896 897 898 899 900 901 902 903
(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)
904
  "Select the frame on the current terminal whose name is NAME and raise it.
905 906
If there is no frame by that name, signal an error."
  (interactive
907 908 909 910 911
   (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)))
912 913 914
     (if (= (length input) 0)
	 (list default)
       (list input))))
915 916
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
917 918 919 920
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
921 922
    (select-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
923 924
    (cond ((memq (window-system frame) '(x w32))
	   (x-focus-frame frame)))
925 926
    (when focus-follows-mouse
      (set-mouse-position frame (1- (frame-width frame)) 0))))
Jim Blandy's avatar
Jim Blandy committed
927

Jim Blandy's avatar
Jim Blandy committed
928 929 930 931
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
932 933 934 935 936 937 938
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
939 940 941 942
	(mapcar (lambda (frame)
                  (list frame
                        (frame-parameters frame)
                        (current-window-configuration frame)))
943
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
944

945
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
946 947
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
948
configuration, and other parameters set as specified in CONFIGURATION.
949 950
However, this function does not restore deleted frames.

951 952
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
953
is given and non-nil, the unwanted frames are iconified instead."
954 955 956 957 958
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
959 960 961 962 963 964 965 966 967
    (dolist (frame (frame-list))
      (let ((parameters (assq frame config-alist)))
        (if parameters
            (progn
              (modify-frame-parameters
               frame
               ;; Since we can't set a frame's minibuffer status,
               ;; we might as well omit the parameter altogether.
               (let* ((parms (nth 1 parameters))
Miles Bader's avatar
Miles Bader committed
968 969 970 971 972 973 974 975 976
		      (mini (assq 'minibuffer parms))
		      (name (assq 'name parms))
		      (explicit-name (cdr (assq 'explicit-name parms))))
		 (when mini (setq parms (delq mini parms)))
		 ;; Leave name in iff it was set explicitly.
		 ;; This should fix the behavior reported in
		 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg01632.html
		 (when (and name (not explicit-name))
		   (setq parms (delq name parms)))
977 978 979 980 981 982 983 984 985 986 987
                 parms))
              (set-window-configuration (nth 2 parameters)))
          (setq frames-to-delete (cons frame frames-to-delete)))))
    (mapc (if nodelete
              ;; 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.
              'iconify-frame
            'delete-frame)
          frames-to-delete)))
Jim Blandy's avatar
Jim Blandy committed
988

Jim Blandy's avatar
Jim Blandy committed
989 990
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.