| 1 | ;;; frame.el --- multi-frame management independent of window systems |
| 2 | |
| 3 | ;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2002, 2003, |
| 4 | ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
| 5 | |
| 6 | ;; Maintainer: FSF |
| 7 | ;; Keywords: internal |
| 8 | |
| 9 | ;; This file is part of GNU Emacs. |
| 10 | |
| 11 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
| 12 | ;; it under the terms of the GNU General Public License as published by |
| 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
| 14 | ;; any later version. |
| 15 | |
| 16 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | ;; GNU General Public License for more details. |
| 20 | |
| 21 | ;; You should have received a copy of the GNU General Public License |
| 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| 24 | ;; Boston, MA 02110-1301, USA. |
| 25 | |
| 26 | ;;; Commentary: |
| 27 | |
| 28 | ;;; Code: |
| 29 | |
| 30 | (defvar frame-creation-function nil |
| 31 | "Window-system dependent function to call to create a new frame. |
| 32 | The window system startup file should set this to its frame creation |
| 33 | function, which should take an alist of parameters as its argument.") |
| 34 | |
| 35 | ;; The initial value given here used to ask for a minibuffer. |
| 36 | ;; But that's not necessary, because the default is to have one. |
| 37 | ;; By not specifying it here, we let an X resource specify it. |
| 38 | (defcustom initial-frame-alist nil |
| 39 | "*Alist of frame parameters for creating the initial X window frame. |
| 40 | You can set this in your `.emacs' file; for example, |
| 41 | (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55))) |
| 42 | Parameters specified here supersede the values given in `default-frame-alist'. |
| 43 | |
| 44 | If the value calls for a frame without a minibuffer, and you have not created |
| 45 | a minibuffer frame on your own, one is created according to |
| 46 | `minibuffer-frame-alist'. |
| 47 | |
| 48 | You can specify geometry-related options for just the initial frame |
| 49 | by setting this variable in your `.emacs' file; however, they won't |
| 50 | take effect until Emacs reads `.emacs', which happens after first creating |
| 51 | the frame. If you want the frame to have the proper geometry as soon |
| 52 | as it appears, you need to use this three-step process: |
| 53 | * Specify X resources to give the geometry you want. |
| 54 | * Set `default-frame-alist' to override these options so that they |
| 55 | don't affect subsequent frames. |
| 56 | * Set `initial-frame-alist' in a way that matches the X resources, |
| 57 | to override what you put in `default-frame-alist'." |
| 58 | :type '(repeat (cons :format "%v" |
| 59 | (symbol :tag "Parameter") |
| 60 | (sexp :tag "Value"))) |
| 61 | :group 'frames) |
| 62 | |
| 63 | (defcustom minibuffer-frame-alist '((width . 80) (height . 2)) |
| 64 | "*Alist of frame parameters for initially creating a minibuffer frame. |
| 65 | You can set this in your `.emacs' file; for example, |
| 66 | (setq minibuffer-frame-alist |
| 67 | '((top . 1) (left . 1) (width . 80) (height . 2))) |
| 68 | Parameters specified here supersede the values given in |
| 69 | `default-frame-alist', for a minibuffer frame." |
| 70 | :type '(repeat (cons :format "%v" |
| 71 | (symbol :tag "Parameter") |
| 72 | (sexp :tag "Value"))) |
| 73 | :group 'frames) |
| 74 | |
| 75 | (defcustom pop-up-frame-alist nil |
| 76 | "*Alist of frame parameters used when creating pop-up frames. |
| 77 | Pop-up frames are used for completions, help, and the like. |
| 78 | This variable can be set in your init file, like this: |
| 79 | (setq pop-up-frame-alist '((width . 80) (height . 20))) |
| 80 | These supersede the values given in `default-frame-alist', |
| 81 | for pop-up frames." |
| 82 | :type '(repeat (cons :format "%v" |
| 83 | (symbol :tag "Parameter") |
| 84 | (sexp :tag "Value"))) |
| 85 | :group 'frames) |
| 86 | |
| 87 | (setq pop-up-frame-function |
| 88 | ;; Using `function' here caused some sort of problem. |
| 89 | '(lambda () |
| 90 | (make-frame pop-up-frame-alist))) |
| 91 | |
| 92 | (defcustom special-display-frame-alist |
| 93 | '((height . 14) (width . 80) (unsplittable . t)) |
| 94 | "*Alist of frame parameters used when creating special frames. |
| 95 | Special frames are used for buffers whose names are in |
| 96 | `special-display-buffer-names' and for buffers whose names match |
| 97 | one of the regular expressions in `special-display-regexps'. |
| 98 | This variable can be set in your init file, like this: |
| 99 | (setq special-display-frame-alist '((width . 80) (height . 20))) |
| 100 | These supersede the values given in `default-frame-alist'." |
| 101 | :type '(repeat (cons :format "%v" |
| 102 | (symbol :tag "Parameter") |
| 103 | (sexp :tag "Value"))) |
| 104 | :group 'frames) |
| 105 | |
| 106 | (defun special-display-popup-frame (buffer &optional args) |
| 107 | "Display BUFFER in its own frame, reusing an existing window if any. |
| 108 | Return the window chosen. |
| 109 | Currently we do not insist on selecting the window within its frame. |
| 110 | If ARGS is an alist, use it as a list of frame parameter specs. |
| 111 | If ARGS is a list whose car is a symbol, |
| 112 | use (car ARGS) as a function to do the work. |
| 113 | Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args." |
| 114 | (if (and args (symbolp (car args))) |
| 115 | (apply (car args) buffer (cdr args)) |
| 116 | (let ((window (get-buffer-window buffer 0))) |
| 117 | (or |
| 118 | ;; If we have a window already, make it visible. |
| 119 | (when window |
| 120 | (let ((frame (window-frame window))) |
| 121 | (make-frame-visible frame) |
| 122 | (raise-frame frame) |
| 123 | window)) |
| 124 | ;; Reuse the current window if the user requested it. |
| 125 | (when (cdr (assq 'same-window args)) |
| 126 | (condition-case nil |
| 127 | (progn (switch-to-buffer buffer) (selected-window)) |
| 128 | (error nil))) |
| 129 | ;; Stay on the same frame if requested. |
| 130 | (when (or (cdr (assq 'same-frame args)) (cdr (assq 'same-window args))) |
| 131 | (let* ((pop-up-frames nil) (pop-up-windows t) |
| 132 | special-display-regexps special-display-buffer-names |
| 133 | (window (display-buffer buffer))) |
| 134 | ;; Only do it if this is a new window: |
| 135 | ;; (set-window-dedicated-p window t) |
| 136 | window)) |
| 137 | ;; If no window yet, make one in a new frame. |
| 138 | (let ((frame |
| 139 | (with-current-buffer buffer |
| 140 | (make-frame (append args special-display-frame-alist))))) |
| 141 | (set-window-buffer (frame-selected-window frame) buffer) |
| 142 | (set-window-dedicated-p (frame-selected-window frame) t) |
| 143 | (frame-selected-window frame)))))) |
| 144 | |
| 145 | (defun handle-delete-frame (event) |
| 146 | "Handle delete-frame events from the X server." |
| 147 | (interactive "e") |
| 148 | (let ((frame (posn-window (event-start event))) |
| 149 | (i 0) |
| 150 | (tail (frame-list))) |
| 151 | (while tail |
| 152 | (and (frame-visible-p (car tail)) |
| 153 | (not (eq (car tail) frame)) |
| 154 | (setq i (1+ i))) |
| 155 | (setq tail (cdr tail))) |
| 156 | (if (> i 0) |
| 157 | (delete-frame frame t) |
| 158 | ;; Gildea@x.org says it is ok to ask questions before terminating. |
| 159 | (save-buffers-kill-emacs)))) |
| 160 | \f |
| 161 | ;;;; Arrangement of frames at startup |
| 162 | |
| 163 | ;; 1) Load the window system startup file from the lisp library and read the |
| 164 | ;; high-priority arguments (-q and the like). The window system startup |
| 165 | ;; file should create any frames specified in the window system defaults. |
| 166 | ;; |
| 167 | ;; 2) If no frames have been opened, we open an initial text frame. |
| 168 | ;; |
| 169 | ;; 3) Once the init file is done, we apply any newly set parameters |
| 170 | ;; in initial-frame-alist to the frame. |
| 171 | |
| 172 | ;; These are now called explicitly at the proper times, |
| 173 | ;; since that is easier to understand. |
| 174 | ;; Actually using hooks within Emacs is bad for future maintenance. --rms. |
| 175 | ;; (add-hook 'before-init-hook 'frame-initialize) |
| 176 | ;; (add-hook 'window-setup-hook 'frame-notice-user-settings) |
| 177 | |
| 178 | ;; If we create the initial frame, this is it. |
| 179 | (defvar frame-initial-frame nil) |
| 180 | |
| 181 | ;; Record the parameters used in frame-initialize to make the initial frame. |
| 182 | (defvar frame-initial-frame-alist) |
| 183 | |
| 184 | (defvar frame-initial-geometry-arguments nil) |
| 185 | |
| 186 | ;; startup.el calls this function before loading the user's init |
| 187 | ;; file - if there is no frame with a minibuffer open now, create |
| 188 | ;; one to display messages while loading the init file. |
| 189 | (defun frame-initialize () |
| 190 | "Create an initial frame if necessary." |
| 191 | ;; Are we actually running under a window system at all? |
| 192 | (if (and window-system (not noninteractive) (not (eq window-system 'pc))) |
| 193 | (progn |
| 194 | ;; Turn on special-display processing only if there's a window system. |
| 195 | (setq special-display-function 'special-display-popup-frame) |
| 196 | |
| 197 | ;; If there is no frame with a minibuffer besides the terminal |
| 198 | ;; frame, then we need to create the opening frame. Make sure |
| 199 | ;; it has a minibuffer, but let initial-frame-alist omit the |
| 200 | ;; minibuffer spec. |
| 201 | (or (delq terminal-frame (minibuffer-frame-list)) |
| 202 | (progn |
| 203 | (setq frame-initial-frame-alist |
| 204 | (append initial-frame-alist default-frame-alist nil)) |
| 205 | (or (assq 'horizontal-scroll-bars frame-initial-frame-alist) |
| 206 | (setq frame-initial-frame-alist |
| 207 | (cons '(horizontal-scroll-bars . t) |
| 208 | frame-initial-frame-alist))) |
| 209 | (setq default-minibuffer-frame |
| 210 | (setq frame-initial-frame |
| 211 | (make-frame frame-initial-frame-alist))) |
| 212 | ;; Delete any specifications for window geometry parameters |
| 213 | ;; so that we won't reapply them in frame-notice-user-settings. |
| 214 | ;; It would be wrong to reapply them then, |
| 215 | ;; because that would override explicit user resizing. |
| 216 | (setq initial-frame-alist |
| 217 | (frame-remove-geometry-params initial-frame-alist)))) |
| 218 | ;; At this point, we know that we have a frame open, so we |
| 219 | ;; can delete the terminal frame. |
| 220 | (delete-frame terminal-frame) |
| 221 | (setq terminal-frame nil)) |
| 222 | |
| 223 | ;; No, we're not running a window system. Use make-terminal-frame if |
| 224 | ;; we support that feature, otherwise arrange to cause errors. |
| 225 | (or (eq window-system 'pc) |
| 226 | (setq frame-creation-function |
| 227 | (if (fboundp 'tty-create-frame-with-faces) |
| 228 | 'tty-create-frame-with-faces |
| 229 | (function |
| 230 | (lambda (parameters) |
| 231 | (error |
| 232 | "Can't create multiple frames without a window system")))))))) |
| 233 | |
| 234 | (defvar frame-notice-user-settings t |
| 235 | "Non-nil means function `frame-notice-user-settings' wasn't run yet.") |
| 236 | |
| 237 | ;; startup.el calls this function after loading the user's init |
| 238 | ;; file. Now default-frame-alist and initial-frame-alist contain |
| 239 | ;; information to which we must react; do what needs to be done. |
| 240 | (defun frame-notice-user-settings () |
| 241 | "Act on user's init file settings of frame parameters. |
| 242 | React to settings of `default-frame-alist', `initial-frame-alist' there." |
| 243 | ;; Make menu-bar-mode and default-frame-alist consistent. |
| 244 | (when (boundp 'menu-bar-mode) |
| 245 | (let ((default (assq 'menu-bar-lines default-frame-alist))) |
| 246 | (if default |
| 247 | (setq menu-bar-mode (not (eq (cdr default) 0))) |
| 248 | (setq default-frame-alist |
| 249 | (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0)) |
| 250 | default-frame-alist))))) |
| 251 | |
| 252 | ;; Make tool-bar-mode and default-frame-alist consistent. Don't do |
| 253 | ;; it in batch mode since that would leave a tool-bar-lines |
| 254 | ;; parameter in default-frame-alist in a dumped Emacs, which is not |
| 255 | ;; what we want. |
| 256 | (when (and (boundp 'tool-bar-mode) |
| 257 | (not noninteractive)) |
| 258 | (let ((default (assq 'tool-bar-lines default-frame-alist))) |
| 259 | (if default |
| 260 | (setq tool-bar-mode (not (eq (cdr default) 0))) |
| 261 | (setq default-frame-alist |
| 262 | (cons (cons 'tool-bar-lines (if tool-bar-mode 1 0)) |
| 263 | default-frame-alist))))) |
| 264 | |
| 265 | ;; Creating and deleting frames may shift the selected frame around, |
| 266 | ;; and thus the current buffer. Protect against that. We don't |
| 267 | ;; want to use save-excursion here, because that may also try to set |
| 268 | ;; the buffer of the selected window, which fails when the selected |
| 269 | ;; window is the minibuffer. |
| 270 | (let ((old-buffer (current-buffer))) |
| 271 | |
| 272 | (when (and frame-notice-user-settings |
| 273 | (null frame-initial-frame)) |
| 274 | ;; This case happens when we don't have a window system, and |
| 275 | ;; also for MS-DOS frames. |
| 276 | (let ((parms (frame-parameters frame-initial-frame))) |
| 277 | ;; Don't change the frame names. |
| 278 | (setq parms (delq (assq 'name parms) parms)) |
| 279 | ;; Can't modify the minibuffer parameter, so don't try. |
| 280 | (setq parms (delq (assq 'minibuffer parms) parms)) |
| 281 | (modify-frame-parameters nil |
| 282 | (if (null window-system) |
| 283 | (append initial-frame-alist |
| 284 | default-frame-alist |
| 285 | parms |
| 286 | nil) |
| 287 | ;; initial-frame-alist and |
| 288 | ;; default-frame-alist were already |
| 289 | ;; applied in pc-win.el. |
| 290 | parms)) |
| 291 | (if (null window-system) ;; MS-DOS does this differently in pc-win.el |
| 292 | (let ((newparms (frame-parameters)) |
| 293 | (frame (selected-frame))) |
| 294 | (tty-handle-reverse-video frame newparms) |
| 295 | ;; If we changed the background color, we need to update |
| 296 | ;; the background-mode parameter, and maybe some faces, |
| 297 | ;; too. |
| 298 | (when (assq 'background-color newparms) |
| 299 | (unless (or (assq 'background-mode initial-frame-alist) |
| 300 | (assq 'background-mode default-frame-alist)) |
| 301 | (frame-set-background-mode frame)) |
| 302 | (face-set-after-frame-default frame)))))) |
| 303 | |
| 304 | ;; If the initial frame is still around, apply initial-frame-alist |
| 305 | ;; and default-frame-alist to it. |
| 306 | (when (frame-live-p frame-initial-frame) |
| 307 | |
| 308 | ;; When tool-bar has been switched off, correct the frame size |
| 309 | ;; by the lines added in x-create-frame for the tool-bar and |
| 310 | ;; switch `tool-bar-mode' off. |
| 311 | (when (display-graphic-p) |
| 312 | (let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist) |
| 313 | (assq 'tool-bar-lines default-frame-alist)))) |
| 314 | (when (and tool-bar-originally-present |
| 315 | (or (null tool-bar-lines) |
| 316 | (null (cdr tool-bar-lines)) |
| 317 | (eq 0 (cdr tool-bar-lines)))) |
| 318 | (let* ((char-height (frame-char-height frame-initial-frame)) |
| 319 | (image-height tool-bar-images-pixel-height) |
| 320 | (margin (cond ((and (consp tool-bar-button-margin) |
| 321 | (integerp (cdr tool-bar-button-margin)) |
| 322 | (> tool-bar-button-margin 0)) |
| 323 | (cdr tool-bar-button-margin)) |
| 324 | ((and (integerp tool-bar-button-margin) |
| 325 | (> tool-bar-button-margin 0)) |
| 326 | tool-bar-button-margin) |
| 327 | (t 0))) |
| 328 | (relief (if (and (integerp tool-bar-button-relief) |
| 329 | (> tool-bar-button-relief 0)) |
| 330 | tool-bar-button-relief 3)) |
| 331 | (lines (/ (+ image-height |
| 332 | (* 2 margin) |
| 333 | (* 2 relief) |
| 334 | (1- char-height)) |
| 335 | char-height)) |
| 336 | (height (frame-parameter frame-initial-frame 'height)) |
| 337 | (newparms (list (cons 'height (- height lines)))) |
| 338 | (initial-top (cdr (assq 'top |
| 339 | frame-initial-geometry-arguments))) |
| 340 | (top (frame-parameter frame-initial-frame 'top))) |
| 341 | (when (and (consp initial-top) (eq '- (car initial-top))) |
| 342 | (let ((adjusted-top |
| 343 | (cond ((and (consp top) |
| 344 | (eq '+ (car top))) |
| 345 | (list '+ |
| 346 | (+ (cadr top) |
| 347 | (* lines char-height)))) |
| 348 | ((and (consp top) |
| 349 | (eq '- (car top))) |
| 350 | (list '- |
| 351 | (- (cadr top) |
| 352 | (* lines char-height)))) |
| 353 | (t (+ top (* lines char-height)))))) |
| 354 | (setq newparms |
| 355 | (append newparms |
| 356 | `((top . ,adjusted-top)) |
| 357 | nil)))) |
| 358 | (modify-frame-parameters frame-initial-frame newparms) |
| 359 | (tool-bar-mode -1))))) |
| 360 | |
| 361 | ;; The initial frame we create above always has a minibuffer. |
| 362 | ;; If the user wants to remove it, or make it a minibuffer-only |
| 363 | ;; frame, then we'll have to delete the current frame and make a |
| 364 | ;; new one; you can't remove or add a root window to/from an |
| 365 | ;; existing frame. |
| 366 | ;; |
| 367 | ;; NOTE: default-frame-alist was nil when we created the |
| 368 | ;; existing frame. We need to explicitly include |
| 369 | ;; default-frame-alist in the parameters of the screen we |
| 370 | ;; create here, so that its new value, gleaned from the user's |
| 371 | ;; .emacs file, will be applied to the existing screen. |
| 372 | (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist) |
| 373 | (assq 'minibuffer default-frame-alist) |
| 374 | '(minibuffer . t))) |
| 375 | t)) |
| 376 | ;; Create the new frame. |
| 377 | (let (parms new) |
| 378 | ;; If the frame isn't visible yet, wait till it is. |
| 379 | ;; If the user has to position the window, |
| 380 | ;; Emacs doesn't know its real position until |
| 381 | ;; the frame is seen to be visible. |
| 382 | (while (not (cdr (assq 'visibility |
| 383 | (frame-parameters frame-initial-frame)))) |
| 384 | (sleep-for 1)) |
| 385 | (setq parms (frame-parameters frame-initial-frame)) |
| 386 | |
| 387 | ;; Get rid of `name' unless it was specified explicitly before. |
| 388 | (or (assq 'name frame-initial-frame-alist) |
| 389 | (setq parms (delq (assq 'name parms) parms))) |
| 390 | |
| 391 | (setq parms (append initial-frame-alist |
| 392 | default-frame-alist |
| 393 | parms |
| 394 | nil)) |
| 395 | |
| 396 | ;; Get rid of `reverse', because that was handled |
| 397 | ;; when we first made the frame. |
| 398 | (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms))) |
| 399 | |
| 400 | (if (assq 'height frame-initial-geometry-arguments) |
| 401 | (setq parms (assq-delete-all 'height parms))) |
| 402 | (if (assq 'width frame-initial-geometry-arguments) |
| 403 | (setq parms (assq-delete-all 'width parms))) |
| 404 | (if (assq 'left frame-initial-geometry-arguments) |
| 405 | (setq parms (assq-delete-all 'left parms))) |
| 406 | (if (assq 'top frame-initial-geometry-arguments) |
| 407 | (setq parms (assq-delete-all 'top parms))) |
| 408 | (setq new |
| 409 | (make-frame |
| 410 | ;; Use the geometry args that created the existing |
| 411 | ;; frame, rather than the parms we get for it. |
| 412 | (append frame-initial-geometry-arguments |
| 413 | '((user-size . t) (user-position . t)) |
| 414 | parms))) |
| 415 | ;; The initial frame, which we are about to delete, may be |
| 416 | ;; the only frame with a minibuffer. If it is, create a |
| 417 | ;; new one. |
| 418 | (or (delq frame-initial-frame (minibuffer-frame-list)) |
| 419 | (make-initial-minibuffer-frame nil)) |
| 420 | |
| 421 | ;; If the initial frame is serving as a surrogate |
| 422 | ;; minibuffer frame for any frames, we need to wean them |
| 423 | ;; onto a new frame. The default-minibuffer-frame |
| 424 | ;; variable must be handled similarly. |
| 425 | (let ((users-of-initial |
| 426 | (filtered-frame-list |
| 427 | (function (lambda (frame) |
| 428 | (and (not (eq frame frame-initial-frame)) |
| 429 | (eq (window-frame |
| 430 | (minibuffer-window frame)) |
| 431 | frame-initial-frame))))))) |
| 432 | (if (or users-of-initial |
| 433 | (eq default-minibuffer-frame frame-initial-frame)) |
| 434 | |
| 435 | ;; Choose an appropriate frame. Prefer frames which |
| 436 | ;; are only minibuffers. |
| 437 | (let* ((new-surrogate |
| 438 | (car |
| 439 | (or (filtered-frame-list |
| 440 | (function |
| 441 | (lambda (frame) |
| 442 | (eq (cdr (assq 'minibuffer |
| 443 | (frame-parameters frame))) |
| 444 | 'only)))) |
| 445 | (minibuffer-frame-list)))) |
| 446 | (new-minibuffer (minibuffer-window new-surrogate))) |
| 447 | |
| 448 | (if (eq default-minibuffer-frame frame-initial-frame) |
| 449 | (setq default-minibuffer-frame new-surrogate)) |
| 450 | |
| 451 | ;; Wean the frames using frame-initial-frame as |
| 452 | ;; their minibuffer frame. |
| 453 | (mapcar |
| 454 | (function |
| 455 | (lambda (frame) |
| 456 | (modify-frame-parameters |
| 457 | frame (list (cons 'minibuffer new-minibuffer))))) |
| 458 | users-of-initial)))) |
| 459 | |
| 460 | ;; Redirect events enqueued at this frame to the new frame. |
| 461 | ;; Is this a good idea? |
| 462 | (redirect-frame-focus frame-initial-frame new) |
| 463 | |
| 464 | ;; Finally, get rid of the old frame. |
| 465 | (delete-frame frame-initial-frame t)) |
| 466 | |
| 467 | ;; Otherwise, we don't need all that rigamarole; just apply |
| 468 | ;; the new parameters. |
| 469 | (let (newparms allparms tail) |
| 470 | (setq allparms (append initial-frame-alist |
| 471 | default-frame-alist nil)) |
| 472 | (if (assq 'height frame-initial-geometry-arguments) |
| 473 | (setq allparms (assq-delete-all 'height allparms))) |
| 474 | (if (assq 'width frame-initial-geometry-arguments) |
| 475 | (setq allparms (assq-delete-all 'width allparms))) |
| 476 | (if (assq 'left frame-initial-geometry-arguments) |
| 477 | (setq allparms (assq-delete-all 'left allparms))) |
| 478 | (if (assq 'top frame-initial-geometry-arguments) |
| 479 | (setq allparms (assq-delete-all 'top allparms))) |
| 480 | (setq tail allparms) |
| 481 | ;; Find just the parms that have changed since we first |
| 482 | ;; made this frame. Those are the ones actually set by |
| 483 | ;; the init file. For those parms whose values we already knew |
| 484 | ;; (such as those spec'd by command line options) |
| 485 | ;; it is undesirable to specify the parm again |
| 486 | ;; once the user has seen the frame and been able to alter it |
| 487 | ;; manually. |
| 488 | (while tail |
| 489 | (let (newval oldval) |
| 490 | (setq oldval (assq (car (car tail)) |
| 491 | frame-initial-frame-alist)) |
| 492 | (setq newval (cdr (assq (car (car tail)) allparms))) |
| 493 | (or (and oldval (eq (cdr oldval) newval)) |
| 494 | (setq newparms |
| 495 | (cons (cons (car (car tail)) newval) newparms)))) |
| 496 | (setq tail (cdr tail))) |
| 497 | (setq newparms (nreverse newparms)) |
| 498 | (modify-frame-parameters frame-initial-frame |
| 499 | newparms) |
| 500 | ;; If we changed the background color, |
| 501 | ;; we need to update the background-mode parameter |
| 502 | ;; and maybe some faces too. |
| 503 | (when (assq 'background-color newparms) |
| 504 | (unless (assq 'background-mode newparms) |
| 505 | (frame-set-background-mode frame-initial-frame)) |
| 506 | (face-set-after-frame-default frame-initial-frame))))) |
| 507 | |
| 508 | ;; Restore the original buffer. |
| 509 | (set-buffer old-buffer) |
| 510 | |
| 511 | ;; Make sure the initial frame can be GC'd if it is ever deleted. |
| 512 | ;; Make sure frame-notice-user-settings does nothing if called twice. |
| 513 | (setq frame-notice-user-settings nil) |
| 514 | (setq frame-initial-frame nil))) |
| 515 | |
| 516 | (defun make-initial-minibuffer-frame (display) |
| 517 | (let ((parms (append minibuffer-frame-alist '((minibuffer . only))))) |
| 518 | (if display |
| 519 | (make-frame-on-display display parms) |
| 520 | (make-frame parms)))) |
| 521 | |
| 522 | ;;;; Creation of additional frames, and other frame miscellanea |
| 523 | |
| 524 | (defun modify-all-frames-parameters (alist) |
| 525 | "Modify all current and future frames' parameters according to ALIST. |
| 526 | This changes `default-frame-alist' and possibly `initial-frame-alist'. |
| 527 | See help of `modify-frame-parameters' for more information." |
| 528 | (let (element) ;; temp |
| 529 | (dolist (frame (frame-list)) |
| 530 | (modify-frame-parameters frame alist)) |
| 531 | |
| 532 | (dolist (pair alist) ;; conses to add/replace |
| 533 | ;; initial-frame-alist needs setting only when |
| 534 | ;; frame-notice-user-settings is true |
| 535 | (and frame-notice-user-settings |
| 536 | (setq element (assoc (car pair) initial-frame-alist)) |
| 537 | (setq initial-frame-alist (delq element initial-frame-alist))) |
| 538 | (and (setq element (assoc (car pair) default-frame-alist)) |
| 539 | (setq default-frame-alist (delq element default-frame-alist))))) |
| 540 | (and frame-notice-user-settings |
| 541 | (setq initial-frame-alist (append initial-frame-alist alist))) |
| 542 | (setq default-frame-alist (append default-frame-alist alist))) |
| 543 | |
| 544 | (defun get-other-frame () |
| 545 | "Return some frame other than the current frame. |
| 546 | Create one if necessary. Note that the minibuffer frame, if separate, |
| 547 | is not considered (see `next-frame')." |
| 548 | (let ((s (if (equal (next-frame (selected-frame)) (selected-frame)) |
| 549 | (make-frame) |
| 550 | (next-frame (selected-frame))))) |
| 551 | s)) |
| 552 | |
| 553 | (defun next-multiframe-window () |
| 554 | "Select the next window, regardless of which frame it is on." |
| 555 | (interactive) |
| 556 | (select-window (next-window (selected-window) |
| 557 | (> (minibuffer-depth) 0) |
| 558 | 0)) |
| 559 | (select-frame-set-input-focus (selected-frame))) |
| 560 | |
| 561 | (defun previous-multiframe-window () |
| 562 | "Select the previous window, regardless of which frame it is on." |
| 563 | (interactive) |
| 564 | (select-window (previous-window (selected-window) |
| 565 | (> (minibuffer-depth) 0) |
| 566 | 0)) |
| 567 | (select-frame-set-input-focus (selected-frame))) |
| 568 | |
| 569 | (defun make-frame-on-display (display &optional parameters) |
| 570 | "Make a frame on display DISPLAY. |
| 571 | The optional second argument PARAMETERS specifies additional frame parameters." |
| 572 | (interactive "sMake frame on display: ") |
| 573 | (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display) |
| 574 | (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN")) |
| 575 | (make-frame (cons (cons 'display display) parameters))) |
| 576 | |
| 577 | (defun make-frame-command () |
| 578 | "Make a new frame, and select it if the terminal displays only one frame." |
| 579 | (interactive) |
| 580 | (if (and window-system (not (eq window-system 'pc))) |
| 581 | (make-frame) |
| 582 | (select-frame (make-frame)))) |
| 583 | |
| 584 | (defvar before-make-frame-hook nil |
| 585 | "Functions to run before a frame is created.") |
| 586 | |
| 587 | (defvar after-make-frame-functions nil |
| 588 | "Functions to run after a frame is created. |
| 589 | The functions are run with one arg, the newly created frame.") |
| 590 | |
| 591 | (defvar after-setting-font-hook nil |
| 592 | "Functions to run after a frame's font has been changed.") |
| 593 | |
| 594 | ;; Alias, kept temporarily. |
| 595 | (define-obsolete-function-alias 'new-frame 'make-frame "22.1") |
| 596 | |
| 597 | (defun make-frame (&optional parameters) |
| 598 | "Return a newly created frame displaying the current buffer. |
| 599 | Optional argument PARAMETERS is an alist of parameters for the new frame. |
| 600 | Each element of PARAMETERS should have the form (NAME . VALUE), for example: |
| 601 | |
| 602 | (name . STRING) The frame should be named STRING. |
| 603 | |
| 604 | (width . NUMBER) The frame should be NUMBER characters in width. |
| 605 | (height . NUMBER) The frame should be NUMBER text lines high. |
| 606 | |
| 607 | You cannot specify either `width' or `height', you must use neither or both. |
| 608 | |
| 609 | (minibuffer . t) The frame should have a minibuffer. |
| 610 | (minibuffer . nil) The frame should have no minibuffer. |
| 611 | (minibuffer . only) The frame should contain only a minibuffer. |
| 612 | (minibuffer . WINDOW) The frame should use WINDOW as its minibuffer window. |
| 613 | |
| 614 | Before the frame is created (via `frame-creation-function'), functions on the |
| 615 | hook `before-make-frame-hook' are run. After the frame is created, functions |
| 616 | on `after-make-frame-functions' are run with one arg, the newly created frame. |
| 617 | |
| 618 | This function itself does not make the new frame the selected frame. |
| 619 | The previously selected frame remains selected. However, the |
| 620 | window system may select the new frame for its own reasons, for |
| 621 | instance if the frame appears under the mouse pointer and your |
| 622 | setup is for focus to follow the pointer." |
| 623 | (interactive) |
| 624 | (run-hooks 'before-make-frame-hook) |
| 625 | (let ((frame (funcall frame-creation-function parameters))) |
| 626 | (run-hook-with-args 'after-make-frame-functions frame) |
| 627 | frame)) |
| 628 | |
| 629 | (defun filtered-frame-list (predicate) |
| 630 | "Return a list of all live frames which satisfy PREDICATE." |
| 631 | (let* ((frames (frame-list)) |
| 632 | (list frames)) |
| 633 | (while (consp frames) |
| 634 | (unless (funcall predicate (car frames)) |
| 635 | (setcar frames nil)) |
| 636 | (setq frames (cdr frames))) |
| 637 | (delq nil list))) |
| 638 | |
| 639 | (defun minibuffer-frame-list () |
| 640 | "Return a list of all frames with their own minibuffers." |
| 641 | (filtered-frame-list |
| 642 | (function (lambda (frame) |
| 643 | (eq frame (window-frame (minibuffer-window frame))))))) |
| 644 | |
| 645 | (defun frames-on-display-list (&optional display) |
| 646 | "Return a list of all frames on DISPLAY. |
| 647 | DISPLAY is a name of a display, a string of the form HOST:SERVER.SCREEN. |
| 648 | If DISPLAY is omitted or nil, it defaults to the selected frame's display." |
| 649 | (let* ((display (or display (frame-parameter nil 'display))) |
| 650 | (func #'(lambda (frame) |
| 651 | (equal (frame-parameter frame 'display) display)))) |
| 652 | (filtered-frame-list func))) |
| 653 | |
| 654 | (defun framep-on-display (&optional display) |
| 655 | "Return the type of frames on DISPLAY. |
| 656 | DISPLAY may be a display name or a frame. If it is a frame, its type is |
| 657 | returned. |
| 658 | If DISPLAY is omitted or nil, it defaults to the selected frame's display. |
| 659 | All frames on a given display are of the same type." |
| 660 | (or (framep display) |
| 661 | (framep (car (frames-on-display-list display))))) |
| 662 | |
| 663 | (defun frame-remove-geometry-params (param-list) |
| 664 | "Return the parameter list PARAM-LIST, but with geometry specs removed. |
| 665 | This deletes all bindings in PARAM-LIST for `top', `left', `width', |
| 666 | `height', `user-size' and `user-position' parameters. |
| 667 | Emacs uses this to avoid overriding explicit moves and resizings from |
| 668 | the user during startup." |
| 669 | (setq param-list (cons nil param-list)) |
| 670 | (let ((tail param-list)) |
| 671 | (while (consp (cdr tail)) |
| 672 | (if (and (consp (car (cdr tail))) |
| 673 | (memq (car (car (cdr tail))) |
| 674 | '(height width top left user-position user-size))) |
| 675 | (progn |
| 676 | (setq frame-initial-geometry-arguments |
| 677 | (cons (car (cdr tail)) frame-initial-geometry-arguments)) |
| 678 | (setcdr tail (cdr (cdr tail)))) |
| 679 | (setq tail (cdr tail))))) |
| 680 | (setq frame-initial-geometry-arguments |
| 681 | (nreverse frame-initial-geometry-arguments)) |
| 682 | (cdr param-list)) |
| 683 | |
| 684 | (defcustom focus-follows-mouse (not (eq window-system 'mac)) |
| 685 | "*Non-nil if window system changes focus when you move the mouse. |
| 686 | You should set this variable to tell Emacs how your window manager |
| 687 | handles focus, since there is no way in general for Emacs to find out |
| 688 | automatically. |
| 689 | |
| 690 | This variable does not have any effect on MS-Windows." |
| 691 | :type 'boolean |
| 692 | :group 'frames |
| 693 | :version "20.3") |
| 694 | |
| 695 | (defun select-frame-set-input-focus (frame) |
| 696 | "Select FRAME, raise it, and set input focus, if possible." |
| 697 | (select-frame frame) |
| 698 | (raise-frame frame) |
| 699 | ;; Ensure, if possible, that frame gets input focus. |
| 700 | (cond ((memq window-system '(x mac)) |
| 701 | (x-focus-frame frame)) |
| 702 | ((eq window-system 'w32) |
| 703 | (w32-focus-frame frame))) |
| 704 | (cond (focus-follows-mouse |
| 705 | (set-mouse-position (selected-frame) (1- (frame-width)) 0)))) |
| 706 | |
| 707 | (defun other-frame (arg) |
| 708 | "Select the ARGth different visible frame on current display, and raise it. |
| 709 | All frames are arranged in a cyclic order. |
| 710 | This command selects the frame ARG steps away in that order. |
| 711 | A negative ARG moves in the opposite order. |
| 712 | |
| 713 | To make this command work properly, you must tell Emacs |
| 714 | how the system (or the window manager) generally handles |
| 715 | focus-switching between windows. If moving the mouse onto a window |
| 716 | selects it (gives it focus), set `focus-follows-mouse' to t. |
| 717 | Otherwise, that variable should be nil." |
| 718 | (interactive "p") |
| 719 | (let ((frame (selected-frame))) |
| 720 | (while (> arg 0) |
| 721 | (setq frame (next-frame frame)) |
| 722 | (while (not (eq (frame-visible-p frame) t)) |
| 723 | (setq frame (next-frame frame))) |
| 724 | (setq arg (1- arg))) |
| 725 | (while (< arg 0) |
| 726 | (setq frame (previous-frame frame)) |
| 727 | (while (not (eq (frame-visible-p frame) t)) |
| 728 | (setq frame (previous-frame frame))) |
| 729 | (setq arg (1+ arg))) |
| 730 | (select-frame-set-input-focus frame))) |
| 731 | |
| 732 | (defun iconify-or-deiconify-frame () |
| 733 | "Iconify the selected frame, or deiconify if it's currently an icon." |
| 734 | (interactive) |
| 735 | (if (eq (cdr (assq 'visibility (frame-parameters))) t) |
| 736 | (iconify-frame) |
| 737 | (make-frame-visible))) |
| 738 | |
| 739 | (defun make-frame-names-alist () |
| 740 | (let* ((current-frame (selected-frame)) |
| 741 | (falist |
| 742 | (cons |
| 743 | (cons (frame-parameter current-frame 'name) current-frame) nil)) |
| 744 | (frame (next-frame nil t))) |
| 745 | (while (not (eq frame current-frame)) |
| 746 | (progn |
| 747 | (setq falist (cons (cons (frame-parameter frame 'name) frame) falist)) |
| 748 | (setq frame (next-frame frame t)))) |
| 749 | falist)) |
| 750 | |
| 751 | (defvar frame-name-history nil) |
| 752 | (defun select-frame-by-name (name) |
| 753 | "Select the frame on the current terminal whose name is NAME and raise it. |
| 754 | If there is no frame by that name, signal an error." |
| 755 | (interactive |
| 756 | (let* ((frame-names-alist (make-frame-names-alist)) |
| 757 | (default (car (car frame-names-alist))) |
| 758 | (input (completing-read |
| 759 | (format "Select Frame (default %s): " default) |
| 760 | frame-names-alist nil t nil 'frame-name-history))) |
| 761 | (if (= (length input) 0) |
| 762 | (list default) |
| 763 | (list input)))) |
| 764 | (let* ((frame-names-alist (make-frame-names-alist)) |
| 765 | (frame (cdr (assoc name frame-names-alist)))) |
| 766 | (or frame |
| 767 | (error "There is no frame named `%s'" name)) |
| 768 | (make-frame-visible frame) |
| 769 | (raise-frame frame) |
| 770 | (select-frame frame) |
| 771 | ;; Ensure, if possible, that frame gets input focus. |
| 772 | (cond ((memq window-system '(x mac)) |
| 773 | (x-focus-frame frame)) |
| 774 | ((eq window-system 'w32) |
| 775 | (w32-focus-frame frame))) |
| 776 | (when focus-follows-mouse |
| 777 | (set-mouse-position frame (1- (frame-width frame)) 0)))) |
| 778 | \f |
| 779 | ;;;; Frame configurations |
| 780 | |
| 781 | (defun current-frame-configuration () |
| 782 | "Return a list describing the positions and states of all frames. |
| 783 | Its car is `frame-configuration'. |
| 784 | Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG), |
| 785 | where |
| 786 | FRAME is a frame object, |
| 787 | ALIST is an association list specifying some of FRAME's parameters, and |
| 788 | WINDOW-CONFIG is a window configuration object for FRAME." |
| 789 | (cons 'frame-configuration |
| 790 | (mapcar (function |
| 791 | (lambda (frame) |
| 792 | (list frame |
| 793 | (frame-parameters frame) |
| 794 | (current-window-configuration frame)))) |
| 795 | (frame-list)))) |
| 796 | |
| 797 | (defun set-frame-configuration (configuration &optional nodelete) |
| 798 | "Restore the frames to the state described by CONFIGURATION. |
| 799 | Each frame listed in CONFIGURATION has its position, size, window |
| 800 | configuration, and other parameters set as specified in CONFIGURATION. |
| 801 | However, this function does not restore deleted frames. |
| 802 | |
| 803 | Ordinarily, this function deletes all existing frames not |
| 804 | listed in CONFIGURATION. But if optional second argument NODELETE |
| 805 | is given and non-nil, the unwanted frames are iconified instead." |
| 806 | (or (frame-configuration-p configuration) |
| 807 | (signal 'wrong-type-argument |
| 808 | (list 'frame-configuration-p configuration))) |
| 809 | (let ((config-alist (cdr configuration)) |
| 810 | frames-to-delete) |
| 811 | (mapcar (function |
| 812 | (lambda (frame) |
| 813 | (let ((parameters (assq frame config-alist))) |
| 814 | (if parameters |
| 815 | (progn |
| 816 | (modify-frame-parameters |
| 817 | frame |
| 818 | ;; Since we can't set a frame's minibuffer status, |
| 819 | ;; we might as well omit the parameter altogether. |
| 820 | (let* ((parms (nth 1 parameters)) |
| 821 | (mini (assq 'minibuffer parms))) |
| 822 | (if mini (setq parms (delq mini parms))) |
| 823 | parms)) |
| 824 | (set-window-configuration (nth 2 parameters))) |
| 825 | (setq frames-to-delete (cons frame frames-to-delete)))))) |
| 826 | (frame-list)) |
| 827 | (if nodelete |
| 828 | ;; Note: making frames invisible here was tried |
| 829 | ;; but led to some strange behavior--each time the frame |
| 830 | ;; was made visible again, the window manager asked afresh |
| 831 | ;; for where to put it. |
| 832 | (mapcar 'iconify-frame frames-to-delete) |
| 833 | (mapcar 'delete-frame frames-to-delete)))) |
| 834 | \f |
| 835 | ;;;; Convenience functions for accessing and interactively changing |
| 836 | ;;;; frame parameters. |
| 837 | |
| 838 | (defun frame-height (&optional frame) |
| 839 | "Return number of lines available for display on FRAME. |
| 840 | If FRAME is omitted, describe the currently selected frame." |
| 841 | (cdr (assq 'height (frame-parameters frame)))) |
| 842 | |
| 843 | (defun frame-width (&optional frame) |
| 844 | "Return number of columns available for display on FRAME. |
| 845 | If FRAME is omitted, describe the currently selected frame." |
| 846 | (cdr (assq 'width (frame-parameters frame)))) |
| 847 | |
| 848 | (defalias 'set-default-font 'set-frame-font) |
| 849 | (defun set-frame-font (font-name &optional keep-size) |
| 850 | "Set the font of the selected frame to FONT-NAME. |
| 851 | When called interactively, prompt for the name of the font to use. |
| 852 | To get the frame's current default font, use `frame-parameters'. |
| 853 | |
| 854 | The default behavior is to keep the numbers of lines and columns in |
| 855 | the frame, thus may change its pixel size. If optional KEEP-SIZE is |
| 856 | non-nil (interactively, prefix argument) the current frame size (in |
| 857 | pixels) is kept by adjusting the numbers of the lines and columns." |
| 858 | (interactive |
| 859 | (let* ((completion-ignore-case t) |
| 860 | (font (completing-read "Font name: " |
| 861 | (mapcar #'list |
| 862 | ;; x-list-fonts will fail with an error |
| 863 | ;; if this frame doesn't support fonts. |
| 864 | (x-list-fonts "*" nil (selected-frame))) |
| 865 | nil nil nil nil |
| 866 | (frame-parameter nil 'font)))) |
| 867 | (list font current-prefix-arg))) |
| 868 | (let (fht fwd) |
| 869 | (if keep-size |
| 870 | (setq fht (* (frame-parameter nil 'height) (frame-char-height)) |
| 871 | fwd (* (frame-parameter nil 'width) (frame-char-width)))) |
| 872 | (modify-frame-parameters (selected-frame) |
| 873 | (list (cons 'font font-name))) |
| 874 | (if keep-size |
| 875 | (modify-frame-parameters |
| 876 | (selected-frame) |
| 877 | (list (cons 'height (round fht (frame-char-height))) |
| 878 | (cons 'width (round fwd (frame-char-width))))))) |
| 879 | (run-hooks 'after-setting-font-hook 'after-setting-font-hooks)) |
| 880 | |
| 881 | (defun set-frame-parameter (frame parameter value) |
| 882 | "Set frame parameter PARAMETER to VALUE on FRAME. |
| 883 | If FRAME is nil, it defaults to the selected frame. |
| 884 | See `modify-frame-parameters'." |
| 885 | (modify-frame-parameters frame (list (cons parameter value)))) |
| 886 | |
| 887 | (defun set-background-color (color-name) |
| 888 | "Set the background color of the selected frame to COLOR-NAME. |
| 889 | When called interactively, prompt for the name of the color to use. |
| 890 | To get the frame's current background color, use `frame-parameters'." |
| 891 | (interactive (list (facemenu-read-color "Background color: "))) |
| 892 | (modify-frame-parameters (selected-frame) |
| 893 | (list (cons 'background-color color-name))) |
| 894 | (or window-system |
| 895 | (face-set-after-frame-default (selected-frame)))) |
| 896 | |
| 897 | (defun set-foreground-color (color-name) |
| 898 | "Set the foreground color of the selected frame to COLOR-NAME. |
| 899 | When called interactively, prompt for the name of the color to use. |
| 900 | To get the frame's current foreground color, use `frame-parameters'." |
| 901 | (interactive (list (facemenu-read-color "Foreground color: "))) |
| 902 | (modify-frame-parameters (selected-frame) |
| 903 | (list (cons 'foreground-color color-name))) |
| 904 | (or window-system |
| 905 | (face-set-after-frame-default (selected-frame)))) |
| 906 | |
| 907 | (defun set-cursor-color (color-name) |
| 908 | "Set the text cursor color of the selected frame to COLOR-NAME. |
| 909 | When called interactively, prompt for the name of the color to use. |
| 910 | To get the frame's current cursor color, use `frame-parameters'." |
| 911 | (interactive (list (facemenu-read-color "Cursor color: "))) |
| 912 | (modify-frame-parameters (selected-frame) |
| 913 | (list (cons 'cursor-color color-name)))) |
| 914 | |
| 915 | (defun set-mouse-color (color-name) |
| 916 | "Set the color of the mouse pointer of the selected frame to COLOR-NAME. |
| 917 | When called interactively, prompt for the name of the color to use. |
| 918 | To get the frame's current mouse color, use `frame-parameters'." |
| 919 | (interactive (list (facemenu-read-color "Mouse color: "))) |
| 920 | (modify-frame-parameters (selected-frame) |
| 921 | (list (cons 'mouse-color |
| 922 | (or color-name |
| 923 | (cdr (assq 'mouse-color |
| 924 | (frame-parameters)))))))) |
| 925 | |
| 926 | (defun set-border-color (color-name) |
| 927 | "Set the color of the border of the selected frame to COLOR-NAME. |
| 928 | When called interactively, prompt for the name of the color to use. |
| 929 | To get the frame's current border color, use `frame-parameters'." |
| 930 | (interactive (list (facemenu-read-color "Border color: "))) |
| 931 | (modify-frame-parameters (selected-frame) |
| 932 | (list (cons 'border-color color-name)))) |
| 933 | |
| 934 | (defun auto-raise-mode (arg) |
| 935 | "Toggle whether or not the selected frame should auto-raise. |
| 936 | With arg, turn auto-raise mode on if and only if arg is positive. |
| 937 | Note that this controls Emacs's own auto-raise feature. |
| 938 | Some window managers allow you to enable auto-raise for certain windows. |
| 939 | You can use that for Emacs windows if you wish, but if you do, |
| 940 | that is beyond the control of Emacs and this command has no effect on it." |
| 941 | (interactive "P") |
| 942 | (if (null arg) |
| 943 | (setq arg |
| 944 | (if (cdr (assq 'auto-raise (frame-parameters (selected-frame)))) |
| 945 | -1 1))) |
| 946 | (if (> arg 0) |
| 947 | (raise-frame (selected-frame))) |
| 948 | (modify-frame-parameters (selected-frame) |
| 949 | (list (cons 'auto-raise (> arg 0))))) |
| 950 | |
| 951 | (defun auto-lower-mode (arg) |
| 952 | "Toggle whether or not the selected frame should auto-lower. |
| 953 | With arg, turn auto-lower mode on if and only if arg is positive. |
| 954 | Note that this controls Emacs's own auto-lower feature. |
| 955 | Some window managers allow you to enable auto-lower for certain windows. |
| 956 | You can use that for Emacs windows if you wish, but if you do, |
| 957 | that is beyond the control of Emacs and this command has no effect on it." |
| 958 | (interactive "P") |
| 959 | (if (null arg) |
| 960 | (setq arg |
| 961 | (if (cdr (assq 'auto-lower (frame-parameters (selected-frame)))) |
| 962 | -1 1))) |
| 963 | (modify-frame-parameters (selected-frame) |
| 964 | (list (cons 'auto-lower (> arg 0))))) |
| 965 | (defun set-frame-name (name) |
| 966 | "Set the name of the selected frame to NAME. |
| 967 | When called interactively, prompt for the name of the frame. |
| 968 | The frame name is displayed on the modeline if the terminal displays only |
| 969 | one frame, otherwise the name is displayed on the frame's caption bar." |
| 970 | (interactive "sFrame name: ") |
| 971 | (modify-frame-parameters (selected-frame) |
| 972 | (list (cons 'name name)))) |
| 973 | |
| 974 | (defun frame-current-scroll-bars (&optional frame) |
| 975 | "Return the current scroll-bar settings in frame FRAME. |
| 976 | Value is a cons (VERTICAL . HORIZ0NTAL) where VERTICAL specifies the |
| 977 | current location of the vertical scroll-bars (left, right, or nil), |
| 978 | and HORIZONTAL specifies the current location of the horizontal scroll |
| 979 | bars (top, bottom, or nil)." |
| 980 | (let ((vert (frame-parameter frame 'vertical-scroll-bars)) |
| 981 | (hor nil)) |
| 982 | (unless (memq vert '(left right nil)) |
| 983 | (setq vert default-frame-scroll-bars)) |
| 984 | (cons vert hor))) |
| 985 | \f |
| 986 | ;;;; Frame/display capabilities. |
| 987 | (defun display-mouse-p (&optional display) |
| 988 | "Return non-nil if DISPLAY has a mouse available. |
| 989 | DISPLAY can be a display name, a frame, or nil (meaning the selected |
| 990 | frame's display)." |
| 991 | (let ((frame-type (framep-on-display display))) |
| 992 | (cond |
| 993 | ((eq frame-type 'pc) |
| 994 | (msdos-mouse-p)) |
| 995 | ((eq system-type 'windows-nt) |
| 996 | (with-no-warnings |
| 997 | (> w32-num-mouse-buttons 0))) |
| 998 | ((memq frame-type '(x mac)) |
| 999 | t) ;; We assume X and Mac *always* have a pointing device |
| 1000 | (t |
| 1001 | (or (and (featurep 'xt-mouse) |
| 1002 | xterm-mouse-mode) |
| 1003 | ;; t-mouse is distributed with the GPM package. It doesn't have |
| 1004 | ;; a toggle. |
| 1005 | (featurep 't-mouse)))))) |
| 1006 | |
| 1007 | (defun display-popup-menus-p (&optional display) |
| 1008 | "Return non-nil if popup menus are supported on DISPLAY. |
| 1009 | DISPLAY can be a display name, a frame, or nil (meaning the selected |
| 1010 | frame's display). |
| 1011 | Support for popup menus requires that the mouse be available." |
| 1012 | (and |
| 1013 | (let ((frame-type (framep-on-display display))) |
| 1014 | (memq frame-type '(x w32 pc mac))) |
| 1015 | (display-mouse-p display))) |
| 1016 | |
| 1017 | (defun display-graphic-p (&optional display) |
| 1018 | "Return non-nil if DISPLAY is a graphic display. |
| 1019 | Graphical displays are those which are capable of displaying several |
| 1020 | frames and several different fonts at once. This is true for displays |
| 1021 | that use a window system such as X, and false for text-only terminals. |
| 1022 | DISPLAY can be a display name, a frame, or nil (meaning the selected |
| 1023 | frame's display)." |
| 1024 | (not (null (memq (framep-on-display display) '(x w32 mac))))) |
| 1025 | |
| 1026 | (defun display-images-p (&optional display) |
| 1027 | "Return non-nil if DISPLAY can display images. |
| 1028 | |
| 1029 | DISPLAY can be a display name, a frame, or nil (meaning the selected |
| 1030 | frame's display)." |
| 1031 | (and (display-graphic-p display) |
| 1032 | (fboundp 'image-mask-p) |
| 1033 | (fboundp 'image-size))) |
| 1034 | |
| 1035 | (defalias 'display-multi-frame-p 'display-graphic-p) |
| 1036 | (defalias 'display-multi-font-p 'display-graphic-p) |
| 1037 | |
| 1038 | (defun display-selections-p (&optional display) |
| 1039 | "Return non-nil if DISPLAY supports selections. |
| 1040 | A selection is a way to transfer text or other data between programs |
| 1041 | via special system buffers called `selection' or `cut buffer' or |
| 1042 | `clipboard'. |
| 1043 | DISPLAY can be a display name, a frame, or nil (meaning the selected |
| 1044 | frame's display)." |
| 1045 | (let ((frame-type (framep-on-display display))) |
| 1046 | (cond |
| 1047 | ((eq frame-type 'pc) |
| 1048 | ;; MS-DOG frames support selections when Emacs runs inside |
| 1049 | ;; the Windows' DOS Box. |
| 1050 | (with-no-warnings |
| 1051 | (not (null dos-windows-version)))) |
| 1052 | ((memq frame-type '(x w32 mac)) |
| 1053 | t) ;; FIXME? |
| 1054 | (t |
| 1055 | nil)))) |
| 1056 | |
| 1057 | (defun display-screens (&optional display) |
| 1058 | "Return the number of screens associated with DISPLAY." |
| 1059 | (let ((frame-type (framep-on-display display))) |
| 1060 | (cond |
| 1061 | ((memq frame-type '(x w32 mac)) |
| 1062 | (x-display-screens display)) |
| 1063 | (t |
| 1064 | 1)))) |
| 1065 | |
| 1066 | (defun display-pixel-height (&optional display) |
| 1067 | "Return the height of DISPLAY's screen in pixels. |
| 1068 | For character terminals, each character counts as a single pixel." |
| 1069 | (let ((frame-type (framep-on-display display))) |
| 1070 | (cond |
| 1071 | ((memq frame-type '(x w32 mac)) |
| 1072 | (x-display-pixel-height display)) |
| 1073 | (t |
| 1074 | (frame-height (if (framep display) display (selected-frame))))))) |
| 1075 | |
| 1076 | (defun display-pixel-width (&optional display) |
| 1077 | "Return the width of DISPLAY's screen in pixels. |
| 1078 | For character terminals, each character counts as a single pixel." |
| 1079 | (let ((frame-type (framep-on-display display))) |
| 1080 | (cond |
| 1081 | ((memq frame-type '(x w32 mac)) |
| 1082 | (x-display-pixel-width display)) |
| 1083 | (t |
| 1084 | (frame-width (if (framep display) display (selected-frame))))))) |
| 1085 | |
| 1086 | (defcustom display-mm-dimensions-alist nil |
| 1087 | "Alist for specifying screen dimensions in millimeters. |
| 1088 | The dimensions will be used for `display-mm-height' and |
| 1089 | `display-mm-width' if defined for the respective display. |
| 1090 | |
| 1091 | Each element of the alist has the form (display . (width . height)), |
| 1092 | e.g. (\":0.0\" . (287 . 215)). |
| 1093 | |
| 1094 | If `display' equals t, it specifies dimensions for all graphical |
| 1095 | displays not explicitely specified." |
| 1096 | :version "22.1" |
| 1097 | :type '(alist :key-type (choice (string :tag "Display name") |
| 1098 | (const :tag "Default" t)) |
| 1099 | :value-type (cons :tag "Dimensions" |
| 1100 | (integer :tag "Width") |
| 1101 | (integer :tag "Height"))) |
| 1102 | :group 'frames) |
| 1103 | |
| 1104 | (defun display-mm-height (&optional display) |
| 1105 | "Return the height of DISPLAY's screen in millimeters. |
| 1106 | System values can be overriden by `display-mm-dimensions-alist'. |
| 1107 | If the information is unavailable, value is nil." |
| 1108 | (and (memq (framep-on-display display) '(x w32 mac)) |
| 1109 | (or (cddr (assoc (or display (frame-parameter nil 'display)) |
| 1110 | display-mm-dimensions-alist)) |
| 1111 | (cddr (assoc t display-mm-dimensions-alist)) |
| 1112 | (x-display-mm-height display)))) |
| 1113 | |
| 1114 | (defun display-mm-width (&optional display) |
| 1115 | "Return the width of DISPLAY's screen in millimeters. |
| 1116 | System values can be overriden by `display-mm-dimensions-alist'. |
| 1117 | If the information is unavailable, value is nil." |
| 1118 | (and (memq (framep-on-display display) '(x w32 mac)) |
| 1119 | (or (cadr (assoc (or display (frame-parameter nil 'display)) |
| 1120 | display-mm-dimensions-alist)) |
| 1121 | (cadr (assoc t display-mm-dimensions-alist)) |
| 1122 | (x-display-mm-width display)))) |
| 1123 | |
| 1124 | (defun display-backing-store (&optional display) |
| 1125 | "Return the backing store capability of DISPLAY's screen. |
| 1126 | The value may be `always', `when-mapped', `not-useful', or nil if |
| 1127 | the question is inapplicable to a certain kind of display." |
| 1128 | (let ((frame-type (framep-on-display display))) |
| 1129 | (cond |
| 1130 | ((memq frame-type '(x w32 mac)) |
| 1131 | (x-display-backing-store display)) |
| 1132 | (t |
| 1133 | 'not-useful)))) |
| 1134 | |
| 1135 | (defun display-save-under (&optional display) |
| 1136 | "Return non-nil if DISPLAY's screen supports the SaveUnder feature." |
| 1137 | (let ((frame-type (framep-on-display display))) |
| 1138 | (cond |
| 1139 | ((memq frame-type '(x w32 mac)) |
| 1140 | (x-display-save-under display)) |
| 1141 | (t |
| 1142 | 'not-useful)))) |
| 1143 | |
| 1144 | (defun display-planes (&optional display) |
| 1145 | "Return the number of planes supported by DISPLAY." |
| 1146 | (let ((frame-type (framep-on-display display))) |
| 1147 | (cond |
| 1148 | ((memq frame-type '(x w32 mac)) |
| 1149 | (x-display-planes display)) |
| 1150 | ((eq frame-type 'pc) |
| 1151 | 4) |
| 1152 | (t |
| 1153 | (truncate (log (length (tty-color-alist)) 2)))))) |
| 1154 | |
| 1155 | (defun display-color-cells (&optional display) |
| 1156 | "Return the number of color cells supported by DISPLAY." |
| 1157 | (let ((frame-type (framep-on-display display))) |
| 1158 | (cond |
| 1159 | ((memq frame-type '(x w32 mac)) |
| 1160 | (x-display-color-cells display)) |
| 1161 | ((eq frame-type 'pc) |
| 1162 | 16) |
| 1163 | (t |
| 1164 | (tty-display-color-cells))))) |
| 1165 | |
| 1166 | (defun display-visual-class (&optional display) |
| 1167 | "Returns the visual class of DISPLAY. |
| 1168 | The value is one of the symbols `static-gray', `gray-scale', |
| 1169 | `static-color', `pseudo-color', `true-color', or `direct-color'." |
| 1170 | (let ((frame-type (framep-on-display display))) |
| 1171 | (cond |
| 1172 | ((memq frame-type '(x w32 mac)) |
| 1173 | (x-display-visual-class display)) |
| 1174 | ((and (memq frame-type '(pc t)) |
| 1175 | (tty-display-color-p display)) |
| 1176 | 'static-color) |
| 1177 | (t |
| 1178 | 'static-gray)))) |
| 1179 | |
| 1180 | \f |
| 1181 | ;;;; Aliases for backward compatibility with Emacs 18. |
| 1182 | (define-obsolete-function-alias 'screen-height 'frame-height) ;before 19.15 |
| 1183 | (define-obsolete-function-alias 'screen-width 'frame-width) ;before 19.15 |
| 1184 | |
| 1185 | (defun set-screen-width (cols &optional pretend) |
| 1186 | "Change the size of the screen to COLS columns. |
| 1187 | Optional second arg non-nil means that redisplay should use COLS columns |
| 1188 | but that the idea of the actual width of the frame should not be changed. |
| 1189 | This function is provided only for compatibility with Emacs 18." |
| 1190 | (set-frame-width (selected-frame) cols pretend)) |
| 1191 | |
| 1192 | (defun set-screen-height (lines &optional pretend) |
| 1193 | "Change the height of the screen to LINES lines. |
| 1194 | Optional second arg non-nil means that redisplay should use LINES lines |
| 1195 | but that the idea of the actual height of the screen should not be changed. |
| 1196 | This function is provided only for compatibility with Emacs 18." |
| 1197 | (set-frame-height (selected-frame) lines pretend)) |
| 1198 | |
| 1199 | (defun delete-other-frames (&optional frame) |
| 1200 | "Delete all frames except FRAME. |
| 1201 | If FRAME uses another frame's minibuffer, the minibuffer frame is |
| 1202 | left untouched. FRAME nil or omitted means use the selected frame." |
| 1203 | (interactive) |
| 1204 | (unless frame |
| 1205 | (setq frame (selected-frame))) |
| 1206 | (let* ((mini-frame (window-frame (minibuffer-window frame))) |
| 1207 | (frames (delq mini-frame (delq frame (frame-list))))) |
| 1208 | ;; Delete mon-minibuffer-only frames first, because `delete-frame' |
| 1209 | ;; signals an error when trying to delete a mini-frame that's |
| 1210 | ;; still in use by another frame. |
| 1211 | (dolist (frame frames) |
| 1212 | (unless (eq (frame-parameter frame 'minibuffer) 'only) |
| 1213 | (delete-frame frame))) |
| 1214 | ;; Delete minibuffer-only frames. |
| 1215 | (dolist (frame frames) |
| 1216 | (when (eq (frame-parameter frame 'minibuffer) 'only) |
| 1217 | (delete-frame frame))))) |
| 1218 | |
| 1219 | (make-obsolete 'set-screen-width 'set-frame-width) ;before 19.15 |
| 1220 | (make-obsolete 'set-screen-height 'set-frame-height) ;before 19.15 |
| 1221 | |
| 1222 | ;; miscellaneous obsolescence declarations |
| 1223 | (define-obsolete-variable-alias 'delete-frame-hook |
| 1224 | 'delete-frame-functions "22.1") |
| 1225 | |
| 1226 | \f |
| 1227 | ;; Highlighting trailing whitespace. |
| 1228 | |
| 1229 | (make-variable-buffer-local 'show-trailing-whitespace) |
| 1230 | |
| 1231 | (defcustom show-trailing-whitespace nil |
| 1232 | "*Non-nil means highlight trailing whitespace. |
| 1233 | This is done in the face `trailing-whitespace'." |
| 1234 | :type 'boolean |
| 1235 | :group 'whitespace-faces) |
| 1236 | |
| 1237 | |
| 1238 | \f |
| 1239 | ;; Scrolling |
| 1240 | |
| 1241 | (defgroup scrolling nil |
| 1242 | "Scrolling windows." |
| 1243 | :version "21.1" |
| 1244 | :group 'frames) |
| 1245 | |
| 1246 | (defcustom auto-hscroll-mode t |
| 1247 | "*Allow or disallow automatic scrolling windows horizontally. |
| 1248 | If non-nil, windows are automatically scrolled horizontally to make |
| 1249 | point visible." |
| 1250 | :version "21.1" |
| 1251 | :type 'boolean |
| 1252 | :group 'scrolling) |
| 1253 | (defvaralias 'automatic-hscrolling 'auto-hscroll-mode) |
| 1254 | |
| 1255 | \f |
| 1256 | ;; Blinking cursor |
| 1257 | |
| 1258 | (defgroup cursor nil |
| 1259 | "Displaying text cursors." |
| 1260 | :version "21.1" |
| 1261 | :group 'frames) |
| 1262 | |
| 1263 | (defcustom blink-cursor-delay 0.5 |
| 1264 | "*Seconds of idle time after which cursor starts to blink." |
| 1265 | :type 'number |
| 1266 | :group 'cursor) |
| 1267 | |
| 1268 | (defcustom blink-cursor-interval 0.5 |
| 1269 | "*Length of cursor blink interval in seconds." |
| 1270 | :type 'number |
| 1271 | :group 'cursor) |
| 1272 | |
| 1273 | (defvar blink-cursor-idle-timer nil |
| 1274 | "Timer started after `blink-cursor-delay' seconds of Emacs idle time. |
| 1275 | The function `blink-cursor-start' is called when the timer fires.") |
| 1276 | |
| 1277 | (defvar blink-cursor-timer nil |
| 1278 | "Timer started from `blink-cursor-start'. |
| 1279 | This timer calls `blink-cursor-timer-function' every |
| 1280 | `blink-cursor-interval' seconds.") |
| 1281 | |
| 1282 | (defun blink-cursor-start () |
| 1283 | "Timer function called from the timer `blink-cursor-idle-timer'. |
| 1284 | This starts the timer `blink-cursor-timer', which makes the cursor blink |
| 1285 | if appropriate. It also arranges to cancel that timer when the next |
| 1286 | command starts, by installing a pre-command hook." |
| 1287 | (when (null blink-cursor-timer) |
| 1288 | ;; Set up the timer first, so that if this signals an error, |
| 1289 | ;; blink-cursor-end is not added to pre-command-hook. |
| 1290 | (setq blink-cursor-timer |
| 1291 | (run-with-timer blink-cursor-interval blink-cursor-interval |
| 1292 | 'blink-cursor-timer-function)) |
| 1293 | (add-hook 'pre-command-hook 'blink-cursor-end) |
| 1294 | (internal-show-cursor nil nil))) |
| 1295 | |
| 1296 | (defun blink-cursor-timer-function () |
| 1297 | "Timer function of timer `blink-cursor-timer'." |
| 1298 | (internal-show-cursor nil (not (internal-show-cursor-p)))) |
| 1299 | |
| 1300 | (defun blink-cursor-end () |
| 1301 | "Stop cursor blinking. |
| 1302 | This is installed as a pre-command hook by `blink-cursor-start'. |
| 1303 | When run, it cancels the timer `blink-cursor-timer' and removes |
| 1304 | itself as a pre-command hook." |
| 1305 | (remove-hook 'pre-command-hook 'blink-cursor-end) |
| 1306 | (internal-show-cursor nil t) |
| 1307 | (when blink-cursor-timer |
| 1308 | (cancel-timer blink-cursor-timer) |
| 1309 | (setq blink-cursor-timer nil))) |
| 1310 | |
| 1311 | (define-minor-mode blink-cursor-mode |
| 1312 | "Toggle blinking cursor mode. |
| 1313 | With a numeric argument, turn blinking cursor mode on iff ARG is positive. |
| 1314 | When blinking cursor mode is enabled, the cursor of the selected |
| 1315 | window blinks. |
| 1316 | |
| 1317 | Note that this command is effective only when Emacs |
| 1318 | displays through a window system, because then Emacs does its own |
| 1319 | cursor display. On a text-only terminal, this is not implemented." |
| 1320 | :init-value (not (or noninteractive |
| 1321 | no-blinking-cursor |
| 1322 | (eq system-type 'ms-dos) |
| 1323 | (not (memq window-system '(x w32 mac))))) |
| 1324 | :initialize 'custom-initialize-safe-default |
| 1325 | :group 'cursor |
| 1326 | :global t |
| 1327 | (if blink-cursor-idle-timer (cancel-timer blink-cursor-idle-timer)) |
| 1328 | (setq blink-cursor-idle-timer nil) |
| 1329 | (blink-cursor-end) |
| 1330 | (when blink-cursor-mode |
| 1331 | ;; Hide the cursor. |
| 1332 | ;;(internal-show-cursor nil nil) |
| 1333 | (setq blink-cursor-idle-timer |
| 1334 | (run-with-idle-timer blink-cursor-delay |
| 1335 | blink-cursor-delay |
| 1336 | 'blink-cursor-start)))) |
| 1337 | |
| 1338 | (define-obsolete-variable-alias 'blink-cursor 'blink-cursor-mode "22.1") |
| 1339 | \f |
| 1340 | ;; Hourglass pointer |
| 1341 | |
| 1342 | (defcustom display-hourglass t |
| 1343 | "*Non-nil means show an hourglass pointer, when Emacs is busy. |
| 1344 | This feature only works when on a window system that can change |
| 1345 | cursor shapes." |
| 1346 | :type 'boolean |
| 1347 | :group 'cursor) |
| 1348 | |
| 1349 | (defcustom hourglass-delay 1 |
| 1350 | "*Seconds to wait before displaying an hourglass pointer when Emacs is busy." |
| 1351 | :type 'number |
| 1352 | :group 'cursor) |
| 1353 | |
| 1354 | \f |
| 1355 | (defcustom cursor-in-non-selected-windows t |
| 1356 | "*Non-nil means show a hollow box cursor in non-selected windows. |
| 1357 | If nil, don't show a cursor except in the selected window. |
| 1358 | Use Custom to set this variable to get the display updated." |
| 1359 | :tag "Cursor In Non-selected Windows" |
| 1360 | :type 'boolean |
| 1361 | :group 'cursor |
| 1362 | :set #'(lambda (symbol value) |
| 1363 | (set-default symbol value) |
| 1364 | (force-mode-line-update t))) |
| 1365 | |
| 1366 | \f |
| 1367 | ;;;; Key bindings |
| 1368 | |
| 1369 | (define-key ctl-x-5-map "2" 'make-frame-command) |
| 1370 | (define-key ctl-x-5-map "1" 'delete-other-frames) |
| 1371 | (define-key ctl-x-5-map "0" 'delete-frame) |
| 1372 | (define-key ctl-x-5-map "o" 'other-frame) |
| 1373 | |
| 1374 | (provide 'frame) |
| 1375 | |
| 1376 | ;; arch-tag: 82979c70-b8f2-4306-b2ad-ddbd6b328b56 |
| 1377 | ;;; frame.el ends here |