frame.el 26.2 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

Karl Heuer's avatar
Karl Heuer 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

Jim Blandy's avatar
Jim Blandy committed
8 9 10 11
;;; 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
Jim Blandy's avatar
Jim Blandy committed
12
;;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19 20 21 22 23
;;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.

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

Jim Blandy's avatar
Jim Blandy committed
26 27 28
(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
29 30
function, which should take an alist of parameters as its argument.")

31 32 33
;;; The initial value given here for this must ask for a minibuffer.
;;; There must always exist a frame with a minibuffer, and after we
;;; delete the terminal frame, this will be the only frame.
Jim Blandy's avatar
Jim Blandy committed
34
(defvar initial-frame-alist '((minibuffer . t))
35 36
  "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
37
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
38 39 40 41
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
42
`minibuffer-frame-alist'.
43 44 45 46 47 48 49 50 51 52 53

You can specify geometry-related options for just the initial frame
by setting this variable in your `.emacs' file; however, they won't
take affect until Emacs reads `.emacs', which happens after first creating
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
54

55
(defvar minibuffer-frame-alist '((width . 80) (height . 2))
56 57
  "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
58
 (setq minibuffer-frame-alist
59
   '((top . 1) (left . 1) (width . 80) (height . 2)))
60 61
Parameters specified here supersede the values given in
`default-frame-alist'.")
Jim Blandy's avatar
Jim Blandy committed
62

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

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

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
(defvar special-display-frame-alist 
  '((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.
(defun special-display-popup-frame (buffer)
  (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.
96
      (let ((frame (make-frame special-display-frame-alist)))
97 98 99 100 101
	(set-window-buffer (frame-selected-window frame) buffer)
	(set-window-dedicated-p (frame-selected-window frame) t)
	(frame-selected-window frame)))))

(setq special-display-function 'special-display-popup-frame)
Jim Blandy's avatar
Jim Blandy committed
102

Jim Blandy's avatar
Jim Blandy committed
103
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
104 105 106

;;; 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
107
;;; file should create any frames specified in the window system defaults.
Jim Blandy's avatar
Jim Blandy committed
108
;;; 
Jim Blandy's avatar
Jim Blandy committed
109
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
110 111
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
112
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
113

114 115 116 117 118
;; These are now called explicitly at the proper times, 
;; 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
119

Jim Blandy's avatar
Jim Blandy committed
120 121
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
122

123 124 125
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

126 127
(defvar frame-initial-geometry-arguments nil)

Jim Blandy's avatar
Jim Blandy committed
128
;;; startup.el calls this function before loading the user's init
Jim Blandy's avatar
Jim Blandy committed
129
;;; file - if there is no frame with a minibuffer open now, create
Jim Blandy's avatar
Jim Blandy committed
130
;;; one to display messages while loading the init file.
Jim Blandy's avatar
Jim Blandy committed
131
(defun frame-initialize ()
Jim Blandy's avatar
Jim Blandy committed
132 133 134
  
  ;; Are we actually running under a window system at all?
  (if (and window-system (not noninteractive))
135 136 137 138 139 140
      (progn
	;; If there is no frame with a minibuffer besides the terminal
	;; frame, then we need to create the opening frame.  Make sure
	;; it has a minibuffer, but let initial-frame-alist omit the
	;; minibuffer spec.
	(or (delq terminal-frame (minibuffer-frame-list))
141
	    (progn
142 143
	      (setq frame-initial-frame-alist
		    (append initial-frame-alist default-frame-alist))
144 145 146 147 148 149 150 151 152 153
	      ;; 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)))
154 155
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
156
			  (make-frame initial-frame-alist)))
157 158 159 160
	      ;; 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.
161
	      (setq initial-frame-alist
162
		    (frame-remove-geometry-params initial-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166
	;; At this point, we know that we have a frame open, so we 
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Jim Blandy's avatar
Jim Blandy committed
167 168
    
    ;; No, we're not running a window system.  Arrange to cause errors.
Jim Blandy's avatar
Jim Blandy committed
169
    (setq frame-creation-function
170 171 172
	  (function
	   (lambda (parameters)
	     (error
173
	      "Can't create multiple frames without a window system"))))))
Jim Blandy's avatar
Jim Blandy committed
174
					
175 176 177
;;; 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
178
(defun frame-notice-user-settings ()
179

180 181 182 183 184 185 186 187
  ;; Make menu-bar-mode and default-frame-alist consistent.
  (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))))

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
  ;; 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
205 206 207 208 209
	;; 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.
210 211 212 213 214
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
215 216 217 218 219 220 221 222 223
	    (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 (append initial-frame-alist
224 225 226
				  default-frame-alist
				  (frame-parameters frame-initial-frame)
				  nil))
227 228 229 230
	      ;; 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)
231
		  (setq parms (frame-delete-all 'height parms)))
232
	      (if (assq 'width frame-initial-geometry-arguments)
233
		  (setq parms (frame-delete-all 'width parms)))
234
	      (if (assq 'left frame-initial-geometry-arguments)
235
		  (setq parms (frame-delete-all 'left parms)))
236
	      (if (assq 'top frame-initial-geometry-arguments)
237
		  (setq parms (frame-delete-all 'top parms)))
238 239 240 241 242
	      (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 parms)))
243 244 245 246
	      ;; 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))
247
		  (make-frame (append minibuffer-frame-alist
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
				     '((minibuffer . only)))))

	      ;; 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
288 289 290

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

293
	      ;; Finally, get rid of the old frame.
294
	      (delete-frame frame-initial-frame t))
295 296 297

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
298 299 300
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
301 302 303 304 305 306 307 308
	    (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)))
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
	    (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)
		(setq oldval (cdr (assq (car (car tail))
					frame-initial-frame-alist)))
		(setq newval (cdr (assq (car (car tail)) allparms)))
		(or (eq oldval newval)
		    (setq newparms
			  (cons (cons (car (car tail)) newval) newparms))))
	      (setq tail (cdr tail)))
	    (modify-frame-parameters frame-initial-frame
				     (nreverse newparms)))))
Jim Blandy's avatar
Jim Blandy committed
328

329 330 331 332
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

336 337 338
;; Delete from ALIST all elements whose car is KEY.
;; Return the modified alist.
(defun frame-delete-all (key alist)
339
  (setq alist (copy-sequence alist))
340 341 342 343 344 345
  (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
346

347
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
348

349
;;; Return some frame other than the current frame, creating one if
350
;;; necessary.  Note that the minibuffer frame, if separate, is not
351
;;; considered (see next-frame).
Jim Blandy's avatar
Jim Blandy committed
352
(defun get-other-frame ()
Jim Blandy's avatar
Jim Blandy committed
353
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
354
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
355
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
356 357
    s))

Jim Blandy's avatar
Jim Blandy committed
358 359
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363 364
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
			      t)))

Jim Blandy's avatar
Jim Blandy committed
365 366
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
367 368 369 370 371
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

372
;; Alias, kept temporarily.
373
(defalias 'new-frame 'make-frame)
374
(defun make-frame (&optional parameters)
Jim Blandy's avatar
Jim Blandy committed
375
  "Create a new frame, displaying the current buffer.
Jim Blandy's avatar
Jim Blandy committed
376

Jim Blandy's avatar
Jim Blandy committed
377
Optional argument PARAMETERS is an alist of parameters for the new
Jim Blandy's avatar
Jim Blandy committed
378
frame.  Specifically, PARAMETERS is a list of pairs, each having one
Jim Blandy's avatar
Jim Blandy committed
379 380
of the following forms:

381
\(name . STRING)	- The frame should be named STRING.
Jim Blandy's avatar
Jim Blandy committed
382

383
\(height . NUMBER) - The frame should be NUMBER text lines high.  If
Jim Blandy's avatar
Jim Blandy committed
384 385 386
	this parameter is present, the width parameter must also be
	given.

387
\(width . NUMBER) - The frame should be NUMBER characters in width.
Jim Blandy's avatar
Jim Blandy committed
388 389 390
	If this parameter is present, the height parameter must also
	be given.

391
\(minibuffer . t) - the frame should have a minibuffer
Jim Blandy's avatar
Jim Blandy committed
392
\(minibuffer . nil) - the frame should have no minibuffer
393
\(minibuffer . only) - the frame should contain only a minibuffer
Richard M. Stallman's avatar
Richard M. Stallman committed
394
\(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window."
Jim Blandy's avatar
Jim Blandy committed
395
  (interactive)
396 397 398 399 400
  (let ((nframe))
    (run-hooks 'before-make-frame-hook)
    (setq nframe (funcall frame-creation-function parameters))
    (run-hooks 'after-make-frame-hook)
    nframe))
Jim Blandy's avatar
Jim Blandy committed
401

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
(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)))))))

418 419 420
(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',
421
`height', `user-size' and `user-position' parameters.
422 423 424 425 426 427
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)))
428 429 430 431 432 433
	       (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))))
434
	(setq tail (cdr tail)))))
435 436
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
437 438 439
  (cdr param-list))


440
(defun other-frame (arg)
441
  "Select the ARG'th different visible frame, and raise it.
442 443 444 445 446 447
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)
448 449 450 451
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
452
    (while (< arg 0)
453 454 455
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
456
      (setq arg (1+ arg)))
457
    (raise-frame frame)
458
    (select-frame frame)
459
    (set-mouse-position (selected-frame) (1- (frame-width)) 0)
460
    (unfocus-frame)))
Jim Blandy's avatar
Jim Blandy committed
461

Jim Blandy's avatar
Jim Blandy committed
462 463 464 465
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
466 467 468 469 470 471 472 473 474 475 476 477 478
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
479

480
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
481 482
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
483
configuration, and other parameters set as specified in CONFIGURATION.
484 485
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
486
is given and non-nil, the unwanted frames are iconified instead."
487 488 489 490 491
  (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
492
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
493
	     (lambda (frame)
494
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
495 496
		 (if parameters
		     (progn
497 498 499 500 501 502 503 504
		       (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))
Jim Blandy's avatar
Jim Blandy committed
505
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
506 507
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
508
    (if nodelete
509 510 511 512 513
	;; 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)
514
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
515

516 517 518 519 520 521 522
(defun frame-configuration-p (object)
  "Return non-nil if OBJECT seems to be a frame configuration.
Any list whose car is `frame-configuration' is assumed to be a frame
configuration."
  (and (consp object)
       (eq (car object) 'frame-configuration)))

Jim Blandy's avatar
Jim Blandy committed
523

Jim Blandy's avatar
Jim Blandy committed
524 525
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
526

Jim Blandy's avatar
Jim Blandy committed
527
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
528 529
  "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
530
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
531 532 533 534

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

Jim Blandy's avatar
Jim Blandy committed
537
(defun set-default-font (font-name)
538 539
  "Set the font of the selected frame to FONT.
When called interactively, prompt for the name of the font to use."
Jim Blandy's avatar
Jim Blandy committed
540
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
541
  (modify-frame-parameters (selected-frame)
542 543 544
			   (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
545

546
(defun set-background-color (color-name)
547 548
  "Set the background color of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
549
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
550
  (modify-frame-parameters (selected-frame)
551
			   (list (cons 'background-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
552

553
(defun set-foreground-color (color-name)
554 555
  "Set the foreground color of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
556
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
557
  (modify-frame-parameters (selected-frame)
558
			   (list (cons 'foreground-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
559 560

(defun set-cursor-color (color-name)
561 562
  "Set the text cursor color of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
563
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
564
  (modify-frame-parameters (selected-frame)
565
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
566

567
(defun set-mouse-color (color-name)
568 569
  "Set the color of the mouse pointer of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
Jim Blandy's avatar
Jim Blandy committed
570
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
571
  (modify-frame-parameters (selected-frame)
572 573
			   (list (cons 'mouse-color color-name))))

574 575 576 577 578 579 580 581
(defun set-border-color (color-name)
  "Set the color of the border of the selected frame to COLOR.
When called interactively, prompt for the name of the color to use."
  (interactive "sColor: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
582
  "Toggle whether or not the selected frame should auto-raise.
583 584 585 586 587
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."
588 589 590 591 592
  (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
593
  (modify-frame-parameters (selected-frame)
594 595
			   (list (cons 'auto-raise (> arg 0)))))

596
(defun auto-lower-mode (arg)
597
  "Toggle whether or not the selected frame should auto-lower.
598 599 600 601 602
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."
603 604 605 606 607
  (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
608
  (modify-frame-parameters (selected-frame)
609 610
			   (list (cons 'auto-lower (> arg 0)))))

611
(defun toggle-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
612 613
  "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."
614 615 616
  (interactive "P")
  (if (null arg)
      (setq arg
Jim Blandy's avatar
Jim Blandy committed
617
	    (if (cdr (assq 'vertical-scroll-bars
618 619
			   (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
620
  (modify-frame-parameters (selected-frame)
Jim Blandy's avatar
Jim Blandy committed
621
			   (list (cons 'vertical-scroll-bars (> arg 0)))))
622

623
(defun toggle-horizontal-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
624 625 626
  "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."
627
  (interactive "P")
628
  (error "Horizontal scroll bars aren't implemented yet"))
Jim Blandy's avatar
Jim Blandy committed
629

Jim Blandy's avatar
Jim Blandy committed
630 631

;;;; Aliases for backward compatibility with Emacs 18.
632 633
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
634 635 636 637 638 639

(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
640
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644 645 646 647
  (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
648
should use `set-frame-width' instead."
Jim Blandy's avatar
Jim Blandy committed
649 650 651 652 653 654
  (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
655

Jim Blandy's avatar
Jim Blandy committed
656 657

;;;; Key bindings
Jim Blandy's avatar
Jim Blandy committed
658
(defvar ctl-x-5-map (make-sparse-keymap)
Jim Blandy's avatar
Jim Blandy committed
659
  "Keymap for frame commands.")
660
(defalias 'ctl-x-5-prefix ctl-x-5-map)
Jim Blandy's avatar
Jim Blandy committed
661
(define-key ctl-x-map "5" 'ctl-x-5-prefix)
Jim Blandy's avatar
Jim Blandy committed
662

663
(define-key ctl-x-5-map "2" 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
664
(define-key ctl-x-5-map "0" 'delete-frame)
665
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
666

Jim Blandy's avatar
Jim Blandy committed
667
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
668

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