frame.el 27 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
(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.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
;; 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.
(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))))))
106 107

(setq special-display-function 'special-display-popup-frame)
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

;; 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)
      (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.
Jim Blandy's avatar
Jim Blandy 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

135 136 137 138 139
;; 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
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 ()
Jim Blandy's avatar
Jim Blandy committed
153 154 155
  
  ;; Are we actually running under a window system at all?
  (if (and window-system (not noninteractive))
156 157 158 159 160 161
      (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))
162
	    (progn
163 164
	      (setq frame-initial-frame-alist
		    (append initial-frame-alist default-frame-alist))
165 166 167 168 169 170 171 172 173 174
	      ;; 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)))
175 176
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
177
			  (make-frame initial-frame-alist)))
178 179 180 181
	      ;; 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.
182
	      (setq initial-frame-alist
183
		    (frame-remove-geometry-params initial-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
184 185 186 187
	;; 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
188 189
    
    ;; No, we're not running a window system.  Arrange to cause errors.
Jim Blandy's avatar
Jim Blandy committed
190
    (setq frame-creation-function
191 192 193
	  (function
	   (lambda (parameters)
	     (error
194
	      "Can't create multiple frames without a window system"))))))
Jim Blandy's avatar
Jim Blandy committed
195
					
196 197 198
;;; 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
199
(defun frame-notice-user-settings ()
200

201 202 203 204 205 206 207 208
  ;; 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))))

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
  ;; 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
226 227 228 229 230
	;; 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.
231 232 233 234 235
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
236 237 238 239 240 241 242 243 244
	    (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
245 246 247
				  default-frame-alist
				  (frame-parameters frame-initial-frame)
				  nil))
248 249 250 251
	      ;; 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)
252
		  (setq parms (frame-delete-all 'height parms)))
253
	      (if (assq 'width frame-initial-geometry-arguments)
254
		  (setq parms (frame-delete-all 'width parms)))
255
	      (if (assq 'left frame-initial-geometry-arguments)
256
		  (setq parms (frame-delete-all 'left parms)))
257
	      (if (assq 'top frame-initial-geometry-arguments)
258
		  (setq parms (frame-delete-all 'top parms)))
259 260 261 262 263
	      (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)))
264 265 266 267
	      ;; 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))
268
		  (make-frame (append minibuffer-frame-alist
269 270 271 272 273 274 275 276 277 278 279 280 281 282 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
				     '((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
309 310 311

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

314
	      ;; Finally, get rid of the old frame.
315
	      (delete-frame frame-initial-frame t))
316 317 318

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
319 320 321
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
322 323 324 325 326 327 328 329
	    (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)))
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
	    (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)))
347
	    (setq newparms (nreverse newparms))
348
	    (modify-frame-parameters frame-initial-frame
349 350 351
				     newparms)
	    (if (assq 'font newparms)
		(frame-update-faces frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
352

353 354 355 356
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

360 361 362
;; Delete from ALIST all elements whose car is KEY.
;; Return the modified alist.
(defun frame-delete-all (key alist)
363
  (setq alist (copy-sequence alist))
364 365 366 367 368 369
  (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
370

371
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
372

373
;;; Return some frame other than the current frame, creating one if
374
;;; necessary.  Note that the minibuffer frame, if separate, is not
375
;;; considered (see next-frame).
Jim Blandy's avatar
Jim Blandy committed
376
(defun get-other-frame ()
Jim Blandy's avatar
Jim Blandy committed
377
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
378
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
379
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
380 381
    s))

Jim Blandy's avatar
Jim Blandy committed
382 383
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
384 385 386 387 388
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
			      t)))

Jim Blandy's avatar
Jim Blandy committed
389 390
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394 395
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

396
;; Alias, kept temporarily.
397
(defalias 'new-frame 'make-frame)
398
(defun make-frame (&optional parameters)
Jim Blandy's avatar
Jim Blandy committed
399
  "Create a new frame, displaying the current buffer.
Jim Blandy's avatar
Jim Blandy committed
400

Jim Blandy's avatar
Jim Blandy committed
401
Optional argument PARAMETERS is an alist of parameters for the new
Jim Blandy's avatar
Jim Blandy committed
402
frame.  Specifically, PARAMETERS is a list of pairs, each having one
Jim Blandy's avatar
Jim Blandy committed
403 404
of the following forms:

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

407
\(height . NUMBER) - The frame should be NUMBER text lines high.  If
Jim Blandy's avatar
Jim Blandy committed
408 409 410
	this parameter is present, the width parameter must also be
	given.

411
\(width . NUMBER) - The frame should be NUMBER characters in width.
Jim Blandy's avatar
Jim Blandy committed
412 413 414
	If this parameter is present, the height parameter must also
	be given.

415
\(minibuffer . t) - the frame should have a minibuffer
Jim Blandy's avatar
Jim Blandy committed
416
\(minibuffer . nil) - the frame should have no minibuffer
417
\(minibuffer . only) - the frame should contain only a minibuffer
Richard M. Stallman's avatar
Richard M. Stallman committed
418
\(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window."
Jim Blandy's avatar
Jim Blandy committed
419
  (interactive)
420 421 422 423 424
  (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
425

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
(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)))))))

442 443 444
(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',
445
`height', `user-size' and `user-position' parameters.
446 447 448 449 450 451
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)))
452 453 454 455 456 457
	       (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))))
458
	(setq tail (cdr tail)))))
459 460
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
461 462 463
  (cdr param-list))


464
(defun other-frame (arg)
465
  "Select the ARG'th different visible frame, and raise it.
466 467 468 469 470 471
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)
472 473 474 475
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
476
    (while (< arg 0)
477 478 479
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
480
      (setq arg (1+ arg)))
481
    (raise-frame frame)
482
    (select-frame frame)
483
    (set-mouse-position (selected-frame) (1- (frame-width)) 0)
484
    (unfocus-frame)))
Jim Blandy's avatar
Jim Blandy committed
485

Jim Blandy's avatar
Jim Blandy committed
486 487 488 489
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
490 491 492 493 494 495 496 497 498 499 500 501 502
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
503

504
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
505 506
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
507
configuration, and other parameters set as specified in CONFIGURATION.
508 509
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
510
is given and non-nil, the unwanted frames are iconified instead."
511 512 513 514 515
  (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
516
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
517
	     (lambda (frame)
518
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
519 520
		 (if parameters
		     (progn
521 522 523 524 525 526 527 528
		       (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
529
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
530 531
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
532
    (if nodelete
533 534 535 536 537
	;; 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)
538
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
539

540 541 542 543 544 545 546
(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
547

Jim Blandy's avatar
Jim Blandy committed
548 549
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
550

Jim Blandy's avatar
Jim Blandy committed
551
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
552 553
  "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
554
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
555 556 557 558

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

Jim Blandy's avatar
Jim Blandy committed
561
(defun set-default-font (font-name)
562 563
  "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
564
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
565
  (modify-frame-parameters (selected-frame)
566 567 568
			   (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
569

570
(defun set-background-color (color-name)
571 572
  "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
573
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
574
  (modify-frame-parameters (selected-frame)
575
			   (list (cons 'background-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
576

577
(defun set-foreground-color (color-name)
578 579
  "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
580
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
581
  (modify-frame-parameters (selected-frame)
582
			   (list (cons 'foreground-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
583 584

(defun set-cursor-color (color-name)
585 586
  "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
587
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
588
  (modify-frame-parameters (selected-frame)
589
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
590

591
(defun set-mouse-color (color-name)
592 593
  "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
594
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
595
  (modify-frame-parameters (selected-frame)
596 597
			   (list (cons 'mouse-color color-name))))

598 599 600 601 602 603 604 605
(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)
606
  "Toggle whether or not the selected frame should auto-raise.
607 608 609 610 611
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."
612 613 614 615 616
  (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
617
  (modify-frame-parameters (selected-frame)
618 619
			   (list (cons 'auto-raise (> arg 0)))))

620
(defun auto-lower-mode (arg)
621
  "Toggle whether or not the selected frame should auto-lower.
622 623 624 625 626
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."
627 628 629 630 631
  (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
632
  (modify-frame-parameters (selected-frame)
633 634
			   (list (cons 'auto-lower (> arg 0)))))

635
(defun toggle-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
636 637
  "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."
638 639 640
  (interactive "P")
  (if (null arg)
      (setq arg
Jim Blandy's avatar
Jim Blandy committed
641
	    (if (cdr (assq 'vertical-scroll-bars
642 643
			   (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
644
  (modify-frame-parameters (selected-frame)
Jim Blandy's avatar
Jim Blandy committed
645
			   (list (cons 'vertical-scroll-bars (> arg 0)))))
646

647
(defun toggle-horizontal-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
648 649 650
  "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."
651
  (interactive "P")
652
  (error "Horizontal scroll bars aren't implemented yet"))
Jim Blandy's avatar
Jim Blandy committed
653

Jim Blandy's avatar
Jim Blandy committed
654 655

;;;; Aliases for backward compatibility with Emacs 18.
656 657
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662 663

(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
664
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
665 666 667 668 669 670 671
  (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
672
should use `set-frame-width' instead."
Jim Blandy's avatar
Jim Blandy committed
673 674 675 676 677 678
  (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
679

Jim Blandy's avatar
Jim Blandy committed
680 681

;;;; Key bindings
Jim Blandy's avatar
Jim Blandy committed
682
(defvar ctl-x-5-map (make-sparse-keymap)
Jim Blandy's avatar
Jim Blandy committed
683
  "Keymap for frame commands.")
684
(defalias 'ctl-x-5-prefix ctl-x-5-map)
Jim Blandy's avatar
Jim Blandy committed
685
(define-key ctl-x-map "5" 'ctl-x-5-prefix)
Jim Blandy's avatar
Jim Blandy committed
686

687
(define-key ctl-x-5-map "2" 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
688
(define-key ctl-x-5-map "0" 'delete-frame)
689
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
690

Jim Blandy's avatar
Jim Blandy committed
691
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
692

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