frame.el 77.3 KB
Newer Older
1
;;; frame.el --- multi-frame management independent of window systems  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Paul Eggert's avatar
Paul Eggert committed
3 4
;; Copyright (C) 1993-1994, 1996-1997, 2000-2015 Free Software
;; Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Maintainer: emacs-devel@gnu.org
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Erik Naggum's avatar
Erik Naggum committed
10 11
;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Erik Naggum's avatar
Erik Naggum committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Erik Naggum's avatar
Erik Naggum committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Jim Blandy's avatar
Jim Blandy committed
24

25 26
;;; Commentary:

Eric S. Raymond's avatar
Eric S. Raymond committed
27
;;; Code:
28 29
(eval-when-compile (require 'cl-lib))

30
(cl-defgeneric frame-creation-function (params)
Stefan Monnier's avatar
Stefan Monnier committed
31
  "Method for window-system dependent functions to create a new frame.
32
The window system startup file should add its frame creation
Stefan Monnier's avatar
Stefan Monnier committed
33
function to this method, which should take an alist of parameters
34
as its argument.")
35

36 37 38 39 40 41 42 43
(cl-defmethod frame-creation-function (params
                                       &context (window-system (eql nil)))
  ;; It's tempting to get rid of tty-create-frame-with-faces and turn it into
  ;; this method (i.e. move this method to faces.el), but faces.el is loaded
  ;; much earlier from loadup.el (before cl-generic and even before
  ;; cl-preloaded), so we'd first have to reorder that part.
  (tty-create-frame-with-faces params))

44
(defvar window-system-default-frame-alist nil
45 46
  "Window-system dependent default frame parameters.
The value should be an alist of elements (WINDOW-SYSTEM . ALIST),
Stefan Monnier's avatar
Stefan Monnier committed
47
where WINDOW-SYSTEM is a window system symbol (as returned by `framep')
48 49 50
and ALIST is a frame parameter alist like `default-frame-alist'.
Then, for frames on WINDOW-SYSTEM, any parameters specified in
ALIST supersede the corresponding parameters specified in
51
`default-frame-alist'.")
52

53 54 55 56 57 58
(defvar display-format-alist nil
  "Alist of patterns to decode display names.
The car of each entry is a regular expression matching a display
name string.  The cdr is a symbol giving the window-system that
handles the corresponding kind of display.")

59 60 61
;; The initial value given here 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.
Chong Yidong's avatar
Chong Yidong committed
62
(defcustom initial-frame-alist nil
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
  "Alist of parameters for the initial X window frame.
You can set this in your init file; for example,

 (setq initial-frame-alist
       '((top . 1) (left . 1) (width . 80) (height . 55)))

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, a minibuffer frame is
created according to `minibuffer-frame-alist'.

You can specify geometry-related options for just the initial
frame by setting this variable in your init file; however, they
won't take effect until Emacs reads your init file, which happens
after creating the initial frame.  If you want the initial frame
to have the proper geometry as soon as it appears, you need to
use this three-step process:
82 83 84 85
* 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,
86 87 88 89 90
  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
91

92
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
93 94 95 96 97 98
  "Alist of parameters for the initial minibuffer frame.
This is the minibuffer frame created if `initial-frame-alist'
calls for a frame without a minibuffer.  The parameters specified
here supersede those given in `default-frame-alist', for the
initial minibuffer frame.

99 100
You can set this in your init file; for example,

Jim Blandy's avatar
Jim Blandy committed
101
 (setq minibuffer-frame-alist
102 103
       '((top . 1) (left . 1) (width . 80) (height . 2)))

104 105
It is not necessary to include (minibuffer . only); that is
appended when the minibuffer frame is created."
106 107 108 109
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
110

111
(defun handle-delete-frame (event)
112
  "Handle delete-frame events from the X server."
113 114 115 116 117 118 119 120 121 122 123
  (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)
124 125
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
126 127 128 129 130 131 132

(defun handle-focus-in (_event)
  "Handle a focus-in event.
Focus-in events are usually bound to this function.
Focus-in events occur when a frame has focus, but a switch-frame event
is not generated.
This function runs the hook `focus-in-hook'."
133
  (interactive "e")
134 135 136 137 138 139 140
  (run-hooks 'focus-in-hook))

(defun handle-focus-out (_event)
  "Handle a focus-out event.
Focus-out events are usually bound to this function.
Focus-out events occur when no frame has focus.
This function runs the hook `focus-out-hook'."
141
  (interactive "e")
142
  (run-hooks 'focus-out-hook))
Jim Blandy's avatar
Jim Blandy committed
143

Jim Blandy's avatar
Jim Blandy committed
144
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
145

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

155
;; If we create the initial frame, this is it.
Jim Blandy's avatar
Jim Blandy committed
156
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
157

158 159 160
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

161 162
(defvar frame-initial-geometry-arguments nil)

163 164 165
;; startup.el calls this function before loading the user's init
;; file - if there is no frame with a minibuffer open now, create
;; one to display messages while loading the init file.
Jim Blandy's avatar
Jim Blandy committed
166
(defun frame-initialize ()
Eli Zaretskii's avatar
Eli Zaretskii committed
167
  "Create an initial frame if necessary."
Jim Blandy's avatar
Jim Blandy committed
168
  ;; Are we actually running under a window system at all?
169 170 171
  (if (and initial-window-system
	   (not noninteractive)
	   (not (eq initial-window-system 'pc)))
172 173 174 175 176 177
      (progn
	;; If there is no frame with a minibuffer besides the terminal
	;; frame, then we need to create the opening frame.  Make sure
	;; it has a minibuffer, but let initial-frame-alist omit the
	;; minibuffer spec.
	(or (delq terminal-frame (minibuffer-frame-list))
178
	    (progn
179
	      (setq frame-initial-frame-alist
180
		    (append initial-frame-alist default-frame-alist nil))
181 182 183
	      (setq frame-initial-frame-alist
		    (cons (cons 'window-system initial-window-system)
			  frame-initial-frame-alist))
184 185
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
186
			  (make-frame frame-initial-frame-alist)))
187 188 189 190
	      ;; 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.
191
	      (setq initial-frame-alist
192
		    (frame-remove-geometry-params initial-frame-alist))))
193 194 195
	;; Copy the environment of the Emacs process into the new frame.
	(set-frame-parameter frame-initial-frame 'environment
			     (frame-parameter terminal-frame 'environment))
Karl Heuer's avatar
Karl Heuer committed
196
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
197 198
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
199
	(setq terminal-frame nil))))
Karl Heuer's avatar
Karl Heuer committed
200

201 202 203
(defvar frame-notice-user-settings t
  "Non-nil means function `frame-notice-user-settings' wasn't run yet.")

204
(declare-function tool-bar-mode "tool-bar" (&optional arg))
205
(declare-function tool-bar-height "xdisp.c" (&optional frame pixelwise))
206

207 208
(defalias 'tool-bar-lines-needed 'tool-bar-height)

209 210 211
;; 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
212
(defun frame-notice-user-settings ()
213
  "Act on user's init file settings of frame parameters.
214 215 216
React to settings of `initial-frame-alist',
`window-system-default-frame-alist' and `default-frame-alist'
there (in decreasing order of priority)."
217 218 219 220 221
  ;; 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.
222
  (let ((old-buffer (current-buffer))
Stefan Monnier's avatar
Stefan Monnier committed
223 224 225
	(window-system-frame-alist
         (cdr (assq initial-window-system
                    window-system-default-frame-alist))))
226

227 228
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
229 230
      ;; This case happens when we don't have a window system, and
      ;; also for MS-DOS frames.
231
      (let ((parms (frame-parameters)))
232 233 234 235
	;; Don't change the frame names.
	(setq parms (delq (assq 'name parms) parms))
	;; Can't modify the minibuffer parameter, so don't try.
	(setq parms (delq (assq 'minibuffer parms) parms))
236 237 238 239 240 241 242 243
	(modify-frame-parameters
	 nil
	 (if initial-window-system
	     parms
	   ;; initial-frame-alist and default-frame-alist were already
	   ;; applied in pc-win.el.
	   (append initial-frame-alist window-system-frame-alist
		   default-frame-alist parms nil)))
244
	(if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
245 246 247
	    (let ((newparms (frame-parameters))
		  (frame (selected-frame)))
	      (tty-handle-reverse-video frame newparms)
248 249 250 251
	      ;; tty-handle-reverse-video might change the frame's
	      ;; color parameters, and we need to use the updated
	      ;; value below.
	      (setq newparms (frame-parameters))
252 253 254 255 256 257 258
	      ;; If we changed the background color, we need to update
	      ;; the background-mode parameter, and maybe some faces,
	      ;; too.
	      (when (assq 'background-color newparms)
		(unless (or (assq 'background-mode initial-frame-alist)
			    (assq 'background-mode default-frame-alist))
		  (frame-set-background-mode frame))
259
		(face-set-after-frame-default frame newparms))))))
260

261 262
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
263 264 265 266
    (when (frame-live-p frame-initial-frame)
      ;; When tool-bar has been switched off, correct the frame size
      ;; by the lines added in x-create-frame for the tool-bar and
      ;; switch `tool-bar-mode' off.
267
      (when (display-graphic-p)
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
	(let* ((init-lines
		(assq 'tool-bar-lines initial-frame-alist))
	       (other-lines
		(or (assq 'tool-bar-lines window-system-frame-alist)
		    (assq 'tool-bar-lines default-frame-alist)))
	       (lines (or init-lines other-lines))
	       (height (tool-bar-height frame-initial-frame t)))
	  ;; Adjust frame top if either zero (nil) tool bar lines have
	  ;; been requested in the most relevant of the frame's alists
	  ;; or tool bar mode has been explicitly turned off in the
	  ;; user's init file.
	  (when (and (> height 0)
		     (or (and lines
			      (or (null (cdr lines))
				  (eq 0 (cdr lines))))
			 (not tool-bar-mode)))
284 285
	    (let* ((initial-top
		    (cdr (assq 'top frame-initial-geometry-arguments)))
286 287
		   (top (frame-parameter frame-initial-frame 'top)))
	      (when (and (consp initial-top) (eq '- (car initial-top)))
288
		(let ((adjusted-top
289 290
		       (cond
			((and (consp top) (eq '+ (car top)))
291
			 (list '+ (+ (cadr top) height)))
292
			((and (consp top) (eq '- (car top)))
293 294
			 (list '- (- (cadr top) height)))
			(t (+ top height)))))
295
		  (modify-frame-parameters
296
		   frame-initial-frame `((top . ,adjusted-top))))))
297 298 299 300 301 302 303
	    ;; Reset `tool-bar-mode' when zero tool bar lines have been
	    ;; requested for the window-system or default frame alists.
	    (when (and tool-bar-mode
		       (and other-lines
			    (or (null (cdr other-lines))
				(eq 0 (cdr other-lines)))))
	      (tool-bar-mode -1)))))
304 305 306 307 308 309 310 311 312 313 314

      ;; 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.
      ;;
      ;; 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
315
      ;; init file, will be applied to the existing screen.
316
      (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
317
			    (assq 'minibuffer window-system-frame-alist)
318 319 320 321 322
			    (assq 'minibuffer default-frame-alist)
			    '(minibuffer . t)))
		   t))
	  ;; Create the new frame.
	  (let (parms new)
323 324 325
	    ;; MS-Windows needs this to avoid inflooping below.
	    (if (eq system-type 'windows-nt)
		(sit-for 0 t))
326 327 328 329 330 331 332 333
	    ;; 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 (frame-parameters frame-initial-frame))
334

Sam Steingold's avatar
Sam Steingold committed
335
            ;; Get rid of `name' unless it was specified explicitly before.
336 337
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))
338 339 340
	    ;; An explicit parent-id is a request to XEmbed the frame.
	    (or (assq 'parent-id frame-initial-frame-alist)
                (setq parms (delq (assq 'parent-id parms) parms)))
341 342

	    (setq parms (append initial-frame-alist
343
				window-system-frame-alist
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
				default-frame-alist
				parms
				nil))

	    ;; 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)
		(setq parms (assq-delete-all 'height parms)))
	    (if (assq 'width frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'width parms)))
	    (if (assq 'left frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'left parms)))
	    (if (assq 'top frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'top parms)))
	    (setq new
		  (make-frame
		   ;; Use the geometry args that created the existing
		   ;; frame, rather than the parms we get for it.
		   (append frame-initial-geometry-arguments
			   '((user-size . t) (user-position . t))
			   parms)))
	    ;; 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))
		(make-initial-minibuffer-frame nil))

	    ;; 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
379 380 381 382 383 384
                    (lambda (frame)
                      (and (not (eq frame frame-initial-frame))
                           (eq (window-frame
                                (minibuffer-window frame))
                               frame-initial-frame))))))
              (if (or users-of-initial
385 386 387 388 389 390 391
		      (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
392 393 394 395
                                (lambda (frame)
                                  (eq (cdr (assq 'minibuffer
                                                 (frame-parameters frame)))
                                      'only)))
396 397 398 399 400 401 402 403
			       (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.
404 405 406 407 408
		    (dolist (frame users-of-initial)
                      (modify-frame-parameters
                       frame (list (cons 'minibuffer new-minibuffer)))))))

            ;; Redirect events enqueued at this frame to the new frame.
409 410 411 412 413
	    ;; Is this a good idea?
	    (redirect-frame-focus frame-initial-frame new)

	    ;; Finally, get rid of the old frame.
	    (delete-frame frame-initial-frame t))
414

Paul Eggert's avatar
Paul Eggert committed
415
	;; Otherwise, we don't need all that rigmarole; just apply
416 417 418
	;; the new parameters.
	(let (newparms allparms tail)
	  (setq allparms (append initial-frame-alist
419
				 window-system-frame-alist
420 421 422 423 424 425 426 427 428 429 430 431
				 default-frame-alist nil))
	  (if (assq 'height frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'height allparms)))
	  (if (assq 'width frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'width allparms)))
	  (if (assq 'left frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'left allparms)))
	  (if (assq 'top frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'top allparms)))
	  (setq tail allparms)
	  ;; Find just the parms that have changed since we first
	  ;; made this frame.  Those are the ones actually set by
Sam Steingold's avatar
Sam Steingold committed
432
          ;; the init file.  For those parms whose values we already knew
433 434
	  ;; (such as those spec'd by command line options)
	  ;; it is undesirable to specify the parm again
Sam Steingold's avatar
Sam Steingold committed
435
          ;; once the user has seen the frame and been able to alter it
436
	  ;; manually.
437 438 439 440
	  (let (newval oldval)
	    (dolist (entry tail)
	      (setq oldval (assq (car entry) frame-initial-frame-alist))
	      (setq newval (cdr (assq (car entry) allparms)))
441 442
	      (or (and oldval (eq (cdr oldval) newval))
		  (setq newparms
443
			(cons (cons (car entry) newval) newparms)))))
444
	  (setq newparms (nreverse newparms))
445 446 447 448 449 450 451 452 453 454 455 456 457

	  (let ((new-bg (assq 'background-color newparms)))
	    ;; If the `background-color' parameter is changed, apply
	    ;; it first, then make sure that the `background-mode'
	    ;; parameter and other faces are updated, before applying
	    ;; the other parameters.
	    (when new-bg
	      (modify-frame-parameters frame-initial-frame
				       (list new-bg))
	      (unless (assq 'background-mode newparms)
		(frame-set-background-mode frame-initial-frame))
	      (face-set-after-frame-default frame-initial-frame)
	      (setq newparms (delq new-bg newparms)))
458 459 460 461 462 463 464 465 466 467

	    (when (numberp (car frame-size-history))
	      (setq frame-size-history
		    (cons (1- (car frame-size-history))
			  (cons
			   (list frame-initial-frame
				 "frame-notice-user-settings"
				 nil newparms)
			   (cdr frame-size-history)))))

468
	    (modify-frame-parameters frame-initial-frame newparms)))))
Jim Blandy's avatar
Jim Blandy committed
469

470 471 472 473
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

478 479 480 481 482 483
(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))))

484
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
485

486
(defun modify-all-frames-parameters (alist)
487
  "Modify all current and future frames' parameters according to ALIST.
488
This changes `default-frame-alist' and possibly `initial-frame-alist'.
489 490
Furthermore, this function removes all parameters in ALIST from
`window-system-default-frame-alist'.
491
See help of `modify-frame-parameters' for more information."
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
  (dolist (frame (frame-list))
    (modify-frame-parameters frame alist))

  (dolist (pair alist) ;; conses to add/replace
    ;; initial-frame-alist needs setting only when
    ;; frame-notice-user-settings is true.
    (and frame-notice-user-settings
	 (setq initial-frame-alist
	       (assq-delete-all (car pair) initial-frame-alist)))
    (setq default-frame-alist
	  (assq-delete-all (car pair) default-frame-alist))
    ;; Remove any similar settings from the window-system specific
    ;; parameters---they would override default-frame-alist.
    (dolist (w window-system-default-frame-alist)
      (setcdr w (assq-delete-all (car pair) (cdr w)))))

508 509 510 511
  (and frame-notice-user-settings
       (setq initial-frame-alist (append initial-frame-alist alist)))
  (setq default-frame-alist (append default-frame-alist alist)))

Jim Blandy's avatar
Jim Blandy committed
512
(defun get-other-frame ()
513 514 515
  "Return some frame other than the current frame.
Create one if necessary.  Note that the minibuffer frame, if separate,
is not considered (see `next-frame')."
516
  (if (equal (next-frame) (selected-frame)) (make-frame) (next-frame)))
Jim Blandy's avatar
Jim Blandy committed
517

Jim Blandy's avatar
Jim Blandy committed
518 519
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
520 521 522
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
523
			      0))
524
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
525

Jim Blandy's avatar
Jim Blandy committed
526 527
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
528 529 530
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
531
				  0))
532
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
533

534 535 536
(defun window-system-for-display (display)
  "Return the window system for DISPLAY.
Return nil if we don't know how to interpret DISPLAY."
537 538
  ;; MS-Windows doesn't know how to create a GUI frame in a -nw session.
  (if (and (eq system-type 'windows-nt)
539 540
	   (null (window-system))
	   (not (daemonp)))
541 542 543 544 545
      nil
    (cl-loop for descriptor in display-format-alist
	     for pattern = (car descriptor)
	     for system = (cdr descriptor)
	     when (string-match-p pattern display) return system)))
546

547
(defun make-frame-on-display (display &optional parameters)
548 549
  "Make a frame on display DISPLAY.
The optional argument PARAMETERS specifies additional frame parameters."
550
  (interactive "sMake frame on display: ")
551
  (make-frame (cons (cons 'display display) parameters)))
552

553 554
(declare-function x-close-connection "xfns.c" (terminal))

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
(defun close-display-connection (display)
  "Close the connection to a display, deleting all its associated frames.
For DISPLAY, specify either a frame or a display name (a string).
If DISPLAY is nil, that stands for the selected frame's display."
  (interactive
   (list
    (let* ((default (frame-parameter nil 'display))
           (display (completing-read
                     (format "Close display (default %s): " default)
                     (delete-dups
                      (mapcar (lambda (frame)
                                (frame-parameter frame 'display))
                              (frame-list)))
                     nil t nil nil
                     default)))
      (if (zerop (length display)) default display))))
  (let ((frames (delq nil
                      (mapcar (lambda (frame)
                                (if (equal display
                                           (frame-parameter frame 'display))
                                    frame))
                              (frame-list)))))
    (if (and (consp frames)
             (not (y-or-n-p (if (cdr frames)
                                (format "Delete %s frames? " (length frames))
                              (format "Delete %s ? " (car frames))))))
        (error "Abort!")
      (mapc 'delete-frame frames)
      (x-close-connection display))))

585
(defun make-frame-command ()
586 587 588
  "Make a new frame, on the same terminal as the selected frame.
If the terminal is a text-only terminal, this also selects the
new frame."
589
  (interactive)
590
  (if (display-graphic-p)
591 592 593
      (make-frame)
    (select-frame (make-frame))))

594 595 596 597 598 599 600
(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.")

601
(defvar after-setting-font-hook nil
602 603
  "Functions to run after a frame's font has been changed.")

604
;; Alias, kept temporarily.
605
(define-obsolete-function-alias 'new-frame 'make-frame "22.1")
Jim Blandy's avatar
Jim Blandy committed
606

607
(defvar frame-inherited-parameters '()
608 609
  "Parameters `make-frame' copies from the `selected-frame' to the new frame.")

610 611
(defvar x-display-name)

612 613
(defun make-frame (&optional parameters)
  "Return a newly created frame displaying the current buffer.
614 615 616
Optional argument PARAMETERS is an alist of frame 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
617

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

620 621
 (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
622

623 624
You cannot specify either `width' or `height', you must specify
neither or both.
Jim Blandy's avatar
Jim Blandy committed
625

626 627 628 629
 (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
630

631 632 633
 (window-system . nil)	The frame should be displayed on a terminal device.
 (window-system . x)	The frame should be displayed in an X window.

634 635
 (display . \":0\")     The frame should appear on display :0.

636
 (terminal . TERMINAL)  The frame should use the terminal object TERMINAL.
637

638 639
In addition, any parameter specified in `default-frame-alist',
but not present in PARAMETERS, is applied.
Luc Teirlinck's avatar
Luc Teirlinck committed
640

641 642 643 644 645
Before creating the frame (via `frame-creation-function-alist'),
this function runs the hook `before-make-frame-hook'.  After
creating the frame, it runs the hook `after-make-frame-functions'
with one arg, the newly created frame.

646 647 648
If a display parameter is supplied and a window-system is not,
guess the window-system from the display.

649 650 651
On graphical displays, this function does not itself make the new
frame the selected frame.  However, the window system may select
the new frame according to its own rules."
Jim Blandy's avatar
Jim Blandy committed
652
  (interactive)
653
  (let* ((display (cdr (assq 'display parameters)))
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
         (w (cond
             ((assq 'terminal parameters)
              (let ((type (terminal-live-p
                           (cdr (assq 'terminal parameters)))))
                (cond
                 ((eq t type) nil)
                 ((null type) (error "Terminal %s does not exist"
                                     (cdr (assq 'terminal parameters))))
                 (t type))))
             ((assq 'window-system parameters)
              (cdr (assq 'window-system parameters)))
             (display
              (or (window-system-for-display display)
                  (error "Don't know how to interpret display %S"
                         display)))
             (t window-system)))
670
	 (oldframe (selected-frame))
671
	 (params parameters)
672
	 frame)
673 674

    (unless (get w 'window-system-initialized)
675 676
      (let ((window-system w))          ;Hack attack!
        (window-system-initialization display))
677
      (setq x-display-name display)
678 679
      (put w 'window-system-initialized t))

680 681
    ;; Add parameters from `window-system-default-frame-alist'.
    (dolist (p (cdr (assq w window-system-default-frame-alist)))
682
      (unless (assq (car p) params)
683 684 685
	(push p params)))
    ;; Add parameters from `default-frame-alist'.
    (dolist (p default-frame-alist)
686
      (unless (assq (car p) params)
687 688
	(push p params)))
    ;; Now make the frame.
689
    (run-hooks 'before-make-frame-hook)
690

691
;;     (setq frame-size-history '(1000))
692

693 694
    (setq frame (let ((window-system w)) ;Hack attack!
                  (frame-creation-function params)))
695
    (normal-erase-is-backspace-setup-frame frame)
696 697 698 699 700
    ;; Inherit the original frame's parameters.
    (dolist (param frame-inherited-parameters)
      (unless (assq param parameters)   ;Overridden by explicit parameters.
        (let ((val (frame-parameter oldframe param)))
          (when val (set-frame-parameter frame param val)))))
701

702 703 704 705 706
    (when (numberp (car frame-size-history))
      (setq frame-size-history
	    (cons (1- (car frame-size-history))
		  (cons (list frame "make-frame")
			(cdr frame-size-history)))))
707

708 709
    ;; We can run `window-configuration-change-hook' for this frame now.
    (frame-after-make-frame frame t)
710 711
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
712

713 714
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
715 716
  (let* ((frames (frame-list))
	 (list frames))
717
    (while (consp frames)
718 719
      (unless (funcall predicate (car frames))
	(setcar frames nil))
720
      (setq frames (cdr frames)))
721
    (delq nil list)))
722 723 724 725

(defun minibuffer-frame-list ()
  "Return a list of all frames with their own minibuffers."
  (filtered-frame-list
726 727
   (lambda (frame)
     (eq frame (window-frame (minibuffer-window frame))))))
728

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
;; Used to be called `terminal-id' in termdev.el.
(defun get-device-terminal (device)
  "Return the terminal corresponding to DEVICE.
DEVICE can be a terminal, a frame, nil (meaning the selected frame's terminal),
the name of an X display device (HOST.SERVER.SCREEN) or a tty device file."
  (cond
   ((or (null device) (framep device))
    (frame-terminal device))
   ((stringp device)
    (let ((f (car (filtered-frame-list
                   (lambda (frame)
                     (or (equal (frame-parameter frame 'display) device)
                         (equal (frame-parameter frame 'tty) device)))))))
      (or f (error "Display %s does not exist" device))
      (frame-terminal f)))
   ((terminal-live-p device) device)
   (t
    (error "Invalid argument %s in `get-device-terminal'" device))))

(defun frames-on-display-list (&optional device)
  "Return a list of all frames on DEVICE.

DEVICE should be a terminal, a frame,
or a name of an X display or tty (a string of the form
753
HOST:SERVER.SCREEN).
754

755
If DEVICE is omitted or nil, it defaults to the selected
756
frame's terminal device."
757
  (let* ((terminal (get-device-terminal device))
758
	 (func #'(lambda (frame)
759
		   (eq (frame-terminal frame) terminal))))
760 761
    (filtered-frame-list func)))

762 763 764 765 766 767
(defun framep-on-display (&optional terminal)
  "Return the type of frames on TERMINAL.
TERMINAL may be a terminal id, a display name or a frame.  If it
is a frame, its type is returned.  If TERMINAL is omitted or nil,
it defaults to the selected frame's terminal device.  All frames
on a given display are of the same type."
768
  (or (terminal-live-p terminal)
769 770
      (framep terminal)
      (framep (car (frames-on-display-list terminal)))))
771

772 773 774
(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',
775
`height', `user-size' and `user-position' parameters.
776 777 778 779 780 781
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)))
782 783 784 785 786 787
	       (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))))
788
	(setq tail (cdr tail)))))
789 790
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
791 792
  (cdr param-list))

793
(declare-function x-focus-frame "frame.c" (frame))
794

795
(defun select-frame-set-input-focus (frame &optional norecord)
796
  "Select FRAME, raise it, and set input focus, if possible.
797
If `mouse-autoselect-window' is non-nil, also move mouse pointer
798
to FRAME's selected window.  Otherwise, if `focus-follows-mouse'
799 800 801 802 803
is non-nil, move mouse cursor to FRAME.

Optional argument NORECORD means to neither change the order of
recently selected windows nor the buffer list."
  (select-frame frame norecord)
804
  (raise-frame frame)
805
  ;; Ensure, if possible, that FRAME gets input focus.
806 807
  (when (memq (window-system frame) '(x w32 ns))
    (x-focus-frame frame))
808 809 810 811 812 813 814 815 816 817 818
  ;; Move mouse cursor if necessary.
  (cond
   (mouse-autoselect-window
    (let ((edges (window-inside-edges (frame-selected-window frame))))
      ;; Move mouse cursor into FRAME's selected window to avoid that
      ;; Emacs mouse-autoselects another window.
      (set-mouse-position frame (nth 2 edges) (nth 1 edges))))
   (focus-follows-mouse
    ;; Move mouse cursor into FRAME to avoid that another frame gets
    ;; selected by the window manager.
    (set-mouse-position frame (1- (frame-width frame)) 0))))
819

820
(defun other-frame (arg)
Juanma Barranquero's avatar
Juanma Barranquero committed
821
  "Select the ARGth different visible frame on current display, and raise it.
822 823
All frames are arranged in a cyclic order.
This command selects the frame ARG steps away in that order.
Richard M. Stallman's avatar
Richard M. Stallman committed
824 825 826 827 828 829 830
A negative ARG moves in the opposite order.

To make this command work properly, you must tell Emacs
how the system (or the window manager) generally handles
focus-switching between windows.  If moving the mouse onto a window
selects it (gives it focus), set `focus-follows-mouse' to t.
Otherwise, that variable should be nil."
831 832 833
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
834 835 836 837
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
838
    (while (< arg 0)
839 840 841
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
842
      (setq arg (1+ arg)))
843
    (select-frame-set-input-focus frame)))
844

845 846 847 848 849 850 851
(defun iconify-or-deiconify-frame ()
  "Iconify the selected frame, or deiconify if it's currently an icon."
  (interactive)
  (if (eq (cdr (assq 'visibility (frame-parameters))) t)
      (iconify-frame)
    (make-frame-visible)))

852 853
(defun suspend-frame ()
  "Do whatever is right to suspend the current frame.
854 855
Calls `suspend-emacs' if invoked from the controlling tty device,
`suspend-tty' from a secondary tty device, and
856 857 858 859
`iconify-or-deiconify-frame' from an X frame."
  (interactive)
  (let ((type (framep (selected-frame))))
    (cond
860
     ((memq type '(x ns w32)) (iconify-or-deiconify-frame))
861
     ((eq type t)
862
      (if (controlling-tty-p)
863 864
	  (suspend-emacs)
	(suspend-tty)))
865 866
     (t (suspend-emacs)))))

867
(defun make-frame-names-alist ()
868
  ;; Only consider the frames on the same display.
869 870 871 872
  (let* ((current-frame (selected-frame))
	 (falist
	  (cons
	   (cons (frame-parameter current-frame 'name) current-frame) nil))
873
	 (frame (next-frame nil 0)))
874 875
    (while (not (eq frame current-frame))
      (progn
876 877
	(push (cons (frame-parameter frame 'name) frame) falist)
	(setq frame (next-frame frame 0))))
878 879 880 881
    falist))

(defvar frame-name-history nil)
(defun select-frame-by-name (name)
882
  "Select the frame on the current terminal whose name is NAME and raise it.
883 884
If there is no frame by that name, signal an error."
  (interactive
885 886 887 888 889
   (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)))
890 891 892
     (if (= (length input) 0)
	 (list default)
       (list input))))
893 894
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
895 896 897
    (if frame
	(select-frame-set-input-focus frame)
      (error "There is no frame named `%s'" name))))
898 899 900 901 902 903 904 905


;;;; Background mode.

(defcustom frame-background-mode nil
  "The brightness of the background.
Set this to the symbol `dark' if your background color is dark,
`light' if your background is light, or nil (automatic by default)
906 907
if you want Emacs to examine the brightness for you.

Glenn Morris's avatar
Glenn Morris committed
908
If you change this without using customize, you should use
Glenn Morris's avatar
Glenn Morris committed
909 910
`frame-set-background-mode' to update existing frames;
e.g. (mapc 'frame-set-background-mode (frame-list))."
911 912 913 914 915 916 917 918 919 920 921 922
  :group 'faces
  :set #'(lambda (var value)
	   (set-default var value)
	   (mapc 'frame-set-background-mode (frame-list)))
  :initialize 'custom-initialize-changed
  :type '(choice (const dark)
		 (const light)
		 (const :tag "automatic" nil)))

(declare-function x-get-resource "frame.c"
		  (attribute class &optional component subclass))

923 924 925
;; Only used if window-system is not null.
(declare-function x-display-grayscale-p "xfns.c" (&optional terminal))

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
(defvar inhibit-frame-set-background-mode nil)

(defun frame-set-background-mode (frame &optional keep-face-specs)
  "Set up display-dependent faces on FRAME.
Display-dependent faces are those which have different definitions
according to the `background-mode' and `display-type' frame parameters.

If optional arg KEEP-FACE-SPECS is non-nil, don't recalculate
face specs for the new background mode."
  (unless inhibit-frame-set-background-mode
    (let* ((frame-default-bg-mode (frame-terminal-default-bg-mode frame))
	   (bg-color (frame-parameter frame 'background-color))
	   (tty-type (tty-type frame))
	   (default-bg-mode
	     (if (or (window-system frame)
		     (and tty-type
			  (string-match "^\\(xterm\\|\\rxvt\\|dtterm\\|eterm\\)"
					tty-type)))
		 'light
	       'dark))
	   (non-default-bg-mode (if (eq default-bg-mode 'light) 'dark 'light))
	   (bg-mode
	    (cond (frame-default-bg-mode)
		  ((equal bg-color "unspecified-fg") ; inverted colors
		   non-default-bg-mode)
		  ((not (color-values bg-color frame))
		   default-bg-mode)
		  ((>= (apply '+ (color-values bg-color frame))
		       ;; Just looking at the screen, colors whose
		       ;; values add up to .6 of the white total
		       ;; still look dark to me.
		       (* (apply '+ (color-values "white" frame)) .6))
		   'light)
		  (t 'dark)))
	   (display-type
	    (cond ((null (window-system frame))
		   (if (tty-display-color-p frame) 'color 'mono))
		  ((display-color-p frame)
		   'color)
		  ((x-display-grayscale-p frame)
		   'grayscale)
		  (t 'mono)))
	   (old-bg-mode
	    (frame-parameter frame 'background-mode))
	   (old-display-type
	    (frame-parameter frame 'display-type)))

      (unless (and (eq bg-mode old-bg-mode) (eq display-type old-display-type))
	(let ((locally-modified-faces nil)
	      ;; Prevent face-spec-recalc from calling this function
	      ;; again, resulting in a loop (bug#911).
	      (inhibit-frame-set-background-mode t)
	      (params (list (cons 'background-mode bg-mode)
			    (cons 'display-type display-type))))
	  (if keep-face-specs
	      (modify-frame-parameters frame params)
	    ;; If we are recomputing face specs, first collect a list
	    ;; of faces that don't match their face-specs.  These are
	    ;; the faces modified on FRAME, and we avoid changing them
	    ;; below.  Use a negative list to avoid consing (we assume
	    ;; most faces are unmodified).
	    (dolist (face (face-list))
	      (and (not (get face 'face-override-spec))
		   (not (face-spec-match-p face
					   (face-user-default-spec face)
					   (selected-frame)))
		   (push face locally-modified-faces)))
	    ;; Now change to the new frame parameters
	    (modify-frame-parameters frame params)
	    ;; For all unmodified named faces, choose face specs
	    ;; matching the new frame parameters.
	    (dolist (face (face-list))
	      (unless (memq face locally-modified-faces)
		(face-spec-recalc face frame)))))))))

(defun frame-terminal-default-bg-mode (frame)
  "Return the default background mode of FRAME.
This checks the `frame-background-mode' variable, the X resource
named \"backgroundMode\" (if FRAME is an X frame), and finally
the `background-mode' terminal parameter."
  (or frame-background-mode
      (let ((bg-resource
	     (and (window-system frame)
		  (x-get-resource "backgroundMode" "BackgroundMode"))))
	(if bg-resource
	    (intern (downcase bg-resource))))
      (terminal-parameter frame 'background-mode)))

Jim Blandy's avatar
Jim Blandy committed
1014

Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017 1018
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
1019 1020 1021 1022 1023 1024 1025
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
1026 1027 1028 1029
	(mapcar (lambda (frame)
                  (list frame
                        (frame-parameters frame)
                        (current-window-configuration frame)))
1030
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
1031

1032
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
1033 1034
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
1035
configuration, and other parameters set as specified in CONFIGURATION.
1036 1037
However, this function does not restore deleted frames.

1038 1039
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
1040
is given and non-nil, the unwanted frames are iconified instead."
1041 1042 1043 1044 1045
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
1046 1047 1048 1049 1050 1051 1052 1053 1054
    (dolist (frame (frame-list))
      (let ((parameters (assq frame config-alist)))
        (if parameters
            (progn
              (modify-frame-parameters
               frame
               ;; Since we can't set a frame's minibuffer status,
               ;; we might as well omit the parameter altogether.
               (let* ((parms (nth 1 parameters))
Miles Bader's avatar
Miles Bader committed
1055 1056 1057 1058 1059 1060 1061 1062 1063
		      (mini (assq 'minibuffer parms))
		      (name (assq 'name parms))
		      (explicit-name (cdr (assq 'explicit-name parms))))
		 (when mini (setq parms (delq mini parms)))
		 ;; Leave name in iff it was set explicitly.
		 ;; This should fix the behavior reported in
		 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg01632.html
		 (when (and name (not explicit-name))
		   (setq parms (delq name parms)))
1064 1065 1066 1067 1068 1069