Merged from emacs@sv.gnu.org
[bpt/emacs.git] / lisp / frame.el
CommitLineData
55535639 1;;; frame.el --- multi-frame management independent of window systems
c88ab9ce 2
0d30b337
TTN
3;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2002, 2003,
4;; 2004, 2005 Free Software Foundation, Inc.
3a801d0c 5
fc68affa 6;; Maintainer: FSF
fd7fa35a 7;; Keywords: internal
fc68affa 8
b578f267
EN
9;; This file is part of GNU Emacs.
10
11;; GNU Emacs is free software; you can redistribute it and/or modify
12;; it under the terms of the GNU General Public License as published by
13;; the Free Software Foundation; either version 2, or (at your option)
14;; any later version.
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
22;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24;; Boston, MA 02110-1301, USA.
64c669bc 25
55535639
PJ
26;;; Commentary:
27
fc68affa
ER
28;;; Code:
29
2246281f
KL
30(defvar frame-creation-function-alist
31 (list (cons nil
32 (if (fboundp 'tty-create-frame-with-faces)
33 'tty-create-frame-with-faces
34 (function
35 (lambda (parameters)
36 (error "Can't create multiple frames without a window system"))))))
37 "Alist of window-system dependent functions to call to create a new frame.
38The window system startup file should add its frame creation
39function to this list, which should take an alist of parameters
40as its argument.")
114a8b8c 41
bf1ba39f
KL
42(defvar window-system-default-frame-alist nil
43 "Alist of window-system dependent default frame parameters.
44These may be set in your init file, like this:
45
46 ;; Disable menubar and toolbar on the console, but enable them under X.
47 (setq window-system-default-frame-alist
48 '((x (menu-bar-lines . 1) (tool-bar-lines . 1))
49 (nil (menu-bar-lines . 0) (tool-bar-lines . 0))))
50
51Also see `default-frame-alist'.")
52
7e573c4a
SM
53;; The initial value given here used to ask for a minibuffer.
54;; But that's not necessary, because the default is to have one.
55;; By not specifying it here, we let an X resource specify it.
0c966f88 56(defcustom initial-frame-alist nil
0b9d32af 57 "*Alist of frame parameters for creating the initial X window frame.
eaa974e1 58You can set this in your `.emacs' file; for example,
dc6d9681 59 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
de17da15
RS
60Parameters specified here supersede the values given in `default-frame-alist'.
61
62If the value calls for a frame without a minibuffer, and you have not created
63a minibuffer frame on your own, one is created according to
7eadab74 64`minibuffer-frame-alist'.
de17da15
RS
65
66You can specify geometry-related options for just the initial frame
67by setting this variable in your `.emacs' file; however, they won't
85557d7e 68take effect until Emacs reads `.emacs', which happens after first creating
de17da15
RS
69the frame. If you want the frame to have the proper geometry as soon
70as it appears, you need to use this three-step process:
71* Specify X resources to give the geometry you want.
72* Set `default-frame-alist' to override these options so that they
73 don't affect subsequent frames.
74* Set `initial-frame-alist' in a way that matches the X resources,
0c966f88
RS
75 to override what you put in `default-frame-alist'."
76 :type '(repeat (cons :format "%v"
77 (symbol :tag "Parameter")
78 (sexp :tag "Value")))
79 :group 'frames)
64c669bc 80
0b9d32af
RS
81(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
82 "*Alist of frame parameters for initially creating a minibuffer frame.
eaa974e1 83You can set this in your `.emacs' file; for example,
dc6d9681 84 (setq minibuffer-frame-alist
7eadab74 85 '((top . 1) (left . 1) (width . 80) (height . 2)))
eaa974e1 86Parameters specified here supersede the values given in
0b9d32af
RS
87`default-frame-alist', for a minibuffer frame."
88 :type '(repeat (cons :format "%v"
89 (symbol :tag "Parameter")
90 (sexp :tag "Value")))
91 :group 'frames)
64c669bc 92
0b9d32af
RS
93(defcustom pop-up-frame-alist nil
94 "*Alist of frame parameters used when creating pop-up frames.
dc6d9681 95Pop-up frames are used for completions, help, and the like.
64c669bc 96This variable can be set in your init file, like this:
dc6d9681 97 (setq pop-up-frame-alist '((width . 80) (height . 20)))
0b9d32af
RS
98These supersede the values given in `default-frame-alist',
99for pop-up frames."
100 :type '(repeat (cons :format "%v"
101 (symbol :tag "Parameter")
102 (sexp :tag "Value")))
103 :group 'frames)
64c669bc 104
dc6d9681 105(setq pop-up-frame-function
7f18ce22
RS
106 ;; Using `function' here caused some sort of problem.
107 '(lambda ()
108 (make-frame pop-up-frame-alist)))
64c669bc 109
30e19aee 110(defcustom special-display-frame-alist
8a9e86e6
RS
111 '((height . 14) (width . 80) (unsplittable . t))
112 "*Alist of frame parameters used when creating special frames.
113Special frames are used for buffers whose names are in
114`special-display-buffer-names' and for buffers whose names match
115one of the regular expressions in `special-display-regexps'.
116This variable can be set in your init file, like this:
117 (setq special-display-frame-alist '((width . 80) (height . 20)))
30e19aee
RS
118These supersede the values given in `default-frame-alist'."
119 :type '(repeat (cons :format "%v"
120 (symbol :tag "Parameter")
121 (sexp :tag "Value")))
122 :group 'frames)
8a9e86e6 123
95e6cf39 124(defun special-display-popup-frame (buffer &optional args)
40d34803
DL
125 "Display BUFFER in its own frame, reusing an existing window if any.
126Return the window chosen.
127Currently we do not insist on selecting the window within its frame.
128If ARGS is an alist, use it as a list of frame parameter specs.
129If ARGS is a list whose car is a symbol,
130use (car ARGS) as a function to do the work.
131Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args."
95e6cf39
RS
132 (if (and args (symbolp (car args)))
133 (apply (car args) buffer (cdr args))
bb2c34b1 134 (let ((window (get-buffer-window buffer 0)))
7e573c4a
SM
135 (or
136 ;; If we have a window already, make it visible.
137 (when window
138 (let ((frame (window-frame window)))
139 (make-frame-visible frame)
140 (raise-frame frame)
141 window))
142 ;; Reuse the current window if the user requested it.
143 (when (cdr (assq 'same-window args))
144 (condition-case nil
145 (progn (switch-to-buffer buffer) (selected-window))
146 (error nil)))
147 ;; Stay on the same frame if requested.
148 (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args)))
149 (let* ((pop-up-frames nil) (pop-up-windows t)
150 special-display-regexps special-display-buffer-names
151 (window (display-buffer buffer)))
bb2c34b1 152 ;; Only do it if this is a new window:
7e573c4a
SM
153 ;; (set-window-dedicated-p window t)
154 window))
155 ;; If no window yet, make one in a new frame.
bf247b6e 156 (let ((frame
86bd482f
RS
157 (with-current-buffer buffer
158 (make-frame (append args special-display-frame-alist)))))
7e573c4a
SM
159 (set-window-buffer (frame-selected-window frame) buffer)
160 (set-window-dedicated-p (frame-selected-window frame) t)
161 (frame-selected-window frame))))))
8a9e86e6 162
924be53a 163(defun handle-delete-frame (event)
40d34803 164 "Handle delete-frame events from the X server."
924be53a
RS
165 (interactive "e")
166 (let ((frame (posn-window (event-start event)))
167 (i 0)
168 (tail (frame-list)))
169 (while tail
170 (and (frame-visible-p (car tail))
171 (not (eq (car tail) frame))
172 (setq i (1+ i)))
173 (setq tail (cdr tail)))
174 (if (> i 0)
175 (delete-frame frame t)
a9562d19
RS
176 ;; Gildea@x.org says it is ok to ask questions before terminating.
177 (save-buffers-kill-emacs))))
64c669bc 178\f
dc6d9681 179;;;; Arrangement of frames at startup
64c669bc 180
7e573c4a
SM
181;; 1) Load the window system startup file from the lisp library and read the
182;; high-priority arguments (-q and the like). The window system startup
183;; file should create any frames specified in the window system defaults.
184;;
185;; 2) If no frames have been opened, we open an initial text frame.
186;;
187;; 3) Once the init file is done, we apply any newly set parameters
188;; in initial-frame-alist to the frame.
64c669bc 189
85557d7e 190;; These are now called explicitly at the proper times,
fc4d4afb
RS
191;; since that is easier to understand.
192;; Actually using hooks within Emacs is bad for future maintenance. --rms.
193;; (add-hook 'before-init-hook 'frame-initialize)
194;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
64c669bc 195
7e573c4a 196;; If we create the initial frame, this is it.
dc6d9681 197(defvar frame-initial-frame nil)
64c669bc 198
3f2f8c83
RS
199;; Record the parameters used in frame-initialize to make the initial frame.
200(defvar frame-initial-frame-alist)
201
791e09d8
RS
202(defvar frame-initial-geometry-arguments nil)
203
7e573c4a
SM
204;; startup.el calls this function before loading the user's init
205;; file - if there is no frame with a minibuffer open now, create
206;; one to display messages while loading the init file.
dc6d9681 207(defun frame-initialize ()
ff2a1c79 208 "Create an initial frame if necessary."
64c669bc 209 ;; Are we actually running under a window system at all?
2246281f
KL
210 (if (and initial-window-system
211 (not noninteractive)
212 (not (eq initial-window-system 'pc)))
7eadab74 213 (progn
62642af9
RS
214 ;; Turn on special-display processing only if there's a window system.
215 (setq special-display-function 'special-display-popup-frame)
216
7eadab74
JB
217 ;; If there is no frame with a minibuffer besides the terminal
218 ;; frame, then we need to create the opening frame. Make sure
219 ;; it has a minibuffer, but let initial-frame-alist omit the
220 ;; minibuffer spec.
221 (or (delq terminal-frame (minibuffer-frame-list))
36fc9c9f 222 (progn
3f2f8c83 223 (setq frame-initial-frame-alist
9688894d 224 (append initial-frame-alist default-frame-alist nil))
a8bb5882
RS
225 (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
226 (setq frame-initial-frame-alist
227 (cons '(horizontal-scroll-bars . t)
228 frame-initial-frame-alist)))
2246281f
KL
229 (setq frame-initial-frame-alist
230 (cons (cons 'window-system initial-window-system)
231 frame-initial-frame-alist))
36fc9c9f
RS
232 (setq default-minibuffer-frame
233 (setq frame-initial-frame
96a84970 234 (make-frame frame-initial-frame-alist)))
11281034
RS
235 ;; Delete any specifications for window geometry parameters
236 ;; so that we won't reapply them in frame-notice-user-settings.
237 ;; It would be wrong to reapply them then,
238 ;; because that would override explicit user resizing.
58bf6042 239 (setq initial-frame-alist
c2079f0a 240 (frame-remove-geometry-params initial-frame-alist))))
85557d7e 241 ;; At this point, we know that we have a frame open, so we
dc6d9681
JB
242 ;; can delete the terminal frame.
243 (delete-frame terminal-frame)
2246281f 244 (setq terminal-frame nil))))
85557d7e 245
8f2a992b
GM
246(defvar frame-notice-user-settings t
247 "Non-nil means function `frame-notice-user-settings' wasn't run yet.")
248
7e573c4a
SM
249;; startup.el calls this function after loading the user's init
250;; file. Now default-frame-alist and initial-frame-alist contain
251;; information to which we must react; do what needs to be done.
dc6d9681 252(defun frame-notice-user-settings ()
40d34803 253 "Act on user's init file settings of frame parameters.
0e1bfc78
KL
254React to settings of `initial-frame-alist',
255`window-system-default-frame-alist' and `default-frame-alist'
256there (in decreasing order of priority)."
2ffa6186 257 ;; Make menu-bar-mode and default-frame-alist consistent.
61f2bcd7
GM
258 (when (boundp 'menu-bar-mode)
259 (let ((default (assq 'menu-bar-lines default-frame-alist)))
260 (if default
261 (setq menu-bar-mode (not (eq (cdr default) 0)))
262 (setq default-frame-alist
263 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
264 default-frame-alist)))))
f39784dd 265
33a33c06
GM
266 ;; Make tool-bar-mode and default-frame-alist consistent. Don't do
267 ;; it in batch mode since that would leave a tool-bar-lines
268 ;; parameter in default-frame-alist in a dumped Emacs, which is not
9688894d 269 ;; what we want.
33a33c06
GM
270 (when (and (boundp 'tool-bar-mode)
271 (not noninteractive))
61f2bcd7
GM
272 (let ((default (assq 'tool-bar-lines default-frame-alist)))
273 (if default
274 (setq tool-bar-mode (not (eq (cdr default) 0)))
275 (setq default-frame-alist
276 (cons (cons 'tool-bar-lines (if tool-bar-mode 1 0))
277 default-frame-alist)))))
2ffa6186 278
7eadab74
JB
279 ;; Creating and deleting frames may shift the selected frame around,
280 ;; and thus the current buffer. Protect against that. We don't
281 ;; want to use save-excursion here, because that may also try to set
282 ;; the buffer of the selected window, which fails when the selected
283 ;; window is the minibuffer.
0e1bfc78
KL
284 (let ((old-buffer (current-buffer))
285 (window-system-frame-alist (cdr (assq initial-window-system
286 window-system-default-frame-alist))))
7eadab74 287
8f2a992b
GM
288 (when (and frame-notice-user-settings
289 (null frame-initial-frame))
42002db5
EZ
290 ;; This case happens when we don't have a window system, and
291 ;; also for MS-DOS frames.
8f2a992b
GM
292 (let ((parms (frame-parameters frame-initial-frame)))
293 ;; Don't change the frame names.
294 (setq parms (delq (assq 'name parms) parms))
295 ;; Can't modify the minibuffer parameter, so don't try.
296 (setq parms (delq (assq 'minibuffer parms) parms))
297 (modify-frame-parameters nil
2246281f 298 (if (null initial-window-system)
42002db5 299 (append initial-frame-alist
0e1bfc78 300 window-system-frame-alist
42002db5
EZ
301 default-frame-alist
302 parms
303 nil)
304 ;; initial-frame-alist and
305 ;; default-frame-alist were already
306 ;; applied in pc-win.el.
307 parms))
2246281f 308 (if (null initial-window-system) ;; MS-DOS does this differently in pc-win.el
42002db5
EZ
309 (let ((newparms (frame-parameters))
310 (frame (selected-frame)))
311 (tty-handle-reverse-video frame newparms)
312 ;; If we changed the background color, we need to update
313 ;; the background-mode parameter, and maybe some faces,
314 ;; too.
315 (when (assq 'background-color newparms)
316 (unless (or (assq 'background-mode initial-frame-alist)
317 (assq 'background-mode default-frame-alist))
318 (frame-set-background-mode frame))
319 (face-set-after-frame-default frame))))))
8f2a992b 320
7eadab74
JB
321 ;; If the initial frame is still around, apply initial-frame-alist
322 ;; and default-frame-alist to it.
9688894d
GM
323 (when (frame-live-p frame-initial-frame)
324
325 ;; When tool-bar has been switched off, correct the frame size
326 ;; by the lines added in x-create-frame for the tool-bar and
327 ;; switch `tool-bar-mode' off.
085ef9b3
GM
328 (when (display-graphic-p)
329 (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
0e1bfc78 330 (assq 'tool-bar-lines window-system-frame-alist)
085ef9b3 331 (assq 'tool-bar-lines default-frame-alist))))
5c39a60f
JR
332 (when (and tool-bar-originally-present
333 (or (null tool-bar-lines)
334 (null (cdr tool-bar-lines))
335 (eq 0 (cdr tool-bar-lines))))
085ef9b3 336 (let* ((char-height (frame-char-height frame-initial-frame))
5c39a60f 337 (image-height tool-bar-images-pixel-height)
085ef9b3
GM
338 (margin (cond ((and (consp tool-bar-button-margin)
339 (integerp (cdr tool-bar-button-margin))
340 (> tool-bar-button-margin 0))
341 (cdr tool-bar-button-margin))
342 ((and (integerp tool-bar-button-margin)
343 (> tool-bar-button-margin 0))
344 tool-bar-button-margin)
345 (t 0)))
346 (relief (if (and (integerp tool-bar-button-relief)
347 (> tool-bar-button-relief 0))
348 tool-bar-button-relief 3))
f39784dd 349 (lines (/ (+ image-height
085ef9b3
GM
350 (* 2 margin)
351 (* 2 relief)
352 (1- char-height))
353 char-height))
354 (height (frame-parameter frame-initial-frame 'height))
355 (newparms (list (cons 'height (- height lines))))
f39784dd 356 (initial-top (cdr (assq 'top
085ef9b3
GM
357 frame-initial-geometry-arguments)))
358 (top (frame-parameter frame-initial-frame 'top)))
359 (when (and (consp initial-top) (eq '- (car initial-top)))
7f18ce22
RS
360 (let ((adjusted-top
361 (cond ((and (consp top)
362 (eq '+ (car top)))
363 (list '+
364 (+ (cadr top)
365 (* lines char-height))))
366 ((and (consp top)
367 (eq '- (car top)))
368 (list '-
369 (- (cadr top)
370 (* lines char-height))))
371 (t (+ top (* lines char-height))))))
372 (setq newparms
373 (append newparms
374 `((top . ,adjusted-top))
375 nil))))
085ef9b3
GM
376 (modify-frame-parameters frame-initial-frame newparms)
377 (tool-bar-mode -1)))))
9688894d
GM
378
379 ;; The initial frame we create above always has a minibuffer.
380 ;; If the user wants to remove it, or make it a minibuffer-only
381 ;; frame, then we'll have to delete the current frame and make a
382 ;; new one; you can't remove or add a root window to/from an
383 ;; existing frame.
384 ;;
385 ;; NOTE: default-frame-alist was nil when we created the
386 ;; existing frame. We need to explicitly include
387 ;; default-frame-alist in the parameters of the screen we
388 ;; create here, so that its new value, gleaned from the user's
389 ;; .emacs file, will be applied to the existing screen.
de2f5dbe 390 (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
0e1bfc78 391 (assq 'minibuffer window-system-frame-alist)
de2f5dbe
GM
392 (assq 'minibuffer default-frame-alist)
393 '(minibuffer . t)))
394 t))
395 ;; Create the new frame.
396 (let (parms new)
397 ;; If the frame isn't visible yet, wait till it is.
398 ;; If the user has to position the window,
399 ;; Emacs doesn't know its real position until
400 ;; the frame is seen to be visible.
401 (while (not (cdr (assq 'visibility
402 (frame-parameters frame-initial-frame))))
403 (sleep-for 1))
404 (setq parms (frame-parameters frame-initial-frame))
9688894d 405
f39784dd 406 ;; Get rid of `name' unless it was specified explicitly before.
de2f5dbe
GM
407 (or (assq 'name frame-initial-frame-alist)
408 (setq parms (delq (assq 'name parms) parms)))
409
410 (setq parms (append initial-frame-alist
0e1bfc78 411 window-system-frame-alist
de2f5dbe
GM
412 default-frame-alist
413 parms
414 nil))
415
416 ;; Get rid of `reverse', because that was handled
417 ;; when we first made the frame.
418 (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
419
420 (if (assq 'height frame-initial-geometry-arguments)
421 (setq parms (assq-delete-all 'height parms)))
422 (if (assq 'width frame-initial-geometry-arguments)
423 (setq parms (assq-delete-all 'width parms)))
424 (if (assq 'left frame-initial-geometry-arguments)
425 (setq parms (assq-delete-all 'left parms)))
426 (if (assq 'top frame-initial-geometry-arguments)
427 (setq parms (assq-delete-all 'top parms)))
428 (setq new
429 (make-frame
430 ;; Use the geometry args that created the existing
431 ;; frame, rather than the parms we get for it.
432 (append frame-initial-geometry-arguments
433 '((user-size . t) (user-position . t))
434 parms)))
435 ;; The initial frame, which we are about to delete, may be
436 ;; the only frame with a minibuffer. If it is, create a
437 ;; new one.
438 (or (delq frame-initial-frame (minibuffer-frame-list))
439 (make-initial-minibuffer-frame nil))
440
441 ;; If the initial frame is serving as a surrogate
442 ;; minibuffer frame for any frames, we need to wean them
443 ;; onto a new frame. The default-minibuffer-frame
444 ;; variable must be handled similarly.
445 (let ((users-of-initial
446 (filtered-frame-list
447 (function (lambda (frame)
448 (and (not (eq frame frame-initial-frame))
449 (eq (window-frame
450 (minibuffer-window frame))
451 frame-initial-frame)))))))
452 (if (or users-of-initial
453 (eq default-minibuffer-frame frame-initial-frame))
454
455 ;; Choose an appropriate frame. Prefer frames which
456 ;; are only minibuffers.
457 (let* ((new-surrogate
458 (car
459 (or (filtered-frame-list
460 (function
461 (lambda (frame)
462 (eq (cdr (assq 'minibuffer
463 (frame-parameters frame)))
464 'only))))
465 (minibuffer-frame-list))))
466 (new-minibuffer (minibuffer-window new-surrogate)))
467
468 (if (eq default-minibuffer-frame frame-initial-frame)
469 (setq default-minibuffer-frame new-surrogate))
470
471 ;; Wean the frames using frame-initial-frame as
472 ;; their minibuffer frame.
473 (mapcar
474 (function
475 (lambda (frame)
476 (modify-frame-parameters
477 frame (list (cons 'minibuffer new-minibuffer)))))
478 users-of-initial))))
479
480 ;; Redirect events enqueued at this frame to the new frame.
481 ;; Is this a good idea?
482 (redirect-frame-focus frame-initial-frame new)
483
484 ;; Finally, get rid of the old frame.
485 (delete-frame frame-initial-frame t))
9688894d
GM
486
487 ;; Otherwise, we don't need all that rigamarole; just apply
488 ;; the new parameters.
489 (let (newparms allparms tail)
490 (setq allparms (append initial-frame-alist
0e1bfc78 491 window-system-frame-alist
9688894d
GM
492 default-frame-alist nil))
493 (if (assq 'height frame-initial-geometry-arguments)
494 (setq allparms (assq-delete-all 'height allparms)))
495 (if (assq 'width frame-initial-geometry-arguments)
496 (setq allparms (assq-delete-all 'width allparms)))
497 (if (assq 'left frame-initial-geometry-arguments)
498 (setq allparms (assq-delete-all 'left allparms)))
499 (if (assq 'top frame-initial-geometry-arguments)
500 (setq allparms (assq-delete-all 'top allparms)))
501 (setq tail allparms)
502 ;; Find just the parms that have changed since we first
503 ;; made this frame. Those are the ones actually set by
f39784dd 504 ;; the init file. For those parms whose values we already knew
9688894d
GM
505 ;; (such as those spec'd by command line options)
506 ;; it is undesirable to specify the parm again
f39784dd 507 ;; once the user has seen the frame and been able to alter it
9688894d
GM
508 ;; manually.
509 (while tail
510 (let (newval oldval)
511 (setq oldval (assq (car (car tail))
512 frame-initial-frame-alist))
513 (setq newval (cdr (assq (car (car tail)) allparms)))
514 (or (and oldval (eq (cdr oldval) newval))
515 (setq newparms
516 (cons (cons (car (car tail)) newval) newparms))))
517 (setq tail (cdr tail)))
518 (setq newparms (nreverse newparms))
519 (modify-frame-parameters frame-initial-frame
520 newparms)
521 ;; If we changed the background color,
522 ;; we need to update the background-mode parameter
523 ;; and maybe some faces too.
524 (when (assq 'background-color newparms)
525 (unless (assq 'background-mode newparms)
526 (frame-set-background-mode frame-initial-frame))
527 (face-set-after-frame-default frame-initial-frame)))))
64c669bc 528
7eadab74
JB
529 ;; Restore the original buffer.
530 (set-buffer old-buffer)
531
532 ;; Make sure the initial frame can be GC'd if it is ever deleted.
d202f1f2 533 ;; Make sure frame-notice-user-settings does nothing if called twice.
8f2a992b 534 (setq frame-notice-user-settings nil)
d202f1f2 535 (setq frame-initial-frame nil)))
64c669bc 536
746bd265
KH
537(defun make-initial-minibuffer-frame (display)
538 (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
539 (if display
540 (make-frame-on-display display parms)
541 (make-frame parms))))
542
7eadab74 543;;;; Creation of additional frames, and other frame miscellanea
dc6d9681 544
63019bad 545(defun modify-all-frames-parameters (alist)
d398de43 546 "Modify all current and future frames' parameters according to ALIST.
63019bad
JB
547This changes `default-frame-alist' and possibly `initial-frame-alist'.
548See help of `modify-frame-parameters' for more information."
549 (let (element) ;; temp
550 (dolist (frame (frame-list))
551 (modify-frame-parameters frame alist))
552
553 (dolist (pair alist) ;; conses to add/replace
554 ;; initial-frame-alist needs setting only when
555 ;; frame-notice-user-settings is true
556 (and frame-notice-user-settings
557 (setq element (assoc (car pair) initial-frame-alist))
558 (setq initial-frame-alist (delq element initial-frame-alist)))
559 (and (setq element (assoc (car pair) default-frame-alist))
560 (setq default-frame-alist (delq element default-frame-alist)))))
561 (and frame-notice-user-settings
562 (setq initial-frame-alist (append initial-frame-alist alist)))
563 (setq default-frame-alist (append default-frame-alist alist)))
564
7253d8e0 565(defun get-other-frame ()
40d34803
DL
566 "Return some frame other than the current frame.
567Create one if necessary. Note that the minibuffer frame, if separate,
568is not considered (see `next-frame')."
dc6d9681 569 (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
6eb018ba 570 (make-frame)
dc6d9681 571 (next-frame (selected-frame)))))
64c669bc
JB
572 s))
573
dc6d9681
JB
574(defun next-multiframe-window ()
575 "Select the next window, regardless of which frame it is on."
64c669bc
JB
576 (interactive)
577 (select-window (next-window (selected-window)
578 (> (minibuffer-depth) 0)
bb2c34b1 579 0))
030f4537 580 (select-frame-set-input-focus (selected-frame)))
64c669bc 581
dc6d9681
JB
582(defun previous-multiframe-window ()
583 "Select the previous window, regardless of which frame it is on."
64c669bc
JB
584 (interactive)
585 (select-window (previous-window (selected-window)
586 (> (minibuffer-depth) 0)
bb2c34b1 587 0))
030f4537 588 (select-frame-set-input-focus (selected-frame)))
64c669bc 589
6d73e337 590(defun make-frame-on-display (display &optional parameters)
b6660415 591 "Make a frame on X display DISPLAY.
6d73e337
RS
592The optional second argument PARAMETERS specifies additional frame parameters."
593 (interactive "sMake frame on display: ")
a9ca74cd
RS
594 (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
595 (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
6afdd335 596 (when (and (boundp 'x-initialized) (not x-initialized))
e9cda827
KL
597 (setq x-display-name display)
598 (x-initialize-window-system))
2246281f 599 (make-frame `((window-system . x) (display . ,display) . ,parameters)))
6d73e337 600
f35ca2fe
KL
601(defun make-frame-on-tty (tty type &optional parameters)
602 "Make a frame on terminal device TTY.
603TTY should be the file name of the tty device to use. TYPE
604should be the terminal type string of TTY, for example \"xterm\"
605or \"vt100\". The optional third argument PARAMETERS specifies
606additional frame parameters."
428a555e 607 (interactive "fOpen frame on tty device: \nsTerminal type of %s: ")
f35ca2fe 608 (unless tty
fca177d4
KL
609 (error "Invalid terminal device"))
610 (unless type
611 (error "Invalid terminal type"))
f35ca2fe 612 (make-frame `((window-system . nil) (tty . ,tty) (tty-type . ,type) . ,parameters)))
fca177d4 613
6238bfaf
RS
614(defun make-frame-command ()
615 "Make a new frame, and select it if the terminal displays only one frame."
616 (interactive)
c1b1350b 617 (if (and window-system (not (eq window-system 'pc)))
6238bfaf
RS
618 (make-frame)
619 (select-frame (make-frame))))
620
45c4fdeb
SM
621(defvar before-make-frame-hook nil
622 "Functions to run before a frame is created.")
623
624(defvar after-make-frame-functions nil
625 "Functions to run after a frame is created.
626The functions are run with one arg, the newly created frame.")
627
72bf1a8b 628(defvar after-setting-font-hook nil
81b99826
GM
629 "Functions to run after a frame's font has been changed.")
630
92e443b1 631;; Alias, kept temporarily.
84ed1560 632(define-obsolete-function-alias 'new-frame 'make-frame "22.1")
bc93c097 633
45c4fdeb
SM
634(defun make-frame (&optional parameters)
635 "Return a newly created frame displaying the current buffer.
636Optional argument PARAMETERS is an alist of parameters for the new frame.
637Each element of PARAMETERS should have the form (NAME . VALUE), for example:
a105105a 638
45c4fdeb 639 (name . STRING) The frame should be named STRING.
43a2e52c 640
45c4fdeb
SM
641 (width . NUMBER) The frame should be NUMBER characters in width.
642 (height . NUMBER) The frame should be NUMBER text lines high.
43a2e52c 643
45c4fdeb 644You cannot specify either `width' or `height', you must use neither or both.
43a2e52c 645
45c4fdeb
SM
646 (minibuffer . t) The frame should have a minibuffer.
647 (minibuffer . nil) The frame should have no minibuffer.
648 (minibuffer . only) The frame should contain only a minibuffer.
649 (minibuffer . WINDOW) The frame should use WINDOW as its minibuffer window.
43a2e52c 650
2246281f
KL
651 (window-system . nil) The frame should be displayed on a terminal device.
652 (window-system . x) The frame should be displayed in an X window.
653
6ed8eeff 654 (terminal . ID) The frame should use the terminal identified by ID.
b6660415 655
2246281f 656Before the frame is created (via `frame-creation-function-alist'), functions on the
45c4fdeb 657hook `before-make-frame-hook' are run. After the frame is created, functions
8de9d3f6
LT
658on `after-make-frame-functions' are run with one arg, the newly created frame.
659
660This function itself does not make the new frame the selected frame.
661The previously selected frame remains selected. However, the
662window system may select the new frame for its own reasons, for
663instance if the frame appears under the mouse pointer and your
664setup is for focus to follow the pointer."
64c669bc 665 (interactive)
b6660415 666 (let* ((w (cond
6ed8eeff
KL
667 ((assq 'terminal parameters)
668 (let ((type (terminal-live-p (cdr (assq 'terminal parameters)))))
b6660415
KL
669 (cond
670 ((eq type t) nil)
6ed8eeff 671 ((eq type nil) (error "Terminal %s does not exist" (cdr (assq 'terminal parameters))))
b6660415
KL
672 (t type))))
673 ((assq 'window-system parameters)
674 (cdr (assq 'window-system parameters)))
675 (t window-system)))
2246281f 676 (frame-creation-function (cdr (assq w frame-creation-function-alist)))
da8e8fc1 677 (oldframe (selected-frame))
2246281f
KL
678 frame)
679 (unless frame-creation-function
680 (error "Don't know how to create a frame on window system %s" w))
681 (run-hooks 'before-make-frame-hook)
e682e37e 682 (setq frame (funcall frame-creation-function (append parameters (cdr (assq w window-system-default-frame-alist)))))
30a2fded 683 (normal-erase-is-backspace-setup-frame frame)
160f0817 684 ;; Inherit the 'environment and 'client parameters, if needed.
6ed8eeff 685 (when (eq (frame-terminal frame) (frame-terminal oldframe))
160f0817
KL
686 (let ((env (frame-parameter oldframe 'environment))
687 (client (frame-parameter oldframe 'client)))
da8e8fc1
KL
688 (if (not (framep env))
689 (setq env oldframe))
160f0817
KL
690 (if (and env (not (assq 'environment parameters)))
691 (set-frame-parameter frame 'environment env))
692 (if (and client (not (assq 'client parameters)))
693 (set-frame-parameter frame 'client client))))
45c4fdeb
SM
694 (run-hook-with-args 'after-make-frame-functions frame)
695 frame))
64c669bc 696
7eadab74
JB
697(defun filtered-frame-list (predicate)
698 "Return a list of all live frames which satisfy PREDICATE."
047bc928
GM
699 (let* ((frames (frame-list))
700 (list frames))
7eadab74 701 (while (consp frames)
047bc928
GM
702 (unless (funcall predicate (car frames))
703 (setcar frames nil))
7eadab74 704 (setq frames (cdr frames)))
047bc928 705 (delq nil list)))
7eadab74
JB
706
707(defun minibuffer-frame-list ()
708 "Return a list of all frames with their own minibuffers."
709 (filtered-frame-list
710 (function (lambda (frame)
711 (eq frame (window-frame (minibuffer-window frame)))))))
712
9684e4c9
KL
713(defun frames-on-display-list (&optional terminal)
714 "Return a list of all frames on TERMINAL.
b6660415 715
9684e4c9
KL
716TERMINAL should be a terminal identifier (an integer), a frame,
717or a name of an X display (a string of the form
718HOST:SERVER.SCREEN).
b6660415 719
9684e4c9
KL
720If TERMINAL is omitted or nil, it defaults to the selected
721frame's terminal device."
722 (let* ((terminal (terminal-id terminal))
047bc928 723 (func #'(lambda (frame)
6ed8eeff 724 (eq (frame-terminal frame) terminal))))
9911648b
EZ
725 (filtered-frame-list func)))
726
f35ca2fe
KL
727(defun framep-on-display (&optional terminal)
728 "Return the type of frames on TERMINAL.
729TERMINAL may be a terminal id, a display name or a frame. If it
730is a frame, its type is returned. If TERMINAL is omitted or nil,
731it defaults to the selected frame's terminal device. All frames
732on a given display are of the same type."
6ed8eeff 733 (or (terminal-live-p terminal)
f35ca2fe
KL
734 (framep terminal)
735 (framep (car (frames-on-display-list terminal)))))
9911648b 736
58bf6042
JB
737(defun frame-remove-geometry-params (param-list)
738 "Return the parameter list PARAM-LIST, but with geometry specs removed.
739This deletes all bindings in PARAM-LIST for `top', `left', `width',
791e09d8 740`height', `user-size' and `user-position' parameters.
58bf6042
JB
741Emacs uses this to avoid overriding explicit moves and resizings from
742the user during startup."
743 (setq param-list (cons nil param-list))
744 (let ((tail param-list))
745 (while (consp (cdr tail))
746 (if (and (consp (car (cdr tail)))
791e09d8
RS
747 (memq (car (car (cdr tail)))
748 '(height width top left user-position user-size)))
749 (progn
750 (setq frame-initial-geometry-arguments
751 (cons (car (cdr tail)) frame-initial-geometry-arguments))
752 (setcdr tail (cdr (cdr tail))))
58bf6042 753 (setq tail (cdr tail)))))
e11c3dc2
KH
754 (setq frame-initial-geometry-arguments
755 (nreverse frame-initial-geometry-arguments))
58bf6042
JB
756 (cdr param-list))
757
0ac18fb0 758(defcustom focus-follows-mouse t
6527c9b7
RS
759 "*Non-nil if window system changes focus when you move the mouse.
760You should set this variable to tell Emacs how your window manager
761handles focus, since there is no way in general for Emacs to find out
762automatically."
0ac18fb0 763 :type 'boolean
cd32a7ba
DN
764 :group 'frames
765 :version "20.3")
26ef026d 766
030f4537
GM
767(defun select-frame-set-input-focus (frame)
768 "Select FRAME, raise it, and set input focus, if possible."
769 (select-frame frame)
770 (raise-frame frame)
771 ;; Ensure, if possible, that frame gets input focus.
114a8b8c 772 (cond ((eq (window-system frame) 'x)
80c39c38 773 (x-focus-frame frame))
114a8b8c 774 ((eq (window-system frame) 'w32)
80c39c38 775 (w32-focus-frame frame)))
030f4537 776 (cond (focus-follows-mouse
80c39c38 777 (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
030f4537 778
ceab6935 779(defun other-frame (arg)
563283b1 780 "Select the ARG'th different visible frame on current display, and raise it.
ceab6935
RM
781All frames are arranged in a cyclic order.
782This command selects the frame ARG steps away in that order.
bb578a72
RS
783A negative ARG moves in the opposite order.
784
785To make this command work properly, you must tell Emacs
786how the system (or the window manager) generally handles
787focus-switching between windows. If moving the mouse onto a window
788selects it (gives it focus), set `focus-follows-mouse' to t.
789Otherwise, that variable should be nil."
ceab6935
RM
790 (interactive "p")
791 (let ((frame (selected-frame)))
792 (while (> arg 0)
a569dbc3
RM
793 (setq frame (next-frame frame))
794 (while (not (eq (frame-visible-p frame) t))
795 (setq frame (next-frame frame)))
796 (setq arg (1- arg)))
ceab6935 797 (while (< arg 0)
a569dbc3
RM
798 (setq frame (previous-frame frame))
799 (while (not (eq (frame-visible-p frame) t))
800 (setq frame (previous-frame frame)))
915cfd1f 801 (setq arg (1+ arg)))
030f4537 802 (select-frame-set-input-focus frame)))
845cde06 803
3db7df06
SM
804(defun iconify-or-deiconify-frame ()
805 "Iconify the selected frame, or deiconify if it's currently an icon."
806 (interactive)
807 (if (eq (cdr (assq 'visibility (frame-parameters))) t)
808 (iconify-frame)
809 (make-frame-visible)))
810
0b0d3e0b
KL
811(defun suspend-frame ()
812 "Do whatever is right to suspend the current frame.
f35ca2fe
KL
813Calls `suspend-emacs' if invoked from the controlling tty device,
814`suspend-tty' from a secondary tty device, and
0b0d3e0b
KL
815`iconify-or-deiconify-frame' from an X frame."
816 (interactive)
817 (let ((type (framep (selected-frame))))
818 (cond
819 ((eq type 'x) (iconify-or-deiconify-frame))
820 ((eq type t)
6ed8eeff 821 (if (controlling-tty-p)
4a933ef8
KL
822 (suspend-emacs)
823 (suspend-tty)))
0b0d3e0b
KL
824 (t (suspend-emacs)))))
825
845cde06
EZ
826(defun make-frame-names-alist ()
827 (let* ((current-frame (selected-frame))
828 (falist
829 (cons
830 (cons (frame-parameter current-frame 'name) current-frame) nil))
831 (frame (next-frame nil t)))
832 (while (not (eq frame current-frame))
833 (progn
834 (setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
835 (setq frame (next-frame frame t))))
836 falist))
837
838(defvar frame-name-history nil)
845cde06 839(defun select-frame-by-name (name)
563283b1 840 "Select the frame on the current terminal whose name is NAME and raise it.
845cde06
EZ
841If there is no frame by that name, signal an error."
842 (interactive
716ff1c9
RS
843 (let* ((frame-names-alist (make-frame-names-alist))
844 (default (car (car frame-names-alist)))
845 (input (completing-read
846 (format "Select Frame (default %s): " default)
847 frame-names-alist nil t nil 'frame-name-history)))
845cde06
EZ
848 (if (= (length input) 0)
849 (list default)
850 (list input))))
716ff1c9
RS
851 (let* ((frame-names-alist (make-frame-names-alist))
852 (frame (cdr (assoc name frame-names-alist))))
845cde06
EZ
853 (or frame
854 (error "There is no frame named `%s'" name))
855 (make-frame-visible frame)
856 (raise-frame frame)
880a9ae1
AI
857 (select-frame frame)
858 ;; Ensure, if possible, that frame gets input focus.
2246281f 859 (cond ((eq (window-system frame) 'x)
80c39c38 860 (x-focus-frame frame))
2246281f 861 ((eq (window-system frame) 'w32)
80c39c38
RS
862 (w32-focus-frame frame)))
863 (when focus-follows-mouse
864 (set-mouse-position frame (1- (frame-width frame)) 0))))
64c669bc 865\f
dc6d9681
JB
866;;;; Frame configurations
867
868(defun current-frame-configuration ()
869 "Return a list describing the positions and states of all frames.
376a7584
JB
870Its car is `frame-configuration'.
871Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
872where
873 FRAME is a frame object,
874 ALIST is an association list specifying some of FRAME's parameters, and
875 WINDOW-CONFIG is a window configuration object for FRAME."
876 (cons 'frame-configuration
877 (mapcar (function
878 (lambda (frame)
879 (list frame
880 (frame-parameters frame)
881 (current-window-configuration frame))))
882 (frame-list))))
dc6d9681 883
68cd265f 884(defun set-frame-configuration (configuration &optional nodelete)
dc6d9681
JB
885 "Restore the frames to the state described by CONFIGURATION.
886Each frame listed in CONFIGURATION has its position, size, window
68cd265f 887configuration, and other parameters set as specified in CONFIGURATION.
d398de43
LT
888However, this function does not restore deleted frames.
889
a78db71c
RS
890Ordinarily, this function deletes all existing frames not
891listed in CONFIGURATION. But if optional second argument NODELETE
5da841d2 892is given and non-nil, the unwanted frames are iconified instead."
376a7584
JB
893 (or (frame-configuration-p configuration)
894 (signal 'wrong-type-argument
895 (list 'frame-configuration-p configuration)))
896 (let ((config-alist (cdr configuration))
897 frames-to-delete)
06b1a5ef 898 (mapcar (function
dc6d9681 899 (lambda (frame)
376a7584 900 (let ((parameters (assq frame config-alist)))
06b1a5ef
JB
901 (if parameters
902 (progn
98e9d14b
JB
903 (modify-frame-parameters
904 frame
85557d7e 905 ;; Since we can't set a frame's minibuffer status,
98e9d14b
JB
906 ;; we might as well omit the parameter altogether.
907 (let* ((parms (nth 1 parameters))
908 (mini (assq 'minibuffer parms)))
909 (if mini (setq parms (delq mini parms)))
910 parms))
06b1a5ef 911 (set-window-configuration (nth 2 parameters)))
dc6d9681
JB
912 (setq frames-to-delete (cons frame frames-to-delete))))))
913 (frame-list))
a78db71c 914 (if nodelete
5da841d2
RS
915 ;; Note: making frames invisible here was tried
916 ;; but led to some strange behavior--each time the frame
917 ;; was made visible again, the window manager asked afresh
918 ;; for where to put it.
919 (mapcar 'iconify-frame frames-to-delete)
a78db71c 920 (mapcar 'delete-frame frames-to-delete))))
64c669bc 921\f
dc6d9681
JB
922;;;; Convenience functions for accessing and interactively changing
923;;;; frame parameters.
64c669bc 924
151bdc83 925(defun frame-height (&optional frame)
dc6d9681
JB
926 "Return number of lines available for display on FRAME.
927If FRAME is omitted, describe the currently selected frame."
151bdc83 928 (cdr (assq 'height (frame-parameters frame))))
dc6d9681
JB
929
930(defun frame-width (&optional frame)
931 "Return number of columns available for display on FRAME.
932If FRAME is omitted, describe the currently selected frame."
151bdc83 933 (cdr (assq 'width (frame-parameters frame))))
dc6d9681 934
889611f0 935(defalias 'set-default-font 'set-frame-font)
1cef6541 936(defun set-frame-font (font-name &optional keep-size)
40d34803 937 "Set the font of the selected frame to FONT-NAME.
61298010 938When called interactively, prompt for the name of the font to use.
1cef6541
JB
939To get the frame's current default font, use `frame-parameters'.
940
941The default behavior is to keep the numbers of lines and columns in
84ed1560 942the frame, thus may change its pixel size. If optional KEEP-SIZE is
1cef6541
JB
943non-nil (interactively, prefix argument) the current frame size (in
944pixels) is kept by adjusting the numbers of the lines and columns."
f39784dd 945 (interactive
1cef6541
JB
946 (let* ((completion-ignore-case t)
947 (font (completing-read "Font name: "
948 (mapcar #'list
949 ;; x-list-fonts will fail with an error
950 ;; if this frame doesn't support fonts.
93289292
MB
951 (x-list-fonts "*" nil (selected-frame)))
952 nil nil nil nil
953 (frame-parameter nil 'font))))
1cef6541
JB
954 (list font current-prefix-arg)))
955 (let (fht fwd)
956 (if keep-size
957 (setq fht (* (frame-parameter nil 'height) (frame-char-height))
958 fwd (* (frame-parameter nil 'width) (frame-char-width))))
959 (modify-frame-parameters (selected-frame)
960 (list (cons 'font font-name)))
961 (if keep-size
962 (modify-frame-parameters
963 (selected-frame)
964 (list (cons 'height (round fht (frame-char-height)))
965 (cons 'width (round fwd (frame-char-width)))))))
72bf1a8b 966 (run-hooks 'after-setting-font-hook 'after-setting-font-hooks))
64c669bc 967
7e573c4a 968(defun set-frame-parameter (frame parameter value)
0dac35b8
KL
969 "Set frame parameter PARAMETER to VALUE on FRAME.
970If FRAME is nil, it defaults to the selected frame.
971See `modify-frame-parameters.'"
7e573c4a
SM
972 (modify-frame-parameters frame (list (cons parameter value))))
973
8290babd 974(defun set-background-color (color-name)
40d34803 975 "Set the background color of the selected frame to COLOR-NAME.
61298010
RS
976When called interactively, prompt for the name of the color to use.
977To get the frame's current background color, use `frame-parameters'."
63ec4f94 978 (interactive (list (facemenu-read-color "Background color: ")))
dc6d9681 979 (modify-frame-parameters (selected-frame)
528e1416
EZ
980 (list (cons 'background-color color-name)))
981 (or window-system
982 (face-set-after-frame-default (selected-frame))))
64c669bc 983
8290babd 984(defun set-foreground-color (color-name)
40d34803 985 "Set the foreground color of the selected frame to COLOR-NAME.
61298010
RS
986When called interactively, prompt for the name of the color to use.
987To get the frame's current foreground color, use `frame-parameters'."
63ec4f94 988 (interactive (list (facemenu-read-color "Foreground color: ")))
dc6d9681 989 (modify-frame-parameters (selected-frame)
528e1416
EZ
990 (list (cons 'foreground-color color-name)))
991 (or window-system
992 (face-set-after-frame-default (selected-frame))))
64c669bc
JB
993
994(defun set-cursor-color (color-name)
40d34803 995 "Set the text cursor color of the selected frame to COLOR-NAME.
61298010
RS
996When called interactively, prompt for the name of the color to use.
997To get the frame's current cursor color, use `frame-parameters'."
63ec4f94 998 (interactive (list (facemenu-read-color "Cursor color: ")))
dc6d9681 999 (modify-frame-parameters (selected-frame)
7eadab74 1000 (list (cons 'cursor-color color-name))))
64c669bc 1001
eaa974e1 1002(defun set-mouse-color (color-name)
40d34803 1003 "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
61298010
RS
1004When called interactively, prompt for the name of the color to use.
1005To get the frame's current mouse color, use `frame-parameters'."
63ec4f94 1006 (interactive (list (facemenu-read-color "Mouse color: ")))
dc6d9681 1007 (modify-frame-parameters (selected-frame)
ec6d4463
KH
1008 (list (cons 'mouse-color
1009 (or color-name
1010 (cdr (assq 'mouse-color
1011 (frame-parameters))))))))
7eadab74 1012
eaa974e1 1013(defun set-border-color (color-name)
40d34803 1014 "Set the color of the border of the selected frame to COLOR-NAME.
61298010
RS
1015When called interactively, prompt for the name of the color to use.
1016To get the frame's current border color, use `frame-parameters'."
63ec4f94 1017 (interactive (list (facemenu-read-color "Border color: ")))
eaa974e1
JB
1018 (modify-frame-parameters (selected-frame)
1019 (list (cons 'border-color color-name))))
1020
1021(defun auto-raise-mode (arg)
7eadab74 1022 "Toggle whether or not the selected frame should auto-raise.
79e6ae33
RS
1023With arg, turn auto-raise mode on if and only if arg is positive.
1024Note that this controls Emacs's own auto-raise feature.
1025Some window managers allow you to enable auto-raise for certain windows.
1026You can use that for Emacs windows if you wish, but if you do,
1027that is beyond the control of Emacs and this command has no effect on it."
7eadab74
JB
1028 (interactive "P")
1029 (if (null arg)
1030 (setq arg
1031 (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
1032 -1 1)))
9626b928
GM
1033 (if (> arg 0)
1034 (raise-frame (selected-frame)))
dc6d9681 1035 (modify-frame-parameters (selected-frame)
7eadab74
JB
1036 (list (cons 'auto-raise (> arg 0)))))
1037
eaa974e1 1038(defun auto-lower-mode (arg)
7eadab74 1039 "Toggle whether or not the selected frame should auto-lower.
79e6ae33
RS
1040With arg, turn auto-lower mode on if and only if arg is positive.
1041Note that this controls Emacs's own auto-lower feature.
1042Some window managers allow you to enable auto-lower for certain windows.
1043You can use that for Emacs windows if you wish, but if you do,
1044that is beyond the control of Emacs and this command has no effect on it."
7eadab74
JB
1045 (interactive "P")
1046 (if (null arg)
1047 (setq arg
1048 (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
1049 -1 1)))
dc6d9681 1050 (modify-frame-parameters (selected-frame)
7eadab74 1051 (list (cons 'auto-lower (> arg 0)))))
7777d03b
EZ
1052(defun set-frame-name (name)
1053 "Set the name of the selected frame to NAME.
1054When called interactively, prompt for the name of the frame.
1055The frame name is displayed on the modeline if the terminal displays only
1056one frame, otherwise the name is displayed on the frame's caption bar."
1057 (interactive "sFrame name: ")
1058 (modify-frame-parameters (selected-frame)
1059 (list (cons 'name name))))
56cfea72
KS
1060
1061(defun frame-current-scroll-bars (&optional frame)
1062 "Return the current scroll-bar settings in frame FRAME.
1cecf04d 1063Value is a cons (VERTICAL . HORIZ0NTAL) where VERTICAL specifies the
56cfea72 1064current location of the vertical scroll-bars (left, right, or nil),
1cecf04d 1065and HORIZONTAL specifies the current location of the horizontal scroll
56cfea72
KS
1066bars (top, bottom, or nil)."
1067 (let ((vert (frame-parameter frame 'vertical-scroll-bars))
1068 (hor nil))
1069 (unless (memq vert '(left right nil))
1070 (setq vert default-frame-scroll-bars))
1071 (cons vert hor)))
64c669bc 1072\f
9911648b 1073;;;; Frame/display capabilities.
6ed8eeff
KL
1074(defun selected-terminal ()
1075 "Return the terminal that is now selected."
1076 (frame-terminal (selected-frame)))
b6660415 1077
9911648b
EZ
1078(defun display-mouse-p (&optional display)
1079 "Return non-nil if DISPLAY has a mouse available.
1080DISPLAY can be a display name, a frame, or nil (meaning the selected
1081frame's display)."
1082 (let ((frame-type (framep-on-display display)))
1083 (cond
1084 ((eq frame-type 'pc)
1085 (msdos-mouse-p))
1086 ((eq system-type 'windows-nt)
9fa5bb32
RS
1087 (with-no-warnings
1088 (> w32-num-mouse-buttons 0)))
9911648b
EZ
1089 ((memq frame-type '(x mac))
1090 t) ;; We assume X and Mac *always* have a pointing device
1091 (t
7565ee93
DL
1092 (or (and (featurep 'xt-mouse)
1093 xterm-mouse-mode)
1094 ;; t-mouse is distributed with the GPM package. It doesn't have
1095 ;; a toggle.
1096 (featurep 't-mouse))))))
9911648b
EZ
1097
1098(defun display-popup-menus-p (&optional display)
1099 "Return non-nil if popup menus are supported on DISPLAY.
1100DISPLAY can be a display name, a frame, or nil (meaning the selected
1101frame's display).
1102Support for popup menus requires that the mouse be available."
1103 (and
1104 (let ((frame-type (framep-on-display display)))
1105 (memq frame-type '(x w32 pc mac)))
1106 (display-mouse-p display)))
1107
1108(defun display-graphic-p (&optional display)
1109 "Return non-nil if DISPLAY is a graphic display.
1110Graphical displays are those which are capable of displaying several
1111frames and several different fonts at once. This is true for displays
1112that use a window system such as X, and false for text-only terminals.
1113DISPLAY can be a display name, a frame, or nil (meaning the selected
1114frame's display)."
1115 (not (null (memq (framep-on-display display) '(x w32 mac)))))
1116
ddc456e4
EZ
1117(defun display-images-p (&optional display)
1118 "Return non-nil if DISPLAY can display images.
1119
1120DISPLAY can be a display name, a frame, or nil (meaning the selected
1121frame's display)."
1122 (and (display-graphic-p display)
1123 (fboundp 'image-mask-p)
fcc6f5cc 1124 (fboundp 'image-size)))
ddc456e4 1125
6693b279
EZ
1126(defalias 'display-multi-frame-p 'display-graphic-p)
1127(defalias 'display-multi-font-p 'display-graphic-p)
1128
9911648b
EZ
1129(defun display-selections-p (&optional display)
1130 "Return non-nil if DISPLAY supports selections.
1131A selection is a way to transfer text or other data between programs
1132via special system buffers called `selection' or `cut buffer' or
1133`clipboard'.
1134DISPLAY can be a display name, a frame, or nil (meaning the selected
1135frame's display)."
1136 (let ((frame-type (framep-on-display display)))
1137 (cond
1138 ((eq frame-type 'pc)
1139 ;; MS-DOG frames support selections when Emacs runs inside
1140 ;; the Windows' DOS Box.
9fa5bb32
RS
1141 (with-no-warnings
1142 (not (null dos-windows-version))))
9911648b
EZ
1143 ((memq frame-type '(x w32 mac))
1144 t) ;; FIXME?
1145 (t
1146 nil))))
1147
1148(defun display-screens (&optional display)
1149 "Return the number of screens associated with DISPLAY."
1150 (let ((frame-type (framep-on-display display)))
1151 (cond
bb9404d6 1152 ((memq frame-type '(x w32 mac))
9911648b 1153 (x-display-screens display))
bb9404d6 1154 (t
9911648b
EZ
1155 1))))
1156
1157(defun display-pixel-height (&optional display)
1158 "Return the height of DISPLAY's screen in pixels.
1159For character terminals, each character counts as a single pixel."
1160 (let ((frame-type (framep-on-display display)))
1161 (cond
1162 ((memq frame-type '(x w32 mac))
1163 (x-display-pixel-height display))
1164 (t
1165 (frame-height (if (framep display) display (selected-frame)))))))
1166
1167(defun display-pixel-width (&optional display)
1168 "Return the width of DISPLAY's screen in pixels.
1169For character terminals, each character counts as a single pixel."
1170 (let ((frame-type (framep-on-display display)))
1171 (cond
1172 ((memq frame-type '(x w32 mac))
1173 (x-display-pixel-width display))
1174 (t
1175 (frame-width (if (framep display) display (selected-frame)))))))
1176
1177(defun display-mm-height (&optional display)
1178 "Return the height of DISPLAY's screen in millimeters.
1179If the information is unavailable, value is nil."
1180 (and (memq (framep-on-display display) '(x w32 mac))
1181 (x-display-mm-height display)))
1182
1183(defun display-mm-width (&optional display)
1184 "Return the width of DISPLAY's screen in millimeters.
1185If the information is unavailable, value is nil."
1186 (and (memq (framep-on-display display) '(x w32 mac))
1187 (x-display-mm-width display)))
1188
1189(defun display-backing-store (&optional display)
1190 "Return the backing store capability of DISPLAY's screen.
1191The value may be `always', `when-mapped', `not-useful', or nil if
1192the question is inapplicable to a certain kind of display."
1193 (let ((frame-type (framep-on-display display)))
1194 (cond
1195 ((memq frame-type '(x w32 mac))
1196 (x-display-backing-store display))
1197 (t
1198 'not-useful))))
1199
1200(defun display-save-under (&optional display)
1201 "Return non-nil if DISPLAY's screen supports the SaveUnder feature."
1202 (let ((frame-type (framep-on-display display)))
1203 (cond
1204 ((memq frame-type '(x w32 mac))
1205 (x-display-save-under display))
1206 (t
1207 'not-useful))))
1208
1209(defun display-planes (&optional display)
1210 "Return the number of planes supported by DISPLAY."
1211 (let ((frame-type (framep-on-display display)))
1212 (cond
1213 ((memq frame-type '(x w32 mac))
1214 (x-display-planes display))
1215 ((eq frame-type 'pc)
1216 4)
1217 (t
1218 (truncate (log (length (tty-color-alist)) 2))))))
1219
1220(defun display-color-cells (&optional display)
1221 "Return the number of color cells supported by DISPLAY."
1222 (let ((frame-type (framep-on-display display)))
1223 (cond
1224 ((memq frame-type '(x w32 mac))
1225 (x-display-color-cells display))
1226 ((eq frame-type 'pc)
1227 16)
1228 (t
3224dac1 1229 (tty-display-color-cells display)))))
9911648b
EZ
1230
1231(defun display-visual-class (&optional display)
1232 "Returns the visual class of DISPLAY.
1233The value is one of the symbols `static-gray', `gray-scale',
1234`static-color', `pseudo-color', `true-color', or `direct-color'."
1235 (let ((frame-type (framep-on-display display)))
1236 (cond
1237 ((memq frame-type '(x w32 mac))
1238 (x-display-visual-class display))
1239 ((and (memq frame-type '(pc t))
1240 (tty-display-color-p display))
1241 'static-color)
1242 (t
1243 'static-gray))))
1244
1245\f
dc6d9681 1246;;;; Aliases for backward compatibility with Emacs 18.
84ed1560
JB
1247(define-obsolete-function-alias 'screen-height 'frame-height) ;before 19.15
1248(define-obsolete-function-alias 'screen-width 'frame-width) ;before 19.15
9e2b097b
JB
1249
1250(defun set-screen-width (cols &optional pretend)
84ed1560 1251 "Change the size of the screen to COLS columns.
40d34803
DL
1252Optional second arg non-nil means that redisplay should use COLS columns
1253but that the idea of the actual width of the frame should not be changed.
84ed1560 1254This function is provided only for compatibility with Emacs 18."
9e2b097b
JB
1255 (set-frame-width (selected-frame) cols pretend))
1256
1257(defun set-screen-height (lines &optional pretend)
84ed1560 1258 "Change the height of the screen to LINES lines.
40d34803
DL
1259Optional second arg non-nil means that redisplay should use LINES lines
1260but that the idea of the actual height of the screen should not be changed.
84ed1560 1261This function is provided only for compatibility with Emacs 18."
9e2b097b
JB
1262 (set-frame-height (selected-frame) lines pretend))
1263
154a757e
GM
1264(defun delete-other-frames (&optional frame)
1265 "Delete all frames except FRAME.
a2125918
GM
1266If FRAME uses another frame's minibuffer, the minibuffer frame is
1267left untouched. FRAME nil or omitted means use the selected frame."
154a757e
GM
1268 (interactive)
1269 (unless frame
1270 (setq frame (selected-frame)))
a2125918
GM
1271 (let* ((mini-frame (window-frame (minibuffer-window frame)))
1272 (frames (delq mini-frame (delq frame (frame-list)))))
1273 ;; Delete mon-minibuffer-only frames first, because `delete-frame'
1274 ;; signals an error when trying to delete a mini-frame that's
1275 ;; still in use by another frame.
1276 (dolist (frame frames)
1277 (unless (eq (frame-parameter frame 'minibuffer) 'only)
1278 (delete-frame frame)))
1279 ;; Delete minibuffer-only frames.
1280 (dolist (frame frames)
1281 (when (eq (frame-parameter frame 'minibuffer) 'only)
1282 (delete-frame frame)))))
154a757e 1283
2598a293
SM
1284(make-obsolete 'set-screen-width 'set-frame-width) ;before 19.15
1285(make-obsolete 'set-screen-height 'set-frame-height) ;before 19.15
dc6d9681 1286
da7829a3 1287;; miscellaneous obsolescence declarations
84ed1560
JB
1288(define-obsolete-variable-alias 'delete-frame-hook
1289 'delete-frame-functions "22.1")
da7829a3 1290
dc6d9681 1291\f
7e573c4a 1292;; Highlighting trailing whitespace.
81b99826
GM
1293
1294(make-variable-buffer-local 'show-trailing-whitespace)
1295
1296(defcustom show-trailing-whitespace nil
e6c45c29
LT
1297 "*Non-nil means highlight trailing whitespace.
1298This is done in the face `trailing-whitespace'."
81b99826 1299 :type 'boolean
b4aefb19 1300 :group 'whitespace-faces)
81b99826
GM
1301
1302
1303\f
7e573c4a 1304;; Scrolling
79b14b94
GM
1305
1306(defgroup scrolling nil
1307 "Scrolling windows."
1308 :version "21.1"
1309 :group 'frames)
1310
968ecc28 1311(defcustom auto-hscroll-mode t
310e9a21 1312 "*Allow or disallow automatic scrolling windows horizontally.
9ea60c46 1313If non-nil, windows are automatically scrolled horizontally to make
79b14b94
GM
1314point visible."
1315 :version "21.1"
1316 :type 'boolean
1317 :group 'scrolling)
968ecc28 1318(defvaralias 'automatic-hscrolling 'auto-hscroll-mode)
79b14b94
GM
1319
1320\f
7e573c4a 1321;; Blinking cursor
81b99826
GM
1322
1323(defgroup cursor nil
ca693be8 1324 "Displaying text cursors."
40d34803 1325 :version "21.1"
81b99826
GM
1326 :group 'frames)
1327
1328(defcustom blink-cursor-delay 0.5
ca693be8 1329 "*Seconds of idle time after which cursor starts to blink."
81b99826
GM
1330 :type 'number
1331 :group 'cursor)
1332
1333(defcustom blink-cursor-interval 0.5
1334 "*Length of cursor blink interval in seconds."
81b99826
GM
1335 :type 'number
1336 :group 'cursor)
1337
1338(defvar blink-cursor-idle-timer nil
ca693be8
GM
1339 "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
1340The function `blink-cursor-start' is called when the timer fires.")
81b99826
GM
1341
1342(defvar blink-cursor-timer nil
ca693be8 1343 "Timer started from `blink-cursor-start'.
a795e09a
LT
1344This timer calls `blink-cursor-timer-function' every
1345`blink-cursor-interval' seconds.")
1346
485464c4 1347(define-minor-mode blink-cursor-mode
81b99826 1348 "Toggle blinking cursor mode.
be6bbb55 1349With a numeric argument, turn blinking cursor mode on iff ARG is positive.
81b99826 1350When blinking cursor mode is enabled, the cursor of the selected
cacf2193
RS
1351window blinks.
1352
1353Note that this command is effective only when Emacs
1354displays through a window system, because then Emacs does its own
1355cursor display. On a text-only terminal, this is not implemented."
485464c4 1356 :init-value (not (or noninteractive
947d4ae8 1357 no-blinking-cursor
485464c4 1358 (eq system-type 'ms-dos)
6dc59f76 1359 (not (memq initial-window-system '(x w32 mac)))))
947d4ae8 1360 :initialize 'custom-initialize-safe-default
ffa8d0ef 1361 :group 'cursor
485464c4
SM
1362 :global t
1363 (if blink-cursor-idle-timer (cancel-timer blink-cursor-idle-timer))
1364 (if blink-cursor-timer (cancel-timer blink-cursor-timer))
1365 (setq blink-cursor-idle-timer nil
1366 blink-cursor-timer nil)
1367 (if blink-cursor-mode
1368 (progn
1369 ;; Hide the cursor.
1370 ;;(internal-show-cursor nil nil)
1371 (setq blink-cursor-idle-timer
1372 (run-with-idle-timer blink-cursor-delay
1373 blink-cursor-delay
1374 'blink-cursor-start)))
1375 (internal-show-cursor nil t)))
1376
84ed1560 1377(define-obsolete-variable-alias 'blink-cursor 'blink-cursor-mode "22.1")
81b99826 1378
81b99826 1379(defun blink-cursor-start ()
ca693be8
GM
1380 "Timer function called from the timer `blink-cursor-idle-timer'.
1381This starts the timer `blink-cursor-timer', which makes the cursor blink
1382if appropriate. It also arranges to cancel that timer when the next
1383command starts, by installing a pre-command hook."
81b99826
GM
1384 (when (null blink-cursor-timer)
1385 (add-hook 'pre-command-hook 'blink-cursor-end)
9dbf2cd6 1386 (internal-show-cursor nil nil)
81b99826
GM
1387 (setq blink-cursor-timer
1388 (run-with-timer blink-cursor-interval blink-cursor-interval
0a5ebe4b
GM
1389 'blink-cursor-timer-function))))
1390
1391(defun blink-cursor-timer-function ()
1392 "Timer function of timer `blink-cursor-timer'."
1393 (internal-show-cursor nil (not (internal-show-cursor-p))))
81b99826
GM
1394
1395(defun blink-cursor-end ()
1396 "Stop cursor blinking.
ca693be8 1397This is installed as a pre-command hook by `blink-cursor-start'.
f39784dd 1398When run, it cancels the timer `blink-cursor-timer' and removes
ca693be8 1399itself as a pre-command hook."
81b99826 1400 (remove-hook 'pre-command-hook 'blink-cursor-end)
0a5ebe4b 1401 (internal-show-cursor nil t)
81b99826
GM
1402 (cancel-timer blink-cursor-timer)
1403 (setq blink-cursor-timer nil))
1404
1405
1406\f
7e573c4a 1407;; Hourglass pointer
81b99826 1408
a6c411ff 1409(defcustom display-hourglass t
088e75cc
RS
1410 "*Non-nil means show an hourglass pointer, when Emacs is busy.
1411This feature only works when on a window system that can change
1412cursor shapes."
81b99826 1413 :type 'boolean
a6c411ff 1414 :group 'cursor)
81b99826 1415
a6c411ff 1416(defcustom hourglass-delay 1
63ec4f94 1417 "*Seconds to wait before displaying an hourglass pointer when Emacs is busy."
0a86e779 1418 :type 'number
a6c411ff 1419 :group 'cursor)
1d0a3ef4 1420
5b2c5477 1421\f
c0eb3c10 1422(defcustom cursor-in-non-selected-windows t
84ed1560 1423 "*Non-nil means show a hollow box cursor in non-selected windows.
e053c60f 1424If nil, don't show a cursor except in the selected window.
f39784dd 1425Use Custom to set this variable to get the display updated."
63ec4f94 1426 :tag "Cursor In Non-selected Windows"
5b2c5477
GM
1427 :type 'boolean
1428 :group 'cursor
5b2c5477
GM
1429 :set #'(lambda (symbol value)
1430 (set-default symbol value)
5b2c5477 1431 (force-mode-line-update t)))
f39784dd 1432
81b99826 1433\f
64c669bc 1434;;;; Key bindings
64c669bc 1435
6238bfaf 1436(define-key ctl-x-5-map "2" 'make-frame-command)
154a757e 1437(define-key ctl-x-5-map "1" 'delete-other-frames)
dc6d9681 1438(define-key ctl-x-5-map "0" 'delete-frame)
ceab6935 1439(define-key ctl-x-5-map "o" 'other-frame)
49116ac0 1440
dc6d9681 1441(provide 'frame)
c88ab9ce 1442
485464c4 1443;; arch-tag: 82979c70-b8f2-4306-b2ad-ddbd6b328b56
dc6d9681 1444;;; frame.el ends here