1 ;;; frame.el --- multi-frame management independent of window systems.
3 ;;;; Copyright (C) 1993 Free Software Foundation, Inc.
8 ;;; This file is part of GNU Emacs.
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.
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.
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.
26 (defvar frame-creation-function nil
27 "Window-system dependent function to call to create a new frame.
28 The window system startup file should set this to its frame creation
29 function, which should take an alist of parameters as its argument.")
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.
34 (defvar initial-frame-alist
'((minibuffer . t
))
35 "Alist of frame parameters for creating the initial X window frame.
36 You can set this in your `.emacs' file; for example,
37 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
38 If the value calls for a frame without a minibuffer, and you do not create a
39 minibuffer frame on your own, one is created according to
40 `minibuffer-frame-alist'.
41 Parameters specified here supersede the values given in
42 `default-frame-alist'.")
44 (defvar minibuffer-frame-alist
'((width .
80) (height .
2))
45 "Alist of frame parameters for initially creating a minibuffer frame.
46 You can set this in your `.emacs' file; for example,
47 (setq minibuffer-frame-alist
48 '((top . 1) (left . 1) (width . 80) (height . 2)))
49 Parameters specified here supersede the values given in
50 `default-frame-alist'.")
52 (defvar pop-up-frame-alist nil
53 "Alist of frame parameters used when creating pop-up frames.
54 Pop-up frames are used for completions, help, and the like.
55 This variable can be set in your init file, like this:
56 (setq pop-up-frame-alist '((width . 80) (height . 20)))
57 These supersede the values given in `default-frame-alist'.")
59 (setq pop-up-frame-function
61 (new-frame pop-up-frame-alist
))))
64 ;;;; Arrangement of frames at startup
66 ;;; 1) Load the window system startup file from the lisp library and read the
67 ;;; high-priority arguments (-q and the like). The window system startup
68 ;;; file should create any frames specified in the window system defaults.
70 ;;; 2) If no frames have been opened, we open an initial text frame.
72 ;;; 3) Once the init file is done, we apply any newly set parameters
73 ;;; in initial-frame-alist to the frame.
75 ;; These are now called explicitly at the proper times,
76 ;; since that is easier to understand.
77 ;; Actually using hooks within Emacs is bad for future maintenance. --rms.
78 ;; (add-hook 'before-init-hook 'frame-initialize)
79 ;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
81 ;;; If we create the initial frame, this is it.
82 (defvar frame-initial-frame nil
)
84 ;; Record the parameters used in frame-initialize to make the initial frame.
85 (defvar frame-initial-frame-alist
)
87 ;;; startup.el calls this function before loading the user's init
88 ;;; file - if there is no frame with a minibuffer open now, create
89 ;;; one to display messages while loading the init file.
90 (defun frame-initialize ()
92 ;; Are we actually running under a window system at all?
93 (if (and window-system
(not noninteractive
))
95 ;; If there is no frame with a minibuffer besides the terminal
96 ;; frame, then we need to create the opening frame. Make sure
97 ;; it has a minibuffer, but let initial-frame-alist omit the
99 (or (delq terminal-frame
(minibuffer-frame-list))
101 (setq frame-initial-frame-alist
102 (append initial-frame-alist default-frame-alist
))
103 (setq default-minibuffer-frame
104 (setq frame-initial-frame
105 (new-frame initial-frame-alist
)))
106 ;; Delete any specifications for window geometry parameters
107 ;; so that we won't reapply them in frame-notice-user-settings.
108 ;; It would be wrong to reapply them then,
109 ;; because that would override explicit user resizing.
110 (setq initial-frame-alist
111 (frame-remove-geometry-params initial-frame-alist
))
112 ;; Handle `reverse' as a parameter.
113 (if (cdr (or (assq 'reverse initial-frame-alist
)
114 (assq 'reverse default-frame-alist
)))
115 (let ((params (frame-parameters frame-initial-frame
)))
116 (modify-frame-parameters
118 ;; Must set cursor-color after background color.
120 (list (cons 'cursor-color
121 (cdr (assq 'background-color params
)))
122 (cons 'foreground-color
123 (cdr (assq 'background-color params
)))
124 (cons 'background-color
125 (cdr (assq 'foreground-color params
)))
127 (cdr (assq 'background-color params
)))
129 (cdr (assq 'background-color params
)))))))))
131 ;; At this point, we know that we have a frame open, so we
132 ;; can delete the terminal frame.
133 (delete-frame terminal-frame
)
134 (setq terminal-frame nil
))
136 ;; No, we're not running a window system. Arrange to cause errors.
137 (setq frame-creation-function
141 "Can't create multiple frames without a window system"))))))
143 ;;; startup.el calls this function after loading the user's init
144 ;;; file. Now default-frame-alist and initial-frame-alist contain
145 ;;; information to which we must react; do what needs to be done.
146 (defun frame-notice-user-settings ()
148 ;; Creating and deleting frames may shift the selected frame around,
149 ;; and thus the current buffer. Protect against that. We don't
150 ;; want to use save-excursion here, because that may also try to set
151 ;; the buffer of the selected window, which fails when the selected
152 ;; window is the minibuffer.
153 (let ((old-buffer (current-buffer)))
155 ;; If the initial frame is still around, apply initial-frame-alist
156 ;; and default-frame-alist to it.
157 (if (frame-live-p frame-initial-frame
)
159 ;; The initial frame we create above always has a minibuffer.
160 ;; If the user wants to remove it, or make it a minibuffer-only
161 ;; frame, then we'll have to delete the current frame and make a
162 ;; new one; you can't remove or add a root window to/from an
165 ;; NOTE: default-frame-alist was nil when we created the
166 ;; existing frame. We need to explicitly include
167 ;; default-frame-alist in the parameters of the screen we
168 ;; create here, so that its new value, gleaned from the user's
169 ;; .emacs file, will be applied to the existing screen.
170 (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist
)
171 (assq 'minibuffer default-frame-alist
)
174 ;; Create the new frame.
177 (append initial-frame-alist
179 (frame-parameters frame-initial-frame
)))))
181 ;; The initial frame, which we are about to delete, may be
182 ;; the only frame with a minibuffer. If it is, create a
184 (or (delq frame-initial-frame
(minibuffer-frame-list))
185 (new-frame (append minibuffer-frame-alist
186 '((minibuffer . only
)))))
188 ;; If the initial frame is serving as a surrogate
189 ;; minibuffer frame for any frames, we need to wean them
190 ;; onto a new frame. The default-minibuffer-frame
191 ;; variable must be handled similarly.
192 (let ((users-of-initial
194 (function (lambda (frame)
195 (and (not (eq frame frame-initial-frame
))
197 (minibuffer-window frame
))
198 frame-initial-frame
)))))))
199 (if (or users-of-initial
200 (eq default-minibuffer-frame frame-initial-frame
))
202 ;; Choose an appropriate frame. Prefer frames which
203 ;; are only minibuffers.
204 (let* ((new-surrogate
206 (or (filtered-frame-list
209 (eq (cdr (assq 'minibuffer
210 (frame-parameters frame
)))
212 (minibuffer-frame-list))))
213 (new-minibuffer (minibuffer-window new-surrogate
)))
215 (if (eq default-minibuffer-frame frame-initial-frame
)
216 (setq default-minibuffer-frame new-surrogate
))
218 ;; Wean the frames using frame-initial-frame as
219 ;; their minibuffer frame.
223 (modify-frame-parameters
224 frame
(list (cons 'minibuffer new-minibuffer
)))))
227 ;; Redirect events enqueued at this frame to the new frame.
228 ;; Is this a good idea?
229 (redirect-frame-focus frame-initial-frame new
)
231 ;; Finally, get rid of the old frame.
232 (delete-frame frame-initial-frame
))
234 ;; Otherwise, we don't need all that rigamarole; just apply
235 ;; the new parameters.
236 (let (newparms allparms tail
)
237 (setq allparms
(append initial-frame-alist
238 default-frame-alist
))
240 ;; Find just the parms that have changed since we first
241 ;; made this frame. Those are the ones actually set by
242 ;; the init file. For those parms whose values we already knew
243 ;; (such as those spec'd by command line options)
244 ;; it is undesirable to specify the parm again
245 ;; once the user has seen the frame and been able to alter it
249 (setq oldval
(cdr (assq (car (car tail
))
250 frame-initial-frame-alist
)))
251 (setq newval
(cdr (assq (car (car tail
)) allparms
)))
252 (or (eq oldval newval
)
254 (cons (cons (car (car tail
)) newval
) newparms
))))
255 (setq tail
(cdr tail
)))
256 (modify-frame-parameters frame-initial-frame
257 (nreverse newparms
)))))
259 ;; Restore the original buffer.
260 (set-buffer old-buffer
)
262 ;; Make sure the initial frame can be GC'd if it is ever deleted.
263 ;; Make sure frame-notice-user-settings does nothing if called twice.
264 (setq frame-initial-frame nil
)))
267 ;;;; Creation of additional frames, and other frame miscellanea
269 ;;; Return some frame other than the current frame, creating one if
270 ;;; necessary. Note that the minibuffer frame, if separate, is not
271 ;;; considered (see next-frame).
272 (defun get-other-frame ()
273 (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
275 (next-frame (selected-frame)))))
278 (defun next-multiframe-window ()
279 "Select the next window, regardless of which frame it is on."
281 (select-window (next-window (selected-window)
282 (> (minibuffer-depth) 0)
285 (defun previous-multiframe-window ()
286 "Select the previous window, regardless of which frame it is on."
288 (select-window (previous-window (selected-window)
289 (> (minibuffer-depth) 0)
292 ;; Alias, kept temporarily.
293 (defalias 'new-frame
'make-frame
)
294 (defun make-frame (&optional parameters
)
295 "Create a new frame, displaying the current buffer.
297 Optional argument PARAMETERS is an alist of parameters for the new
298 frame. Specifically, PARAMETERS is a list of pairs, each having one
299 of the following forms:
301 \(name . STRING) - The frame should be named STRING.
303 \(height . NUMBER) - The frame should be NUMBER text lines high. If
304 this parameter is present, the width parameter must also be
307 \(width . NUMBER) - The frame should be NUMBER characters in width.
308 If this parameter is present, the height parameter must also
311 \(minibuffer . t) - the frame should have a minibuffer
312 \(minibuffer . nil) - the frame should have no minibuffer
313 \(minibuffer . only) - the frame should contain only a minibuffer
314 \(minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window.
316 The documentation for the function `x-create-frame' describes
317 additional frame parameters that Emacs recognizes for X window frames."
319 (funcall frame-creation-function parameters
))
321 (defun filtered-frame-list (predicate)
322 "Return a list of all live frames which satisfy PREDICATE."
323 (let ((frames (frame-list))
325 (while (consp frames
)
326 (if (funcall predicate
(car frames
))
327 (setq good-frames
(cons (car frames
) good-frames
)))
328 (setq frames
(cdr frames
)))
331 (defun minibuffer-frame-list ()
332 "Return a list of all frames with their own minibuffers."
334 (function (lambda (frame)
335 (eq frame
(window-frame (minibuffer-window frame
)))))))
337 (defun frame-remove-geometry-params (param-list)
338 "Return the parameter list PARAM-LIST, but with geometry specs removed.
339 This deletes all bindings in PARAM-LIST for `top', `left', `width',
340 and `height' parameters.
341 Emacs uses this to avoid overriding explicit moves and resizings from
342 the user during startup."
343 (setq param-list
(cons nil param-list
))
344 (let ((tail param-list
))
345 (while (consp (cdr tail
))
346 (if (and (consp (car (cdr tail
)))
347 (memq (car (car (cdr tail
))) '(height width top left
)))
348 (setcdr tail
(cdr (cdr tail
)))
349 (setq tail
(cdr tail
)))))
354 ;;;; Frame configurations
356 (defun current-frame-configuration ()
357 "Return a list describing the positions and states of all frames.
358 Its car is `frame-configuration'.
359 Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
361 FRAME is a frame object,
362 ALIST is an association list specifying some of FRAME's parameters, and
363 WINDOW-CONFIG is a window configuration object for FRAME."
364 (cons 'frame-configuration
368 (frame-parameters frame
)
369 (current-window-configuration frame
))))
372 (defun set-frame-configuration (configuration)
373 "Restore the frames to the state described by CONFIGURATION.
374 Each frame listed in CONFIGURATION has its position, size, window
375 configuration, and other parameters set as specified in CONFIGURATION."
376 (or (frame-configuration-p configuration
)
377 (signal 'wrong-type-argument
378 (list 'frame-configuration-p configuration
)))
379 (let ((config-alist (cdr configuration
))
383 (let ((parameters (assq frame config-alist
)))
386 (modify-frame-parameters
388 ;; Since we can't set a frame's minibuffer status,
389 ;; we might as well omit the parameter altogether.
390 (let* ((parms (nth 1 parameters
))
391 (mini (assq 'minibuffer parms
)))
392 (if mini
(setq parms
(delq mini parms
)))
394 (set-window-configuration (nth 2 parameters
)))
395 (setq frames-to-delete
(cons frame frames-to-delete
))))))
397 (mapcar 'delete-frame frames-to-delete
)))
399 (defun frame-configuration-p (object)
400 "Return non-nil if OBJECT seems to be a frame configuration.
401 Any list whose car is `frame-configuration' is assumed to be a frame
404 (eq (car object
) 'frame-configuration
)))
407 ;;;; Convenience functions for accessing and interactively changing
408 ;;;; frame parameters.
410 (defun frame-height (&optional frame
)
411 "Return number of lines available for display on FRAME.
412 If FRAME is omitted, describe the currently selected frame."
413 (cdr (assq 'height
(frame-parameters frame
))))
415 (defun frame-width (&optional frame
)
416 "Return number of columns available for display on FRAME.
417 If FRAME is omitted, describe the currently selected frame."
418 (cdr (assq 'width
(frame-parameters frame
))))
420 (defun set-default-font (font-name)
421 "Set the font of the selected frame to FONT.
422 When called interactively, prompt for the name of the font to use."
423 (interactive "sFont name: ")
424 (modify-frame-parameters (selected-frame)
425 (list (cons 'font font-name
))))
427 (defun set-background-color (color-name)
428 "Set the background color of the selected frame to COLOR.
429 When called interactively, prompt for the name of the color to use."
430 (interactive "sColor: ")
431 (modify-frame-parameters (selected-frame)
432 (list (cons 'background-color color-name
))))
434 (defun set-foreground-color (color-name)
435 "Set the foreground color of the selected frame to COLOR.
436 When called interactively, prompt for the name of the color to use."
437 (interactive "sColor: ")
438 (modify-frame-parameters (selected-frame)
439 (list (cons 'foreground-color color-name
))))
441 (defun set-cursor-color (color-name)
442 "Set the text cursor color of the selected frame to COLOR.
443 When called interactively, prompt for the name of the color to use."
444 (interactive "sColor: ")
445 (modify-frame-parameters (selected-frame)
446 (list (cons 'cursor-color color-name
))))
448 (defun set-mouse-color (color-name)
449 "Set the color of the mouse pointer of the selected frame to COLOR.
450 When called interactively, prompt for the name of the color to use."
451 (interactive "sColor: ")
452 (modify-frame-parameters (selected-frame)
453 (list (cons 'mouse-color color-name
))))
455 (defun set-border-color (color-name)
456 "Set the color of the border of the selected frame to COLOR.
457 When called interactively, prompt for the name of the color to use."
458 (interactive "sColor: ")
459 (modify-frame-parameters (selected-frame)
460 (list (cons 'border-color color-name
))))
462 (defun auto-raise-mode (arg)
463 "Toggle whether or not the selected frame should auto-raise.
464 With arg, turn auto-raise mode on if and only if arg is positive."
468 (if (cdr (assq 'auto-raise
(frame-parameters (selected-frame))))
470 (modify-frame-parameters (selected-frame)
471 (list (cons 'auto-raise
(> arg
0)))))
473 (defun auto-lower-mode (arg)
474 "Toggle whether or not the selected frame should auto-lower.
475 With arg, turn auto-lower mode on if and only if arg is positive."
479 (if (cdr (assq 'auto-lower
(frame-parameters (selected-frame))))
481 (modify-frame-parameters (selected-frame)
482 (list (cons 'auto-lower
(> arg
0)))))
484 (defun toggle-scroll-bar (arg)
485 "Toggle whether or not the selected frame has vertical scroll bars.
486 With arg, turn vertical scroll bars on if and only if arg is positive."
490 (if (cdr (assq 'vertical-scroll-bars
491 (frame-parameters (selected-frame))))
493 (modify-frame-parameters (selected-frame)
494 (list (cons 'vertical-scroll-bars
(> arg
0)))))
496 (defun toggle-horizontal-scroll-bar (arg)
497 "Toggle whether or not the selected frame has horizontal scroll bars.
498 With arg, turn horizontal scroll bars on if and only if arg is positive.
499 Horizontal scroll bars aren't implemented yet."
501 (error "Horizontal scroll bars aren't implemented yet"))
504 ;;;; Aliases for backward compatibility with Emacs 18.
505 (defalias 'screen-height
'frame-height
)
506 (defalias 'screen-width
'frame-width
)
508 (defun set-screen-width (cols &optional pretend
)
509 "Obsolete function to change the size of the screen to COLS columns.\n\
510 Optional second arg non-nil means that redisplay should use COLS columns\n\
511 but that the idea of the actual width of the frame should not be changed.\n\
512 This function is provided only for compatibility with Emacs 18; new code\n\
513 should use `set-frame-width instead'."
514 (set-frame-width (selected-frame) cols pretend
))
516 (defun set-screen-height (lines &optional pretend
)
517 "Obsolete function to change the height of the screen to LINES lines.\n\
518 Optional second arg non-nil means that redisplay should use LINES lines\n\
519 but that the idea of the actual height of the screen should not be changed.\n\
520 This function is provided only for compatibility with Emacs 18; new code\n\
521 should use `set-frame-width' instead."
522 (set-frame-height (selected-frame) lines pretend
))
524 (make-obsolete 'screen-height
'frame-height
)
525 (make-obsolete 'screen-width
'frame-width
)
526 (make-obsolete 'set-screen-width
'set-frame-width
)
527 (make-obsolete 'set-screen-height
'set-frame-height
)
531 (defvar ctl-x-5-map
(make-sparse-keymap)
532 "Keymap for frame commands.")
533 (defalias 'ctl-x-5-prefix ctl-x-5-map
)
534 (define-key ctl-x-map
"5" 'ctl-x-5-prefix
)
536 (define-key ctl-x-5-map
"2" 'new-frame
)
537 (define-key ctl-x-5-map
"0" 'delete-frame
)
541 ;;; frame.el ends here