Commit | Line | Data |
---|---|---|
dc6d9681 | 1 | ;;; frame.el --- multi-frame management independent of window systems. |
c88ab9ce | 2 | |
faa3b11d | 3 | ;;;; Copyright (C) 1990, 1992, 1993 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. | |
28 | The window system startup file should set this to its frame creation | |
64c669bc JB |
29 | function, which should take an alist of parameters as its argument.") |
30 | ||
31 | ;;; The default value for this must ask for a minibuffer. There must | |
dc6d9681 JB |
32 | ;;; always exist a frame with a minibuffer, and after we delete the |
33 | ;;; terminal frame, this will be the only frame. | |
9e2b097b | 34 | (defvar initial-frame-alist '((minibuffer . t)) |
dc6d9681 | 35 | "Alist of values used when creating the initial emacs text frame. |
64c669bc | 36 | These may be set in your init file, like this: |
dc6d9681 JB |
37 | (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55))) |
38 | These supercede the values given in frame-default-alist.") | |
64c669bc | 39 | |
dc6d9681 JB |
40 | (defvar minibuffer-frame-alist nil |
41 | "Alist of values to apply to a minibuffer frame. | |
64c669bc | 42 | These may be set in your init file, like this: |
dc6d9681 | 43 | (setq minibuffer-frame-alist |
64c669bc | 44 | '((top . 1) (left . 1) (width . 80) (height . 1))) |
dc6d9681 | 45 | These supercede the values given in default-frame-alist.") |
64c669bc | 46 | |
dc6d9681 JB |
47 | (defvar pop-up-frame-alist nil |
48 | "Alist of values used when creating pop-up frames. | |
49 | Pop-up frames are used for completions, help, and the like. | |
64c669bc | 50 | This variable can be set in your init file, like this: |
dc6d9681 JB |
51 | (setq pop-up-frame-alist '((width . 80) (height . 20))) |
52 | These supercede the values given in default-frame-alist.") | |
64c669bc | 53 | |
dc6d9681 | 54 | (setq pop-up-frame-function |
64c669bc | 55 | (function (lambda () |
dc6d9681 | 56 | (new-frame pop-up-frame-alist)))) |
64c669bc JB |
57 | |
58 | \f | |
dc6d9681 | 59 | ;;;; Arrangement of frames at startup |
64c669bc JB |
60 | |
61 | ;;; 1) Load the window system startup file from the lisp library and read the | |
62 | ;;; high-priority arguments (-q and the like). The window system startup | |
dc6d9681 | 63 | ;;; file should create any frames specified in the window system defaults. |
64c669bc | 64 | ;;; |
dc6d9681 | 65 | ;;; 2) If no frames have been opened, we open an initial text frame. |
64c669bc JB |
66 | ;;; |
67 | ;;; 3) Once the init file is done, we apply any newly set parameters | |
dc6d9681 | 68 | ;;; in initial-frame-alist to the frame. |
64c669bc | 69 | |
dc6d9681 JB |
70 | (add-hook 'before-init-hook 'frame-initialize) |
71 | (add-hook 'window-setup-hook 'frame-notice-user-settings) | |
64c669bc | 72 | |
dc6d9681 JB |
73 | ;;; If we create the initial frame, this is it. |
74 | (defvar frame-initial-frame nil) | |
64c669bc JB |
75 | |
76 | ;;; startup.el calls this function before loading the user's init | |
dc6d9681 | 77 | ;;; file - if there is no frame with a minibuffer open now, create |
64c669bc | 78 | ;;; one to display messages while loading the init file. |
dc6d9681 | 79 | (defun frame-initialize () |
64c669bc JB |
80 | |
81 | ;; Are we actually running under a window system at all? | |
82 | (if (and window-system (not noninteractive)) | |
dc6d9681 | 83 | (let ((frames (frame-list))) |
64c669bc | 84 | |
dc6d9681 JB |
85 | ;; Look for a frame that has a minibuffer. |
86 | (while (and frames | |
87 | (or (eq (car frames) terminal-frame) | |
64c669bc | 88 | (not (cdr (assq 'minibuffer |
dc6d9681 JB |
89 | (frame-parameters |
90 | (car frames))))))) | |
91 | (setq frames (cdr frames))) | |
92 | ||
93 | ;; If there was none, then we need to create the opening frame. | |
94 | (or frames | |
95 | (setq default-minibuffer-frame | |
96 | (setq frame-initial-frame | |
97 | (new-frame initial-frame-alist)))) | |
64c669bc | 98 | |
dc6d9681 JB |
99 | ;; At this point, we know that we have a frame open, so we |
100 | ;; can delete the terminal frame. | |
101 | (delete-frame terminal-frame) | |
102 | (setq terminal-frame nil)) | |
64c669bc JB |
103 | |
104 | ;; No, we're not running a window system. Arrange to cause errors. | |
dc6d9681 | 105 | (setq frame-creation-function |
9198945a MB |
106 | (function |
107 | (lambda (parameters) | |
108 | (error | |
dc6d9681 | 109 | "Can't create multiple frames without a window system.")))))) |
64c669bc JB |
110 | |
111 | ;;; startup.el calls this function after loading the user's init file. | |
112 | ;;; If we created a minibuffer before knowing if we had permission, we | |
dc6d9681 | 113 | ;;; need to see if it should go away or change. Create a text frame |
64c669bc | 114 | ;;; here. |
dc6d9681 | 115 | (defun frame-notice-user-settings () |
dbc4e1c1 | 116 | (if (frame-live-p frame-initial-frame) |
64c669bc | 117 | (progn |
dc6d9681 | 118 | ;; If the user wants a minibuffer-only frame, we'll have to |
64c669bc | 119 | ;; make a new one; you can't remove or add a root window to/from |
dc6d9681 | 120 | ;; an existing frame. |
ec558adc JB |
121 | ;; NOTE: default-frame-alist was nil when we created the |
122 | ;; existing frame. We need to explicitly include | |
123 | ;; default-frame-alist in the parameters of the screen we | |
124 | ;; create here, so that its new value, gleaned from the user's | |
125 | ;; .emacs file, will be applied to the existing screen. | |
dc6d9681 | 126 | (if (eq (cdr (or (assq 'minibuffer initial-frame-alist) |
64c669bc JB |
127 | '(minibuffer . t))) |
128 | 'only) | |
129 | (progn | |
dc6d9681 JB |
130 | (setq default-minibuffer-frame |
131 | (new-frame | |
132 | (append initial-frame-alist | |
ec558adc | 133 | default-frame-alist |
dc6d9681 | 134 | (frame-parameters frame-initial-frame)))) |
ec558adc JB |
135 | |
136 | ;; Redirect events enqueued at this frame to the new frame. | |
137 | ;; Is this a good idea? | |
138 | (redirect-frame-focus frame-initial-frame | |
139 | default-minibuffer-frame) | |
140 | ||
dc6d9681 JB |
141 | (delete-frame frame-initial-frame)) |
142 | (modify-frame-parameters frame-initial-frame | |
ec558adc JB |
143 | (append initial-frame-alist |
144 | default-frame-alist))))) | |
64c669bc | 145 | |
dc6d9681 JB |
146 | ;; Make sure the initial frame can be GC'd if it is ever deleted. |
147 | (makunbound 'frame-initial-frame)) | |
64c669bc JB |
148 | |
149 | \f | |
dc6d9681 JB |
150 | ;;;; Creation of additional frames |
151 | ||
152 | ;;; Return some frame other than the current frame, | |
153 | ;;; creating one if neccessary. Note that the minibuffer frame, if | |
154 | ;;; separate, is not considered (see next-frame). | |
7253d8e0 | 155 | (defun get-other-frame () |
dc6d9681 JB |
156 | (let ((s (if (equal (next-frame (selected-frame)) (selected-frame)) |
157 | (new-frame) | |
158 | (next-frame (selected-frame))))) | |
64c669bc JB |
159 | s)) |
160 | ||
dc6d9681 JB |
161 | (defun next-multiframe-window () |
162 | "Select the next window, regardless of which frame it is on." | |
64c669bc JB |
163 | (interactive) |
164 | (select-window (next-window (selected-window) | |
165 | (> (minibuffer-depth) 0) | |
166 | t))) | |
167 | ||
dc6d9681 JB |
168 | (defun previous-multiframe-window () |
169 | "Select the previous window, regardless of which frame it is on." | |
64c669bc JB |
170 | (interactive) |
171 | (select-window (previous-window (selected-window) | |
172 | (> (minibuffer-depth) 0) | |
173 | t))) | |
174 | ||
dc6d9681 JB |
175 | (defun new-frame (&optional parameters) |
176 | "Create a new frame, displaying the current buffer. | |
bc93c097 | 177 | |
43a2e52c | 178 | Optional argument PARAMETERS is an alist of parameters for the new |
dc6d9681 | 179 | frame. Specifically, PARAMETERS is a list of pairs, each having one |
43a2e52c JB |
180 | of the following forms: |
181 | ||
dc6d9681 | 182 | (name . STRING) - The frame should be named STRING. |
43a2e52c | 183 | |
dc6d9681 | 184 | (height . NUMBER) - The frame should be NUMBER text lines high. If |
43a2e52c JB |
185 | this parameter is present, the width parameter must also be |
186 | given. | |
187 | ||
dc6d9681 | 188 | (width . NUMBER) - The frame should be NUMBER characters in width. |
43a2e52c JB |
189 | If this parameter is present, the height parameter must also |
190 | be given. | |
191 | ||
dc6d9681 JB |
192 | (minibuffer . t) - the frame should have a minibuffer |
193 | (minibuffer . none) - the frame should have no minibuffer | |
194 | (minibuffer . only) - the frame should contain only a minibuffer | |
195 | (minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window. | |
43a2e52c JB |
196 | |
197 | (NAME . VALUE), specifying the parameter and the value it should have. | |
198 | NAME should be one of the following symbols: | |
199 | name VALUE | |
200 | ||
dc6d9681 JB |
201 | The documentation for the function x-create-frame describes |
202 | additional frame parameters that Emacs will recognize when running | |
43a2e52c | 203 | under the X Window System." |
64c669bc | 204 | (interactive) |
dc6d9681 | 205 | (funcall frame-creation-function parameters)) |
64c669bc JB |
206 | |
207 | \f | |
dc6d9681 JB |
208 | ;;;; Frame configurations |
209 | ||
210 | (defun current-frame-configuration () | |
211 | "Return a list describing the positions and states of all frames. | |
212 | Each element is a list of the form (FRAME ALIST WINDOW-CONFIG), where | |
213 | FRAME is a frame object, ALIST is an association list specifying | |
214 | some of FRAME's parameters, and WINDOW-CONFIG is a window | |
215 | configuration object for FRAME." | |
06b1a5ef | 216 | (mapcar (function |
dc6d9681 JB |
217 | (lambda (frame) |
218 | (list frame | |
219 | (frame-parameters frame) | |
220 | (current-window-configuration frame)))) | |
221 | (frame-list))) | |
222 | ||
223 | (defun set-frame-configuration (configuration) | |
224 | "Restore the frames to the state described by CONFIGURATION. | |
225 | Each frame listed in CONFIGURATION has its position, size, window | |
06b1a5ef | 226 | configuration, and other parameters set as specified in CONFIGURATION." |
dc6d9681 | 227 | (let (frames-to-delete) |
06b1a5ef | 228 | (mapcar (function |
dc6d9681 JB |
229 | (lambda (frame) |
230 | (let ((parameters (assq frame configuration))) | |
06b1a5ef JB |
231 | (if parameters |
232 | (progn | |
dc6d9681 | 233 | (modify-frame-parameters frame (nth 1 parameters)) |
06b1a5ef | 234 | (set-window-configuration (nth 2 parameters))) |
dc6d9681 JB |
235 | (setq frames-to-delete (cons frame frames-to-delete)))))) |
236 | (frame-list)) | |
237 | (mapcar 'delete-frame frames-to-delete))) | |
64c669bc JB |
238 | |
239 | \f | |
dc6d9681 JB |
240 | ;;;; Convenience functions for accessing and interactively changing |
241 | ;;;; frame parameters. | |
64c669bc | 242 | |
151bdc83 | 243 | (defun frame-height (&optional frame) |
dc6d9681 JB |
244 | "Return number of lines available for display on FRAME. |
245 | If FRAME is omitted, describe the currently selected frame." | |
151bdc83 | 246 | (cdr (assq 'height (frame-parameters frame)))) |
dc6d9681 JB |
247 | |
248 | (defun frame-width (&optional frame) | |
249 | "Return number of columns available for display on FRAME. | |
250 | If FRAME is omitted, describe the currently selected frame." | |
151bdc83 | 251 | (cdr (assq 'width (frame-parameters frame)))) |
dc6d9681 | 252 | |
64c669bc JB |
253 | (defun set-default-font (font-name) |
254 | (interactive "sFont name: ") | |
dc6d9681 | 255 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
256 | (list (cons 'font font-name)))) |
257 | ||
dc6d9681 | 258 | (defun set-frame-background (color-name) |
64c669bc | 259 | (interactive "sColor: ") |
dc6d9681 | 260 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
261 | (list (cons 'background-color color-name)))) |
262 | ||
dc6d9681 | 263 | (defun set-frame-foreground (color-name) |
64c669bc | 264 | (interactive "sColor: ") |
dc6d9681 | 265 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
266 | (list (cons 'foreground-color color-name)))) |
267 | ||
268 | (defun set-cursor-color (color-name) | |
269 | (interactive "sColor: ") | |
dc6d9681 | 270 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
271 | (list (cons 'cursor-color color-name)))) |
272 | ||
273 | (defun set-pointer-color (color-name) | |
274 | (interactive "sColor: ") | |
dc6d9681 | 275 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
276 | (list (cons 'mouse-color color-name)))) |
277 | ||
278 | (defun set-auto-raise (toggle) | |
279 | (interactive "xt or nil? ") | |
dc6d9681 | 280 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
281 | (list (cons 'auto-raise toggle)))) |
282 | ||
283 | (defun set-auto-lower (toggle) | |
284 | (interactive "xt or nil? ") | |
dc6d9681 | 285 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
286 | (list (cons 'auto-lower toggle)))) |
287 | ||
288 | (defun set-vertical-bar (toggle) | |
289 | (interactive "xt or nil? ") | |
dc6d9681 | 290 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
291 | (list (cons 'vertical-scroll-bar toggle)))) |
292 | ||
293 | (defun set-horizontal-bar (toggle) | |
294 | (interactive "xt or nil? ") | |
dc6d9681 | 295 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
296 | (list (cons 'horizontal-scroll-bar toggle)))) |
297 | \f | |
dc6d9681 JB |
298 | ;;;; Aliases for backward compatibility with Emacs 18. |
299 | (fset 'screen-height 'frame-height) | |
300 | (fset 'screen-width 'frame-width) | |
9e2b097b JB |
301 | |
302 | (defun set-screen-width (cols &optional pretend) | |
303 | "Obsolete function to change the size of the screen to COLS columns.\n\ | |
304 | Optional second arg non-nil means that redisplay should use COLS columns\n\ | |
305 | but that the idea of the actual width of the frame should not be changed.\n\ | |
306 | This function is provided only for compatibility with Emacs 18; new code\n\ | |
fe668515 | 307 | should use `set-frame-width instead'." |
9e2b097b JB |
308 | (set-frame-width (selected-frame) cols pretend)) |
309 | ||
310 | (defun set-screen-height (lines &optional pretend) | |
311 | "Obsolete function to change the height of the screen to LINES lines.\n\ | |
312 | Optional second arg non-nil means that redisplay should use LINES lines\n\ | |
313 | but that the idea of the actual height of the screen should not be changed.\n\ | |
314 | This function is provided only for compatibility with Emacs 18; new code\n\ | |
fe668515 | 315 | should use `set-frame-width' instead." |
9e2b097b JB |
316 | (set-frame-height (selected-frame) lines pretend)) |
317 | ||
318 | (make-obsolete 'screen-height 'frame-height) | |
319 | (make-obsolete 'screen-width 'frame-width) | |
320 | (make-obsolete 'set-screen-width 'set-frame-width) | |
321 | (make-obsolete 'set-screen-height 'set-frame-height) | |
dc6d9681 JB |
322 | |
323 | \f | |
64c669bc | 324 | ;;;; Key bindings |
daa37602 | 325 | (defvar ctl-x-5-map (make-sparse-keymap) |
dc6d9681 | 326 | "Keymap for frame commands.") |
daa37602 JB |
327 | (fset 'ctl-x-5-prefix ctl-x-5-map) |
328 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) | |
64c669bc | 329 | |
dc6d9681 JB |
330 | (define-key ctl-x-5-map "2" 'new-frame) |
331 | (define-key ctl-x-5-map "0" 'delete-frame) | |
49116ac0 | 332 | |
dc6d9681 | 333 | (provide 'frame) |
c88ab9ce | 334 | |
dc6d9681 | 335 | ;;; frame.el ends here |