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