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

Erik Naggum's avatar
Erik Naggum committed
3
;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: internal
Eric S. Raymond's avatar
Eric S. Raymond committed
7

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

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

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

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
24

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

Jim Blandy's avatar
Jim Blandy committed
27 28 29
(defvar frame-creation-function nil
  "Window-system dependent function to call to create a new frame.
The window system startup file should set this to its frame creation
Jim Blandy's avatar
Jim Blandy committed
30 31
function, which should take an alist of parameters as its argument.")

32 33 34 35
;;; The initial value given here for 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.
(defvar initial-frame-alist nil
36 37
  "Alist of frame parameters for creating the initial X window frame.
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
38
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
39 40 41 42
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
43
`minibuffer-frame-alist'.
44 45 46

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
47
take effect until Emacs reads `.emacs', which happens after first creating
48 49 50 51 52 53 54
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,
  to override what you put in `default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
55

56
(defvar minibuffer-frame-alist '((width . 80) (height . 2))
57 58
  "Alist of frame parameters for initially creating a minibuffer frame.
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
59
 (setq minibuffer-frame-alist
60
   '((top . 1) (left . 1) (width . 80) (height . 2)))
61 62
Parameters specified here supersede the values given in
`default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
63

Jim Blandy's avatar
Jim Blandy committed
64
(defvar pop-up-frame-alist nil
65
  "Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
66
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
67
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
68
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
69
These supersede the values given in `default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
70

Jim Blandy's avatar
Jim Blandy committed
71
(setq pop-up-frame-function
Jim Blandy's avatar
Jim Blandy committed
72
      (function (lambda ()
73
		  (make-frame pop-up-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
74

Karl Heuer's avatar
Karl Heuer committed
75
(defvar special-display-frame-alist
76 77 78 79 80 81 82 83 84 85 86 87
  '((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)))
These supersede the values given in `default-frame-alist'.")

;; 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.
88
;; If ARGS is an alist, use it as a list of frame parameter specs.
Karl Heuer's avatar
Karl Heuer committed
89
;; If ARGS is a list whose car is a symbol,
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
;; 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.
(defun special-display-popup-frame (buffer &optional args)
  (if (and args (symbolp (car args)))
      (apply (car args) buffer (cdr args))
    (let ((window (get-buffer-window buffer t)))
      (if window
	  ;; If we have a window already, make it visible.
	  (let ((frame (window-frame window)))
	    (make-frame-visible frame)
	    (raise-frame frame)
	    window)
	;; If no window yet, make one in a new frame.
	(let ((frame (make-frame (append args special-display-frame-alist))))
	  (set-window-buffer (frame-selected-window frame) buffer)
	  (set-window-dedicated-p (frame-selected-window frame) t)
	  (frame-selected-window frame))))))
107

108 109 110 111 112 113 114 115 116 117 118 119 120
;; Handle delete-frame events from the X server.
(defun handle-delete-frame (event)
  (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)
121 122
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
123

Jim Blandy's avatar
Jim Blandy committed
124
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
125 126 127

;;; 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
Jim Blandy's avatar
Jim Blandy committed
128
;;; file should create any frames specified in the window system defaults.
Karl Heuer's avatar
Karl Heuer committed
129
;;;
Jim Blandy's avatar
Jim Blandy committed
130
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
131 132
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
133
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
134

Karl Heuer's avatar
Karl Heuer committed
135
;; These are now called explicitly at the proper times,
136 137 138 139
;; 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
140

Jim Blandy's avatar
Jim Blandy committed
141 142
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
143

144 145 146
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

147 148
(defvar frame-initial-geometry-arguments nil)

Jim Blandy's avatar
Jim Blandy committed
149
;;; startup.el calls this function before loading the user's init
Jim Blandy's avatar
Jim Blandy committed
150
;;; file - if there is no frame with a minibuffer open now, create
Jim Blandy's avatar
Jim Blandy committed
151
;;; one to display messages while loading the init file.
Jim Blandy's avatar
Jim Blandy committed
152
(defun frame-initialize ()
Karl Heuer's avatar
Karl Heuer committed
153

Jim Blandy's avatar
Jim Blandy committed
154
  ;; Are we actually running under a window system at all?
155
  (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
156
      (progn
157 158 159
	;; Turn on special-display processing only if there's a window system.
	(setq special-display-function 'special-display-popup-frame)

160 161 162 163 164
	;; 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))
165
	    (progn
166 167
	      (setq frame-initial-frame-alist
		    (append initial-frame-alist default-frame-alist))
168 169 170 171 172 173 174 175 176 177
	      ;; Record these with their default values
	      ;; if they don't have any values explicitly.
	      (or (assq 'vertical-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(vertical-scroll-bars . t)
			      frame-initial-frame-alist)))
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
178 179
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
180
			  (make-frame initial-frame-alist)))
181 182 183 184
	      ;; 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.
185
	      (setq initial-frame-alist
186
		    (frame-remove-geometry-params initial-frame-alist))))
Karl Heuer's avatar
Karl Heuer committed
187
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
188 189 190
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Karl Heuer's avatar
Karl Heuer committed
191

192 193
    ;; No, we're not running a window system.  Use make-terminal-frame if
    ;; we support that feature, otherwise arrange to cause errors.
194 195 196 197 198 199 200 201
    (or (eq window-system 'pc)
	(setq frame-creation-function
	      (if (fboundp 'make-terminal-frame)
		  'make-terminal-frame
		(function
		 (lambda (parameters)
		   (error
		    "Can't create multiple frames without a window system"))))))))
Karl Heuer's avatar
Karl Heuer committed
202

203 204 205
;;; 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
206
(defun frame-notice-user-settings ()
207

208
  ;; Make menu-bar-mode and default-frame-alist consistent.
209 210 211 212 213 214 215
  (if (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)))))
216

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
  ;; Creating and deleting frames may shift the selected frame around,
  ;; and thus the current buffer.  Protect against that.  We don't
  ;; want to use save-excursion here, because that may also try to set
  ;; the buffer of the selected window, which fails when the selected
  ;; window is the minibuffer.
  (let ((old-buffer (current-buffer)))

    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
    (if (frame-live-p frame-initial-frame)

	;; 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.
	;;
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238
	;; 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.
239 240 241 242 243
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
244 245 246 247 248 249 250 251
	    (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))
252 253 254 255
	      (setq parms (frame-parameters frame-initial-frame))
	      ;; Get rid of `name' unless it was specified explicitly before.
	      (or (assq 'name frame-initial-frame-alist)
		  (setq parms (delq (assq 'name parms) parms)))
256
	      (setq parms (append initial-frame-alist
257
				  default-frame-alist
258
				  parms
259
				  nil))
260 261 262 263
	      ;; 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)
264
		  (setq parms (frame-delete-all 'height parms)))
265
	      (if (assq 'width frame-initial-geometry-arguments)
266
		  (setq parms (frame-delete-all 'width parms)))
267
	      (if (assq 'left frame-initial-geometry-arguments)
268
		  (setq parms (frame-delete-all 'left parms)))
269
	      (if (assq 'top frame-initial-geometry-arguments)
270
		  (setq parms (frame-delete-all 'top parms)))
271 272 273 274
	      (setq new
		    (make-frame
		     ;; Use the geometry args that created the existing
		     ;; frame, rather than the parms we get for it.
275 276 277
		     (append frame-initial-geometry-arguments
			     '((user-size . t) (user-position . t))
			     parms)))
278 279 280 281
	      ;; 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))
282
		  (make-initial-minibuffer-frame nil))
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

	      ;; If the initial frame is serving as a surrogate
	      ;; minibuffer frame for any frames, we need to wean them
	      ;; onto a new frame.  The default-minibuffer-frame
	      ;; variable must be handled similarly.
	      (let ((users-of-initial
		     (filtered-frame-list
		      (function (lambda (frame)
				  (and (not (eq frame frame-initial-frame))
				       (eq (window-frame
					    (minibuffer-window frame))
					   frame-initial-frame)))))))
		(if (or users-of-initial
			(eq default-minibuffer-frame frame-initial-frame))

		    ;; Choose an appropriate frame.  Prefer frames which
		    ;; are only minibuffers.
		    (let* ((new-surrogate
			    (car
			     (or (filtered-frame-list
				  (function
				   (lambda (frame)
				     (eq (cdr (assq 'minibuffer
						    (frame-parameters frame)))
					 'only))))
				 (minibuffer-frame-list))))
			   (new-minibuffer (minibuffer-window new-surrogate)))

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

		      ;; Wean the frames using frame-initial-frame as
		      ;; their minibuffer frame.
		      (mapcar
		       (function
			(lambda (frame)
			  (modify-frame-parameters
			   frame (list (cons 'minibuffer new-minibuffer)))))
		       users-of-initial))))
Jim Blandy's avatar
Jim Blandy committed
322 323 324

	      ;; Redirect events enqueued at this frame to the new frame.
	      ;; Is this a good idea?
325
	      (redirect-frame-focus frame-initial-frame new)
Jim Blandy's avatar
Jim Blandy committed
326

327
	      ;; Finally, get rid of the old frame.
328
	      (delete-frame frame-initial-frame t))
329 330 331

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
332 333 334
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
335 336 337 338 339 340 341 342
	    (if (assq 'height frame-initial-geometry-arguments)
		(setq allparms (frame-delete-all 'height allparms)))
	    (if (assq 'width frame-initial-geometry-arguments)
		(setq allparms (frame-delete-all 'width allparms)))
	    (if (assq 'left frame-initial-geometry-arguments)
		(setq allparms (frame-delete-all 'left allparms)))
	    (if (assq 'top frame-initial-geometry-arguments)
		(setq allparms (frame-delete-all 'top allparms)))
343 344 345 346 347 348 349 350 351 352
	    (setq tail allparms)
	    ;; Find just the parms that have changed since we first
	    ;; made this frame.  Those are the ones actually set by
	    ;; the init file.  For those parms whose values we already knew
	    ;; (such as those spec'd by command line options)
	    ;; it is undesirable to specify the parm again
	    ;; once the user has seen the frame and been able to alter it
	    ;; manually.
	    (while tail
	      (let (newval oldval)
353 354
		(setq oldval (assq (car (car tail))
				   frame-initial-frame-alist))
355
		(setq newval (cdr (assq (car (car tail)) allparms)))
356
		(or (and oldval (eq (cdr oldval) newval))
357 358 359
		    (setq newparms
			  (cons (cons (car (car tail)) newval) newparms))))
	      (setq tail (cdr tail)))
360
	    (setq newparms (nreverse newparms))
361
	    (modify-frame-parameters frame-initial-frame
362 363 364
				     newparms)
	    (if (assq 'font newparms)
		(frame-update-faces frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
365

366 367 368 369
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

373 374 375 376 377 378
(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))))

379 380 381
;; Delete from ALIST all elements whose car is KEY.
;; Return the modified alist.
(defun frame-delete-all (key alist)
382
  (setq alist (copy-sequence alist))
383 384 385 386 387 388
  (let ((tail alist))
    (while tail
      (if (eq (car (car tail)) key)
	  (setq alist (delq (car tail) alist)))
      (setq tail (cdr tail)))
    alist))
Jim Blandy's avatar
Jim Blandy committed
389

390
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
391

392
;;; Return some frame other than the current frame, creating one if
393
;;; necessary.  Note that the minibuffer frame, if separate, is not
394
;;; considered (see next-frame).
Jim Blandy's avatar
Jim Blandy committed
395
(defun get-other-frame ()
Jim Blandy's avatar
Jim Blandy committed
396
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
397
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
398
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
399 400
    s))

Jim Blandy's avatar
Jim Blandy committed
401 402
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
403 404 405 406 407
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
			      t)))

Jim Blandy's avatar
Jim Blandy committed
408 409
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
410 411 412 413 414
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

415 416 417 418 419 420
(defun make-frame-on-display (display &optional parameters)
  "Make a frame on display DISPLAY.
The optional second argument PARAMETERS specifies additional frame parameters."
  (interactive "sMake frame on display: ")
  (make-frame (cons (cons 'display display) parameters)))

421 422 423
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
424
  (if (and window-system (not (eq window-system 'pc)))
425 426 427
      (make-frame)
    (select-frame (make-frame))))

428 429 430 431 432 433 434
(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.")

435
;; Alias, kept temporarily.
436
(defalias 'new-frame 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
437

438 439 440 441
(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
442

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

445 446
 (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
447

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

450 451 452 453
 (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
454

455 456 457
Before the frame is created (via `frame-creation-function'), functions on the
hook `before-make-frame-hook' are run.  After the frame is created, functions
on `after-make-frame-functions' are run with one arg, the newly created frame."
Jim Blandy's avatar
Jim Blandy committed
458
  (interactive)
459 460 461 462
  (run-hooks 'before-make-frame-hook)
  (let ((frame (funcall frame-creation-function parameters)))
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
  (let ((frames (frame-list))
	good-frames)
    (while (consp frames)
      (if (funcall predicate (car frames))
	  (setq good-frames (cons (car frames) good-frames)))
      (setq frames (cdr frames)))
    good-frames))

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

480 481 482
(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',
483
`height', `user-size' and `user-position' parameters.
484 485 486 487 488 489
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)))
490 491 492 493 494 495
	       (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))))
496
	(setq tail (cdr tail)))))
497 498
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
499 500 501
  (cdr param-list))


502
(defun other-frame (arg)
503
  "Select the ARG'th different visible frame, and raise it.
504 505 506 507 508 509
All frames are arranged in a cyclic order.
This command selects the frame ARG steps away in that order.
A negative ARG moves in the opposite order."
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
510 511 512 513
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
514
    (while (< arg 0)
515 516 517
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
518
      (setq arg (1+ arg)))
519
    (raise-frame frame)
520
    (select-frame frame)
521
    (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
Jim Blandy's avatar
Jim Blandy committed
522

Jim Blandy's avatar
Jim Blandy committed
523 524 525 526
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
527 528 529 530 531 532 533 534 535 536 537 538 539
Its car is `frame-configuration'.
Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
where
  FRAME is a frame object,
  ALIST is an association list specifying some of FRAME's parameters, and
  WINDOW-CONFIG is a window configuration object for FRAME."
  (cons 'frame-configuration
	(mapcar (function
		 (lambda (frame)
		   (list frame
			 (frame-parameters frame)
			 (current-window-configuration frame))))
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
540

541
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
542 543
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
544
configuration, and other parameters set as specified in CONFIGURATION.
545 546
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
547
is given and non-nil, the unwanted frames are iconified instead."
548 549 550 551 552
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
Jim Blandy's avatar
Jim Blandy committed
553
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
554
	     (lambda (frame)
555
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
556 557
		 (if parameters
		     (progn
558 559
		       (modify-frame-parameters
			frame
Karl Heuer's avatar
Karl Heuer committed
560
			;; Since we can't set a frame's minibuffer status,
561 562 563 564 565
			;; we might as well omit the parameter altogether.
			(let* ((parms (nth 1 parameters))
			       (mini (assq 'minibuffer parms)))
			  (if mini (setq parms (delq mini parms)))
			  parms))
Jim Blandy's avatar
Jim Blandy committed
566
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
567 568
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
569
    (if nodelete
570 571 572 573 574
	;; Note: making frames invisible here was tried
	;; but led to some strange behavior--each time the frame
	;; was made visible again, the window manager asked afresh
	;; for where to put it.
	(mapcar 'iconify-frame frames-to-delete)
575
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
576

Jim Blandy's avatar
Jim Blandy committed
577 578
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
579

Jim Blandy's avatar
Jim Blandy committed
580
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
581 582
  "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
583
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
584 585 586 587

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

590 591
(defalias 'set-default-font 'set-frame-font)
(defun set-frame-font (font-name)
592
  "Set the font of the selected frame to FONT.
Richard M. Stallman's avatar
Richard M. Stallman committed
593 594
When called interactively, prompt for the name of the font to use.
To get the frame's current default font, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
595
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
596
  (modify-frame-parameters (selected-frame)
597 598 599
			   (list (cons 'font font-name)))
  ;; Update faces that want a bold or italic version of the default font.
  (frame-update-faces (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
600

601
(defun set-background-color (color-name)
602
  "Set the background color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
603 604
When called interactively, prompt for the name of the color to use.
To get the frame's current background color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
605
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
606
  (modify-frame-parameters (selected-frame)
607 608
			   (list (cons 'background-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
609

610
(defun set-foreground-color (color-name)
611
  "Set the foreground color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
612 613
When called interactively, prompt for the name of the color to use.
To get the frame's current foreground color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
614
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
615
  (modify-frame-parameters (selected-frame)
616 617
			   (list (cons 'foreground-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
618 619

(defun set-cursor-color (color-name)
620
  "Set the text cursor color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
621 622
When called interactively, prompt for the name of the color to use.
To get the frame's current cursor color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
623
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
624
  (modify-frame-parameters (selected-frame)
625
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
626

627
(defun set-mouse-color (color-name)
628
  "Set the color of the mouse pointer of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
629 630
When called interactively, prompt for the name of the color to use.
To get the frame's current mouse color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
631
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
632
  (modify-frame-parameters (selected-frame)
633 634
			   (list (cons 'mouse-color color-name))))

635 636
(defun set-border-color (color-name)
  "Set the color of the border of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
637 638
When called interactively, prompt for the name of the color to use.
To get the frame's current border color, use `frame-parameters'."
639 640 641 642 643
  (interactive "sColor: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
644
  "Toggle whether or not the selected frame should auto-raise.
645 646 647 648 649
With arg, turn auto-raise mode on if and only if arg is positive.
Note that this controls Emacs's own auto-raise feature.
Some window managers allow you to enable auto-raise for certain windows.
You can use that for Emacs windows if you wish, but if you do,
that is beyond the control of Emacs and this command has no effect on it."
650 651 652 653 654
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
655
  (modify-frame-parameters (selected-frame)
656 657
			   (list (cons 'auto-raise (> arg 0)))))

658
(defun auto-lower-mode (arg)
659
  "Toggle whether or not the selected frame should auto-lower.
660 661 662 663 664
With arg, turn auto-lower mode on if and only if arg is positive.
Note that this controls Emacs's own auto-lower feature.
Some window managers allow you to enable auto-lower for certain windows.
You can use that for Emacs windows if you wish, but if you do,
that is beyond the control of Emacs and this command has no effect on it."
665 666 667 668 669
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
670
  (modify-frame-parameters (selected-frame)
671 672
			   (list (cons 'auto-lower (> arg 0)))))

673 674 675
(defvar scroll-bar-side 'left
  "*Specify which side scroll bars should be on.  Value is `left' or `right'.")

676
(defun toggle-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
677 678
  "Toggle whether or not the selected frame has vertical scroll bars.
With arg, turn vertical scroll bars on if and only if arg is positive."
679 680 681
  (interactive "P")
  (if (null arg)
      (setq arg
Jim Blandy's avatar
Jim Blandy committed
682
	    (if (cdr (assq 'vertical-scroll-bars
683 684
			   (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
685
  (modify-frame-parameters (selected-frame)
686 687 688
			   (list (cons 'vertical-scroll-bars
				       (if (> arg 0)
					   scroll-bar-side)))))
689

690
(defun toggle-horizontal-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
691 692 693
  "Toggle whether or not the selected frame has horizontal scroll bars.
With arg, turn horizontal scroll bars on if and only if arg is positive.
Horizontal scroll bars aren't implemented yet."
694
  (interactive "P")
695
  (error "Horizontal scroll bars aren't implemented yet"))
Jim Blandy's avatar
Jim Blandy committed
696

Jim Blandy's avatar
Jim Blandy committed
697 698

;;;; Aliases for backward compatibility with Emacs 18.
699 700
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
701 702 703 704 705 706

(defun set-screen-width (cols &optional pretend)
  "Obsolete function to change the size of the screen to COLS columns.\n\
Optional second arg non-nil means that redisplay should use COLS columns\n\
but that the idea of the actual width of the frame should not be changed.\n\
This function is provided only for compatibility with Emacs 18; new code\n\
Christopher Zaborsky's avatar
Christopher Zaborsky committed
707
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
708 709 710 711 712 713 714
  (set-frame-width (selected-frame) cols pretend))

(defun set-screen-height (lines &optional pretend)
  "Obsolete function to change the height of the screen to LINES lines.\n\
Optional second arg non-nil means that redisplay should use LINES lines\n\
but that the idea of the actual height of the screen should not be changed.\n\
This function is provided only for compatibility with Emacs 18; new code\n\
Christopher Zaborsky's avatar
Christopher Zaborsky committed
715
should use `set-frame-width' instead."
Jim Blandy's avatar
Jim Blandy committed
716 717 718 719 720 721
  (set-frame-height (selected-frame) lines pretend))

(make-obsolete 'screen-height 'frame-height)
(make-obsolete 'screen-width  'frame-width)
(make-obsolete 'set-screen-width 'set-frame-width)
(make-obsolete 'set-screen-height 'set-frame-height)
Jim Blandy's avatar
Jim Blandy committed
722

Jim Blandy's avatar
Jim Blandy committed
723 724 725

;;;; Key bindings

726
(define-key ctl-x-5-map "2" 'make-frame-command)
Jim Blandy's avatar
Jim Blandy committed
727
(define-key ctl-x-5-map "0" 'delete-frame)
728
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
729

Jim Blandy's avatar
Jim Blandy committed
730
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
731

Jim Blandy's avatar
Jim Blandy committed
732
;;; frame.el ends here