frame.el 34 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
  "*Alist of frame parameters for creating the initial X window frame.
37
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 61
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  "*Alist of frame parameters for initially creating a minibuffer frame.
62
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
Parameters specified here supersede the values given in
66 67 68 69 70
`default-frame-alist', for a minibuffer frame."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
71

72 73
(defcustom pop-up-frame-alist nil
  "*Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
74
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
75
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
76
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
77 78 79 80 81 82
These supersede the values given in `default-frame-alist',
for pop-up frames."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
83

Jim Blandy's avatar
Jim Blandy committed
84
(setq pop-up-frame-function
Jim Blandy's avatar
Jim Blandy committed
85
      (function (lambda ()
86
		  (make-frame pop-up-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
87

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

;; 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.
105
;; If ARGS is an alist, use it as a list of frame parameter specs.
Karl Heuer's avatar
Karl Heuer committed
106
;; If ARGS is a list whose car is a symbol,
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
;; 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))))))
124

125 126 127 128 129 130 131 132 133 134 135 136 137
;; 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)
138 139
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
140

Jim Blandy's avatar
Jim Blandy committed
141
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
142 143 144

;;; 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
145
;;; file should create any frames specified in the window system defaults.
Karl Heuer's avatar
Karl Heuer committed
146
;;;
Jim Blandy's avatar
Jim Blandy committed
147
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
148 149
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
150
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
151

Karl Heuer's avatar
Karl Heuer committed
152
;; These are now called explicitly at the proper times,
153 154 155 156
;; 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
157

Jim Blandy's avatar
Jim Blandy committed
158 159
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
160

161 162 163
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

164 165
(defvar frame-initial-geometry-arguments nil)

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

Jim Blandy's avatar
Jim Blandy committed
171
  ;; Are we actually running under a window system at all?
172
  (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
173
      (progn
174 175 176
	;; Turn on special-display processing only if there's a window system.
	(setq special-display-function 'special-display-popup-frame)

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

203 204
    ;; No, we're not running a window system.  Use make-terminal-frame if
    ;; we support that feature, otherwise arrange to cause errors.
205 206
    (or (eq window-system 'pc)
	(setq frame-creation-function
207 208
	      (if (fboundp 'tty-create-frame-with-faces)
		  'tty-create-frame-with-faces
209 210 211 212
		(function
		 (lambda (parameters)
		   (error
		    "Can't create multiple frames without a window system"))))))))
Karl Heuer's avatar
Karl Heuer committed
213

214 215 216
;;; 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
217
(defun frame-notice-user-settings ()
218

219
  ;; Make menu-bar-mode and default-frame-alist consistent.
220 221 222 223 224 225 226
  (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)))))
227

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
  ;; 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
245 246 247 248 249
	;; 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.
250 251 252 253 254
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
255 256 257 258 259 260 261 262
	    (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))
263 264 265 266
	      (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)))
267
	      (setq parms (append initial-frame-alist
268
				  default-frame-alist
269
				  parms
270
				  nil))
271 272 273 274
	      ;; 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)
275
		  (setq parms (frame-delete-all 'height parms)))
276
	      (if (assq 'width frame-initial-geometry-arguments)
277
		  (setq parms (frame-delete-all 'width parms)))
278
	      (if (assq 'left frame-initial-geometry-arguments)
279
		  (setq parms (frame-delete-all 'left parms)))
280
	      (if (assq 'top frame-initial-geometry-arguments)
281
		  (setq parms (frame-delete-all 'top parms)))
282 283 284 285
	      (setq new
		    (make-frame
		     ;; Use the geometry args that created the existing
		     ;; frame, rather than the parms we get for it.
286 287 288
		     (append frame-initial-geometry-arguments
			     '((user-size . t) (user-position . t))
			     parms)))
289 290 291 292
	      ;; 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))
293
		  (make-initial-minibuffer-frame nil))
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 324 325 326 327 328 329 330 331 332

	      ;; 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
333 334 335

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

338
	      ;; Finally, get rid of the old frame.
339
	      (delete-frame frame-initial-frame t))
340 341 342

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

377 378 379 380
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

384 385 386 387 388 389
(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))))

390 391 392
;; Delete from ALIST all elements whose car is KEY.
;; Return the modified alist.
(defun frame-delete-all (key alist)
393
  (setq alist (copy-sequence alist))
394 395 396 397 398 399
  (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
400

401
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
402

403
;;; Return some frame other than the current frame, creating one if
404
;;; necessary.  Note that the minibuffer frame, if separate, is not
405
;;; considered (see next-frame).
Jim Blandy's avatar
Jim Blandy committed
406
(defun get-other-frame ()
Jim Blandy's avatar
Jim Blandy committed
407
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
408
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
409
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
410 411
    s))

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

Jim Blandy's avatar
Jim Blandy committed
419 420
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
421 422 423 424 425
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

426 427 428 429
(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: ")
430 431
  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
432 433
  (make-frame (cons (cons 'display display) parameters)))

434 435 436
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
437
  (if (and window-system (not (eq window-system 'pc)))
438 439 440
      (make-frame)
    (select-frame (make-frame))))

441 442 443 444 445 446 447
(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.")

448 449 450
(defvar after-setting-font-hooks nil
  "Functions to run after a frame's font has been changed.")

451
;; Alias, kept temporarily.
452
(defalias 'new-frame 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
453

454 455 456 457
(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
458

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

461 462
 (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
463

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

466 467 468 469
 (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
470

471 472 473
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
474
  (interactive)
475 476 477 478
  (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
479

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
(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)))))))

496 497 498
(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',
499
`height', `user-size' and `user-position' parameters.
500 501 502 503 504 505
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)))
506 507 508 509 510 511
	       (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))))
512
	(setq tail (cdr tail)))))
513 514
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
515 516 517
  (cdr param-list))


518 519 520
(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
521 522
  :group 'frames
  :version "20.3")
523

524
(defun other-frame (arg)
525
  "Select the ARG'th different visible frame, and raise it.
526 527 528 529 530 531
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)
532 533 534 535
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
536
    (while (< arg 0)
537 538 539
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
540
      (setq arg (1+ arg)))
541
    (raise-frame frame)
542
    (select-frame frame)
543 544 545
    ;; Ensure, if possible, that frame gets input focus.
    (if (eq window-system 'w32)
	(w32-focus-frame frame)
546
      (when focus-follows-mouse
547
	(set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

(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
566 567 568 569 570
   (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)))
571 572 573
     (if (= (length input) 0)
	 (list default)
       (list input))))
574 575
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
576 577 578 579
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
580 581 582 583 584 585
    (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
586

Jim Blandy's avatar
Jim Blandy committed
587 588 589 590
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
591 592 593 594 595 596 597 598 599 600 601 602 603
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
604

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

644
(defun frame-parameter (frame parameter)
645
  "Return FRAME's value for parameter PARAMETER.
646
If FRAME is nil, describe the currently selected frame."
647
  (cdr (assq parameter (frame-parameters frame))))
648

Jim Blandy's avatar
Jim Blandy committed
649
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
650 651
  "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
652
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
653 654 655 656

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

659 660
(defalias 'set-default-font 'set-frame-font)
(defun set-frame-font (font-name)
661
  "Set the font of the selected frame to FONT.
Richard M. Stallman's avatar
Richard M. Stallman committed
662 663
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
664
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
665
  (modify-frame-parameters (selected-frame)
666 667
			   (list (cons 'font font-name)))
  ;; Update faces that want a bold or italic version of the default font.
668 669
  (frame-update-faces (selected-frame))
  (run-hooks 'after-setting-font-hooks))
Jim Blandy's avatar
Jim Blandy committed
670

671
(defun set-background-color (color-name)
672
  "Set the background color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
673 674
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
675
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
676
  (modify-frame-parameters (selected-frame)
677 678
			   (list (cons 'background-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
679

680
(defun set-foreground-color (color-name)
681
  "Set the foreground color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
682 683
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
684
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
685
  (modify-frame-parameters (selected-frame)
686 687
			   (list (cons 'foreground-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
688 689

(defun set-cursor-color (color-name)
690
  "Set the text cursor color of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
691 692
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
693
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
694
  (modify-frame-parameters (selected-frame)
695
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
696

697
(defun set-mouse-color (color-name)
698
  "Set the color of the mouse pointer of the selected frame to COLOR.
Richard M. Stallman's avatar
Richard M. Stallman committed
699 700
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
701
  (interactive "sColor: ")
Jim Blandy's avatar
Jim Blandy committed
702
  (modify-frame-parameters (selected-frame)
703 704 705 706
			   (list (cons 'mouse-color
				       (or color-name
					   (cdr (assq 'mouse-color
						      (frame-parameters))))))))
707

708 709
(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
710 711
When called interactively, prompt for the name of the color to use.
To get the frame's current border color, use `frame-parameters'."
712 713 714 715 716
  (interactive "sColor: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
717
  "Toggle whether or not the selected frame should auto-raise.
718 719 720 721 722
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."
723 724 725 726 727
  (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
728
  (modify-frame-parameters (selected-frame)
729 730
			   (list (cons 'auto-raise (> arg 0)))))

731
(defun auto-lower-mode (arg)
732
  "Toggle whether or not the selected frame should auto-lower.
733 734 735 736 737
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."
738 739 740 741 742
  (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
743
  (modify-frame-parameters (selected-frame)
744
			   (list (cons 'auto-lower (> arg 0)))))
745 746 747 748 749 750 751 752
(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
753 754

;;;; Aliases for backward compatibility with Emacs 18.
755 756
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
757 758 759 760 761 762

(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
763
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
764 765 766 767 768 769 770
  (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\
771
should use `set-frame-height' instead."
Jim Blandy's avatar
Jim Blandy committed
772 773 774 775 776 777
  (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
778

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891

;;; Highlighting trailing whitespace.

(make-variable-buffer-local 'show-trailing-whitespace)

(defcustom show-trailing-whitespace nil
  "*Non-nil means highlight trailing whitespace in face `trailing-whitespace'."
  :tag "Highlight trailing whitespace."
  :set #'(lambda (symbol value) (set-default symbol value))
  :type 'boolean
  :group 'font-lock)



;;; Blinking cursor

(defgroup cursor nil
  "Cursor on frames."
  :group 'frames)

(defcustom blink-cursor-delay 0.5
  "*Seconds of Emacs idle time after which cursor starts to blink."
  :tag "Delay in seconds."
  :type 'number
  :group 'cursor)

(defcustom blink-cursor-interval 0.5
  "*Length of cursor blink interval in seconds."
  :tag "Blink interval in seconds."
  :type 'number
  :group 'cursor)

(defvar blink-cursor-idle-timer nil
  "Timer started after blink-cursor-delay seconds of Emacs idle time.
The function blink-cursor-start is called when the timer fires.")

(defvar blink-cursor-timer nil
  "Time started from blink-cursor-start.  This timer calls blink-cursor
every blink-cursor-interval seconds.")

(defvar blink-cursor-mode nil
  "Non-nil means blinking cursor is active.")

(defun blink-cursor-mode (arg)
  "Toggle blinking cursor mode.
With arg, turn blinking cursor mode on iff arg is positive.
When blinking cursor mode is enabled, the cursor of the selected
window blinks."
  (interactive "P")
  (let ((on-p (if (null arg)
		  (not blink-cursor-mode)
		(> (prefix-numeric-value arg) 0))))
    (if blink-cursor-idle-timer
	(cancel-timer blink-cursor-idle-timer))
    (if blink-cursor-timer
	(cancel-timer blink-cursor-timer))
    (setq blink-cursor-idle-timer nil
	  blink-cursor-timer nil
	  blink-cursor-mode nil)
    (if on-p
	(progn
	  ;; Hide the cursor.
	  (show-cursor 0)
	  (setq blink-cursor-idle-timer
		(run-with-idle-timer blink-cursor-delay
				     blink-cursor-delay
				     'blink-cursor-start))
	  (setq blink-cursor-mode t)))))

(defcustom blink-cursor t
  "*Non-nil means blink-cursor-mode is active."
  :tag "Blinking cursor"
  :type 'boolean
  :group 'cursor
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (blink-cursor-mode (or value 0))))

(defun blink-cursor-start ()
  "Timer function called from timer blink-cursor-idle-timer.
Starts the timer blink-cursor-timer which lets the cursor blink
if the selected frame has a non-nil `cursor-blinking' frame parameter.
Arranges to cancel that timer by installing a pre command hook."
  (when (null blink-cursor-timer)
    (add-hook 'pre-command-hook 'blink-cursor-end)
    (setq blink-cursor-timer
	  (run-with-timer blink-cursor-interval blink-cursor-interval
			  'show-cursor))))

(defun blink-cursor-end ()
  "Stop cursor blinking.
Installed as a pre-command hook by blink-cursor-start.  Cancels
the timer blink-cursor-timer and removes itself from the hook."
  (remove-hook 'pre-command-hook 'blink-cursor-end)
  (show-cursor 0)
  (cancel-timer blink-cursor-timer)
  (setq blink-cursor-timer nil))



;;; Busy-cursor.

(defcustom busy-cursor t
  "*Non-nil means show a busy-cursor when running under a window-system."
  :tag "Busy-cursor"
  :type 'boolean
  :group 'cursor
  :get #'(lambda (symbol) display-busy-cursor)
  :set #'(lambda (symbol value)
	   (set-default symbol value)
	   (setq display-busy-cursor value)))


Jim Blandy's avatar
Jim Blandy committed
892 893 894

;;;; Key bindings

895
(define-key ctl-x-5-map "2" 'make-frame-command)
Jim Blandy's avatar
Jim Blandy committed
896
(define-key ctl-x-5-map "0" 'delete-frame)
897
(define-key ctl-x-5-map "o" 'other-frame)
Jim Blandy's avatar
Jim Blandy committed
898

Jim Blandy's avatar
Jim Blandy committed
899
(provide 'frame)
Eric S. Raymond's avatar
Eric S. Raymond committed
900

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