(compilation-find-file): If FILENAME is absolute, apply
[bpt/emacs.git] / lisp / frame.el
CommitLineData
dc6d9681 1;;; frame.el --- multi-frame management independent of window systems.
c88ab9ce 2
8f1204db 3;;;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
3a801d0c 4
fc68affa 5;; Maintainer: FSF
fd7fa35a 6;; Keywords: internal
fc68affa 7
64c669bc
JB
8;;; This file is part of GNU Emacs.
9;;;
10;;; GNU Emacs is free software; you can redistribute it and/or modify
11;;; it under the terms of the GNU General Public License as published by
de49a6d3 12;;; the Free Software Foundation; either version 2, or (at your option)
64c669bc
JB
13;;; any later version.
14;;;
15;;; GNU Emacs is distributed in the hope that it will be useful,
16;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;;; GNU General Public License for more details.
19;;;
20;;; You should have received a copy of the GNU General Public License
21;;; along with GNU Emacs; see the file COPYING. If not, write to
22;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23
fc68affa
ER
24;;; Code:
25
dc6d9681
JB
26(defvar frame-creation-function nil
27 "Window-system dependent function to call to create a new frame.
28The window system startup file should set this to its frame creation
64c669bc
JB
29function, which should take an alist of parameters as its argument.")
30
7eadab74
JB
31;;; The initial value given here for this must ask for a minibuffer.
32;;; There must always exist a frame with a minibuffer, and after we
33;;; delete the terminal frame, this will be the only frame.
9e2b097b 34(defvar initial-frame-alist '((minibuffer . t))
eaa974e1
JB
35 "Alist of frame parameters for creating the initial X window frame.
36You can set this in your `.emacs' file; for example,
dc6d9681 37 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
de17da15
RS
38Parameters specified here supersede the values given in `default-frame-alist'.
39
40If the value calls for a frame without a minibuffer, and you have not created
41a minibuffer frame on your own, one is created according to
7eadab74 42`minibuffer-frame-alist'.
de17da15
RS
43
44You can specify geometry-related options for just the initial frame
45by setting this variable in your `.emacs' file; however, they won't
85557d7e 46take effect until Emacs reads `.emacs', which happens after first creating
de17da15
RS
47the frame. If you want the frame to have the proper geometry as soon
48as it appears, you need to use this three-step process:
49* Specify X resources to give the geometry you want.
50* Set `default-frame-alist' to override these options so that they
51 don't affect subsequent frames.
52* Set `initial-frame-alist' in a way that matches the X resources,
53 to override what you put in `default-frame-alist'.")
64c669bc 54
7eadab74 55(defvar minibuffer-frame-alist '((width . 80) (height . 2))
eaa974e1
JB
56 "Alist of frame parameters for initially creating a minibuffer frame.
57You can set this in your `.emacs' file; for example,
dc6d9681 58 (setq minibuffer-frame-alist
7eadab74 59 '((top . 1) (left . 1) (width . 80) (height . 2)))
eaa974e1
JB
60Parameters specified here supersede the values given in
61`default-frame-alist'.")
64c669bc 62
dc6d9681 63(defvar pop-up-frame-alist nil
eaa974e1 64 "Alist of frame parameters used when creating pop-up frames.
dc6d9681 65Pop-up frames are used for completions, help, and the like.
64c669bc 66This variable can be set in your init file, like this:
dc6d9681 67 (setq pop-up-frame-alist '((width . 80) (height . 20)))
eb8c3be9 68These supersede the values given in `default-frame-alist'.")
64c669bc 69
dc6d9681 70(setq pop-up-frame-function
64c669bc 71 (function (lambda ()
6eb018ba 72 (make-frame pop-up-frame-alist))))
64c669bc 73
85557d7e 74(defvar special-display-frame-alist
8a9e86e6
RS
75 '((height . 14) (width . 80) (unsplittable . t))
76 "*Alist of frame parameters used when creating special frames.
77Special frames are used for buffers whose names are in
78`special-display-buffer-names' and for buffers whose names match
79one of the regular expressions in `special-display-regexps'.
80This variable can be set in your init file, like this:
81 (setq special-display-frame-alist '((width . 80) (height . 20)))
82These supersede the values given in `default-frame-alist'.")
83
84;; Display BUFFER in its own frame, reusing an existing window if any.
85;; Return the window chosen.
86;; Currently we do not insist on selecting the window within its frame.
95e6cf39 87;; If ARGS is an alist, use it as a list of frame parameter specs.
85557d7e 88;; If ARGS is a list whose car is a symbol,
95e6cf39
RS
89;; use (car ARGS) as a function to do the work.
90;; Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args.
91(defun special-display-popup-frame (buffer &optional args)
92 (if (and args (symbolp (car args)))
93 (apply (car args) buffer (cdr args))
94 (let ((window (get-buffer-window buffer t)))
95 (if window
96 ;; If we have a window already, make it visible.
97 (let ((frame (window-frame window)))
98 (make-frame-visible frame)
99 (raise-frame frame)
100 window)
101 ;; If no window yet, make one in a new frame.
102 (let ((frame (make-frame (append args special-display-frame-alist))))
103 (set-window-buffer (frame-selected-window frame) buffer)
104 (set-window-dedicated-p (frame-selected-window frame) t)
105 (frame-selected-window frame))))))
8a9e86e6 106
924be53a
RS
107;; Handle delete-frame events from the X server.
108(defun handle-delete-frame (event)
109 (interactive "e")
110 (let ((frame (posn-window (event-start event)))
111 (i 0)
112 (tail (frame-list)))
113 (while tail
114 (and (frame-visible-p (car tail))
115 (not (eq (car tail) frame))
116 (setq i (1+ i)))
117 (setq tail (cdr tail)))
118 (if (> i 0)
119 (delete-frame frame t)
120 (kill-emacs))))
64c669bc 121\f
dc6d9681 122;;;; Arrangement of frames at startup
64c669bc
JB
123
124;;; 1) Load the window system startup file from the lisp library and read the
125;;; high-priority arguments (-q and the like). The window system startup
dc6d9681 126;;; file should create any frames specified in the window system defaults.
85557d7e 127;;;
dc6d9681 128;;; 2) If no frames have been opened, we open an initial text frame.
64c669bc
JB
129;;;
130;;; 3) Once the init file is done, we apply any newly set parameters
dc6d9681 131;;; in initial-frame-alist to the frame.
64c669bc 132
85557d7e 133;; These are now called explicitly at the proper times,
fc4d4afb
RS
134;; since that is easier to understand.
135;; Actually using hooks within Emacs is bad for future maintenance. --rms.
136;; (add-hook 'before-init-hook 'frame-initialize)
137;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
64c669bc 138
dc6d9681
JB
139;;; If we create the initial frame, this is it.
140(defvar frame-initial-frame nil)
64c669bc 141
3f2f8c83
RS
142;; Record the parameters used in frame-initialize to make the initial frame.
143(defvar frame-initial-frame-alist)
144
791e09d8
RS
145(defvar frame-initial-geometry-arguments nil)
146
64c669bc 147;;; startup.el calls this function before loading the user's init
dc6d9681 148;;; file - if there is no frame with a minibuffer open now, create
64c669bc 149;;; one to display messages while loading the init file.
dc6d9681 150(defun frame-initialize ()
85557d7e 151
64c669bc
JB
152 ;; Are we actually running under a window system at all?
153 (if (and window-system (not noninteractive))
7eadab74 154 (progn
62642af9
RS
155 ;; Turn on special-display processing only if there's a window system.
156 (setq special-display-function 'special-display-popup-frame)
157
7eadab74
JB
158 ;; If there is no frame with a minibuffer besides the terminal
159 ;; frame, then we need to create the opening frame. Make sure
160 ;; it has a minibuffer, but let initial-frame-alist omit the
161 ;; minibuffer spec.
162 (or (delq terminal-frame (minibuffer-frame-list))
36fc9c9f 163 (progn
3f2f8c83
RS
164 (setq frame-initial-frame-alist
165 (append initial-frame-alist default-frame-alist))
a8bb5882
RS
166 ;; Record these with their default values
167 ;; if they don't have any values explicitly.
168 (or (assq 'vertical-scroll-bars frame-initial-frame-alist)
169 (setq frame-initial-frame-alist
170 (cons '(vertical-scroll-bars . t)
171 frame-initial-frame-alist)))
172 (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
173 (setq frame-initial-frame-alist
174 (cons '(horizontal-scroll-bars . t)
175 frame-initial-frame-alist)))
36fc9c9f
RS
176 (setq default-minibuffer-frame
177 (setq frame-initial-frame
6eb018ba 178 (make-frame initial-frame-alist)))
11281034
RS
179 ;; Delete any specifications for window geometry parameters
180 ;; so that we won't reapply them in frame-notice-user-settings.
181 ;; It would be wrong to reapply them then,
182 ;; because that would override explicit user resizing.
58bf6042 183 (setq initial-frame-alist
c2079f0a 184 (frame-remove-geometry-params initial-frame-alist))))
85557d7e 185 ;; At this point, we know that we have a frame open, so we
dc6d9681
JB
186 ;; can delete the terminal frame.
187 (delete-frame terminal-frame)
188 (setq terminal-frame nil))
85557d7e 189
0759c4d0
KH
190 ;; No, we're not running a window system. Use make-terminal-frame if
191 ;; we support that feature, otherwise arrange to cause errors.
dc6d9681 192 (setq frame-creation-function
0759c4d0
KH
193 (if (fboundp 'make-terminal-frame)
194 'make-terminal-frame
195 (function
196 (lambda (parameters)
197 (error
198 "Can't create multiple frames without a window system")))))))
85557d7e 199
7eadab74
JB
200;;; startup.el calls this function after loading the user's init
201;;; file. Now default-frame-alist and initial-frame-alist contain
202;;; information to which we must react; do what needs to be done.
dc6d9681 203(defun frame-notice-user-settings ()
7eadab74 204
2ffa6186 205 ;; Make menu-bar-mode and default-frame-alist consistent.
b65be6a8
KH
206 (if (boundp 'menu-bar-mode)
207 (let ((default (assq 'menu-bar-lines default-frame-alist)))
208 (if default
209 (setq menu-bar-mode (not (eq (cdr default) 0)))
210 (setq default-frame-alist
211 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
212 default-frame-alist)))))
2ffa6186 213
7eadab74
JB
214 ;; Creating and deleting frames may shift the selected frame around,
215 ;; and thus the current buffer. Protect against that. We don't
216 ;; want to use save-excursion here, because that may also try to set
217 ;; the buffer of the selected window, which fails when the selected
218 ;; window is the minibuffer.
219 (let ((old-buffer (current-buffer)))
220
221 ;; If the initial frame is still around, apply initial-frame-alist
222 ;; and default-frame-alist to it.
223 (if (frame-live-p frame-initial-frame)
224
225 ;; The initial frame we create above always has a minibuffer.
226 ;; If the user wants to remove it, or make it a minibuffer-only
227 ;; frame, then we'll have to delete the current frame and make a
228 ;; new one; you can't remove or add a root window to/from an
229 ;; existing frame.
230 ;;
ec558adc
JB
231 ;; NOTE: default-frame-alist was nil when we created the
232 ;; existing frame. We need to explicitly include
233 ;; default-frame-alist in the parameters of the screen we
234 ;; create here, so that its new value, gleaned from the user's
235 ;; .emacs file, will be applied to the existing screen.
7eadab74
JB
236 (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
237 (assq 'minibuffer default-frame-alist)
238 '(minibuffer . t)))
239 t))
240 ;; Create the new frame.
b65e2f74
RS
241 (let (parms new)
242 ;; If the frame isn't visible yet, wait till it is.
243 ;; If the user has to position the window,
244 ;; Emacs doesn't know its real position until
245 ;; the frame is seen to be visible.
246 (while (not (cdr (assq 'visibility
247 (frame-parameters frame-initial-frame))))
248 (sleep-for 1))
249 (setq parms (append initial-frame-alist
6eb018ba
RS
250 default-frame-alist
251 (frame-parameters frame-initial-frame)
252 nil))
c1e67401
RS
253 ;; Get rid of `reverse', because that was handled
254 ;; when we first made the frame.
255 (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
256 (if (assq 'height frame-initial-geometry-arguments)
5b66a32f 257 (setq parms (frame-delete-all 'height parms)))
c1e67401 258 (if (assq 'width frame-initial-geometry-arguments)
5b66a32f 259 (setq parms (frame-delete-all 'width parms)))
c1e67401 260 (if (assq 'left frame-initial-geometry-arguments)
5b66a32f 261 (setq parms (frame-delete-all 'left parms)))
c1e67401 262 (if (assq 'top frame-initial-geometry-arguments)
5b66a32f 263 (setq parms (frame-delete-all 'top parms)))
c1e67401
RS
264 (setq new
265 (make-frame
266 ;; Use the geometry args that created the existing
267 ;; frame, rather than the parms we get for it.
3ce3ff11
KH
268 (append frame-initial-geometry-arguments
269 '((user-size . t) (user-position . t))
270 parms)))
7eadab74
JB
271 ;; The initial frame, which we are about to delete, may be
272 ;; the only frame with a minibuffer. If it is, create a
273 ;; new one.
274 (or (delq frame-initial-frame (minibuffer-frame-list))
746bd265 275 (make-initial-minibuffer-frame nil))
7eadab74
JB
276
277 ;; If the initial frame is serving as a surrogate
278 ;; minibuffer frame for any frames, we need to wean them
279 ;; onto a new frame. The default-minibuffer-frame
280 ;; variable must be handled similarly.
281 (let ((users-of-initial
282 (filtered-frame-list
283 (function (lambda (frame)
284 (and (not (eq frame frame-initial-frame))
285 (eq (window-frame
286 (minibuffer-window frame))
287 frame-initial-frame)))))))
288 (if (or users-of-initial
289 (eq default-minibuffer-frame frame-initial-frame))
290
291 ;; Choose an appropriate frame. Prefer frames which
292 ;; are only minibuffers.
293 (let* ((new-surrogate
294 (car
295 (or (filtered-frame-list
296 (function
297 (lambda (frame)
298 (eq (cdr (assq 'minibuffer
299 (frame-parameters frame)))
300 'only))))
301 (minibuffer-frame-list))))
302 (new-minibuffer (minibuffer-window new-surrogate)))
303
304 (if (eq default-minibuffer-frame frame-initial-frame)
305 (setq default-minibuffer-frame new-surrogate))
306
307 ;; Wean the frames using frame-initial-frame as
308 ;; their minibuffer frame.
309 (mapcar
310 (function
311 (lambda (frame)
312 (modify-frame-parameters
313 frame (list (cons 'minibuffer new-minibuffer)))))
314 users-of-initial))))
ec558adc
JB
315
316 ;; Redirect events enqueued at this frame to the new frame.
317 ;; Is this a good idea?
7eadab74 318 (redirect-frame-focus frame-initial-frame new)
ec558adc 319
7eadab74 320 ;; Finally, get rid of the old frame.
0cffbbb9 321 (delete-frame frame-initial-frame t))
7eadab74
JB
322
323 ;; Otherwise, we don't need all that rigamarole; just apply
324 ;; the new parameters.
3f2f8c83
RS
325 (let (newparms allparms tail)
326 (setq allparms (append initial-frame-alist
327 default-frame-alist))
5b66a32f
RS
328 (if (assq 'height frame-initial-geometry-arguments)
329 (setq allparms (frame-delete-all 'height allparms)))
330 (if (assq 'width frame-initial-geometry-arguments)
331 (setq allparms (frame-delete-all 'width allparms)))
332 (if (assq 'left frame-initial-geometry-arguments)
333 (setq allparms (frame-delete-all 'left allparms)))
334 (if (assq 'top frame-initial-geometry-arguments)
335 (setq allparms (frame-delete-all 'top allparms)))
3f2f8c83
RS
336 (setq tail allparms)
337 ;; Find just the parms that have changed since we first
338 ;; made this frame. Those are the ones actually set by
339 ;; the init file. For those parms whose values we already knew
340 ;; (such as those spec'd by command line options)
341 ;; it is undesirable to specify the parm again
342 ;; once the user has seen the frame and been able to alter it
343 ;; manually.
344 (while tail
345 (let (newval oldval)
66de157d
RS
346 (setq oldval (assq (car (car tail))
347 frame-initial-frame-alist))
3f2f8c83 348 (setq newval (cdr (assq (car (car tail)) allparms)))
66de157d 349 (or (and oldval (eq (cdr oldval) newval))
3f2f8c83
RS
350 (setq newparms
351 (cons (cons (car (car tail)) newval) newparms))))
352 (setq tail (cdr tail)))
86e58378 353 (setq newparms (nreverse newparms))
3f2f8c83 354 (modify-frame-parameters frame-initial-frame
86e58378
RS
355 newparms)
356 (if (assq 'font newparms)
357 (frame-update-faces frame-initial-frame)))))
64c669bc 358
7eadab74
JB
359 ;; Restore the original buffer.
360 (set-buffer old-buffer)
361
362 ;; Make sure the initial frame can be GC'd if it is ever deleted.
d202f1f2
JB
363 ;; Make sure frame-notice-user-settings does nothing if called twice.
364 (setq frame-initial-frame nil)))
64c669bc 365
746bd265
KH
366(defun make-initial-minibuffer-frame (display)
367 (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
368 (if display
369 (make-frame-on-display display parms)
370 (make-frame parms))))
371
5b66a32f
RS
372;; Delete from ALIST all elements whose car is KEY.
373;; Return the modified alist.
374(defun frame-delete-all (key alist)
9759578f 375 (setq alist (copy-sequence alist))
5b66a32f
RS
376 (let ((tail alist))
377 (while tail
378 (if (eq (car (car tail)) key)
379 (setq alist (delq (car tail) alist)))
380 (setq tail (cdr tail)))
381 alist))
64c669bc 382\f
7eadab74 383;;;; Creation of additional frames, and other frame miscellanea
dc6d9681 384
7eadab74 385;;; Return some frame other than the current frame, creating one if
eb8c3be9 386;;; necessary. Note that the minibuffer frame, if separate, is not
7eadab74 387;;; considered (see next-frame).
7253d8e0 388(defun get-other-frame ()
dc6d9681 389 (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
6eb018ba 390 (make-frame)
dc6d9681 391 (next-frame (selected-frame)))))
64c669bc
JB
392 s))
393
dc6d9681
JB
394(defun next-multiframe-window ()
395 "Select the next window, regardless of which frame it is on."
64c669bc
JB
396 (interactive)
397 (select-window (next-window (selected-window)
398 (> (minibuffer-depth) 0)
399 t)))
400
dc6d9681
JB
401(defun previous-multiframe-window ()
402 "Select the previous window, regardless of which frame it is on."
64c669bc
JB
403 (interactive)
404 (select-window (previous-window (selected-window)
405 (> (minibuffer-depth) 0)
406 t)))
407
6d73e337
RS
408(defun make-frame-on-display (display &optional parameters)
409 "Make a frame on display DISPLAY.
410The optional second argument PARAMETERS specifies additional frame parameters."
411 (interactive "sMake frame on display: ")
412 (make-frame (cons (cons 'display display) parameters)))
413
92e443b1 414;; Alias, kept temporarily.
31e1d920 415(defalias 'new-frame 'make-frame)
92e443b1 416(defun make-frame (&optional parameters)
dc6d9681 417 "Create a new frame, displaying the current buffer.
bc93c097 418
43a2e52c 419Optional argument PARAMETERS is an alist of parameters for the new
a105105a
RS
420frame. Specifically, PARAMETERS is a list of pairs, each having
421the form (NAME . VALUE).
422
423Here are some of the parameters allowed (not a complete list):
43a2e52c 424
eaa974e1 425\(name . STRING) - The frame should be named STRING.
43a2e52c 426
eaa974e1 427\(height . NUMBER) - The frame should be NUMBER text lines high. If
43a2e52c
JB
428 this parameter is present, the width parameter must also be
429 given.
430
eaa974e1 431\(width . NUMBER) - The frame should be NUMBER characters in width.
43a2e52c
JB
432 If this parameter is present, the height parameter must also
433 be given.
434
eaa974e1 435\(minibuffer . t) - the frame should have a minibuffer
0ca90494 436\(minibuffer . nil) - the frame should have no minibuffer
eaa974e1 437\(minibuffer . only) - the frame should contain only a minibuffer
8dbd5c78 438\(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window."
64c669bc 439 (interactive)
4133ab49
RS
440 (let ((nframe))
441 (run-hooks 'before-make-frame-hook)
442 (setq nframe (funcall frame-creation-function parameters))
443 (run-hooks 'after-make-frame-hook)
444 nframe))
64c669bc 445
7eadab74
JB
446(defun filtered-frame-list (predicate)
447 "Return a list of all live frames which satisfy PREDICATE."
448 (let ((frames (frame-list))
449 good-frames)
450 (while (consp frames)
451 (if (funcall predicate (car frames))
452 (setq good-frames (cons (car frames) good-frames)))
453 (setq frames (cdr frames)))
454 good-frames))
455
456(defun minibuffer-frame-list ()
457 "Return a list of all frames with their own minibuffers."
458 (filtered-frame-list
459 (function (lambda (frame)
460 (eq frame (window-frame (minibuffer-window frame)))))))
461
58bf6042
JB
462(defun frame-remove-geometry-params (param-list)
463 "Return the parameter list PARAM-LIST, but with geometry specs removed.
464This deletes all bindings in PARAM-LIST for `top', `left', `width',
791e09d8 465`height', `user-size' and `user-position' parameters.
58bf6042
JB
466Emacs uses this to avoid overriding explicit moves and resizings from
467the user during startup."
468 (setq param-list (cons nil param-list))
469 (let ((tail param-list))
470 (while (consp (cdr tail))
471 (if (and (consp (car (cdr tail)))
791e09d8
RS
472 (memq (car (car (cdr tail)))
473 '(height width top left user-position user-size)))
474 (progn
475 (setq frame-initial-geometry-arguments
476 (cons (car (cdr tail)) frame-initial-geometry-arguments))
477 (setcdr tail (cdr (cdr tail))))
58bf6042 478 (setq tail (cdr tail)))))
e11c3dc2
KH
479 (setq frame-initial-geometry-arguments
480 (nreverse frame-initial-geometry-arguments))
58bf6042
JB
481 (cdr param-list))
482
483
ceab6935 484(defun other-frame (arg)
a569dbc3 485 "Select the ARG'th different visible frame, and raise it.
ceab6935
RM
486All frames are arranged in a cyclic order.
487This command selects the frame ARG steps away in that order.
488A negative ARG moves in the opposite order."
489 (interactive "p")
490 (let ((frame (selected-frame)))
491 (while (> arg 0)
a569dbc3
RM
492 (setq frame (next-frame frame))
493 (while (not (eq (frame-visible-p frame) t))
494 (setq frame (next-frame frame)))
495 (setq arg (1- arg)))
ceab6935 496 (while (< arg 0)
a569dbc3
RM
497 (setq frame (previous-frame frame))
498 (while (not (eq (frame-visible-p frame) t))
499 (setq frame (previous-frame frame)))
915cfd1f 500 (setq arg (1+ arg)))
ceab6935 501 (raise-frame frame)
699213bc 502 (select-frame frame)
2b88f7a0 503 (set-mouse-position (selected-frame) (1- (frame-width)) 0)
b65be6a8
KH
504 (if (fboundp 'unfocus-frame)
505 (unfocus-frame))))
64c669bc 506\f
dc6d9681
JB
507;;;; Frame configurations
508
509(defun current-frame-configuration ()
510 "Return a list describing the positions and states of all frames.
376a7584
JB
511Its car is `frame-configuration'.
512Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
513where
514 FRAME is a frame object,
515 ALIST is an association list specifying some of FRAME's parameters, and
516 WINDOW-CONFIG is a window configuration object for FRAME."
517 (cons 'frame-configuration
518 (mapcar (function
519 (lambda (frame)
520 (list frame
521 (frame-parameters frame)
522 (current-window-configuration frame))))
523 (frame-list))))
dc6d9681 524
68cd265f 525(defun set-frame-configuration (configuration &optional nodelete)
dc6d9681
JB
526 "Restore the frames to the state described by CONFIGURATION.
527Each frame listed in CONFIGURATION has its position, size, window
68cd265f 528configuration, and other parameters set as specified in CONFIGURATION.
a78db71c
RS
529Ordinarily, this function deletes all existing frames not
530listed in CONFIGURATION. But if optional second argument NODELETE
5da841d2 531is given and non-nil, the unwanted frames are iconified instead."
376a7584
JB
532 (or (frame-configuration-p configuration)
533 (signal 'wrong-type-argument
534 (list 'frame-configuration-p configuration)))
535 (let ((config-alist (cdr configuration))
536 frames-to-delete)
06b1a5ef 537 (mapcar (function
dc6d9681 538 (lambda (frame)
376a7584 539 (let ((parameters (assq frame config-alist)))
06b1a5ef
JB
540 (if parameters
541 (progn
98e9d14b
JB
542 (modify-frame-parameters
543 frame
85557d7e 544 ;; Since we can't set a frame's minibuffer status,
98e9d14b
JB
545 ;; we might as well omit the parameter altogether.
546 (let* ((parms (nth 1 parameters))
547 (mini (assq 'minibuffer parms)))
548 (if mini (setq parms (delq mini parms)))
549 parms))
06b1a5ef 550 (set-window-configuration (nth 2 parameters)))
dc6d9681
JB
551 (setq frames-to-delete (cons frame frames-to-delete))))))
552 (frame-list))
a78db71c 553 (if nodelete
5da841d2
RS
554 ;; Note: making frames invisible here was tried
555 ;; but led to some strange behavior--each time the frame
556 ;; was made visible again, the window manager asked afresh
557 ;; for where to put it.
558 (mapcar 'iconify-frame frames-to-delete)
a78db71c 559 (mapcar 'delete-frame frames-to-delete))))
64c669bc 560\f
dc6d9681
JB
561;;;; Convenience functions for accessing and interactively changing
562;;;; frame parameters.
64c669bc 563
151bdc83 564(defun frame-height (&optional frame)
dc6d9681
JB
565 "Return number of lines available for display on FRAME.
566If FRAME is omitted, describe the currently selected frame."
151bdc83 567 (cdr (assq 'height (frame-parameters frame))))
dc6d9681
JB
568
569(defun frame-width (&optional frame)
570 "Return number of columns available for display on FRAME.
571If FRAME is omitted, describe the currently selected frame."
151bdc83 572 (cdr (assq 'width (frame-parameters frame))))
dc6d9681 573
64c669bc 574(defun set-default-font (font-name)
7eadab74
JB
575 "Set the font of the selected frame to FONT.
576When called interactively, prompt for the name of the font to use."
64c669bc 577 (interactive "sFont name: ")
dc6d9681 578 (modify-frame-parameters (selected-frame)
4033f46b
RS
579 (list (cons 'font font-name)))
580 ;; Update faces that want a bold or italic version of the default font.
581 (frame-update-faces (selected-frame)))
64c669bc 582
8290babd 583(defun set-background-color (color-name)
7eadab74
JB
584 "Set the background color of the selected frame to COLOR.
585When called interactively, prompt for the name of the color to use."
64c669bc 586 (interactive "sColor: ")
dc6d9681 587 (modify-frame-parameters (selected-frame)
1787c22a
RS
588 (list (cons 'background-color color-name)))
589 (frame-update-face-colors (selected-frame)))
64c669bc 590
8290babd 591(defun set-foreground-color (color-name)
7eadab74
JB
592 "Set the foreground color of the selected frame to COLOR.
593When called interactively, prompt for the name of the color to use."
64c669bc 594 (interactive "sColor: ")
dc6d9681 595 (modify-frame-parameters (selected-frame)
1787c22a
RS
596 (list (cons 'foreground-color color-name)))
597 (frame-update-face-colors (selected-frame)))
64c669bc
JB
598
599(defun set-cursor-color (color-name)
7eadab74
JB
600 "Set the text cursor color of the selected frame to COLOR.
601When called interactively, prompt for the name of the color to use."
64c669bc 602 (interactive "sColor: ")
dc6d9681 603 (modify-frame-parameters (selected-frame)
7eadab74 604 (list (cons 'cursor-color color-name))))
64c669bc 605
eaa974e1 606(defun set-mouse-color (color-name)
7eadab74
JB
607 "Set the color of the mouse pointer of the selected frame to COLOR.
608When called interactively, prompt for the name of the color to use."
64c669bc 609 (interactive "sColor: ")
dc6d9681 610 (modify-frame-parameters (selected-frame)
7eadab74
JB
611 (list (cons 'mouse-color color-name))))
612
eaa974e1
JB
613(defun set-border-color (color-name)
614 "Set the color of the border of the selected frame to COLOR.
615When called interactively, prompt for the name of the color to use."
616 (interactive "sColor: ")
617 (modify-frame-parameters (selected-frame)
618 (list (cons 'border-color color-name))))
619
620(defun auto-raise-mode (arg)
7eadab74 621 "Toggle whether or not the selected frame should auto-raise.
79e6ae33
RS
622With arg, turn auto-raise mode on if and only if arg is positive.
623Note that this controls Emacs's own auto-raise feature.
624Some window managers allow you to enable auto-raise for certain windows.
625You can use that for Emacs windows if you wish, but if you do,
626that is beyond the control of Emacs and this command has no effect on it."
7eadab74
JB
627 (interactive "P")
628 (if (null arg)
629 (setq arg
630 (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
631 -1 1)))
dc6d9681 632 (modify-frame-parameters (selected-frame)
7eadab74
JB
633 (list (cons 'auto-raise (> arg 0)))))
634
eaa974e1 635(defun auto-lower-mode (arg)
7eadab74 636 "Toggle whether or not the selected frame should auto-lower.
79e6ae33
RS
637With arg, turn auto-lower mode on if and only if arg is positive.
638Note that this controls Emacs's own auto-lower feature.
639Some window managers allow you to enable auto-lower for certain windows.
640You can use that for Emacs windows if you wish, but if you do,
641that is beyond the control of Emacs and this command has no effect on it."
7eadab74
JB
642 (interactive "P")
643 (if (null arg)
644 (setq arg
645 (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
646 -1 1)))
dc6d9681 647 (modify-frame-parameters (selected-frame)
7eadab74
JB
648 (list (cons 'auto-lower (> arg 0)))))
649
7e85c6b5 650(defun toggle-scroll-bar (arg)
0ca90494
JB
651 "Toggle whether or not the selected frame has vertical scroll bars.
652With arg, turn vertical scroll bars on if and only if arg is positive."
7eadab74
JB
653 (interactive "P")
654 (if (null arg)
655 (setq arg
0ca90494 656 (if (cdr (assq 'vertical-scroll-bars
7eadab74
JB
657 (frame-parameters (selected-frame))))
658 -1 1)))
dc6d9681 659 (modify-frame-parameters (selected-frame)
0ca90494 660 (list (cons 'vertical-scroll-bars (> arg 0)))))
7eadab74 661
8290babd 662(defun toggle-horizontal-scroll-bar (arg)
0ca90494
JB
663 "Toggle whether or not the selected frame has horizontal scroll bars.
664With arg, turn horizontal scroll bars on if and only if arg is positive.
665Horizontal scroll bars aren't implemented yet."
7eadab74 666 (interactive "P")
8290babd 667 (error "Horizontal scroll bars aren't implemented yet"))
64c669bc 668
64c669bc 669\f
dc6d9681 670;;;; Aliases for backward compatibility with Emacs 18.
31e1d920
ER
671(defalias 'screen-height 'frame-height)
672(defalias 'screen-width 'frame-width)
9e2b097b
JB
673
674(defun set-screen-width (cols &optional pretend)
675 "Obsolete function to change the size of the screen to COLS columns.\n\
676Optional second arg non-nil means that redisplay should use COLS columns\n\
677but that the idea of the actual width of the frame should not be changed.\n\
678This function is provided only for compatibility with Emacs 18; new code\n\
fe668515 679should use `set-frame-width instead'."
9e2b097b
JB
680 (set-frame-width (selected-frame) cols pretend))
681
682(defun set-screen-height (lines &optional pretend)
683 "Obsolete function to change the height of the screen to LINES lines.\n\
684Optional second arg non-nil means that redisplay should use LINES lines\n\
685but that the idea of the actual height of the screen should not be changed.\n\
686This function is provided only for compatibility with Emacs 18; new code\n\
fe668515 687should use `set-frame-width' instead."
9e2b097b
JB
688 (set-frame-height (selected-frame) lines pretend))
689
690(make-obsolete 'screen-height 'frame-height)
691(make-obsolete 'screen-width 'frame-width)
692(make-obsolete 'set-screen-width 'set-frame-width)
693(make-obsolete 'set-screen-height 'set-frame-height)
dc6d9681
JB
694
695\f
64c669bc 696;;;; Key bindings
daa37602 697(defvar ctl-x-5-map (make-sparse-keymap)
dc6d9681 698 "Keymap for frame commands.")
31e1d920 699(defalias 'ctl-x-5-prefix ctl-x-5-map)
daa37602 700(define-key ctl-x-map "5" 'ctl-x-5-prefix)
64c669bc 701
6eb018ba 702(define-key ctl-x-5-map "2" 'make-frame)
dc6d9681 703(define-key ctl-x-5-map "0" 'delete-frame)
ceab6935 704(define-key ctl-x-5-map "o" 'other-frame)
49116ac0 705
dc6d9681 706(provide 'frame)
c88ab9ce 707
dc6d9681 708;;; frame.el ends here