1 ;;; frame.el --- multi-frame management independent of window systems
3 ;; Copyright (C) 1993-1994, 1996-1997, 2000-2013 Free Software
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; 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/>.
28 (eval-when-compile (require 'cl-lib))
30 (defvar frame-creation-function-alist
32 (if (fboundp 'tty-create-frame-with-faces)
33 'tty-create-frame-with-faces
35 (error "Can't create multiple frames without a window system")))))
36 "Alist of window-system dependent functions to call to create a new frame.
37 The window system startup file should add its frame creation
38 function to this list, which should take an alist of parameters
41 (defvar window-system-default-frame-alist nil
42 "Window-system dependent default frame parameters.
43 The value should be an alist of elements (WINDOW-SYSTEM . ALIST),
44 where WINDOW-SYSTEM is a window system symbol (see `window-system')
45 and ALIST is a frame parameter alist like `default-frame-alist'.
46 Then, for frames on WINDOW-SYSTEM, any parameters specified in
47 ALIST supersede the corresponding parameters specified in
48 `default-frame-alist'.")
50 (defvar display-format-alist nil
51 "Alist of patterns to decode display names.
52 The car of each entry is a regular expression matching a display
53 name string. The cdr is a symbol giving the window-system that
54 handles the corresponding kind of display.")
56 ;; The initial value given here used to ask for a minibuffer.
57 ;; But that's not necessary, because the default is to have one.
58 ;; By not specifying it here, we let an X resource specify it.
59 (defcustom initial-frame-alist nil
60 "Alist of parameters for the initial X window frame.
61 You can set this in your init file; for example,
63 (setq initial-frame-alist
64 '((top . 1) (left . 1) (width . 80) (height . 55)))
66 Parameters specified here supersede the values given in
67 `default-frame-alist'.
69 If the value calls for a frame without a minibuffer, and you have
70 not created a minibuffer frame on your own, a minibuffer frame is
71 created according to `minibuffer-frame-alist'.
73 You can specify geometry-related options for just the initial
74 frame by setting this variable in your init file; however, they
75 won't take effect until Emacs reads your init file, which happens
76 after creating the initial frame. If you want the initial frame
77 to have the proper geometry as soon as it appears, you need to
78 use this three-step process:
79 * Specify X resources to give the geometry you want.
80 * Set `default-frame-alist' to override these options so that they
81 don't affect subsequent frames.
82 * Set `initial-frame-alist' in a way that matches the X resources,
83 to override what you put in `default-frame-alist'."
84 :type '(repeat (cons :format "%v"
85 (symbol :tag "Parameter")
89 (defcustom minibuffer-frame-alist '((width . 80) (height . 2))
90 "Alist of parameters for the initial minibuffer frame.
91 This is the minibuffer frame created if `initial-frame-alist'
92 calls for a frame without a minibuffer. The parameters specified
93 here supersede those given in `default-frame-alist', for the
94 initial minibuffer frame.
96 You can set this in your init file; for example,
98 (setq minibuffer-frame-alist
99 '((top . 1) (left . 1) (width . 80) (height . 2)))
101 It is not necessary to include (minibuffer . only); that is
102 appended when the minibuffer frame is created."
103 :type '(repeat (cons :format "%v"
104 (symbol :tag "Parameter")
105 (sexp :tag "Value")))
108 (defun handle-delete-frame (event)
109 "Handle delete-frame events from the X server."
111 (let ((frame (posn-window (event-start event)))
115 (and (frame-visible-p (car tail))
116 (not (eq (car tail) frame))
118 (setq tail (cdr tail)))
120 (delete-frame frame t)
121 ;; Gildea@x.org says it is ok to ask questions before terminating.
122 (save-buffers-kill-emacs))))
124 ;;;; Arrangement of frames at startup
126 ;; 1) Load the window system startup file from the lisp library and read the
127 ;; high-priority arguments (-q and the like). The window system startup
128 ;; file should create any frames specified in the window system defaults.
130 ;; 2) If no frames have been opened, we open an initial text frame.
132 ;; 3) Once the init file is done, we apply any newly set parameters
133 ;; in initial-frame-alist to the frame.
135 ;; These are now called explicitly at the proper times,
136 ;; since that is easier to understand.
137 ;; Actually using hooks within Emacs is bad for future maintenance. --rms.
138 ;; (add-hook 'before-init-hook 'frame-initialize)
139 ;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
141 ;; If we create the initial frame, this is it.
142 (defvar frame-initial-frame nil)
144 ;; Record the parameters used in frame-initialize to make the initial frame.
145 (defvar frame-initial-frame-alist)
147 (defvar frame-initial-geometry-arguments nil)
149 ;; startup.el calls this function before loading the user's init
150 ;; file - if there is no frame with a minibuffer open now, create
151 ;; one to display messages while loading the init file.
152 (defun frame-initialize ()
153 "Create an initial frame if necessary."
154 ;; Are we actually running under a window system at all?
155 (if (and initial-window-system
157 (not (eq initial-window-system 'pc)))
159 ;; If there is no frame with a minibuffer besides the terminal
160 ;; frame, then we need to create the opening frame. Make sure
161 ;; it has a minibuffer, but let initial-frame-alist omit the
163 (or (delq terminal-frame (minibuffer-frame-list))
165 (setq frame-initial-frame-alist
166 (append initial-frame-alist default-frame-alist nil))
167 (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
168 (setq frame-initial-frame-alist
169 (cons '(horizontal-scroll-bars . t)
170 frame-initial-frame-alist)))
171 (setq frame-initial-frame-alist
172 (cons (cons 'window-system initial-window-system)
173 frame-initial-frame-alist))
174 (setq default-minibuffer-frame
175 (setq frame-initial-frame
176 (make-frame frame-initial-frame-alist)))
177 ;; Delete any specifications for window geometry parameters
178 ;; so that we won't reapply them in frame-notice-user-settings.
179 ;; It would be wrong to reapply them then,
180 ;; because that would override explicit user resizing.
181 (setq initial-frame-alist
182 (frame-remove-geometry-params initial-frame-alist))))
183 ;; Copy the environment of the Emacs process into the new frame.
184 (set-frame-parameter frame-initial-frame 'environment
185 (frame-parameter terminal-frame 'environment))
186 ;; At this point, we know that we have a frame open, so we
187 ;; can delete the terminal frame.
188 (delete-frame terminal-frame)
189 (setq terminal-frame nil))))
191 (defvar frame-notice-user-settings t
192 "Non-nil means function `frame-notice-user-settings' wasn't run yet.")
194 (declare-function tool-bar-mode "tool-bar" (&optional arg))
196 ;; startup.el calls this function after loading the user's init
197 ;; file. Now default-frame-alist and initial-frame-alist contain
198 ;; information to which we must react; do what needs to be done.
199 (defun frame-notice-user-settings ()
200 "Act on user's init file settings of frame parameters.
201 React to settings of `initial-frame-alist',
202 `window-system-default-frame-alist' and `default-frame-alist'
203 there (in decreasing order of priority)."
204 ;; Creating and deleting frames may shift the selected frame around,
205 ;; and thus the current buffer. Protect against that. We don't
206 ;; want to use save-excursion here, because that may also try to set
207 ;; the buffer of the selected window, which fails when the selected
208 ;; window is the minibuffer.
209 (let ((old-buffer (current-buffer))
210 (window-system-frame-alist
211 (cdr (assq initial-window-system
212 window-system-default-frame-alist))))
214 (when (and frame-notice-user-settings
215 (null frame-initial-frame))
216 ;; This case happens when we don't have a window system, and
217 ;; also for MS-DOS frames.
218 (let ((parms (frame-parameters)))
219 ;; Don't change the frame names.
220 (setq parms (delq (assq 'name parms) parms))
221 ;; Can't modify the minibuffer parameter, so don't try.
222 (setq parms (delq (assq 'minibuffer parms) parms))
223 (modify-frame-parameters
225 (if initial-window-system
227 ;; initial-frame-alist and default-frame-alist were already
228 ;; applied in pc-win.el.
229 (append initial-frame-alist window-system-frame-alist
230 default-frame-alist parms nil)))
231 (if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
232 (let ((newparms (frame-parameters))
233 (frame (selected-frame)))
234 (tty-handle-reverse-video frame newparms)
235 ;; If we changed the background color, we need to update
236 ;; the background-mode parameter, and maybe some faces,
238 (when (assq 'background-color newparms)
239 (unless (or (assq 'background-mode initial-frame-alist)
240 (assq 'background-mode default-frame-alist))
241 (frame-set-background-mode frame))
242 (face-set-after-frame-default frame))))))
244 ;; If the initial frame is still around, apply initial-frame-alist
245 ;; and default-frame-alist to it.
246 (when (frame-live-p frame-initial-frame)
248 ;; When tool-bar has been switched off, correct the frame size
249 ;; by the lines added in x-create-frame for the tool-bar and
250 ;; switch `tool-bar-mode' off.
251 (when (display-graphic-p)
252 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
253 (assq 'tool-bar-lines window-system-frame-alist)
254 (assq 'tool-bar-lines default-frame-alist))))
255 (when (and tool-bar-originally-present
256 (or (null tool-bar-lines)
257 (null (cdr tool-bar-lines))
258 (eq 0 (cdr tool-bar-lines))))
259 (let* ((char-height (frame-char-height frame-initial-frame))
260 (image-height tool-bar-images-pixel-height)
261 (margin (cond ((and (consp tool-bar-button-margin)
262 (integerp (cdr tool-bar-button-margin))
263 (> tool-bar-button-margin 0))
264 (cdr tool-bar-button-margin))
265 ((and (integerp tool-bar-button-margin)
266 (> tool-bar-button-margin 0))
267 tool-bar-button-margin)
269 (relief (if (and (integerp tool-bar-button-relief)
270 (> tool-bar-button-relief 0))
271 tool-bar-button-relief 3))
272 (lines (/ (+ image-height
277 (height (frame-parameter frame-initial-frame 'height))
278 (newparms (list (cons 'height (- height lines))))
279 (initial-top (cdr (assq 'top
280 frame-initial-geometry-arguments)))
281 (top (frame-parameter frame-initial-frame 'top)))
282 (when (and (consp initial-top) (eq '- (car initial-top)))
284 (cond ((and (consp top)
288 (* lines char-height))))
293 (* lines char-height))))
294 (t (+ top (* lines char-height))))))
297 `((top . ,adjusted-top))
299 (modify-frame-parameters frame-initial-frame newparms)
300 (tool-bar-mode -1)))))
302 ;; The initial frame we create above always has a minibuffer.
303 ;; If the user wants to remove it, or make it a minibuffer-only
304 ;; frame, then we'll have to delete the current frame and make a
305 ;; new one; you can't remove or add a root window to/from an
308 ;; NOTE: default-frame-alist was nil when we created the
309 ;; existing frame. We need to explicitly include
310 ;; default-frame-alist in the parameters of the screen we
311 ;; create here, so that its new value, gleaned from the user's
312 ;; init file, will be applied to the existing screen.
313 (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
314 (assq 'minibuffer window-system-frame-alist)
315 (assq 'minibuffer default-frame-alist)
318 ;; Create the new frame.
320 ;; MS-Windows needs this to avoid inflooping below.
321 (if (eq system-type 'windows-nt)
323 ;; If the frame isn't visible yet, wait till it is.
324 ;; If the user has to position the window,
325 ;; Emacs doesn't know its real position until
326 ;; the frame is seen to be visible.
327 (while (not (cdr (assq 'visibility
328 (frame-parameters frame-initial-frame))))
330 (setq parms (frame-parameters frame-initial-frame))
332 ;; Get rid of `name' unless it was specified explicitly before.
333 (or (assq 'name frame-initial-frame-alist)
334 (setq parms (delq (assq 'name parms) parms)))
335 ;; An explicit parent-id is a request to XEmbed the frame.
336 (or (assq 'parent-id frame-initial-frame-alist)
337 (setq parms (delq (assq 'parent-id parms) parms)))
339 (setq parms (append initial-frame-alist
340 window-system-frame-alist
345 ;; Get rid of `reverse', because that was handled
346 ;; when we first made the frame.
347 (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
349 (if (assq 'height frame-initial-geometry-arguments)
350 (setq parms (assq-delete-all 'height parms)))
351 (if (assq 'width frame-initial-geometry-arguments)
352 (setq parms (assq-delete-all 'width parms)))
353 (if (assq 'left frame-initial-geometry-arguments)
354 (setq parms (assq-delete-all 'left parms)))
355 (if (assq 'top frame-initial-geometry-arguments)
356 (setq parms (assq-delete-all 'top parms)))
359 ;; Use the geometry args that created the existing
360 ;; frame, rather than the parms we get for it.
361 (append frame-initial-geometry-arguments
362 '((user-size . t) (user-position . t))
364 ;; The initial frame, which we are about to delete, may be
365 ;; the only frame with a minibuffer. If it is, create a
367 (or (delq frame-initial-frame (minibuffer-frame-list))
368 (make-initial-minibuffer-frame nil))
370 ;; If the initial frame is serving as a surrogate
371 ;; minibuffer frame for any frames, we need to wean them
372 ;; onto a new frame. The default-minibuffer-frame
373 ;; variable must be handled similarly.
374 (let ((users-of-initial
377 (and (not (eq frame frame-initial-frame))
379 (minibuffer-window frame))
380 frame-initial-frame))))))
381 (if (or users-of-initial
382 (eq default-minibuffer-frame frame-initial-frame))
384 ;; Choose an appropriate frame. Prefer frames which
385 ;; are only minibuffers.
386 (let* ((new-surrogate
388 (or (filtered-frame-list
390 (eq (cdr (assq 'minibuffer
391 (frame-parameters frame)))
393 (minibuffer-frame-list))))
394 (new-minibuffer (minibuffer-window new-surrogate)))
396 (if (eq default-minibuffer-frame frame-initial-frame)
397 (setq default-minibuffer-frame new-surrogate))
399 ;; Wean the frames using frame-initial-frame as
400 ;; their minibuffer frame.
401 (dolist (frame users-of-initial)
402 (modify-frame-parameters
403 frame (list (cons 'minibuffer new-minibuffer)))))))
405 ;; Redirect events enqueued at this frame to the new frame.
406 ;; Is this a good idea?
407 (redirect-frame-focus frame-initial-frame new)
409 ;; Finally, get rid of the old frame.
410 (delete-frame frame-initial-frame t))
412 ;; Otherwise, we don't need all that rigmarole; just apply
413 ;; the new parameters.
414 (let (newparms allparms tail)
415 (setq allparms (append initial-frame-alist
416 window-system-frame-alist
417 default-frame-alist nil))
418 (if (assq 'height frame-initial-geometry-arguments)
419 (setq allparms (assq-delete-all 'height allparms)))
420 (if (assq 'width frame-initial-geometry-arguments)
421 (setq allparms (assq-delete-all 'width allparms)))
422 (if (assq 'left frame-initial-geometry-arguments)
423 (setq allparms (assq-delete-all 'left allparms)))
424 (if (assq 'top frame-initial-geometry-arguments)
425 (setq allparms (assq-delete-all 'top allparms)))
427 ;; Find just the parms that have changed since we first
428 ;; made this frame. Those are the ones actually set by
429 ;; the init file. For those parms whose values we already knew
430 ;; (such as those spec'd by command line options)
431 ;; it is undesirable to specify the parm again
432 ;; once the user has seen the frame and been able to alter it
436 (setq oldval (assq (car entry) frame-initial-frame-alist))
437 (setq newval (cdr (assq (car entry) allparms)))
438 (or (and oldval (eq (cdr oldval) newval))
440 (cons (cons (car entry) newval) newparms)))))
441 (setq newparms (nreverse newparms))
443 (let ((new-bg (assq 'background-color newparms)))
444 ;; If the `background-color' parameter is changed, apply
445 ;; it first, then make sure that the `background-mode'
446 ;; parameter and other faces are updated, before applying
447 ;; the other parameters.
449 (modify-frame-parameters frame-initial-frame
451 (unless (assq 'background-mode newparms)
452 (frame-set-background-mode frame-initial-frame))
453 (face-set-after-frame-default frame-initial-frame)
454 (setq newparms (delq new-bg newparms)))
455 (modify-frame-parameters frame-initial-frame newparms)))))
457 ;; Restore the original buffer.
458 (set-buffer old-buffer)
460 ;; Make sure the initial frame can be GC'd if it is ever deleted.
461 ;; Make sure frame-notice-user-settings does nothing if called twice.
462 (setq frame-notice-user-settings nil)
463 (setq frame-initial-frame nil)))
465 (defun make-initial-minibuffer-frame (display)
466 (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
468 (make-frame-on-display display parms)
469 (make-frame parms))))
471 ;;;; Creation of additional frames, and other frame miscellanea
473 (defun modify-all-frames-parameters (alist)
474 "Modify all current and future frames' parameters according to ALIST.
475 This changes `default-frame-alist' and possibly `initial-frame-alist'.
476 Furthermore, this function removes all parameters in ALIST from
477 `window-system-default-frame-alist'.
478 See help of `modify-frame-parameters' for more information."
479 (dolist (frame (frame-list))
480 (modify-frame-parameters frame alist))
482 (dolist (pair alist) ;; conses to add/replace
483 ;; initial-frame-alist needs setting only when
484 ;; frame-notice-user-settings is true.
485 (and frame-notice-user-settings
486 (setq initial-frame-alist
487 (assq-delete-all (car pair) initial-frame-alist)))
488 (setq default-frame-alist
489 (assq-delete-all (car pair) default-frame-alist))
490 ;; Remove any similar settings from the window-system specific
491 ;; parameters---they would override default-frame-alist.
492 (dolist (w window-system-default-frame-alist)
493 (setcdr w (assq-delete-all (car pair) (cdr w)))))
495 (and frame-notice-user-settings
496 (setq initial-frame-alist (append initial-frame-alist alist)))
497 (setq default-frame-alist (append default-frame-alist alist)))
499 (defun get-other-frame ()
500 "Return some frame other than the current frame.
501 Create one if necessary. Note that the minibuffer frame, if separate,
502 is not considered (see `next-frame')."
503 (if (equal (next-frame) (selected-frame)) (make-frame) (next-frame)))
505 (defun next-multiframe-window ()
506 "Select the next window, regardless of which frame it is on."
508 (select-window (next-window (selected-window)
509 (> (minibuffer-depth) 0)
511 (select-frame-set-input-focus (selected-frame)))
513 (defun previous-multiframe-window ()
514 "Select the previous window, regardless of which frame it is on."
516 (select-window (previous-window (selected-window)
517 (> (minibuffer-depth) 0)
519 (select-frame-set-input-focus (selected-frame)))
521 (defun window-system-for-display (display)
522 "Return the window system for DISPLAY.
523 Return nil if we don't know how to interpret DISPLAY."
524 (cl-loop for descriptor in display-format-alist
525 for pattern = (car descriptor)
526 for system = (cdr descriptor)
527 when (string-match-p pattern display) return system))
529 (defun make-frame-on-display (display &optional parameters)
530 "Make a frame on display DISPLAY.
531 The optional argument PARAMETERS specifies additional frame parameters."
532 (interactive "sMake frame on display: ")
533 (make-frame (cons (cons 'display display) parameters)))
535 (declare-function x-close-connection "xfns.c" (terminal))
537 (defun close-display-connection (display)
538 "Close the connection to a display, deleting all its associated frames.
539 For DISPLAY, specify either a frame or a display name (a string).
540 If DISPLAY is nil, that stands for the selected frame's display."
543 (let* ((default (frame-parameter nil 'display))
544 (display (completing-read
545 (format "Close display (default %s): " default)
547 (mapcar (lambda (frame)
548 (frame-parameter frame 'display))
552 (if (zerop (length display)) default display))))
553 (let ((frames (delq nil
554 (mapcar (lambda (frame)
556 (frame-parameter frame 'display))
559 (if (and (consp frames)
560 (not (y-or-n-p (if (cdr frames)
561 (format "Delete %s frames? " (length frames))
562 (format "Delete %s ? " (car frames))))))
564 (mapc 'delete-frame frames)
565 (x-close-connection display))))
567 (defun make-frame-command ()
568 "Make a new frame, on the same terminal as the selected frame.
569 If the terminal is a text-only terminal, this also selects the
572 (if (display-graphic-p)
574 (select-frame (make-frame))))
576 (defvar before-make-frame-hook nil
577 "Functions to run before a frame is created.")
579 (defvar after-make-frame-functions nil
580 "Functions to run after a frame is created.
581 The functions are run with one arg, the newly created frame.")
583 (defvar after-setting-font-hook nil
584 "Functions to run after a frame's font has been changed.")
586 ;; Alias, kept temporarily.
587 (define-obsolete-function-alias 'new-frame 'make-frame "22.1")
589 (defvar frame-inherited-parameters '()
590 ;; FIXME: Shouldn't we add `font' here as well?
591 "Parameters `make-frame' copies from the `selected-frame' to the new frame.")
593 (defun make-frame (&optional parameters)
594 "Return a newly created frame displaying the current buffer.
595 Optional argument PARAMETERS is an alist of frame parameters for
596 the new frame. Each element of PARAMETERS should have the
597 form (NAME . VALUE), for example:
599 (name . STRING) The frame should be named STRING.
601 (width . NUMBER) The frame should be NUMBER characters in width.
602 (height . NUMBER) The frame should be NUMBER text lines high.
604 You cannot specify either `width' or `height', you must specify
607 (minibuffer . t) The frame should have a minibuffer.
608 (minibuffer . nil) The frame should have no minibuffer.
609 (minibuffer . only) The frame should contain only a minibuffer.
610 (minibuffer . WINDOW) The frame should use WINDOW as its minibuffer window.
612 (window-system . nil) The frame should be displayed on a terminal device.
613 (window-system . x) The frame should be displayed in an X window.
615 (display . \":0\") The frame should appear on display :0.
617 (terminal . TERMINAL) The frame should use the terminal object TERMINAL.
619 In addition, any parameter specified in `default-frame-alist',
620 but not present in PARAMETERS, is applied.
622 Before creating the frame (via `frame-creation-function-alist'),
623 this function runs the hook `before-make-frame-hook'. After
624 creating the frame, it runs the hook `after-make-frame-functions'
625 with one arg, the newly created frame.
627 If a display parameter is supplied and a window-system is not,
628 guess the window-system from the display.
630 On graphical displays, this function does not itself make the new
631 frame the selected frame. However, the window system may select
632 the new frame according to its own rules."
634 (let* ((display (cdr (assq 'display parameters)))
636 ((assq 'terminal parameters)
637 (let ((type (terminal-live-p (cdr (assq 'terminal parameters)))))
640 ((eq type nil) (error "Terminal %s does not exist"
641 (cdr (assq 'terminal parameters))))
643 ((assq 'window-system parameters)
644 (cdr (assq 'window-system parameters)))
646 (or (window-system-for-display display)
647 (error "Don't know how to interpret display \"%S\""
650 (frame-creation-function (cdr (assq w frame-creation-function-alist)))
651 (oldframe (selected-frame))
654 (unless frame-creation-function
655 (error "Don't know how to create a frame on window system %s" w))
657 (unless (get w 'window-system-initialized)
658 (funcall (cdr (assq w window-system-initialization-alist)) display)
659 (setq x-display-name display)
660 (put w 'window-system-initialized t))
662 ;; Add parameters from `window-system-default-frame-alist'.
663 (dolist (p (cdr (assq w window-system-default-frame-alist)))
664 (unless (assq (car p) params)
666 ;; Add parameters from `default-frame-alist'.
667 (dolist (p default-frame-alist)
668 (unless (assq (car p) params)
670 ;; Now make the frame.
671 (run-hooks 'before-make-frame-hook)
672 (setq frame (funcall frame-creation-function params))
673 (normal-erase-is-backspace-setup-frame frame)
674 ;; Inherit the original frame's parameters.
675 (dolist (param frame-inherited-parameters)
676 (unless (assq param parameters) ;Overridden by explicit parameters.
677 (let ((val (frame-parameter oldframe param)))
678 (when val (set-frame-parameter frame param val)))))
679 (run-hook-with-args 'after-make-frame-functions frame)
682 (defun filtered-frame-list (predicate)
683 "Return a list of all live frames which satisfy PREDICATE."
684 (let* ((frames (frame-list))
686 (while (consp frames)
687 (unless (funcall predicate (car frames))
689 (setq frames (cdr frames)))
692 (defun minibuffer-frame-list ()
693 "Return a list of all frames with their own minibuffers."
696 (eq frame (window-frame (minibuffer-window frame))))))
698 ;; Used to be called `terminal-id' in termdev.el.
699 (defun get-device-terminal (device)
700 "Return the terminal corresponding to DEVICE.
701 DEVICE can be a terminal, a frame, nil (meaning the selected frame's terminal),
702 the name of an X display device (HOST.SERVER.SCREEN) or a tty device file."
704 ((or (null device) (framep device))
705 (frame-terminal device))
707 (let ((f (car (filtered-frame-list
709 (or (equal (frame-parameter frame 'display) device)
710 (equal (frame-parameter frame 'tty) device)))))))
711 (or f (error "Display %s does not exist" device))
713 ((terminal-live-p device) device)
715 (error "Invalid argument %s in `get-device-terminal'" device))))
717 (defun frames-on-display-list (&optional device)
718 "Return a list of all frames on DEVICE.
720 DEVICE should be a terminal, a frame,
721 or a name of an X display or tty (a string of the form
724 If DEVICE is omitted or nil, it defaults to the selected
725 frame's terminal device."
726 (let* ((terminal (get-device-terminal device))
727 (func #'(lambda (frame)
728 (eq (frame-terminal frame) terminal))))
729 (filtered-frame-list func)))
731 (defun framep-on-display (&optional terminal)
732 "Return the type of frames on TERMINAL.
733 TERMINAL may be a terminal id, a display name or a frame. If it
734 is a frame, its type is returned. If TERMINAL is omitted or nil,
735 it defaults to the selected frame's terminal device. All frames
736 on a given display are of the same type."
737 (or (terminal-live-p terminal)
739 (framep (car (frames-on-display-list terminal)))))
741 (defun frame-remove-geometry-params (param-list)
742 "Return the parameter list PARAM-LIST, but with geometry specs removed.
743 This deletes all bindings in PARAM-LIST for `top', `left', `width',
744 `height', `user-size' and `user-position' parameters.
745 Emacs uses this to avoid overriding explicit moves and resizings from
746 the user during startup."
747 (setq param-list (cons nil param-list))
748 (let ((tail param-list))
749 (while (consp (cdr tail))
750 (if (and (consp (car (cdr tail)))
751 (memq (car (car (cdr tail)))
752 '(height width top left user-position user-size)))
754 (setq frame-initial-geometry-arguments
755 (cons (car (cdr tail)) frame-initial-geometry-arguments))
756 (setcdr tail (cdr (cdr tail))))
757 (setq tail (cdr tail)))))
758 (setq frame-initial-geometry-arguments
759 (nreverse frame-initial-geometry-arguments))
762 (declare-function x-focus-frame "frame.c" (frame))
764 (defun select-frame-set-input-focus (frame &optional norecord)
765 "Select FRAME, raise it, and set input focus, if possible.
766 If `mouse-autoselect-window' is non-nil, also move mouse pointer
767 to FRAME's selected window. Otherwise, if `focus-follows-mouse'
768 is non-nil, move mouse cursor to FRAME.
770 Optional argument NORECORD means to neither change the order of
771 recently selected windows nor the buffer list."
772 (select-frame frame norecord)
774 ;; Ensure, if possible, that FRAME gets input focus.
775 (when (memq (window-system frame) '(x w32 ns))
776 (x-focus-frame frame))
777 ;; Move mouse cursor if necessary.
779 (mouse-autoselect-window
780 (let ((edges (window-inside-edges (frame-selected-window frame))))
781 ;; Move mouse cursor into FRAME's selected window to avoid that
782 ;; Emacs mouse-autoselects another window.
783 (set-mouse-position frame (nth 2 edges) (nth 1 edges))))
785 ;; Move mouse cursor into FRAME to avoid that another frame gets
786 ;; selected by the window manager.
787 (set-mouse-position frame (1- (frame-width frame)) 0))))
789 (defun other-frame (arg)
790 "Select the ARGth different visible frame on current display, and raise it.
791 All frames are arranged in a cyclic order.
792 This command selects the frame ARG steps away in that order.
793 A negative ARG moves in the opposite order.
795 To make this command work properly, you must tell Emacs
796 how the system (or the window manager) generally handles
797 focus-switching between windows. If moving the mouse onto a window
798 selects it (gives it focus), set `focus-follows-mouse' to t.
799 Otherwise, that variable should be nil."
801 (let ((frame (selected-frame)))
803 (setq frame (next-frame frame))
804 (while (not (eq (frame-visible-p frame) t))
805 (setq frame (next-frame frame)))
808 (setq frame (previous-frame frame))
809 (while (not (eq (frame-visible-p frame) t))
810 (setq frame (previous-frame frame)))
812 (select-frame-set-input-focus frame)))
814 (defun iconify-or-deiconify-frame ()
815 "Iconify the selected frame, or deiconify if it's currently an icon."
817 (if (eq (cdr (assq 'visibility (frame-parameters))) t)
819 (make-frame-visible)))
821 (defun suspend-frame ()
822 "Do whatever is right to suspend the current frame.
823 Calls `suspend-emacs' if invoked from the controlling tty device,
824 `suspend-tty' from a secondary tty device, and
825 `iconify-or-deiconify-frame' from an X frame."
827 (let ((type (framep (selected-frame))))
829 ((memq type '(x ns w32)) (iconify-or-deiconify-frame))
831 (if (controlling-tty-p)
834 (t (suspend-emacs)))))
836 (defun make-frame-names-alist ()
837 ;; Only consider the frames on the same display.
838 (let* ((current-frame (selected-frame))
841 (cons (frame-parameter current-frame 'name) current-frame) nil))
842 (frame (next-frame nil 0)))
843 (while (not (eq frame current-frame))
845 (push (cons (frame-parameter frame 'name) frame) falist)
846 (setq frame (next-frame frame 0))))
849 (defvar frame-name-history nil)
850 (defun select-frame-by-name (name)
851 "Select the frame on the current terminal whose name is NAME and raise it.
852 If there is no frame by that name, signal an error."
854 (let* ((frame-names-alist (make-frame-names-alist))
855 (default (car (car frame-names-alist)))
856 (input (completing-read
857 (format "Select Frame (default %s): " default)
858 frame-names-alist nil t nil 'frame-name-history)))
859 (if (= (length input) 0)
862 (let* ((frame-names-alist (make-frame-names-alist))
863 (frame (cdr (assoc name frame-names-alist))))
865 (select-frame-set-input-focus frame)
866 (error "There is no frame named `%s'" name))))
869 ;;;; Background mode.
871 (defcustom frame-background-mode nil
872 "The brightness of the background.
873 Set this to the symbol `dark' if your background color is dark,
874 `light' if your background is light, or nil (automatic by default)
875 if you want Emacs to examine the brightness for you.
877 If you change this without using customize, you should use
878 `frame-set-background-mode' to update existing frames;
879 e.g. (mapc 'frame-set-background-mode (frame-list))."
881 :set #'(lambda (var value)
882 (set-default var value)
883 (mapc 'frame-set-background-mode (frame-list)))
884 :initialize 'custom-initialize-changed
885 :type '(choice (const dark)
887 (const :tag "automatic" nil)))
889 (declare-function x-get-resource "frame.c"
890 (attribute class &optional component subclass))
892 ;; Only used if window-system is not null.
893 (declare-function x-display-grayscale-p "xfns.c" (&optional terminal))
895 (defvar inhibit-frame-set-background-mode nil)
897 (defun frame-set-background-mode (frame &optional keep-face-specs)
898 "Set up display-dependent faces on FRAME.
899 Display-dependent faces are those which have different definitions
900 according to the `background-mode' and `display-type' frame parameters.
902 If optional arg KEEP-FACE-SPECS is non-nil, don't recalculate
903 face specs for the new background mode."
904 (unless inhibit-frame-set-background-mode
905 (let* ((frame-default-bg-mode (frame-terminal-default-bg-mode frame))
906 (bg-color (frame-parameter frame 'background-color))
907 (tty-type (tty-type frame))
909 (if (or (window-system frame)
911 (string-match "^\\(xterm\\|\\rxvt\\|dtterm\\|eterm\\)"
915 (non-default-bg-mode (if (eq default-bg-mode 'light) 'dark 'light))
917 (cond (frame-default-bg-mode)
918 ((equal bg-color "unspecified-fg") ; inverted colors
920 ((not (color-values bg-color frame))
922 ((>= (apply '+ (color-values bg-color frame))
923 ;; Just looking at the screen, colors whose
924 ;; values add up to .6 of the white total
925 ;; still look dark to me.
926 (* (apply '+ (color-values "white" frame)) .6))
930 (cond ((null (window-system frame))
931 (if (tty-display-color-p frame) 'color 'mono))
932 ((display-color-p frame)
934 ((x-display-grayscale-p frame)
938 (frame-parameter frame 'background-mode))
940 (frame-parameter frame 'display-type)))
942 (unless (and (eq bg-mode old-bg-mode) (eq display-type old-display-type))
943 (let ((locally-modified-faces nil)
944 ;; Prevent face-spec-recalc from calling this function
945 ;; again, resulting in a loop (bug#911).
946 (inhibit-frame-set-background-mode t)
947 (params (list (cons 'background-mode bg-mode)
948 (cons 'display-type display-type))))
950 (modify-frame-parameters frame params)
951 ;; If we are recomputing face specs, first collect a list
952 ;; of faces that don't match their face-specs. These are
953 ;; the faces modified on FRAME, and we avoid changing them
954 ;; below. Use a negative list to avoid consing (we assume
955 ;; most faces are unmodified).
956 (dolist (face (face-list))
957 (and (not (get face 'face-override-spec))
958 (not (face-spec-match-p face
959 (face-user-default-spec face)
961 (push face locally-modified-faces)))
962 ;; Now change to the new frame parameters
963 (modify-frame-parameters frame params)
964 ;; For all unmodified named faces, choose face specs
965 ;; matching the new frame parameters.
966 (dolist (face (face-list))
967 (unless (memq face locally-modified-faces)
968 (face-spec-recalc face frame)))))))))
970 (defun frame-terminal-default-bg-mode (frame)
971 "Return the default background mode of FRAME.
972 This checks the `frame-background-mode' variable, the X resource
973 named \"backgroundMode\" (if FRAME is an X frame), and finally
974 the `background-mode' terminal parameter."
975 (or frame-background-mode
977 (and (window-system frame)
978 (x-get-resource "backgroundMode" "BackgroundMode"))))
980 (intern (downcase bg-resource))))
981 (terminal-parameter frame 'background-mode)))
984 ;;;; Frame configurations
986 (defun current-frame-configuration ()
987 "Return a list describing the positions and states of all frames.
988 Its car is `frame-configuration'.
989 Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
991 FRAME is a frame object,
992 ALIST is an association list specifying some of FRAME's parameters, and
993 WINDOW-CONFIG is a window configuration object for FRAME."
994 (cons 'frame-configuration
995 (mapcar (lambda (frame)
997 (frame-parameters frame)
998 (current-window-configuration frame)))
1001 (defun set-frame-configuration (configuration &optional nodelete)
1002 "Restore the frames to the state described by CONFIGURATION.
1003 Each frame listed in CONFIGURATION has its position, size, window
1004 configuration, and other parameters set as specified in CONFIGURATION.
1005 However, this function does not restore deleted frames.
1007 Ordinarily, this function deletes all existing frames not
1008 listed in CONFIGURATION. But if optional second argument NODELETE
1009 is given and non-nil, the unwanted frames are iconified instead."
1010 (or (frame-configuration-p configuration)
1011 (signal 'wrong-type-argument
1012 (list 'frame-configuration-p configuration)))
1013 (let ((config-alist (cdr configuration))
1015 (dolist (frame (frame-list))
1016 (let ((parameters (assq frame config-alist)))
1019 (modify-frame-parameters
1021 ;; Since we can't set a frame's minibuffer status,
1022 ;; we might as well omit the parameter altogether.
1023 (let* ((parms (nth 1 parameters))
1024 (mini (assq 'minibuffer parms))
1025 (name (assq 'name parms))
1026 (explicit-name (cdr (assq 'explicit-name parms))))
1027 (when mini (setq parms (delq mini parms)))
1028 ;; Leave name in iff it was set explicitly.
1029 ;; This should fix the behavior reported in
1030 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg01632.html
1031 (when (and name (not explicit-name))
1032 (setq parms (delq name parms)))
1034 (set-window-configuration (nth 2 parameters)))
1035 (setq frames-to-delete (cons frame frames-to-delete)))))
1037 ;; Note: making frames invisible here was tried
1038 ;; but led to some strange behavior--each time the frame
1039 ;; was made visible again, the window manager asked afresh
1040 ;; for where to put it.
1045 ;;;; Convenience functions for accessing and interactively changing
1046 ;;;; frame parameters.
1048 (defun frame-height (&optional frame)
1049 "Return number of lines available for display on FRAME.
1050 If FRAME is omitted, describe the currently selected frame.
1051 Exactly what is included in the return value depends on the
1052 window-system and toolkit in use - see `frame-pixel-height' for
1053 more details. The lines are in units of the default font height.
1055 The result is roughly related to the frame pixel height via
1056 height in pixels = height in lines * `frame-char-height'.
1057 However, this is only approximate, and is complicated e.g. by the
1058 fact that individual window lines and menu bar lines can have
1059 differing font heights."
1060 (cdr (assq 'height (frame-parameters frame))))
1062 (defun frame-width (&optional frame)
1063 "Return number of columns available for display on FRAME.
1064 If FRAME is omitted, describe the currently selected frame."
1065 (cdr (assq 'width (frame-parameters frame))))
1067 (declare-function x-list-fonts "xfaces.c"
1068 (pattern &optional face frame maximum width))
1070 (define-obsolete-function-alias 'set-default-font 'set-frame-font "23.1")
1072 (defun set-frame-font (font &optional keep-size frames)
1073 "Set the default font to FONT.
1074 When called interactively, prompt for the name of a font, and use
1075 that font on the selected frame. When called from Lisp, FONT
1076 should be a font name (a string), a font object, font entity, or
1079 If KEEP-SIZE is nil, keep the number of frame lines and columns
1080 fixed. If KEEP-SIZE is non-nil (or with a prefix argument), try
1081 to keep the current frame size fixed (in pixels) by adjusting the
1082 number of lines and columns.
1084 If FRAMES is nil, apply the font to the selected frame only.
1085 If FRAMES is non-nil, it should be a list of frames to act upon,
1086 or t meaning all graphical frames. Also, if FRAME is non-nil,
1087 alter the user's Customization settings as though the
1088 font-related attributes of the `default' face had been \"set in
1089 this session\", so that the font is applied to future frames."
1091 (let* ((completion-ignore-case t)
1092 (font (completing-read "Font name: "
1093 ;; x-list-fonts will fail with an error
1094 ;; if this frame doesn't support fonts.
1095 (x-list-fonts "*" nil (selected-frame))
1097 (frame-parameter nil 'font))))
1098 (list font current-prefix-arg nil)))
1099 (when (or (stringp font) (fontp font))
1100 (let* ((this-frame (selected-frame))
1101 ;; FRAMES nil means affect the selected frame.
1102 (frame-list (cond ((null frames)
1108 (dolist (f frame-list)
1109 (when (display-multi-font-p f)
1111 (setq height (* (frame-parameter f 'height)
1112 (frame-char-height f))
1113 width (* (frame-parameter f 'width)
1114 (frame-char-width f))))
1115 ;; When set-face-attribute is called for :font, Emacs
1116 ;; guesses the best font according to other face attributes
1117 ;; (:width, :weight, etc.) so reset them too (Bug#2476).
1118 (set-face-attribute 'default f
1119 :width 'normal :weight 'normal
1120 :slant 'normal :font font)
1122 (modify-frame-parameters
1124 (list (cons 'height (round height (frame-char-height f)))
1125 (cons 'width (round width (frame-char-width f))))))))
1127 ;; Alter the user's Custom setting of the `default' face, but
1128 ;; only for font-related attributes.
1129 (let ((specs (cadr (assq 'user (get 'default 'theme-face))))
1130 (attrs '(:family :foundry :slant :weight :height :width))
1132 (if (null specs) (setq specs '((t nil))))
1133 (dolist (spec specs)
1134 ;; Each SPEC has the form (DISPLAY ATTRIBUTE-PLIST)
1135 (let ((display (nth 0 spec))
1136 (plist (copy-tree (nth 1 spec))))
1137 ;; Alter only DISPLAY conditions matching this frame.
1138 (when (or (memq display '(t default))
1139 (face-spec-set-match-display display this-frame))
1140 (dolist (attr attrs)
1141 (setq plist (plist-put plist attr
1142 (face-attribute 'default attr)))))
1143 (push (list display plist) new-specs)))
1144 (setq new-specs (nreverse new-specs))
1145 (put 'default 'customized-face new-specs)
1146 (custom-push-theme 'theme-face 'default 'user 'set new-specs)
1147 (put 'default 'face-modified nil))))
1148 (run-hooks 'after-setting-font-hook 'after-setting-font-hooks)))
1150 (defun set-frame-parameter (frame parameter value)
1151 "Set frame parameter PARAMETER to VALUE on FRAME.
1152 If FRAME is nil, it defaults to the selected frame.
1153 See `modify-frame-parameters'."
1154 (modify-frame-parameters frame (list (cons parameter value))))
1156 (defun set-background-color (color-name)
1157 "Set the background color of the selected frame to COLOR-NAME.
1158 When called interactively, prompt for the name of the color to use.
1159 To get the frame's current background color, use `frame-parameters'."
1160 (interactive (list (read-color "Background color: ")))
1161 (modify-frame-parameters (selected-frame)
1162 (list (cons 'background-color color-name)))
1164 (face-set-after-frame-default (selected-frame))))
1166 (defun set-foreground-color (color-name)
1167 "Set the foreground color of the selected frame to COLOR-NAME.
1168 When called interactively, prompt for the name of the color to use.
1169 To get the frame's current foreground color, use `frame-parameters'."
1170 (interactive (list (read-color "Foreground color: ")))
1171 (modify-frame-parameters (selected-frame)
1172 (list (cons 'foreground-color color-name)))
1174 (face-set-after-frame-default (selected-frame))))
1176 (defun set-cursor-color (color-name)
1177 "Set the text cursor color of the selected frame to COLOR-NAME.
1178 When called interactively, prompt for the name of the color to use.
1179 This works by setting the `cursor-color' frame parameter on the
1182 You can also set the text cursor color, for all frames, by
1183 customizing the `cursor' face."
1184 (interactive (list (read-color "Cursor color: ")))
1185 (modify-frame-parameters (selected-frame)
1186 (list (cons 'cursor-color color-name))))
1188 (defun set-mouse-color (color-name)
1189 "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
1190 When called interactively, prompt for the name of the color to use.
1191 To get the frame's current mouse color, use `frame-parameters'."
1192 (interactive (list (read-color "Mouse color: ")))
1193 (modify-frame-parameters (selected-frame)
1194 (list (cons 'mouse-color
1196 (cdr (assq 'mouse-color
1197 (frame-parameters))))))))
1199 (defun set-border-color (color-name)
1200 "Set the color of the border of the selected frame to COLOR-NAME.
1201 When called interactively, prompt for the name of the color to use.
1202 To get the frame's current border color, use `frame-parameters'."
1203 (interactive (list (read-color "Border color: ")))
1204 (modify-frame-parameters (selected-frame)
1205 (list (cons 'border-color color-name))))
1207 (define-minor-mode auto-raise-mode
1208 "Toggle whether or not selected frames should auto-raise.
1209 With a prefix argument ARG, enable Auto Raise mode if ARG is
1210 positive, and disable it otherwise. If called from Lisp, enable
1211 the mode if ARG is omitted or nil.
1213 Auto Raise mode does nothing under most window managers, which
1214 switch focus on mouse clicks. It only has an effect if your
1215 window manager switches focus on mouse movement (in which case
1216 you should also change `focus-follows-mouse' to t). Then,
1217 enabling Auto Raise mode causes any graphical Emacs frame which
1218 acquires focus to be automatically raised.
1220 Note that this minor mode controls Emacs's own auto-raise
1221 feature. Window managers that switch focus on mouse movement
1222 often have their own auto-raise feature."
1223 :variable (frame-parameter nil 'auto-raise)
1224 (if (frame-parameter nil 'auto-raise)
1227 (define-minor-mode auto-lower-mode
1228 "Toggle whether or not the selected frame should auto-lower.
1229 With a prefix argument ARG, enable Auto Lower mode if ARG is
1230 positive, and disable it otherwise. If called from Lisp, enable
1231 the mode if ARG is omitted or nil.
1233 Auto Lower mode does nothing under most window managers, which
1234 switch focus on mouse clicks. It only has an effect if your
1235 window manager switches focus on mouse movement (in which case
1236 you should also change `focus-follows-mouse' to t). Then,
1237 enabling Auto Lower Mode causes any graphical Emacs frame which
1238 loses focus to be automatically lowered.
1240 Note that this minor mode controls Emacs's own auto-lower
1241 feature. Window managers that switch focus on mouse movement
1242 often have their own features for raising or lowering frames."
1243 :variable (frame-parameter nil 'auto-lower))
1245 (defun set-frame-name (name)
1246 "Set the name of the selected frame to NAME.
1247 When called interactively, prompt for the name of the frame.
1248 On text terminals, the frame name is displayed on the mode line.
1249 On graphical displays, it is displayed on the frame's title bar."
1250 (interactive "sFrame name: ")
1251 (modify-frame-parameters (selected-frame)
1252 (list (cons 'name name))))
1254 (defun frame-current-scroll-bars (&optional frame)
1255 "Return the current scroll-bar settings in frame FRAME.
1256 Value is a cons (VERTICAL . HORIZ0NTAL) where VERTICAL specifies the
1257 current location of the vertical scroll-bars (left, right, or nil),
1258 and HORIZONTAL specifies the current location of the horizontal scroll
1259 bars (top, bottom, or nil)."
1260 (let ((vert (frame-parameter frame 'vertical-scroll-bars))
1262 (unless (memq vert '(left right nil))
1263 (setq vert default-frame-scroll-bars))
1266 (defun frame-monitor-attributes (&optional frame)
1267 "Return the attributes of the physical monitor dominating FRAME.
1268 If FRAME is omitted, describe the currently selected frame.
1270 A frame is dominated by a physical monitor when either the
1271 largest area of the frame resides in the monitor, or the monitor
1272 is the closest to the frame if the frame does not intersect any
1275 See `display-monitor-attributes-list' for the list of attribute
1276 keys and their meanings."
1277 (or frame (setq frame (selected-frame)))
1278 (cl-loop for attributes in (display-monitor-attributes-list frame)
1279 for frames = (cdr (assq 'frames attributes))
1280 if (memq frame frames) return attributes))
1283 ;;;; Frame/display capabilities.
1285 (declare-function msdos-mouse-p "dosfns.c")
1287 (defun display-mouse-p (&optional display)
1288 "Return non-nil if DISPLAY has a mouse available.
1289 DISPLAY can be a display name, a frame, or nil (meaning the selected
1291 (let ((frame-type (framep-on-display display)))
1293 ((eq frame-type 'pc)
1295 ((eq frame-type 'w32)
1297 (> w32-num-mouse-buttons 0)))
1298 ((memq frame-type '(x ns))
1299 t) ;; We assume X and NeXTstep *always* have a pointing device
1301 (or (and (featurep 'xt-mouse)
1303 ;; t-mouse is distributed with the GPM package. It doesn't have
1305 (featurep 't-mouse))))))
1307 (defun display-popup-menus-p (&optional display)
1308 "Return non-nil if popup menus are supported on DISPLAY.
1309 DISPLAY can be a display name, a frame, or nil (meaning the selected
1311 Support for popup menus requires that the mouse be available."
1313 (let ((frame-type (framep-on-display display)))
1314 (memq frame-type '(x w32 pc ns)))
1315 (display-mouse-p display)))
1317 (defun display-graphic-p (&optional display)
1318 "Return non-nil if DISPLAY is a graphic display.
1319 Graphical displays are those which are capable of displaying several
1320 frames and several different fonts at once. This is true for displays
1321 that use a window system such as X, and false for text-only terminals.
1322 DISPLAY can be a display name, a frame, or nil (meaning the selected
1324 (not (null (memq (framep-on-display display) '(x w32 ns)))))
1326 (defun display-images-p (&optional display)
1327 "Return non-nil if DISPLAY can display images.
1329 DISPLAY can be a display name, a frame, or nil (meaning the selected
1331 (and (display-graphic-p display)
1332 (fboundp 'image-mask-p)
1333 (fboundp 'image-size)))
1335 (defalias 'display-multi-frame-p 'display-graphic-p)
1336 (defalias 'display-multi-font-p 'display-graphic-p)
1338 (defun display-selections-p (&optional display)
1339 "Return non-nil if DISPLAY supports selections.
1340 A selection is a way to transfer text or other data between programs
1341 via special system buffers called `selection' or `clipboard'.
1342 DISPLAY can be a display name, a frame, or nil (meaning the selected
1344 (let ((frame-type (framep-on-display display)))
1346 ((eq frame-type 'pc)
1347 ;; MS-DOG frames support selections when Emacs runs inside
1348 ;; the Windows' DOS Box.
1350 (not (null dos-windows-version))))
1351 ((memq frame-type '(x w32 ns))
1356 (declare-function x-display-screens "xfns.c" (&optional terminal))
1358 (defun display-screens (&optional display)
1359 "Return the number of screens associated with DISPLAY."
1360 (let ((frame-type (framep-on-display display)))
1362 ((memq frame-type '(x w32 ns))
1363 (x-display-screens display))
1367 (declare-function x-display-pixel-height "xfns.c" (&optional terminal))
1369 (defun display-pixel-height (&optional display)
1370 "Return the height of DISPLAY's screen in pixels.
1371 For character terminals, each character counts as a single pixel.
1372 For graphical terminals, note that on \"multi-monitor\" setups this
1373 refers to the pixel height for all physical monitors associated
1374 with DISPLAY. To get information for each physical monitor, use
1375 `display-monitor-attributes-list'."
1376 (let ((frame-type (framep-on-display display)))
1378 ((memq frame-type '(x w32 ns))
1379 (x-display-pixel-height display))
1381 (frame-height (if (framep display) display (selected-frame)))))))
1383 (declare-function x-display-pixel-width "xfns.c" (&optional terminal))
1385 (defun display-pixel-width (&optional display)
1386 "Return the width of DISPLAY's screen in pixels.
1387 For character terminals, each character counts as a single pixel.
1388 For graphical terminals, note that on \"multi-monitor\" setups this
1389 refers to the pixel width for all physical monitors associated
1390 with DISPLAY. To get information for each physical monitor, use
1391 `display-monitor-attributes-list'."
1392 (let ((frame-type (framep-on-display display)))
1394 ((memq frame-type '(x w32 ns))
1395 (x-display-pixel-width display))
1397 (frame-width (if (framep display) display (selected-frame)))))))
1399 (defcustom display-mm-dimensions-alist nil
1400 "Alist for specifying screen dimensions in millimeters.
1401 The dimensions will be used for `display-mm-height' and
1402 `display-mm-width' if defined for the respective display.
1404 Each element of the alist has the form (display . (width . height)),
1405 e.g. (\":0.0\" . (287 . 215)).
1407 If `display' equals t, it specifies dimensions for all graphical
1408 displays not explicitly specified."
1410 :type '(alist :key-type (choice (string :tag "Display name")
1411 (const :tag "Default" t))
1412 :value-type (cons :tag "Dimensions"
1413 (integer :tag "Width")
1414 (integer :tag "Height")))
1417 (declare-function x-display-mm-height "xfns.c" (&optional terminal))
1419 (defun display-mm-height (&optional display)
1420 "Return the height of DISPLAY's screen in millimeters.
1421 System values can be overridden by `display-mm-dimensions-alist'.
1422 If the information is unavailable, value is nil.
1423 For graphical terminals, note that on \"multi-monitor\" setups this
1424 refers to the height in millimeters for all physical monitors
1425 associated with DISPLAY. To get information for each physical
1426 monitor, use `display-monitor-attributes-list'."
1427 (and (memq (framep-on-display display) '(x w32 ns))
1428 (or (cddr (assoc (or display (frame-parameter nil 'display))
1429 display-mm-dimensions-alist))
1430 (cddr (assoc t display-mm-dimensions-alist))
1431 (x-display-mm-height display))))
1433 (declare-function x-display-mm-width "xfns.c" (&optional terminal))
1435 (defun display-mm-width (&optional display)
1436 "Return the width of DISPLAY's screen in millimeters.
1437 System values can be overridden by `display-mm-dimensions-alist'.
1438 If the information is unavailable, value is nil.
1439 For graphical terminals, note that on \"multi-monitor\" setups this
1440 refers to the width in millimeters for all physical monitors
1441 associated with DISPLAY. To get information for each physical
1442 monitor, use `display-monitor-attributes-list'."
1443 (and (memq (framep-on-display display) '(x w32 ns))
1444 (or (cadr (assoc (or display (frame-parameter nil 'display))
1445 display-mm-dimensions-alist))
1446 (cadr (assoc t display-mm-dimensions-alist))
1447 (x-display-mm-width display))))
1449 (declare-function x-display-backing-store "xfns.c" (&optional terminal))
1451 ;; In NS port, the return value may be `buffered', `retained', or
1452 ;; `non-retained'. See src/nsfns.m.
1453 (defun display-backing-store (&optional display)
1454 "Return the backing store capability of DISPLAY's screen.
1455 The value may be `always', `when-mapped', `not-useful', or nil if
1456 the question is inapplicable to a certain kind of display."
1457 (let ((frame-type (framep-on-display display)))
1459 ((memq frame-type '(x w32 ns))
1460 (x-display-backing-store display))
1464 (declare-function x-display-save-under "xfns.c" (&optional terminal))
1466 (defun display-save-under (&optional display)
1467 "Return non-nil if DISPLAY's screen supports the SaveUnder feature."
1468 (let ((frame-type (framep-on-display display)))
1470 ((memq frame-type '(x w32 ns))
1471 (x-display-save-under display))
1475 (declare-function x-display-planes "xfns.c" (&optional terminal))
1477 (defun display-planes (&optional display)
1478 "Return the number of planes supported by DISPLAY."
1479 (let ((frame-type (framep-on-display display)))
1481 ((memq frame-type '(x w32 ns))
1482 (x-display-planes display))
1483 ((eq frame-type 'pc)
1486 (truncate (log (length (tty-color-alist)) 2))))))
1488 (declare-function x-display-color-cells "xfns.c" (&optional terminal))
1490 (defun display-color-cells (&optional display)
1491 "Return the number of color cells supported by DISPLAY."
1492 (let ((frame-type (framep-on-display display)))
1494 ((memq frame-type '(x w32 ns))
1495 (x-display-color-cells display))
1496 ((eq frame-type 'pc)
1499 (tty-display-color-cells display)))))
1501 (declare-function x-display-visual-class "xfns.c" (&optional terminal))
1503 (defun display-visual-class (&optional display)
1504 "Return the visual class of DISPLAY.
1505 The value is one of the symbols `static-gray', `gray-scale',
1506 `static-color', `pseudo-color', `true-color', or `direct-color'."
1507 (let ((frame-type (framep-on-display display)))
1509 ((memq frame-type '(x w32 ns))
1510 (x-display-visual-class display))
1511 ((and (memq frame-type '(pc t))
1512 (tty-display-color-p display))
1517 (declare-function x-display-monitor-attributes-list "xfns.c"
1518 (&optional terminal))
1519 (declare-function w32-display-monitor-attributes-list "w32fns.c"
1520 (&optional display))
1521 (declare-function ns-display-monitor-attributes-list "nsfns.m"
1522 (&optional terminal))
1524 (defun display-monitor-attributes-list (&optional display)
1525 "Return a list of physical monitor attributes on DISPLAY.
1526 Each element of the list represents the attributes of each
1527 physical monitor. The first element corresponds to the primary
1530 Attributes for a physical monitor is represented as an alist of
1531 attribute keys and values as follows:
1533 geometry -- Position and size in pixels in the form of
1535 workarea -- Position and size of the workarea in pixels in the
1536 form of (X Y WIDTH HEIGHT)
1537 mm-size -- Width and height in millimeters in the form of
1539 frames -- List of frames dominated by the physical monitor
1540 name (*) -- Name of the physical monitor as a string
1542 where X, Y, WIDTH, and HEIGHT are integers. Keys labeled
1543 with (*) are optional.
1545 A frame is dominated by a physical monitor when either the
1546 largest area of the frame resides in the monitor, or the monitor
1547 is the closest to the frame if the frame does not intersect any
1548 physical monitors. Every non-tip frame (including invisible one)
1549 in a graphical display is dominated by exactly one physical
1550 monitor at a time, though it can span multiple (or no) physical
1552 (let ((frame-type (framep-on-display display)))
1555 (x-display-monitor-attributes-list display))
1556 ((eq frame-type 'w32)
1557 (w32-display-monitor-attributes-list display))
1558 ((eq frame-type 'ns)
1559 (ns-display-monitor-attributes-list display))
1561 (let ((geometry (list 0 0 (display-pixel-width display)
1562 (display-pixel-height display))))
1563 `(((geometry . ,geometry)
1564 (workarea . ,geometry)
1565 (mm-size . (,(display-mm-width display)
1566 ,(display-mm-height display)))
1567 (frames . ,(frames-on-display-list display)))))))))
1570 ;;;; Frame geometry values
1572 (defun frame-geom-value-cons (type value &optional frame)
1573 "Return equivalent geometry value for FRAME as a cons with car `+'.
1574 A geometry value equivalent to VALUE for FRAME is returned,
1575 where the value is a cons with car `+', not numeric.
1576 TYPE is the car of the original geometry spec (TYPE . VALUE).
1577 It is `top' or `left', depending on which edge VALUE is related to.
1578 VALUE is the cdr of a frame geometry spec: (left/top . VALUE).
1579 If VALUE is a number, then it is converted to a cons value, perhaps
1580 relative to the opposite frame edge from that in the original spec.
1581 FRAME defaults to the selected frame.
1583 Examples (measures in pixels) -
1584 Assuming display height/width=1024, frame height/width=600:
1585 300 inside display edge: 300 => (+ 300)
1587 300 inside opposite display edge: (- 300) => (+ 124)
1589 300 beyond display edge
1590 (= 724 inside opposite display edge): (+ -300) => (+ -300)
1591 300 beyond display edge
1592 (= 724 inside opposite display edge): (- -300) => (+ 724)
1594 In the 3rd, 4th, and 6th examples, the returned value is relative to
1595 the opposite frame edge from the edge indicated in the input spec."
1596 (cond ((and (consp value) (eq '+ (car value))) ; e.g. (+ 300), (+ -300)
1598 ((natnump value) (list '+ value)) ; e.g. 300 => (+ 300)
1599 (t ; e.g. -300, (- 300), (- -300)
1600 (list '+ (- (if (eq 'left type) ; => (+ 124), (+ 124), (+ 724)
1601 (x-display-pixel-width)
1602 (x-display-pixel-height))
1603 (if (integerp value) (- value) (cadr value))
1605 (frame-pixel-width frame)
1606 (frame-pixel-height frame)))))))
1608 (defun frame-geom-spec-cons (spec &optional frame)
1609 "Return equivalent geometry spec for FRAME as a cons with car `+'.
1610 A geometry specification equivalent to SPEC for FRAME is returned,
1611 where the value is a cons with car `+', not numeric.
1612 SPEC is a frame geometry spec: (left . VALUE) or (top . VALUE).
1613 If VALUE is a number, then it is converted to a cons value, perhaps
1614 relative to the opposite frame edge from that in the original spec.
1615 FRAME defaults to the selected frame.
1617 Examples (measures in pixels) -
1618 Assuming display height=1024, frame height=600:
1619 top 300 below display top: (top . 300) => (top + 300)
1620 (top + 300) => (top + 300)
1621 bottom 300 above display bottom: (top - 300) => (top + 124)
1622 (top . -300) => (top + 124)
1623 top 300 above display top
1624 (= bottom 724 above display bottom): (top + -300) => (top + -300)
1625 bottom 300 below display bottom
1626 (= top 724 below display top): (top - -300) => (top + 724)
1628 In the 3rd, 4th, and 6th examples, the returned value is relative to
1629 the opposite frame edge from the edge indicated in the input spec."
1630 (cons (car spec) (frame-geom-value-cons (car spec) (cdr spec) frame)))
1633 (defun delete-other-frames (&optional frame)
1634 "Delete all frames on the current terminal, except FRAME.
1635 If FRAME uses another frame's minibuffer, the minibuffer frame is
1636 left untouched. FRAME nil or omitted means use the selected frame."
1639 (setq frame (selected-frame)))
1640 (let* ((mini-frame (window-frame (minibuffer-window frame)))
1641 (frames (delq mini-frame (delq frame (frame-list)))))
1642 ;; Only consider frames on the same terminal.
1643 (dolist (frame (prog1 frames (setq frames nil)))
1644 (if (eq (frame-terminal) (frame-terminal frame))
1645 (push frame frames)))
1646 ;; Delete mon-minibuffer-only frames first, because `delete-frame'
1647 ;; signals an error when trying to delete a mini-frame that's
1648 ;; still in use by another frame.
1649 (dolist (frame frames)
1650 (unless (eq (frame-parameter frame 'minibuffer) 'only)
1651 (delete-frame frame)))
1652 ;; Delete minibuffer-only frames.
1653 (dolist (frame frames)
1654 (when (eq (frame-parameter frame 'minibuffer) 'only)
1655 (delete-frame frame)))))
1657 ;; miscellaneous obsolescence declarations
1658 (define-obsolete-variable-alias 'delete-frame-hook
1659 'delete-frame-functions "22.1")
1664 (defgroup cursor nil
1665 "Displaying text cursors."
1669 (defcustom blink-cursor-delay 0.5
1670 "Seconds of idle time after which cursor starts to blink."
1674 (defcustom blink-cursor-interval 0.5
1675 "Length of cursor blink interval in seconds."
1679 (defcustom blink-cursor-blinks 10
1680 "How many times to blink before using a solid cursor on NS and X.
1681 Use 0 or negative value to blink forever."
1686 (defvar blink-cursor-blinks-done 1
1687 "Number of blinks done since we started blinking on NS and X")
1689 (defvar blink-cursor-idle-timer nil
1690 "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
1691 The function `blink-cursor-start' is called when the timer fires.")
1693 (defvar blink-cursor-timer nil
1694 "Timer started from `blink-cursor-start'.
1695 This timer calls `blink-cursor-timer-function' every
1696 `blink-cursor-interval' seconds.")
1698 (defun blink-cursor-start ()
1699 "Timer function called from the timer `blink-cursor-idle-timer'.
1700 This starts the timer `blink-cursor-timer', which makes the cursor blink
1701 if appropriate. It also arranges to cancel that timer when the next
1702 command starts, by installing a pre-command hook."
1703 (when (null blink-cursor-timer)
1704 ;; Set up the timer first, so that if this signals an error,
1705 ;; blink-cursor-end is not added to pre-command-hook.
1706 (setq blink-cursor-blinks-done 1)
1707 (setq blink-cursor-timer
1708 (run-with-timer blink-cursor-interval blink-cursor-interval
1709 'blink-cursor-timer-function))
1710 (add-hook 'pre-command-hook 'blink-cursor-end)
1711 (internal-show-cursor nil nil)))
1713 (defun blink-cursor-timer-function ()
1714 "Timer function of timer `blink-cursor-timer'."
1715 (internal-show-cursor nil (not (internal-show-cursor-p)))
1716 ;; Each blink is two calls to this function.
1717 (when (memq window-system '(x ns w32))
1718 (setq blink-cursor-blinks-done (1+ blink-cursor-blinks-done))
1719 (when (and (> blink-cursor-blinks 0)
1720 (<= (* 2 blink-cursor-blinks) blink-cursor-blinks-done))
1721 (blink-cursor-suspend)
1722 (add-hook 'post-command-hook 'blink-cursor-check))))
1725 (defun blink-cursor-end ()
1726 "Stop cursor blinking.
1727 This is installed as a pre-command hook by `blink-cursor-start'.
1728 When run, it cancels the timer `blink-cursor-timer' and removes
1729 itself as a pre-command hook."
1730 (remove-hook 'pre-command-hook 'blink-cursor-end)
1731 (internal-show-cursor nil t)
1732 (when blink-cursor-timer
1733 (cancel-timer blink-cursor-timer)
1734 (setq blink-cursor-timer nil)))
1736 (defun blink-cursor-suspend ()
1737 "Suspend cursor blinking on NS, X and W32.
1738 This is called when no frame has focus and timers can be suspended.
1739 Timers are restarted by `blink-cursor-check', which is called when a
1740 frame receives focus."
1741 (when (memq window-system '(x ns w32))
1743 (when blink-cursor-idle-timer
1744 (cancel-timer blink-cursor-idle-timer)
1745 (setq blink-cursor-idle-timer nil))))
1747 (defun blink-cursor-check ()
1748 "Check if cursor blinking shall be restarted.
1749 This is done when a frame gets focus. Blink timers may be stopped by
1750 `blink-cursor-suspend'."
1751 (when (and blink-cursor-mode
1752 (not blink-cursor-idle-timer))
1753 (remove-hook 'post-command-hook 'blink-cursor-check)
1754 (setq blink-cursor-idle-timer
1755 (run-with-idle-timer blink-cursor-delay
1757 'blink-cursor-start))))
1759 (define-obsolete-variable-alias 'blink-cursor 'blink-cursor-mode "22.1")
1761 (define-minor-mode blink-cursor-mode
1762 "Toggle cursor blinking (Blink Cursor mode).
1763 With a prefix argument ARG, enable Blink Cursor mode if ARG is
1764 positive, and disable it otherwise. If called from Lisp, enable
1765 the mode if ARG is omitted or nil.
1767 This command is effective only on graphical frames. On text-only
1768 terminals, cursor blinking is controlled by the terminal."
1769 :init-value (not (or noninteractive
1771 (eq system-type 'ms-dos)
1772 (not (memq window-system '(x w32 ns)))))
1773 :initialize 'custom-initialize-delay
1776 (if blink-cursor-idle-timer (cancel-timer blink-cursor-idle-timer))
1777 (setq blink-cursor-idle-timer nil)
1779 (when blink-cursor-mode
1781 ;;(internal-show-cursor nil nil)
1782 (setq blink-cursor-idle-timer
1783 (run-with-idle-timer blink-cursor-delay
1785 'blink-cursor-start))))
1788 ;; Frame maximization/fullscreen
1790 (defun toggle-frame-maximized ()
1791 "Toggle maximization state of the selected frame.
1792 Maximize the selected frame or un-maximize if it is already maximized.
1793 Respect window manager screen decorations.
1794 If the frame is in fullscreen mode, don't change its mode,
1795 just toggle the temporary frame parameter `maximized',
1796 so the frame will go to the right maximization state
1797 after disabling fullscreen mode.
1798 See also `toggle-frame-fullscreen'."
1800 (if (memq (frame-parameter nil 'fullscreen) '(fullscreen fullboth))
1801 (modify-frame-parameters
1804 . ,(unless (eq (frame-parameter nil 'maximized) 'maximized)
1806 (modify-frame-parameters
1809 . ,(unless (eq (frame-parameter nil 'fullscreen) 'maximized)
1812 (defun toggle-frame-fullscreen ()
1813 "Toggle fullscreen mode of the selected frame.
1814 Enable fullscreen mode of the selected frame or disable if it is
1815 already fullscreen. Ignore window manager screen decorations.
1816 When turning on fullscreen mode, remember the previous value of the
1817 maximization state in the temporary frame parameter `maximized'.
1818 Restore the maximization state when turning off fullscreen mode.
1819 See also `toggle-frame-maximized'."
1821 (modify-frame-parameters
1824 . ,(unless (memq (frame-parameter nil 'fullscreen) '(fullscreen fullboth))
1825 (frame-parameter nil 'fullscreen)))
1827 . ,(if (memq (frame-parameter nil 'fullscreen) '(fullscreen fullboth))
1828 (if (eq (frame-parameter nil 'maximized) 'maximized)
1835 (define-key ctl-x-5-map "2" 'make-frame-command)
1836 (define-key ctl-x-5-map "1" 'delete-other-frames)
1837 (define-key ctl-x-5-map "0" 'delete-frame)
1838 (define-key ctl-x-5-map "o" 'other-frame)
1839 (define-key global-map [f11] 'toggle-frame-fullscreen)
1840 (define-key global-map [(meta f10)] 'toggle-frame-maximized)
1841 (define-key esc-map [f10] 'toggle-frame-maximized)
1846 ;; Only marked as obsolete in 24.3.
1847 (define-obsolete-variable-alias 'automatic-hscrolling
1848 'auto-hscroll-mode "22.1")
1850 (make-variable-buffer-local 'show-trailing-whitespace)
1852 ;; Defined in dispnew.c.
1853 (make-obsolete-variable
1854 'window-system-version "it does not give useful information." "24.3")
1858 ;;; frame.el ends here