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

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
46
take effect until Emacs reads `.emacs', which happens after first creating
47 48 49 50 51 52 53
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

Karl Heuer's avatar
Karl Heuer committed
74
(defvar special-display-frame-alist
75 76 77 78 79 80 81 82 83 84 85 86
  '((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
;; If ARGS is an alist, use it as a list of frame parameter specs.
Karl Heuer's avatar
Karl Heuer committed
88
;; If ARGS is a list whose car is a symbol,
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
;; 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 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)
      (kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
121

Jim Blandy's avatar
Jim Blandy committed
122
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
123 124 125

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

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

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

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

145 146
(defvar frame-initial-geometry-arguments nil)

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

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

158 159 160 161 162
	;; 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))
163
	    (progn
164 165
	      (setq frame-initial-frame-alist
		    (append initial-frame-alist default-frame-alist))
166 167 168 169 170 171 172 173 174 175
	      ;; 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)))
176 177
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
178
			  (make-frame initial-frame-alist)))
179 180 181 182
	      ;; 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.
183
	      (setq initial-frame-alist
184
		    (frame-remove-geometry-params initial-frame-alist))))
Karl Heuer's avatar
Karl Heuer committed
185
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
186 187 188
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Karl Heuer's avatar
Karl Heuer committed
189

190 191
    ;; No, we're not running a window system.  Use make-terminal-frame if
    ;; we support that feature, otherwise arrange to cause errors.
Jim Blandy's avatar
Jim Blandy committed
192
    (setq frame-creation-function
193 194 195 196 197 198
	  (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
199

200 201 202
;;; 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
203
(defun frame-notice-user-settings ()
204

205 206 207 208 209 210 211 212
  ;; 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))))

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
  ;; 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
230 231 232 233 234
	;; 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.
235 236 237 238 239
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
240 241 242 243 244 245 246 247 248
	    (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
249 250 251
				  default-frame-alist
				  (frame-parameters frame-initial-frame)
				  nil))
252 253 254 255
	      ;; 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)
256
		  (setq parms (frame-delete-all 'height parms)))
257
	      (if (assq 'width frame-initial-geometry-arguments)
258
		  (setq parms (frame-delete-all 'width parms)))
259
	      (if (assq 'left frame-initial-geometry-arguments)
260
		  (setq parms (frame-delete-all 'left parms)))
261
	      (if (assq 'top frame-initial-geometry-arguments)
262
		  (setq parms (frame-delete-all 'top parms)))
263 264 265 266
	      (setq new
		    (make-frame
		     ;; Use the geometry args that created the existing
		     ;; frame, rather than the parms we get for it.
267 268 269
		     (append frame-initial-geometry-arguments
			     '((user-size . t) (user-position . t))
			     parms)))
270 271 272 273
	      ;; 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))
274
		  (make-frame (append minibuffer-frame-alist
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 309 310 311 312 313 314
				     '((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
315 316 317

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

320
	      ;; Finally, get rid of the old frame.
321
	      (delete-frame frame-initial-frame t))
322 323 324

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
325 326 327
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
328 329 330 331 332 333 334 335
	    (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)))
336 337 338 339 340 341 342 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)
		(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)))
353
	    (setq newparms (nreverse newparms))
354
	    (modify-frame-parameters frame-initial-frame
355 356 357
				     newparms)
	    (if (assq 'font newparms)
		(frame-update-faces frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
358

359 360 361 362
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

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

379
;;; Return some frame other than the current frame, creating one if
380
;;; necessary.  Note that the minibuffer frame, if separate, is not
381
;;; considered (see next-frame).
Jim Blandy's avatar
Jim Blandy committed
382
(defun get-other-frame ()
Jim Blandy's avatar
Jim Blandy committed
383
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
384
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
385
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
386 387
    s))

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

Jim Blandy's avatar
Jim Blandy committed
395 396
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
397 398 399 400 401
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

402 403 404 405 406 407
(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)))

408
;; Alias, kept temporarily.
409
(defalias 'new-frame 'make-frame)
410
(defun make-frame (&optional parameters)
Jim Blandy's avatar
Jim Blandy committed
411
  "Create a new frame, displaying the current buffer.
Jim Blandy's avatar
Jim Blandy committed
412

Jim Blandy's avatar
Jim Blandy committed
413
Optional argument PARAMETERS is an alist of parameters for the new
Richard M. Stallman's avatar
Richard M. Stallman committed
414 415 416 417
frame.  Specifically, PARAMETERS is a list of pairs, each having
the form (NAME . VALUE).

Here are some of the parameters allowed (not a complete list):
Jim Blandy's avatar
Jim Blandy committed
418

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

421
\(height . NUMBER) - The frame should be NUMBER text lines high.  If
Jim Blandy's avatar
Jim Blandy committed
422 423 424
	this parameter is present, the width parameter must also be
	given.

425
\(width . NUMBER) - The frame should be NUMBER characters in width.
Jim Blandy's avatar
Jim Blandy committed
426 427 428
	If this parameter is present, the height parameter must also
	be given.

429
\(minibuffer . t) - the frame should have a minibuffer
Jim Blandy's avatar
Jim Blandy committed
430
\(minibuffer . nil) - the frame should have no minibuffer
431
\(minibuffer . only) - the frame should contain only a minibuffer
Richard M. Stallman's avatar
Richard M. Stallman committed
432
\(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window."
Jim Blandy's avatar
Jim Blandy committed
433
  (interactive)
434 435 436 437 438
  (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
439

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
(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)))))))

456 457 458
(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',
459
`height', `user-size' and `user-position' parameters.
460 461 462 463 464 465
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)))
466 467 468 469 470 471
	       (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))))
472
	(setq tail (cdr tail)))))
473 474
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
475 476 477
  (cdr param-list))


478
(defun other-frame (arg)
479
  "Select the ARG'th different visible frame, and raise it.
480 481 482 483 484 485
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)
486 487 488 489
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
490
    (while (< arg 0)
491 492 493
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
494
      (setq arg (1+ arg)))
495
    (raise-frame frame)
496
    (select-frame frame)
497
    (set-mouse-position (selected-frame) (1- (frame-width)) 0)
498
    (unfocus-frame)))
Jim Blandy's avatar
Jim Blandy committed
499

Jim Blandy's avatar
Jim Blandy committed
500 501 502 503
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
504 505 506 507 508 509 510 511 512 513 514 515 516
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
517

518
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
519 520
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
521
configuration, and other parameters set as specified in CONFIGURATION.
522 523
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
524
is given and non-nil, the unwanted frames are iconified instead."
525 526 527 528 529
  (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
530
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
531
	     (lambda (frame)
532
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
533 534
		 (if parameters
		     (progn
535 536
		       (modify-frame-parameters
			frame
Karl Heuer's avatar
Karl Heuer committed
537
			;; Since we can't set a frame's minibuffer status,
538 539 540 541 542
			;; 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
543
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
544 545
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
546
    (if nodelete
547 548 549 550 551
	;; 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)
552
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
553

554 555 556 557 558 559 560
(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
561

Jim Blandy's avatar
Jim Blandy committed
562 563
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
564

Jim Blandy's avatar
Jim Blandy committed
565
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
566 567
  "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
568
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
569 570 571 572

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

Jim Blandy's avatar
Jim Blandy committed
575
(defun set-default-font (font-name)
576 577
  "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
578
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
579
  (modify-frame-parameters (selected-frame)
580 581 582
			   (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
583

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

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

(defun set-cursor-color (color-name)
601 602
  "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
603
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
604
  (modify-frame-parameters (selected-frame)
605
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
606

607
(defun set-mouse-color (color-name)
608 609
  "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
610
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
611
  (modify-frame-parameters (selected-frame)
612 613
			   (list (cons 'mouse-color color-name))))

614 615 616 617 618 619 620 621
(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)
622
  "Toggle whether or not the selected frame should auto-raise.
623 624 625 626 627
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."
628 629 630 631 632
  (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
633
  (modify-frame-parameters (selected-frame)
634 635
			   (list (cons 'auto-raise (> arg 0)))))

636
(defun auto-lower-mode (arg)
637
  "Toggle whether or not the selected frame should auto-lower.
638 639 640 641 642
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."
643 644 645 646 647
  (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
648
  (modify-frame-parameters (selected-frame)
649 650
			   (list (cons 'auto-lower (> arg 0)))))

651
(defun toggle-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
652 653
  "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."
654 655 656
  (interactive "P")
  (if (null arg)
      (setq arg
Jim Blandy's avatar
Jim Blandy committed
657
	    (if (cdr (assq 'vertical-scroll-bars
658 659
			   (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
660
  (modify-frame-parameters (selected-frame)
Jim Blandy's avatar
Jim Blandy committed
661
			   (list (cons 'vertical-scroll-bars (> arg 0)))))
662

663
(defun toggle-horizontal-scroll-bar (arg)
Jim Blandy's avatar
Jim Blandy committed
664 665 666
  "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."
667
  (interactive "P")
668
  (error "Horizontal scroll bars aren't implemented yet"))
Jim Blandy's avatar
Jim Blandy committed
669

Jim Blandy's avatar
Jim Blandy committed
670 671

;;;; Aliases for backward compatibility with Emacs 18.
672 673
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
674 675 676 677 678 679

(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
680
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
681 682 683 684 685 686 687
  (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
688
should use `set-frame-width' instead."
Jim Blandy's avatar
Jim Blandy committed
689 690 691 692 693 694
  (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
695

Jim Blandy's avatar
Jim Blandy committed
696 697

;;;; Key bindings
Jim Blandy's avatar
Jim Blandy committed
698
(defvar ctl-x-5-map (make-sparse-keymap)
Jim Blandy's avatar
Jim Blandy committed
699
  "Keymap for frame commands.")
700
(defalias 'ctl-x-5-prefix ctl-x-5-map)
Jim Blandy's avatar
Jim Blandy committed
701
(define-key ctl-x-map "5" 'ctl-x-5-prefix)
Jim Blandy's avatar
Jim Blandy committed
702

703
(define-key ctl-x-5-map "2" 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
704
(define-key ctl-x-5-map "0" 'delete-frame)
705
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
706

Jim Blandy's avatar
Jim Blandy committed
707
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
708

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