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

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

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

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

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

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

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

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

32 33 34
;;; The initial value given here for used to ask for a minibuffer.
;;; But that's not necessary, because the default is to have one.
;;; By not specifying it here, we let an X resource specify it.
35
(defcustom initial-frame-alist nil
36 37
  "Alist of frame parameters for creating the initial X window frame.
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
38
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
39 40 41 42
Parameters specified here supersede the values given in `default-frame-alist'.

If the value calls for a frame without a minibuffer, and you have not created
a minibuffer frame on your own, one is created according to
43
`minibuffer-frame-alist'.
44 45 46

You can specify geometry-related options for just the initial frame
by setting this variable in your `.emacs' file; however, they won't
Karl Heuer's avatar
Karl Heuer committed
47
take effect until Emacs reads `.emacs', which happens after first creating
48 49 50 51 52 53
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,
54 55 56 57 58
  to override what you put in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
59

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

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

Jim Blandy's avatar
Jim Blandy committed
75
(setq pop-up-frame-function
Jim Blandy's avatar
Jim Blandy committed
76
      (function (lambda ()
77
		  (make-frame pop-up-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
78

Richard M. Stallman's avatar
Richard M. Stallman committed
79
(defcustom special-display-frame-alist
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)))
Richard M. Stallman's avatar
Richard M. Stallman committed
87 88 89 90 91
These supersede the values given in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
			 (symbol :tag "Parameter")
			 (sexp :tag "Value")))
  :group 'frames)
92 93 94 95

;; 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.
96
;; If ARGS is an alist, use it as a list of frame parameter specs.
Karl Heuer's avatar
Karl Heuer committed
97
;; If ARGS is a list whose car is a symbol,
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
;; 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))))))
115

116 117 118 119 120 121 122 123 124 125 126 127 128
;; 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)
129 130
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
131

Jim Blandy's avatar
Jim Blandy committed
132
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
133 134 135

;;; 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
136
;;; file should create any frames specified in the window system defaults.
Karl Heuer's avatar
Karl Heuer committed
137
;;;
Jim Blandy's avatar
Jim Blandy committed
138
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
139 140
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
141
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
142

Karl Heuer's avatar
Karl Heuer committed
143
;; These are now called explicitly at the proper times,
144 145 146 147
;; 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
148

Jim Blandy's avatar
Jim Blandy committed
149 150
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
151

152 153 154
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

155 156
(defvar frame-initial-geometry-arguments nil)

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

Jim Blandy's avatar
Jim Blandy committed
162
  ;; Are we actually running under a window system at all?
163
  (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
164
      (progn
165 166 167
	;; Turn on special-display processing only if there's a window system.
	(setq special-display-function 'special-display-popup-frame)

168 169 170 171 172
	;; 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))
173
	    (progn
174 175
	      (setq frame-initial-frame-alist
		    (append initial-frame-alist default-frame-alist))
176 177 178 179
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
180 181
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
182
			  (make-frame frame-initial-frame-alist)))
183 184 185 186
	      ;; 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.
187
	      (setq initial-frame-alist
188
		    (frame-remove-geometry-params initial-frame-alist))))
Karl Heuer's avatar
Karl Heuer committed
189
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
190 191 192
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Karl Heuer's avatar
Karl Heuer committed
193

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

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

210
  ;; Make menu-bar-mode and default-frame-alist consistent.
211 212 213 214 215 216 217
  (if (boundp 'menu-bar-mode)
      (let ((default (assq 'menu-bar-lines default-frame-alist)))
	(if default
	    (setq menu-bar-mode (not (eq (cdr default) 0)))
	  (setq default-frame-alist
		(cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
		      default-frame-alist)))))
218

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

	      ;; 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
324 325 326

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

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

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
334 335 336
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
337 338 339 340 341 342 343 344
	    (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)))
345 346 347 348 349 350 351 352 353 354
	    (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)
355 356
		(setq oldval (assq (car (car tail))
				   frame-initial-frame-alist))
357
		(setq newval (cdr (assq (car (car tail)) allparms)))
358
		(or (and oldval (eq (cdr oldval) newval))
359 360 361
		    (setq newparms
			  (cons (cons (car (car tail)) newval) newparms))))
	      (setq tail (cdr tail)))
362
	    (setq newparms (nreverse newparms))
363
	    (modify-frame-parameters frame-initial-frame
364 365 366
				     newparms)
	    (if (assq 'font newparms)
		(frame-update-faces frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
367

368 369 370 371
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

375 376 377 378 379 380
(defun make-initial-minibuffer-frame (display)
  (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
    (if display
	(make-frame-on-display display parms)
      (make-frame parms))))

381 382 383
;; Delete from ALIST all elements whose car is KEY.
;; Return the modified alist.
(defun frame-delete-all (key alist)
384
  (setq alist (copy-sequence alist))
385 386 387 388 389 390
  (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
391

392
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
393

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

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

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

417 418 419 420
(defun make-frame-on-display (display &optional parameters)
  "Make a frame on display DISPLAY.
The optional second argument PARAMETERS specifies additional frame parameters."
  (interactive "sMake frame on display: ")
421 422
  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
423 424
  (make-frame (cons (cons 'display display) parameters)))

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

432 433 434 435 436 437 438
(defvar before-make-frame-hook nil
  "Functions to run before a frame is created.")

(defvar after-make-frame-functions nil
  "Functions to run after a frame is created.
The functions are run with one arg, the newly created frame.")

439
;; Alias, kept temporarily.
440
(defalias 'new-frame 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
441

442 443 444 445
(defun make-frame (&optional parameters)
  "Return a newly created frame displaying the current buffer.
Optional argument PARAMETERS is an alist of parameters for the new frame.
Each element of PARAMETERS should have the form (NAME . VALUE), for example:
Richard M. Stallman's avatar
Richard M. Stallman committed
446

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

449 450
 (width . NUMBER)	The frame should be NUMBER characters in width.
 (height . NUMBER)	The frame should be NUMBER text lines high.
Jim Blandy's avatar
Jim Blandy committed
451

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

454 455 456 457
 (minibuffer . t)	The frame should have a minibuffer.
 (minibuffer . nil)	The frame should have no minibuffer.
 (minibuffer . only)	The frame should contain only a minibuffer.
 (minibuffer . WINDOW)	The frame should use WINDOW as its minibuffer window.
Jim Blandy's avatar
Jim Blandy committed
458

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

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
(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)))))))

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


506 507 508
(defcustom focus-follows-mouse t
  "*Non-nil if window system changes focus when you move the mouse."
  :type 'boolean
Dan Nicolaescu's avatar
Dan Nicolaescu committed
509 510
  :group 'frames
  :version "20.3")
511

512
(defun other-frame (arg)
513
  "Select the ARG'th different visible frame, and raise it.
514 515 516 517 518 519
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)
520 521 522 523
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
524
    (while (< arg 0)
525 526 527
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
528
      (setq arg (1+ arg)))
529
    (raise-frame frame)
530
    (select-frame frame)
531 532 533
    ;; Ensure, if possible, that frame gets input focus.
    (if (eq window-system 'w32)
	(w32-focus-frame frame)
534
      (when focus-follows-mouse
535
	(set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553

(defun make-frame-names-alist ()
  (let* ((current-frame (selected-frame))
	 (falist
	  (cons
	   (cons (frame-parameter current-frame 'name) current-frame) nil))
	 (frame (next-frame nil t)))
    (while (not (eq frame current-frame))
      (progn
	(setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
	(setq frame (next-frame frame t))))
    falist))

(defvar frame-name-history nil)
(defun select-frame-by-name (name)
  "Select the frame whose name is NAME and raise it.
If there is no frame by that name, signal an error."
  (interactive
554 555 556 557 558
   (let* ((frame-names-alist (make-frame-names-alist))
	   (default (car (car frame-names-alist)))
	   (input (completing-read
		   (format "Select Frame (default %s): " default)
		   frame-names-alist nil t nil 'frame-name-history)))
559 560 561
     (if (= (length input) 0)
	 (list default)
       (list input))))
562 563
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
564 565 566 567
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
568 569 570 571 572 573
    (select-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
    (if (eq window-system 'w32)
	(w32-focus-frame frame)
      (when focus-follows-mouse
	(set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
Jim Blandy's avatar
Jim Blandy committed
574

Jim Blandy's avatar
Jim Blandy committed
575 576 577 578
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
579 580 581 582 583 584 585 586 587 588 589 590 591
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
592

593
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
594 595
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
596
configuration, and other parameters set as specified in CONFIGURATION.
597 598
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
599
is given and non-nil, the unwanted frames are iconified instead."
600 601 602 603 604
  (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
605
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
606
	     (lambda (frame)
607
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
608 609
		 (if parameters
		     (progn
610 611
		       (modify-frame-parameters
			frame
Karl Heuer's avatar
Karl Heuer committed
612
			;; Since we can't set a frame's minibuffer status,
613 614 615 616 617
			;; 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
618
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
619 620
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
621
    (if nodelete
622 623 624 625 626
	;; 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)
627
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
628

Jim Blandy's avatar
Jim Blandy committed
629 630
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
631

632
(defun frame-parameter (frame parameter)
633
  "Return FRAME's value for parameter PARAMETER.
634
If FRAME is nil, describe the currently selected frame."
635
  (cdr (assq parameter (frame-parameters frame))))
636

Jim Blandy's avatar
Jim Blandy committed
637
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
638 639
  "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
640
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
641 642 643 644

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

647 648
(defalias 'set-default-font 'set-frame-font)
(defun set-frame-font (font-name)
649
  "Set the font of the selected frame to FONT.
Richard M. Stallman's avatar
Richard M. Stallman committed
650 651
When called interactively, prompt for the name of the font to use.
To get the frame's current default font, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
652
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
653
  (modify-frame-parameters (selected-frame)
654 655 656
			   (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
657

658
(defun set-background-color (color-name)
659
  "Set the background color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
660 661
When called interactively, prompt for the name of the color to use.
To get the frame's current background color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
662
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
663
  (modify-frame-parameters (selected-frame)
664 665
			   (list (cons 'background-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
666

667
(defun set-foreground-color (color-name)
668
  "Set the foreground color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
669 670
When called interactively, prompt for the name of the color to use.
To get the frame's current foreground color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
671
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
672
  (modify-frame-parameters (selected-frame)
673 674
			   (list (cons 'foreground-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
675 676

(defun set-cursor-color (color-name)
677
  "Set the text cursor color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
678 679
When called interactively, prompt for the name of the color to use.
To get the frame's current cursor color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
680
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
681
  (modify-frame-parameters (selected-frame)
682
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
683

684
(defun set-mouse-color (color-name)
685
  "Set the color of the mouse pointer of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
686 687
When called interactively, prompt for the name of the color to use.
To get the frame's current mouse color, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
688
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
689
  (modify-frame-parameters (selected-frame)
690 691
			   (list (cons 'mouse-color color-name))))

692 693
(defun set-border-color (color-name)
  "Set the color of the border of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
694 695
When called interactively, prompt for the name of the color to use.
To get the frame's current border color, use `frame-parameters'."
696 697 698 699 700
  (interactive "sColor: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
701
  "Toggle whether or not the selected frame should auto-raise.
702 703 704 705 706
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."
707 708 709 710 711
  (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
712
  (modify-frame-parameters (selected-frame)
713 714
			   (list (cons 'auto-raise (> arg 0)))))

715
(defun auto-lower-mode (arg)
716
  "Toggle whether or not the selected frame should auto-lower.
717 718 719 720 721
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."
722 723 724 725 726
  (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
727
  (modify-frame-parameters (selected-frame)
728
			   (list (cons 'auto-lower (> arg 0)))))
729 730 731 732 733 734 735 736
(defun set-frame-name (name)
  "Set the name of the selected frame to NAME.
When called interactively, prompt for the name of the frame.
The frame name is displayed on the modeline if the terminal displays only
one frame, otherwise the name is displayed on the frame's caption bar."
  (interactive "sFrame name: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'name name))))
Jim Blandy's avatar
Jim Blandy committed
737 738

;;;; Aliases for backward compatibility with Emacs 18.
739 740
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
741 742 743 744 745 746

(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
747
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751 752 753 754
  (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\
755
should use `set-frame-height' instead."
Jim Blandy's avatar
Jim Blandy committed
756 757 758 759 760 761
  (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
762

Jim Blandy's avatar
Jim Blandy committed
763 764 765

;;;; Key bindings

766
(define-key ctl-x-5-map "2" 'make-frame-command)
Jim Blandy's avatar
Jim Blandy committed
767
(define-key ctl-x-5-map "0" 'delete-frame)
768
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
769

Jim Blandy's avatar
Jim Blandy committed
770
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
771

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