frame.el 59.1 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 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
;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
Erik Naggum's avatar
Erik Naggum committed
14 15 16 17 18 19 20 21 22
;; 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
(defvar frame-creation-function-alist
  (list (cons nil
	      (if (fboundp 'tty-create-frame-with-faces)
		  'tty-create-frame-with-faces
34 35
                (lambda (parameters)
                  (error "Can't create multiple frames without a window system")))))
36 37 38 39
  "Alist of window-system dependent functions to call to create a new frame.
The window system startup file should add its frame creation
function to this list, which should take an alist of parameters
as its argument.")
40

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 295 296
  (let ((old-buffer (current-buffer))
	(window-system-frame-alist (cdr (assq initial-window-system
					      window-system-default-frame-alist))))
297

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

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

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

Sam Steingold's avatar
Sam Steingold committed
416
            ;; Get rid of `name' unless it was specified explicitly before.
417 418 419 420
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))

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

            ;; Redirect events enqueued at this frame to the new frame.
487 488 489 490 491
	    ;; 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))
492 493 494 495 496

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

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

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

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

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

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

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

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

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

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

613 614 615 616 617 618
(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."
619
  (interactive "fOpen frame on tty device: \nsTerminal type of %s: ")
620
  (unless tty
621 622 623
    (error "Invalid terminal device"))
  (unless type
    (error "Invalid terminal type"))
624
  (make-frame `((window-system . nil) (tty . ,tty) (tty-type . ,type) . ,parameters)))
625

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

656 657 658
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
659
  (if (and window-system (not (eq window-system 'pc)))
660 661 662
      (make-frame)
    (select-frame (make-frame))))

663 664 665 666 667 668 669
(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.")

670
(defvar after-setting-font-hook nil
671 672
  "Functions to run after a frame's font has been changed.")

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

676
(defvar frame-inherited-parameters '()
677 678 679
  ;; FIXME: Shouldn't we add `font' here as well?
  "Parameters `make-frame' copies from the `selected-frame' to the new frame.")

680 681 682 683
(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
684

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

687 688
 (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
689

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

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

697 698 699
 (window-system . nil)	The frame should be displayed on a terminal device.
 (window-system . x)	The frame should be displayed in an X window.

700
 (terminal . ID)          The frame should use the terminal identified by ID.
701

702
Before the frame is created (via `frame-creation-function-alist'), functions on the
703
hook `before-make-frame-hook' are run.  After the frame is created, functions
Luc Teirlinck's avatar
Luc Teirlinck committed
704 705 706 707 708 709 710
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
711
  (interactive)
712
  (let* ((w (cond
713 714
	     ((assq 'terminal parameters)
	      (let ((type (terminal-live-p (cdr (assq 'terminal parameters)))))
715 716
		(cond
		 ((eq type t) nil)
717
		 ((eq type nil) (error "Terminal %s does not exist" (cdr (assq 'terminal parameters))))
718 719 720 721
		 (t type))))
	     ((assq 'window-system parameters)
	      (cdr (assq 'window-system parameters)))
	     (t window-system)))
722
	 (frame-creation-function (cdr (assq w frame-creation-function-alist)))
723
	 (oldframe (selected-frame))
724 725 726 727
	 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)
728
    (setq frame (funcall frame-creation-function (append parameters (cdr (assq w window-system-default-frame-alist)))))
729
    (normal-erase-is-backspace-setup-frame frame)
730 731 732 733 734
    ;; 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)))))
735 736
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
737

738 739
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
740 741
  (let* ((frames (frame-list))
	 (list frames))
742
    (while (consp frames)
743 744
      (unless (funcall predicate (car frames))
	(setcar frames nil))
745
      (setq frames (cdr frames)))
746
    (delq nil list)))
747 748 749 750

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

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
;; 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
778
HOST:SERVER.SCREEN).
779

780
If DEVICE is omitted or nil, it defaults to the selected
781
frame's terminal device."
782
  (let* ((terminal (get-device-terminal device))
783
	 (func #'(lambda (frame)
784
		   (eq (frame-terminal frame) terminal))))
785 786
    (filtered-frame-list func)))

787 788 789 790 791 792
(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."
793
  (or (terminal-live-p terminal)
794 795
      (framep terminal)
      (framep (car (frames-on-display-list terminal)))))
796

797 798 799
(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',
800
`height', `user-size' and `user-position' parameters.
801 802 803 804 805 806
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)))
807 808 809 810 811 812
	       (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))))
813
	(setq tail (cdr tail)))))
814 815
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
816 817
  (cdr param-list))

818 819 820 821 822
(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.
823
    (when (memq (window-system frame) '(x mac w32))
824 825 826
      (x-focus-frame frame))
    (when focus-follows-mouse
      (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
827

828
(defun other-frame (arg)
Juanma Barranquero's avatar
Juanma Barranquero committed
829
  "Select the ARGth different visible frame on current display, and raise it.
830 831
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
832 833 834 835 836 837 838
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."
839 840 841
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
842 843 844 845
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
846
    (while (< arg 0)
847 848 849
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
850
      (setq arg (1+ arg)))
851
    (select-frame-set-input-focus frame)))
852

853 854 855 856 857 858 859
(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)))

860 861
(defun suspend-frame ()
  "Do whatever is right to suspend the current frame.
862 863
Calls `suspend-emacs' if invoked from the controlling tty device,
`suspend-tty' from a secondary tty device, and
864 865 866 867
`iconify-or-deiconify-frame' from an X frame."
  (interactive)
  (let ((type (framep (selected-frame))))
    (cond
868
     ((memq type '(x w32)) (iconify-or-deiconify-frame))
869
     ((eq type t)
870
      (if (controlling-tty-p)
871 872
	  (suspend-emacs)
	(suspend-tty)))
873 874
     (t (suspend-emacs)))))

875 876 877 878 879 880 881 882 883 884 885 886 887 888
(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)
889
  "Select the frame on the current terminal whose name is NAME and raise it.
890 891
If there is no frame by that name, signal an error."
  (interactive
892 893 894 895 896
   (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)))
897 898 899
     (if (= (length input) 0)
	 (list default)
       (list input))))
900 901
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
902 903 904 905
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
906 907
    (select-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
908 909
    (cond ((memq (window-system frame) '(x w32))
	   (x-focus-frame frame)))
910 911
    (when focus-follows-mouse
      (set-mouse-position frame (1- (frame-width frame)) 0))))
Jim Blandy's avatar
Jim Blandy committed
912

Jim Blandy's avatar
Jim Blandy committed
913 914 915 916
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
917 918 919 920 921 922 923
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
924 925 926 927
	(mapcar (lambda (frame)
                  (list frame
                        (frame-parameters frame)
                        (current-window-configuration frame)))
928
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
929

930
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
931 932
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
933
configuration, and other parameters set as specified in CONFIGURATION.
934 935
However, this function does not restore deleted frames.

936 937
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
938
is given and non-nil, the unwanted frames are iconified instead."
939 940 941 942 943
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
    (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))
                      (mini (assq 'minibuffer parms)))
                 (if mini (setq parms (delq mini parms)))
                 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
966

Jim Blandy's avatar
Jim Blandy committed
967 968
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
969

Jim Blandy's avatar
Jim Blandy committed
970
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
971 972
  "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
973
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
974 975 976 977

(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
978
  (cdr (assq 'width (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
979

980
(defalias 'set-default-font 'set-frame-font)
981
(defun set-frame-font (font-name &optional keep-size)
982
  "Set the font of the selected frame to FONT-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
983
When called interactively, prompt for the name of the font to use.
984 985 986
To get the frame's current default font, use `frame-parameters'.

The default behavior is to keep the numbers of lines and columns in
987
the frame, thus may change its pixel size.  If optional KEEP-SIZE is
988 989
non-nil (interactively, prefix argument) the current frame size (in
pixels) is kept by adjusting the numbers of the lines and columns."