frame.el 46.9 KB
Newer Older
1
;;; frame.el --- multi-frame management independent of window systems
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3 4
;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Erik Naggum's avatar
Erik Naggum committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
25

26 27
;;; Commentary:

Eric S. Raymond's avatar
Eric S. Raymond committed
28 29
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
30 31 32
(defvar frame-creation-function nil
  "Window-system dependent function to call to create a new frame.
The window system startup file should set this to its frame creation
Jim Blandy's avatar
Jim Blandy committed
33 34
function, which should take an alist of parameters as its argument.")

35 36 37
;;; The initial value given here for used to ask for a minibuffer.
;;; But that's not necessary, because the default is to have one.
;;; 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,
Jim Blandy's avatar
Jim Blandy committed
41
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
42 43 44 45
Parameters specified here supersede the values given in `default-frame-alist'.

If the value calls for a frame without a minibuffer, and you have not created
a minibuffer frame on your own, one is created according to
46
`minibuffer-frame-alist'.
47 48 49

You can specify geometry-related options for just the initial frame
by setting this variable in your `.emacs' file; however, they won't
Karl Heuer's avatar
Karl Heuer committed
50
take effect until Emacs reads `.emacs', which happens after first creating
51 52 53 54 55 56
the frame.  If you want the frame to have the proper geometry as soon
as it appears, you need to use this three-step process:
* Specify X resources to give the geometry you want.
* Set `default-frame-alist' to override these options so that they
  don't affect subsequent frames.
* Set `initial-frame-alist' in a way that matches the X resources,
57 58 59 60 61
  to override what you put in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
62

63 64
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  "*Alist of frame parameters for initially creating a minibuffer frame.
65
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
66
 (setq minibuffer-frame-alist
67
   '((top . 1) (left . 1) (width . 80) (height . 2)))
68
Parameters specified here supersede the values given in
69 70 71 72 73
`default-frame-alist', for a minibuffer frame."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
74

75 76
(defcustom pop-up-frame-alist nil
  "*Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
77
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
78
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
79
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
80 81 82 83 84 85
These supersede the values given in `default-frame-alist',
for pop-up frames."
  :type '(repeat (cons :format "%v"
		       (symbol :tag "Parameter")
		       (sexp :tag "Value")))
  :group 'frames)
Jim Blandy's avatar
Jim Blandy committed
86

Jim Blandy's avatar
Jim Blandy committed
87
(setq pop-up-frame-function
Jim Blandy's avatar
Jim Blandy committed
88
      (function (lambda ()
89
		  (make-frame pop-up-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
90

Richard M. Stallman's avatar
Richard M. Stallman committed
91
(defcustom special-display-frame-alist
92 93 94 95 96 97 98
  '((height . 14) (width . 80) (unsplittable . t))
  "*Alist of frame parameters used when creating special frames.
Special frames are used for buffers whose names are in
`special-display-buffer-names' and for buffers whose names match
one of the regular expressions in `special-display-regexps'.
This variable can be set in your init file, like this:
  (setq special-display-frame-alist '((width . 80) (height . 20)))
Richard M. Stallman's avatar
Richard M. Stallman committed
99 100 101 102 103
These supersede the values given in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
			 (symbol :tag "Parameter")
			 (sexp :tag "Value")))
  :group 'frames)
104

105
(defun special-display-popup-frame (buffer &optional args)
106 107 108 109 110 111 112
  "Display BUFFER in its own frame, reusing an existing window if any.
Return the window chosen.
Currently we do not insist on selecting the window within its frame.
If ARGS is an alist, use it as a list of frame parameter specs.
If ARGS is a list whose car is a symbol,
use (car ARGS) as a function to do the work.
Pass it BUFFER as first arg, and (cdr ARGS) gives the rest of the args."
113 114 115 116 117 118 119 120 121 122 123 124 125 126
  (if (and args (symbolp (car args)))
      (apply (car args) buffer (cdr args))
    (let ((window (get-buffer-window buffer t)))
      (if window
	  ;; If we have a window already, make it visible.
	  (let ((frame (window-frame window)))
	    (make-frame-visible frame)
	    (raise-frame frame)
	    window)
	;; If no window yet, make one in a new frame.
	(let ((frame (make-frame (append args special-display-frame-alist))))
	  (set-window-buffer (frame-selected-window frame) buffer)
	  (set-window-dedicated-p (frame-selected-window frame) t)
	  (frame-selected-window frame))))))
127

128
(defun handle-delete-frame (event)
129
  "Handle delete-frame events from the X server."
130 131 132 133 134 135 136 137 138 139 140
  (interactive "e")
  (let ((frame (posn-window (event-start event)))
	(i 0)
	(tail (frame-list)))
    (while tail
      (and (frame-visible-p (car tail))
	   (not (eq (car tail) frame))
	  (setq i (1+ i)))
      (setq tail (cdr tail)))
    (if (> i 0)
	(delete-frame frame t)
141 142
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
143

Jim Blandy's avatar
Jim Blandy committed
144
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
145 146 147

;;; 1) Load the window system startup file from the lisp library and read the
;;; high-priority arguments (-q and the like).  The window system startup
Jim Blandy's avatar
Jim Blandy committed
148
;;; file should create any frames specified in the window system defaults.
Karl Heuer's avatar
Karl Heuer committed
149
;;;
Jim Blandy's avatar
Jim Blandy committed
150
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
151 152
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
153
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
154

Karl Heuer's avatar
Karl Heuer committed
155
;; These are now called explicitly at the proper times,
156 157 158 159
;; since that is easier to understand.
;; Actually using hooks within Emacs is bad for future maintenance. --rms.
;; (add-hook 'before-init-hook 'frame-initialize)
;; (add-hook 'window-setup-hook 'frame-notice-user-settings)
Jim Blandy's avatar
Jim Blandy committed
160

Jim Blandy's avatar
Jim Blandy committed
161 162
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
163

164 165 166
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

167 168
(defvar frame-initial-geometry-arguments nil)

Jim Blandy's avatar
Jim Blandy committed
169
;;; startup.el calls this function before loading the user's init
Jim Blandy's avatar
Jim Blandy committed
170
;;; file - if there is no frame with a minibuffer open now, create
Jim Blandy's avatar
Jim Blandy committed
171
;;; one to display messages while loading the init file.
Jim Blandy's avatar
Jim Blandy committed
172
(defun frame-initialize ()
Eli Zaretskii's avatar
Eli Zaretskii committed
173
  "Create an initial frame if necessary."
Jim Blandy's avatar
Jim Blandy committed
174
  ;; Are we actually running under a window system at all?
175
  (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
176
      (progn
177 178 179
	;; Turn on special-display processing only if there's a window system.
	(setq special-display-function 'special-display-popup-frame)

180 181 182 183 184
	;; If there is no frame with a minibuffer besides the terminal
	;; frame, then we need to create the opening frame.  Make sure
	;; it has a minibuffer, but let initial-frame-alist omit the
	;; minibuffer spec.
	(or (delq terminal-frame (minibuffer-frame-list))
185
	    (progn
186
	      (setq frame-initial-frame-alist
187
		    (append initial-frame-alist default-frame-alist nil))
188 189 190 191
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
192 193
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
194
			  (make-frame frame-initial-frame-alist)))
195 196 197 198
	      ;; Delete any specifications for window geometry parameters
	      ;; so that we won't reapply them in frame-notice-user-settings.
	      ;; It would be wrong to reapply them then,
	      ;; because that would override explicit user resizing.
199
	      (setq initial-frame-alist
200
		    (frame-remove-geometry-params initial-frame-alist))))
Karl Heuer's avatar
Karl Heuer committed
201
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
202 203 204
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Karl Heuer's avatar
Karl Heuer committed
205

206 207
    ;; No, we're not running a window system.  Use make-terminal-frame if
    ;; we support that feature, otherwise arrange to cause errors.
208 209
    (or (eq window-system 'pc)
	(setq frame-creation-function
210 211
	      (if (fboundp 'tty-create-frame-with-faces)
		  'tty-create-frame-with-faces
212 213 214 215
		(function
		 (lambda (parameters)
		   (error
		    "Can't create multiple frames without a window system"))))))))
Karl Heuer's avatar
Karl Heuer committed
216

217 218 219
(defvar frame-notice-user-settings t
  "Non-nil means function `frame-notice-user-settings' wasn't run yet.")

220 221 222
;;; startup.el calls this function after loading the user's init
;;; file.  Now default-frame-alist and initial-frame-alist contain
;;; information to which we must react; do what needs to be done.
Jim Blandy's avatar
Jim Blandy committed
223
(defun frame-notice-user-settings ()
224 225
  "Act on user's init file settings of frame parameters.
React to settings of `default-frame-alist', `initial-frame-alist' there."
226
  ;; Make menu-bar-mode and default-frame-alist consistent.
227 228 229 230 231 232 233 234
  (when (boundp 'menu-bar-mode)
    (let ((default (assq 'menu-bar-lines default-frame-alist)))
      (if default
	  (setq menu-bar-mode (not (eq (cdr default) 0)))
	(setq default-frame-alist
	      (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
		    default-frame-alist)))))
  
235 236 237
  ;; Make tool-bar-mode and default-frame-alist consistent.  Don't do
  ;; it in batch mode since that would leave a tool-bar-lines
  ;; parameter in default-frame-alist in a dumped Emacs, which is not
238
  ;; what we want.
239 240
  (when (and (boundp 'tool-bar-mode)
	     (not noninteractive))
241 242 243 244 245 246
    (let ((default (assq 'tool-bar-lines default-frame-alist)))
      (if default
	  (setq tool-bar-mode (not (eq (cdr default) 0)))
	(setq default-frame-alist
	      (cons (cons 'tool-bar-lines (if tool-bar-mode 1 0))
		    default-frame-alist)))))
247

248 249 250 251 252 253 254
  ;; Creating and deleting frames may shift the selected frame around,
  ;; and thus the current buffer.  Protect against that.  We don't
  ;; want to use save-excursion here, because that may also try to set
  ;; the buffer of the selected window, which fails when the selected
  ;; window is the minibuffer.
  (let ((old-buffer (current-buffer)))

255 256
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
257 258
      ;; This case happens when we don't have a window system, and
      ;; also for MS-DOS frames.
259 260 261 262 263 264
      (let ((parms (frame-parameters frame-initial-frame)))
	;; Don't change the frame names.
	(setq parms (delq (assq 'name parms) parms))
	;; Can't modify the minibuffer parameter, so don't try.
	(setq parms (delq (assq 'minibuffer parms) parms))
	(modify-frame-parameters nil
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
				 (if (null window-system)
				     (append initial-frame-alist
					     default-frame-alist
					     parms
					     nil)
				   ;; initial-frame-alist and
				   ;; default-frame-alist were already
				   ;; applied in pc-win.el.
				   parms))
	(if (null window-system) ;; MS-DOS does this differently in pc-win.el
	    (let ((newparms (frame-parameters))
		  (frame (selected-frame)))
	      (tty-handle-reverse-video frame newparms)
	      ;; If we changed the background color, we need to update
	      ;; the background-mode parameter, and maybe some faces,
	      ;; too.
	      (when (assq 'background-color newparms)
		(unless (or (assq 'background-mode initial-frame-alist)
			    (assq 'background-mode default-frame-alist))
		  (frame-set-background-mode frame))
		(face-set-after-frame-default frame))))))
286

287 288
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
289 290 291 292 293
    (when (frame-live-p frame-initial-frame)

      ;; When tool-bar has been switched off, correct the frame size
      ;; by the lines added in x-create-frame for the tool-bar and
      ;; switch `tool-bar-mode' off.
294 295 296
      (when (display-graphic-p)
	(let ((tool-bar-lines (or (assq 'tool-bar-lines initial-frame-alist)
				  (assq 'tool-bar-lines default-frame-alist))))
297 298 299 300
	  (when (and tool-bar-originally-present
                     (or (null tool-bar-lines)
                         (null (cdr tool-bar-lines))
                         (eq 0 (cdr tool-bar-lines))))
301
	    (let* ((char-height (frame-char-height frame-initial-frame))
302
		   (image-height tool-bar-images-pixel-height)
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
		   (margin (cond ((and (consp tool-bar-button-margin)
				       (integerp (cdr tool-bar-button-margin))
				       (> tool-bar-button-margin 0))
				  (cdr tool-bar-button-margin))
				 ((and (integerp tool-bar-button-margin)
				       (> tool-bar-button-margin 0))
				  tool-bar-button-margin)
				 (t 0)))
		   (relief (if (and (integerp tool-bar-button-relief)
				    (> tool-bar-button-relief 0))
			       tool-bar-button-relief 3))
		   (lines (/ (+ image-height 
				(* 2 margin)
				(* 2 relief)
				(1- char-height))
			     char-height))
		   (height (frame-parameter frame-initial-frame 'height))
		   (newparms (list (cons 'height (- height lines))))
		   (initial-top (cdr (assq 'top 
					   frame-initial-geometry-arguments)))
		   (top (frame-parameter frame-initial-frame 'top)))
	      (when (and (consp initial-top) (eq '- (car initial-top)))
		(setq newparms 
		      (append newparms 
			      `((top . ,(+ top (* lines char-height))))
			      nil)))
	      (modify-frame-parameters frame-initial-frame newparms)
	      (tool-bar-mode -1)))))
331 332 333 334 335 336 337 338 339 340 341 342

      ;; The initial frame we create above always has a minibuffer.
      ;; If the user wants to remove it, or make it a minibuffer-only
      ;; frame, then we'll have to delete the current frame and make a
      ;; new one; you can't remove or add a root window to/from an
      ;; existing frame.
      ;;
      ;; NOTE: default-frame-alist was nil when we created the
      ;; existing frame.  We need to explicitly include
      ;; default-frame-alist in the parameters of the screen we
      ;; create here, so that its new value, gleaned from the user's
      ;; .emacs file, will be applied to the existing screen.
343 344 345 346 347 348 349 350 351 352 353 354 355 356
      (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			    (assq 'minibuffer default-frame-alist)
			    '(minibuffer . t)))
		   t))
	  ;; Create the new frame.
	  (let (parms new)
	    ;; If the frame isn't visible yet, wait till it is.
	    ;; If the user has to position the window,
	    ;; Emacs doesn't know its real position until
	    ;; the frame is seen to be visible.
	    (while (not (cdr (assq 'visibility
				   (frame-parameters frame-initial-frame))))
	      (sleep-for 1))
	    (setq parms (frame-parameters frame-initial-frame))
357 358

       ;; Get rid of `name' unless it was specified explicitly before.
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
	    (or (assq 'name frame-initial-frame-alist)
		(setq parms (delq (assq 'name parms) parms)))

	    (setq parms (append initial-frame-alist
				default-frame-alist
				parms
				nil))

	    ;; Get rid of `reverse', because that was handled
	    ;; when we first made the frame.
	    (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))

	    (if (assq 'height frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'height parms)))
	    (if (assq 'width frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'width parms)))
	    (if (assq 'left frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'left parms)))
	    (if (assq 'top frame-initial-geometry-arguments)
		(setq parms (assq-delete-all 'top parms)))
	    (setq new
		  (make-frame
		   ;; Use the geometry args that created the existing
		   ;; frame, rather than the parms we get for it.
		   (append frame-initial-geometry-arguments
			   '((user-size . t) (user-position . t))
			   parms)))
	    ;; The initial frame, which we are about to delete, may be
	    ;; the only frame with a minibuffer.  If it is, create a
	    ;; new one.
	    (or (delq frame-initial-frame (minibuffer-frame-list))
		(make-initial-minibuffer-frame nil))

	    ;; If the initial frame is serving as a surrogate
	    ;; minibuffer frame for any frames, we need to wean them
	    ;; onto a new frame.  The default-minibuffer-frame
	    ;; variable must be handled similarly.
	    (let ((users-of-initial
		   (filtered-frame-list
		    (function (lambda (frame)
				(and (not (eq frame frame-initial-frame))
				     (eq (window-frame
					  (minibuffer-window frame))
					 frame-initial-frame)))))))
	      (if (or users-of-initial
		      (eq default-minibuffer-frame frame-initial-frame))

		  ;; Choose an appropriate frame.  Prefer frames which
		  ;; are only minibuffers.
		  (let* ((new-surrogate
			  (car
			   (or (filtered-frame-list
				(function
				 (lambda (frame)
				   (eq (cdr (assq 'minibuffer
						  (frame-parameters frame)))
				       'only))))
			       (minibuffer-frame-list))))
			 (new-minibuffer (minibuffer-window new-surrogate)))

		    (if (eq default-minibuffer-frame frame-initial-frame)
			(setq default-minibuffer-frame new-surrogate))

		    ;; Wean the frames using frame-initial-frame as
		    ;; their minibuffer frame.
		    (mapcar
		     (function
		      (lambda (frame)
			(modify-frame-parameters
			 frame (list (cons 'minibuffer new-minibuffer)))))
		     users-of-initial))))

	   ;; Redirect events enqueued at this frame to the new frame.
	    ;; Is this a good idea?
	    (redirect-frame-focus frame-initial-frame new)

	    ;; Finally, get rid of the old frame.
	    (delete-frame frame-initial-frame t))
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477

	;; Otherwise, we don't need all that rigamarole; just apply
	;; the new parameters.
	(let (newparms allparms tail)
	  (setq allparms (append initial-frame-alist
				 default-frame-alist nil))
	  (if (assq 'height frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'height allparms)))
	  (if (assq 'width frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'width allparms)))
	  (if (assq 'left frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'left allparms)))
	  (if (assq 'top frame-initial-geometry-arguments)
	      (setq allparms (assq-delete-all 'top allparms)))
	  (setq tail allparms)
	  ;; Find just the parms that have changed since we first
	  ;; made this frame.  Those are the ones actually set by
       ;; the init file.  For those parms whose values we already knew
	  ;; (such as those spec'd by command line options)
	  ;; it is undesirable to specify the parm again
	 ;; once the user has seen the frame and been able to alter it
	  ;; manually.
	  (while tail
	    (let (newval oldval)
	      (setq oldval (assq (car (car tail))
				 frame-initial-frame-alist))
	      (setq newval (cdr (assq (car (car tail)) allparms)))
	      (or (and oldval (eq (cdr oldval) newval))
		  (setq newparms
			(cons (cons (car (car tail)) newval) newparms))))
	    (setq tail (cdr tail)))
	  (setq newparms (nreverse newparms))
	  (modify-frame-parameters frame-initial-frame
				   newparms)
	  ;; If we changed the background color,
	  ;; we need to update the background-mode parameter
	  ;; and maybe some faces too.
	  (when (assq 'background-color newparms)
	    (unless (assq 'background-mode newparms)
	      (frame-set-background-mode frame-initial-frame))
	    (face-set-after-frame-default frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
478

479 480 481 482
    ;; Restore the original buffer.
    (set-buffer old-buffer)

    ;; Make sure the initial frame can be GC'd if it is ever deleted.
483
    ;; Make sure frame-notice-user-settings does nothing if called twice.
484
    (setq frame-notice-user-settings nil)
485
    (setq frame-initial-frame nil)))
Jim Blandy's avatar
Jim Blandy committed
486

487 488 489 490 491 492
(defun make-initial-minibuffer-frame (display)
  (let ((parms (append minibuffer-frame-alist '((minibuffer . only)))))
    (if display
	(make-frame-on-display display parms)
      (make-frame parms))))

493
;;;; Creation of additional frames, and other frame miscellanea
Jim Blandy's avatar
Jim Blandy committed
494

Jim Blandy's avatar
Jim Blandy committed
495
(defun get-other-frame ()
496 497 498
  "Return some frame other than the current frame.
Create one if necessary.  Note that the minibuffer frame, if separate,
is not considered (see `next-frame')."
Jim Blandy's avatar
Jim Blandy committed
499
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
500
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
501
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
502 503
    s))

Jim Blandy's avatar
Jim Blandy committed
504 505
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
506 507 508
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
509 510
			      t))
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
511

Jim Blandy's avatar
Jim Blandy committed
512 513
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
514 515 516
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
517 518
				  t))
  (select-frame-set-input-focus (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
519

520 521 522 523
(defun make-frame-on-display (display &optional parameters)
  "Make a frame on display DISPLAY.
The optional second argument PARAMETERS specifies additional frame parameters."
  (interactive "sMake frame on display: ")
524 525
  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
526 527
  (make-frame (cons (cons 'display display) parameters)))

528 529 530
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
531
  (if (and window-system (not (eq window-system 'pc)))
532 533 534
      (make-frame)
    (select-frame (make-frame))))

535 536 537 538 539 540 541
(defvar before-make-frame-hook nil
  "Functions to run before a frame is created.")

(defvar after-make-frame-functions nil
  "Functions to run after a frame is created.
The functions are run with one arg, the newly created frame.")

542
(defvar after-setting-font-hook nil
543 544
  "Functions to run after a frame's font has been changed.")

545
;; Alias, kept temporarily.
546
(defalias 'new-frame 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
547

548 549 550 551
(defun make-frame (&optional parameters)
  "Return a newly created frame displaying the current buffer.
Optional argument PARAMETERS is an alist of parameters for the new frame.
Each element of PARAMETERS should have the form (NAME . VALUE), for example:
Richard M. Stallman's avatar
Richard M. Stallman committed
552

553
 (name . STRING)	The frame should be named STRING.
Jim Blandy's avatar
Jim Blandy committed
554

555 556
 (width . NUMBER)	The frame should be NUMBER characters in width.
 (height . NUMBER)	The frame should be NUMBER text lines high.
Jim Blandy's avatar
Jim Blandy committed
557

558
You cannot specify either `width' or `height', you must use neither or both.
Jim Blandy's avatar
Jim Blandy committed
559

560 561 562 563
 (minibuffer . t)	The frame should have a minibuffer.
 (minibuffer . nil)	The frame should have no minibuffer.
 (minibuffer . only)	The frame should contain only a minibuffer.
 (minibuffer . WINDOW)	The frame should use WINDOW as its minibuffer window.
Jim Blandy's avatar
Jim Blandy committed
564

565 566 567
Before the frame is created (via `frame-creation-function'), functions on the
hook `before-make-frame-hook' are run.  After the frame is created, functions
on `after-make-frame-functions' are run with one arg, the newly created frame."
Jim Blandy's avatar
Jim Blandy committed
568
  (interactive)
569 570 571 572
  (run-hooks 'before-make-frame-hook)
  (let ((frame (funcall frame-creation-function parameters)))
    (run-hook-with-args 'after-make-frame-functions frame)
    frame))
Jim Blandy's avatar
Jim Blandy committed
573

574 575
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
576 577
  (let* ((frames (frame-list))
	 (list frames))
578
    (while (consp frames)
579 580
      (unless (funcall predicate (car frames))
	(setcar frames nil))
581
      (setq frames (cdr frames)))
582
    (delq nil list)))
583 584 585 586 587 588 589

(defun minibuffer-frame-list ()
  "Return a list of all frames with their own minibuffers."
  (filtered-frame-list
   (function (lambda (frame)
	       (eq frame (window-frame (minibuffer-window frame)))))))

590 591 592 593
(defun frames-on-display-list (&optional display)
  "Return a list of all frames on DISPLAY.
DISPLAY is a name of a display, a string of the form HOST:SERVER.SCREEN.
If DISPLAY is omitted or nil, it defaults to the selected frame's display."
594 595 596
  (let* ((display (or display (frame-parameter nil 'display)))
	 (func #'(lambda (frame)
		   (eq (frame-parameter frame 'display) display))))
597 598 599 600 601 602 603 604 605 606 607
    (filtered-frame-list func)))

(defun framep-on-display (&optional display)
  "Return the type of frames on DISPLAY.
DISPLAY may be a display name or a frame.  If it is a frame, its type is
returned.
If DISPLAY is omitted or nil, it defaults to the selected frame's display.
All frames on a given display are of the same type."
  (or (framep display)
      (framep (car (frames-on-display-list display)))))

608 609 610
(defun frame-remove-geometry-params (param-list)
  "Return the parameter list PARAM-LIST, but with geometry specs removed.
This deletes all bindings in PARAM-LIST for `top', `left', `width',
611
`height', `user-size' and `user-position' parameters.
612 613 614 615 616 617
Emacs uses this to avoid overriding explicit moves and resizings from
the user during startup."
  (setq param-list (cons nil param-list))
  (let ((tail param-list))
    (while (consp (cdr tail))
      (if (and (consp (car (cdr tail)))
618 619 620 621 622 623
	       (memq (car (car (cdr tail)))
		     '(height width top left user-position user-size)))
	  (progn
	    (setq frame-initial-geometry-arguments
		  (cons (car (cdr tail)) frame-initial-geometry-arguments))
	    (setcdr tail (cdr (cdr tail))))
624
	(setq tail (cdr tail)))))
625 626
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
627 628 629
  (cdr param-list))


630 631 632
(defcustom focus-follows-mouse t
  "*Non-nil if window system changes focus when you move the mouse."
  :type 'boolean
Dan Nicolaescu's avatar
Dan Nicolaescu committed
633 634
  :group 'frames
  :version "20.3")
635

636 637 638 639 640 641 642 643 644 645 646 647 648 649
(defun select-frame-set-input-focus (frame)
  "Select FRAME, raise it, and set input focus, if possible."
    (select-frame frame)
    (raise-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
    (when (eq window-system 'w32)
      (w32-focus-frame frame))
    (cond (focus-follows-mouse
	   (unless (eq window-system 'w32)
	     (set-mouse-position (selected-frame) (1- (frame-width)) 0)))
	  (t
	   (when (eq window-system 'x)
	     (x-focus-frame frame)))))

650
(defun other-frame (arg)
651
  "Select the ARG'th different visible frame, and raise it.
652 653 654 655 656 657
All frames are arranged in a cyclic order.
This command selects the frame ARG steps away in that order.
A negative ARG moves in the opposite order."
  (interactive "p")
  (let ((frame (selected-frame)))
    (while (> arg 0)
658 659 660 661
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
662
    (while (< arg 0)
663 664 665
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
666
      (setq arg (1+ arg)))
667
    (select-frame-set-input-focus frame)))
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

(defun make-frame-names-alist ()
  (let* ((current-frame (selected-frame))
	 (falist
	  (cons
	   (cons (frame-parameter current-frame 'name) current-frame) nil))
	 (frame (next-frame nil t)))
    (while (not (eq frame current-frame))
      (progn
	(setq falist (cons (cons (frame-parameter frame 'name) frame) falist))
	(setq frame (next-frame frame t))))
    falist))

(defvar frame-name-history nil)
(defun select-frame-by-name (name)
  "Select the frame whose name is NAME and raise it.
If there is no frame by that name, signal an error."
  (interactive
686 687 688 689 690
   (let* ((frame-names-alist (make-frame-names-alist))
	   (default (car (car frame-names-alist)))
	   (input (completing-read
		   (format "Select Frame (default %s): " default)
		   frame-names-alist nil t nil 'frame-name-history)))
691 692 693
     (if (= (length input) 0)
	 (list default)
       (list input))))
694 695
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
696 697 698 699
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
700 701 702 703 704 705
    (select-frame frame)
    ;; Ensure, if possible, that frame gets input focus.
    (if (eq window-system 'w32)
	(w32-focus-frame frame)
      (when focus-follows-mouse
	(set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
Jim Blandy's avatar
Jim Blandy committed
706

Jim Blandy's avatar
Jim Blandy committed
707 708 709 710
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
711 712 713 714 715 716 717 718 719 720 721 722 723
Its car is `frame-configuration'.
Each element of the cdr is a list of the form (FRAME ALIST WINDOW-CONFIG),
where
  FRAME is a frame object,
  ALIST is an association list specifying some of FRAME's parameters, and
  WINDOW-CONFIG is a window configuration object for FRAME."
  (cons 'frame-configuration
	(mapcar (function
		 (lambda (frame)
		   (list frame
			 (frame-parameters frame)
			 (current-window-configuration frame))))
		(frame-list))))
Jim Blandy's avatar
Jim Blandy committed
724

725
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
726 727
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
728
configuration, and other parameters set as specified in CONFIGURATION.
729 730
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
731
is given and non-nil, the unwanted frames are iconified instead."
732 733 734 735 736
  (or (frame-configuration-p configuration)
      (signal 'wrong-type-argument
	      (list 'frame-configuration-p configuration)))
  (let ((config-alist (cdr configuration))
	frames-to-delete)
Jim Blandy's avatar
Jim Blandy committed
737
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
738
	     (lambda (frame)
739
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
740 741
		 (if parameters
		     (progn
742 743
		       (modify-frame-parameters
			frame
Karl Heuer's avatar
Karl Heuer committed
744
			;; Since we can't set a frame's minibuffer status,
745 746 747 748 749
			;; we might as well omit the parameter altogether.
			(let* ((parms (nth 1 parameters))
			       (mini (assq 'minibuffer parms)))
			  (if mini (setq parms (delq mini parms)))
			  parms))
Jim Blandy's avatar
Jim Blandy committed
750
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
751 752
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
753
    (if nodelete
754 755 756 757 758
	;; Note: making frames invisible here was tried
	;; but led to some strange behavior--each time the frame
	;; was made visible again, the window manager asked afresh
	;; for where to put it.
	(mapcar 'iconify-frame frames-to-delete)
759
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
760

Jim Blandy's avatar
Jim Blandy committed
761 762
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
763

Jim Blandy's avatar
Jim Blandy committed
764
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
765 766
  "Return number of lines available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
Jim Blandy's avatar
Jim Blandy committed
767
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
768 769 770 771

(defun frame-width (&optional frame)
  "Return number of columns available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
Jim Blandy's avatar
Jim Blandy committed
772
  (cdr (assq 'width (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
773

774 775
(defalias 'set-default-font 'set-frame-font)
(defun set-frame-font (font-name)
776
  "Set the font of the selected frame to FONT-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
777 778
When called interactively, prompt for the name of the font to use.
To get the frame's current default font, use `frame-parameters'."
779 780 781 782 783 784 785 786
  (interactive 
   (list
    (let ((completion-ignore-case t))
      (completing-read "Font name: "
		       (mapcar #'list
			       ;; x-list-fonts will fail with an error
			       ;; if this frame doesn't support fonts.
			       (x-list-fonts "*" nil (selected-frame)))))))
Jim Blandy's avatar
Jim Blandy committed
787
  (modify-frame-parameters (selected-frame)
788
			   (list (cons 'font font-name)))
789
  (run-hooks 'after-setting-font-hook 'after-setting-font-hooks))
Jim Blandy's avatar
Jim Blandy committed
790

791
(defun set-background-color (color-name)
792
  "Set the background color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
793 794
When called interactively, prompt for the name of the color to use.
To get the frame's current background color, use `frame-parameters'."
795
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
796
  (modify-frame-parameters (selected-frame)
797
			   (list (cons 'background-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
798

799
(defun set-foreground-color (color-name)
800
  "Set the foreground color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
801 802
When called interactively, prompt for the name of the color to use.
To get the frame's current foreground color, use `frame-parameters'."
803
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
804
  (modify-frame-parameters (selected-frame)
805
			   (list (cons 'foreground-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
806 807

(defun set-cursor-color (color-name)
808
  "Set the text cursor color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
809 810
When called interactively, prompt for the name of the color to use.
To get the frame's current cursor color, use `frame-parameters'."
811
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
812
  (modify-frame-parameters (selected-frame)
813
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
814

815
(defun set-mouse-color (color-name)
816
  "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
817 818
When called interactively, prompt for the name of the color to use.
To get the frame's current mouse color, use `frame-parameters'."
819
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
820
  (modify-frame-parameters (selected-frame)
821 822 823 824
			   (list (cons 'mouse-color
				       (or color-name
					   (cdr (assq 'mouse-color
						      (frame-parameters))))))))
825

826
(defun set-border-color (color-name)
827
  "Set the color of the border of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
828 829
When called interactively, prompt for the name of the color to use.
To get the frame's current border color, use `frame-parameters'."
830
  (interactive (list (facemenu-read-color)))
831 832 833 834
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
835
  "Toggle whether or not the selected frame should auto-raise.
836 837 838 839 840
With arg, turn auto-raise mode on if and only if arg is positive.
Note that this controls Emacs's own auto-raise feature.
Some window managers allow you to enable auto-raise for certain windows.
You can use that for Emacs windows if you wish, but if you do,
that is beyond the control of Emacs and this command has no effect on it."
841 842 843 844 845
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
		-1 1)))
846 847
  (if (> arg 0)
      (raise-frame (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
848
  (modify-frame-parameters (selected-frame)
849 850
			   (list (cons 'auto-raise (> arg 0)))))

851
(defun auto-lower-mode (arg)
852
  "Toggle whether or not the selected frame should auto-lower.
853 854 855 856 857
With arg, turn auto-lower mode on if and only if arg is positive.
Note that this controls Emacs's own auto-lower feature.
Some window managers allow you to enable auto-lower for certain windows.
You can use that for Emacs windows if you wish, but if you do,
that is beyond the control of Emacs and this command has no effect on it."
858 859 860 861 862
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
		-1 1)))
Jim Blandy's avatar
Jim Blandy committed
863
  (modify-frame-parameters (selected-frame)
864
			   (list (cons 'auto-lower (> arg 0)))))
865 866 867 868 869 870 871 872
(defun set-frame-name (name)
  "Set the name of the selected frame to NAME.
When called interactively, prompt for the name of the frame.
The frame name is displayed on the modeline if the terminal displays only
one frame, otherwise the name is displayed on the frame's caption bar."
  (interactive "sFrame name: ")
  (modify-frame-parameters (selected-frame)
			   (list (cons 'name name))))
Jim Blandy's avatar
Jim Blandy committed
873

874 875 876 877 878 879 880 881 882 883 884 885 886 887
;;;; Frame/display capabilities.
(defun display-mouse-p (&optional display)
  "Return non-nil if DISPLAY has a mouse available.
DISPLAY can be a display name, a frame, or nil (meaning the selected
frame's display)."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((eq frame-type 'pc)
      (msdos-mouse-p))
     ((eq system-type 'windows-nt)
      (> w32-num-mouse-buttons 0))
     ((memq frame-type '(x mac))
      t)    ;; We assume X and Mac *always* have a pointing device
     (t
888 889 890 891 892
      (or (and (featurep 'xt-mouse)
	       xterm-mouse-mode)
	  ;; t-mouse is distributed with the GPM package.  It doesn't have
	  ;; a toggle.
	  (featurep 't-mouse))))))
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912

(defun display-popup-menus-p (&optional display)
  "Return non-nil if popup menus are supported on DISPLAY.
DISPLAY can be a display name, a frame, or nil (meaning the selected
frame's display).
Support for popup menus requires that the mouse be available."
  (and
   (let ((frame-type (framep-on-display display)))
     (memq frame-type '(x w32 pc mac)))
   (display-mouse-p display)))

(defun display-graphic-p (&optional display)
  "Return non-nil if DISPLAY is a graphic display.
Graphical displays are those which are capable of displaying several
frames and several different fonts at once.  This is true for displays
that use a window system such as X, and false for text-only terminals.
DISPLAY can be a display name, a frame, or nil (meaning the selected
frame's display)."
  (not (null (memq (framep-on-display display) '(x w32 mac)))))

913 914 915 916 917 918 919 920 921 922 923 924
(defun display-images-p (&optional display)
  "Return non-nil if DISPLAY can display images.

DISPLAY can be a display name, a frame, or nil (meaning the selected
frame's display)."
  (and (display-graphic-p display)
       (fboundp 'image-mask-p)
       (fboundp 'image-size)
       ;; FIXME: this will need to be revisited when the Windows port
       ;; supports images.
       (not (eq (framep-on-display display) 'w32))))

925 926 927
(defalias 'display-multi-frame-p 'display-graphic-p)
(defalias 'display-multi-font-p 'display-graphic-p)

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
(defun display-selections-p (&optional display)
  "Return non-nil if DISPLAY supports selections.
A selection is a way to transfer text or other data between programs
via special system buffers called `selection' or `cut buffer' or
`clipboard'.
DISPLAY can be a display name, a frame, or nil (meaning the selected
frame's display)."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((eq frame-type 'pc)
      ;; MS-DOG frames support selections when Emacs runs inside
      ;; the Windows' DOS Box.
      (not (null dos-windows-version)))
     ((memq frame-type '(x w32 mac))
      t)    ;; FIXME?
     (t
      nil))))

(defun display-screens (&optional display)
  "Return the number of screens associated with DISPLAY."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32))
      (x-display-screens display))
     (t	;; FIXME: is this correct for the Mac?
      1))))

(defun display-pixel-height (&optional display)
  "Return the height of DISPLAY's screen in pixels.
For character terminals, each character counts as a single pixel."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-pixel-height display))
     (t
      (frame-height (if (framep display) display (selected-frame)))))))

(defun display-pixel-width (&optional display)
  "Return the width of DISPLAY's screen in pixels.
For character terminals, each character counts as a single pixel."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-pixel-width display))
     (t
      (frame-width (if (framep display) display (selected-frame)))))))

(defun display-mm-height (&optional display)
  "Return the height of DISPLAY's screen in millimeters.
If the information is unavailable, value is nil."
  (and (memq (framep-on-display display) '(x w32 mac))
       (x-display-mm-height display)))

(defun display-mm-width (&optional display)
  "Return the width of DISPLAY's screen in millimeters.
If the information is unavailable, value is nil."
  (and (memq (framep-on-display display) '(x w32 mac))
       (x-display-mm-width display)))

(defun display-backing-store (&optional display)
  "Return the backing store capability of DISPLAY's screen.
The value may be `always', `when-mapped', `not-useful', or nil if
the question is inapplicable to a certain kind of display."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-backing-store display))
     (t
      'not-useful))))

(defun display-save-under (&optional display)
  "Return non-nil if DISPLAY's screen supports the SaveUnder feature."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-save-under display))
     (t
      'not-useful))))

(defun display-planes (&optional display)
  "Return the number of planes supported by DISPLAY."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-planes display))
     ((eq frame-type 'pc)
      4)
     (t
      (truncate (log (length (tty-color-alist)) 2))))))

(defun display-color-cells (&optional display)
  "Return the number of color cells supported by DISPLAY."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-color-cells display))
     ((eq frame-type 'pc)
      16)
     (t
      (length (tty-color-alist))))))

(defun display-visual-class (&optional display)
  "Returns the visual class of DISPLAY.
The value is one of the symbols `static-gray', `gray-scale',
`static-color', `pseudo-color', `true-color', or `direct-color'."
  (let ((frame-type (framep-on-display display)))
    (cond
     ((memq frame-type '(x w32 mac))
      (x-display-visual-class display))
     ((and (memq frame-type '(pc t))
	   (tty-display-color-p display))
      'static-color)
     (t
      'static-gray))))


Jim Blandy's avatar
Jim Blandy committed
1044
;;;; Aliases for backward compatibility with Emacs 18.
1045 1046
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
1047 1048

(defun set-screen-width (cols &optional pretend)
1049 1050 1051 1052
  "Obsolete function to change the size of the screen to COLS columns.
Optional second arg non-nil means that redisplay should use COLS columns
but that the idea of the actual width of the frame should not be changed.
This function is provided only for compatibility with Emacs 18; new code
Christopher Zaborsky's avatar
Christopher Zaborsky committed
1053
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056
  (set-frame-width (selected-frame) cols pretend))

(defun set-screen-height (lines &optional pretend)
1057 1058 1059 1060
  "Obsolete function to change the height of the screen to LINES lines.
Optional second arg non-nil means that redisplay should use LINES lines
but that the idea of the actual height of the screen should not be changed.
This function is provided only for compatibility with Emacs 18; new code
1061
should use `set-frame-height' instead."
Jim Blandy's avatar
Jim Blandy committed
1062 1063
  (set-frame-height (selected-frame) lines pretend))

1064 1065
(defun delete-other-frames (&optional frame)
  "Delete all frames except FRAME.
1066 1067
If FRAME uses another frame's minibuffer, the minibuffer frame is
left untouched.  FRAME nil or omitted means use the selected frame."
1068 1069 1070
  (interactive)
  (unless frame
    (setq frame (selected-frame)))
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
  (let* ((mini-frame (window-frame (minibuffer-window frame)))
	 (frames (delq mini-frame (delq frame (frame-list)))))
    ;; Delete mon-minibuffer-only frames first, because `delete-frame'
    ;; signals an error when trying to delete a mini-frame that's
    ;; still in use by another frame.
    (dolist (frame frames)
      (unless (eq (frame-parameter frame 'minibuffer) 'only)
	(delete-frame frame)))
    ;; Delete minibuffer-only frames.
    (dolist (frame frames)
      (when (eq (frame-parameter frame 'minibuffer) 'only)
	(delete-frame frame)))))
1083 1084


1085 1086 1087 1088
(make-obsolete 'screen-height 'frame-height) ;before 19.15
(make-obsolete 'screen-width  'frame-width) ;before 19.15
(make-obsolete 'set-screen-width 'set-frame-width) ;before 19.15
(make-obsolete 'set-screen-height 'set-frame-height) ;before 19.15
Jim Blandy's avatar
Jim Blandy committed
1089

1090 1091 1092 1093 1094 1095

;;; Highlighting trailing whitespace.

(make-variable-buffer-local 'show-trailing-whitespace)

(defcustom show-trailing-whitespace nil
1096 1097 1098
  "*Non-nil means highlight trailing whitespace in face `trailing-whitespace'.

Setting this variable makes it local to the current buffer."
1099 1100 1101 1102 1103 1104
  :tag "Highlight trailing whitespace."
  :set #'(lambda (symbol value) (set-default symbol value))
  :type 'boolean
  :group 'font-lock)


Gerd Moellmann's avatar
Gerd Moellmann committed
1105 1106 1107 1108 1109 1110 1111 1112 1113

;;; Scrolling

(defgroup scrolling nil
  "Scrolling windows."
  :version "21.1"
  :group 'frames)

(defcustom automatic-hscrolling t