Commit | Line | Data |
---|---|---|
dc6d9681 | 1 | ;;; frame.el --- multi-frame management independent of window systems. |
c88ab9ce | 2 | |
fc68affa ER |
3 | ;; Maintainer: FSF |
4 | ;; Last-Modified: 09 Jul 92 | |
5 | ||
49116ac0 | 6 | ;;;; Copyright (C) 1990, 1992 Free Software Foundation, Inc. |
64c669bc JB |
7 | |
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. | |
34 | (defvar initial-frame-alist '((minibuffer . nil)) | |
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 JB |
115 | (defun frame-notice-user-settings () |
116 | (if frame-initial-frame | |
64c669bc JB |
117 | (progn |
118 | ||
dc6d9681 | 119 | ;; If the user wants a minibuffer-only frame, we'll have to |
64c669bc | 120 | ;; make a new one; you can't remove or add a root window to/from |
dc6d9681 JB |
121 | ;; an existing frame. |
122 | (if (eq (cdr (or (assq 'minibuffer initial-frame-alist) | |
64c669bc JB |
123 | '(minibuffer . t))) |
124 | 'only) | |
125 | (progn | |
dc6d9681 JB |
126 | (setq default-minibuffer-frame |
127 | (new-frame | |
128 | (append initial-frame-alist | |
129 | (frame-parameters frame-initial-frame)))) | |
130 | (delete-frame frame-initial-frame)) | |
131 | (modify-frame-parameters frame-initial-frame | |
132 | initial-frame-alist)))) | |
64c669bc | 133 | |
dc6d9681 JB |
134 | ;; Make sure the initial frame can be GC'd if it is ever deleted. |
135 | (makunbound 'frame-initial-frame)) | |
64c669bc JB |
136 | |
137 | \f | |
dc6d9681 JB |
138 | ;;;; Creation of additional frames |
139 | ||
140 | ;;; Return some frame other than the current frame, | |
141 | ;;; creating one if neccessary. Note that the minibuffer frame, if | |
142 | ;;; separate, is not considered (see next-frame). | |
143 | (defun get-frame () | |
144 | (let ((s (if (equal (next-frame (selected-frame)) (selected-frame)) | |
145 | (new-frame) | |
146 | (next-frame (selected-frame))))) | |
64c669bc JB |
147 | s)) |
148 | ||
dc6d9681 JB |
149 | (defun next-multiframe-window () |
150 | "Select the next window, regardless of which frame it is on." | |
64c669bc JB |
151 | (interactive) |
152 | (select-window (next-window (selected-window) | |
153 | (> (minibuffer-depth) 0) | |
154 | t))) | |
155 | ||
dc6d9681 JB |
156 | (defun previous-multiframe-window () |
157 | "Select the previous window, regardless of which frame it is on." | |
64c669bc JB |
158 | (interactive) |
159 | (select-window (previous-window (selected-window) | |
160 | (> (minibuffer-depth) 0) | |
161 | t))) | |
162 | ||
dc6d9681 JB |
163 | (defun new-frame (&optional parameters) |
164 | "Create a new frame, displaying the current buffer. | |
bc93c097 | 165 | |
43a2e52c | 166 | Optional argument PARAMETERS is an alist of parameters for the new |
dc6d9681 | 167 | frame. Specifically, PARAMETERS is a list of pairs, each having one |
43a2e52c JB |
168 | of the following forms: |
169 | ||
dc6d9681 | 170 | (name . STRING) - The frame should be named STRING. |
43a2e52c | 171 | |
dc6d9681 | 172 | (height . NUMBER) - The frame should be NUMBER text lines high. If |
43a2e52c JB |
173 | this parameter is present, the width parameter must also be |
174 | given. | |
175 | ||
dc6d9681 | 176 | (width . NUMBER) - The frame should be NUMBER characters in width. |
43a2e52c JB |
177 | If this parameter is present, the height parameter must also |
178 | be given. | |
179 | ||
dc6d9681 JB |
180 | (minibuffer . t) - the frame should have a minibuffer |
181 | (minibuffer . none) - the frame should have no minibuffer | |
182 | (minibuffer . only) - the frame should contain only a minibuffer | |
183 | (minibuffer . WINDOW) - the frame should use WINDOW as its minibuffer window. | |
43a2e52c JB |
184 | |
185 | (NAME . VALUE), specifying the parameter and the value it should have. | |
186 | NAME should be one of the following symbols: | |
187 | name VALUE | |
188 | ||
dc6d9681 JB |
189 | The documentation for the function x-create-frame describes |
190 | additional frame parameters that Emacs will recognize when running | |
43a2e52c | 191 | under the X Window System." |
64c669bc | 192 | (interactive) |
dc6d9681 | 193 | (funcall frame-creation-function parameters)) |
64c669bc JB |
194 | |
195 | \f | |
196 | ;;;; Iconification | |
197 | ||
198 | ;;; A possible enhancement for the below: if you iconify a surrogate | |
dc6d9681 JB |
199 | ;;; minibuffer frame, iconify all of its minibuffer's users too; |
200 | ;;; de-iconify them as a group. This will need to wait until frames | |
64c669bc JB |
201 | ;;; have mapping and unmapping hooks. |
202 | ||
203 | (defun iconify () | |
dc6d9681 | 204 | "Iconify or deiconify the selected frame." |
64c669bc | 205 | (interactive) |
dc6d9681 JB |
206 | (let ((frame (selected-frame))) |
207 | (if (eq (frame-visible-p frame) t) | |
208 | (iconify-frame frame) | |
209 | (make-frame-visible frame)))) | |
06b1a5ef JB |
210 | |
211 | \f | |
dc6d9681 JB |
212 | ;;;; Frame configurations |
213 | ||
214 | (defun current-frame-configuration () | |
215 | "Return a list describing the positions and states of all frames. | |
216 | Each element is a list of the form (FRAME ALIST WINDOW-CONFIG), where | |
217 | FRAME is a frame object, ALIST is an association list specifying | |
218 | some of FRAME's parameters, and WINDOW-CONFIG is a window | |
219 | configuration object for FRAME." | |
06b1a5ef | 220 | (mapcar (function |
dc6d9681 JB |
221 | (lambda (frame) |
222 | (list frame | |
223 | (frame-parameters frame) | |
224 | (current-window-configuration frame)))) | |
225 | (frame-list))) | |
226 | ||
227 | (defun set-frame-configuration (configuration) | |
228 | "Restore the frames to the state described by CONFIGURATION. | |
229 | Each frame listed in CONFIGURATION has its position, size, window | |
06b1a5ef | 230 | configuration, and other parameters set as specified in CONFIGURATION." |
dc6d9681 | 231 | (let (frames-to-delete) |
06b1a5ef | 232 | (mapcar (function |
dc6d9681 JB |
233 | (lambda (frame) |
234 | (let ((parameters (assq frame configuration))) | |
06b1a5ef JB |
235 | (if parameters |
236 | (progn | |
dc6d9681 | 237 | (modify-frame-parameters frame (nth 1 parameters)) |
06b1a5ef | 238 | (set-window-configuration (nth 2 parameters))) |
dc6d9681 JB |
239 | (setq frames-to-delete (cons frame frames-to-delete)))))) |
240 | (frame-list)) | |
241 | (mapcar 'delete-frame frames-to-delete))) | |
64c669bc JB |
242 | |
243 | \f | |
dc6d9681 JB |
244 | ;;;; Convenience functions for accessing and interactively changing |
245 | ;;;; frame parameters. | |
64c669bc | 246 | |
dc6d9681 JB |
247 | (defun frame-width (&optional frame) |
248 | "Return number of lines available for display on FRAME. | |
249 | If FRAME is omitted, describe the currently selected frame." | |
250 | (cdr (assq 'width (frame-parameters frame)))) | |
251 | ||
252 | (defun frame-width (&optional frame) | |
253 | "Return number of columns available for display on FRAME. | |
254 | If FRAME is omitted, describe the currently selected frame." | |
255 | (cdr (assq 'height (frame-parameters frame)))) | |
256 | ||
257 | (defun set-frame-height (h) | |
64c669bc | 258 | (interactive "NHeight: ") |
dc6d9681 JB |
259 | (let* ((frame (selected-frame)) |
260 | (width (cdr (assoc 'width (frame-parameters (selected-frame)))))) | |
261 | (set-frame-size (selected-frame) width h))) | |
64c669bc | 262 | |
dc6d9681 | 263 | (defun set-frame-width (w) |
64c669bc | 264 | (interactive "NWidth: ") |
dc6d9681 JB |
265 | (let* ((frame (selected-frame)) |
266 | (height (cdr (assoc 'height (frame-parameters (selected-frame)))))) | |
267 | (set-frame-size (selected-frame) w height))) | |
64c669bc JB |
268 | |
269 | (defun set-default-font (font-name) | |
270 | (interactive "sFont name: ") | |
dc6d9681 | 271 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
272 | (list (cons 'font font-name)))) |
273 | ||
dc6d9681 | 274 | (defun set-frame-background (color-name) |
64c669bc | 275 | (interactive "sColor: ") |
dc6d9681 | 276 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
277 | (list (cons 'background-color color-name)))) |
278 | ||
dc6d9681 | 279 | (defun set-frame-foreground (color-name) |
64c669bc | 280 | (interactive "sColor: ") |
dc6d9681 | 281 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
282 | (list (cons 'foreground-color color-name)))) |
283 | ||
284 | (defun set-cursor-color (color-name) | |
285 | (interactive "sColor: ") | |
dc6d9681 | 286 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
287 | (list (cons 'cursor-color color-name)))) |
288 | ||
289 | (defun set-pointer-color (color-name) | |
290 | (interactive "sColor: ") | |
dc6d9681 | 291 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
292 | (list (cons 'mouse-color color-name)))) |
293 | ||
294 | (defun set-auto-raise (toggle) | |
295 | (interactive "xt or nil? ") | |
dc6d9681 | 296 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
297 | (list (cons 'auto-raise toggle)))) |
298 | ||
299 | (defun set-auto-lower (toggle) | |
300 | (interactive "xt or nil? ") | |
dc6d9681 | 301 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
302 | (list (cons 'auto-lower toggle)))) |
303 | ||
304 | (defun set-vertical-bar (toggle) | |
305 | (interactive "xt or nil? ") | |
dc6d9681 | 306 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
307 | (list (cons 'vertical-scroll-bar toggle)))) |
308 | ||
309 | (defun set-horizontal-bar (toggle) | |
310 | (interactive "xt or nil? ") | |
dc6d9681 | 311 | (modify-frame-parameters (selected-frame) |
64c669bc JB |
312 | (list (cons 'horizontal-scroll-bar toggle)))) |
313 | \f | |
dc6d9681 JB |
314 | ;;;; Aliases for backward compatibility with Emacs 18. |
315 | (fset 'screen-height 'frame-height) | |
316 | (fset 'screen-width 'frame-width) | |
317 | (fset 'set-screen-width 'set-frame-width) | |
318 | (fset 'set-screen-height 'set-frame-height) | |
319 | ||
320 | \f | |
64c669bc | 321 | ;;;; Key bindings |
daa37602 | 322 | (defvar ctl-x-5-map (make-sparse-keymap) |
dc6d9681 | 323 | "Keymap for frame commands.") |
daa37602 JB |
324 | (fset 'ctl-x-5-prefix ctl-x-5-map) |
325 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) | |
64c669bc | 326 | |
dc6d9681 JB |
327 | (define-key ctl-x-5-map "2" 'new-frame) |
328 | (define-key ctl-x-5-map "0" 'delete-frame) | |
49116ac0 | 329 | |
dc6d9681 | 330 | (provide 'frame) |
c88ab9ce | 331 | |
dc6d9681 | 332 | ;;; frame.el ends here |