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

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

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

Erik Naggum's avatar
Erik Naggum committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
;; 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
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25 26
;;; Code:

Jim Blandy's avatar
Jim Blandy committed
27 28 29
(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
30 31
function, which should take an alist of parameters as its argument.")

32 33 34
;;; 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.
35
(defcustom initial-frame-alist nil
36
  "*Alist of frame parameters for creating the initial X window frame.
37
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
38
 (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
39 40 41 42
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
43
`minibuffer-frame-alist'.
44 45 46

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
47
take effect until Emacs reads `.emacs', which happens after first creating
48 49 50 51 52 53
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,
54 55 56 57 58
  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
59

60 61
(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
  "*Alist of frame parameters for initially creating a minibuffer frame.
62
You can set this in your `.emacs' file; for example,
Jim Blandy's avatar
Jim Blandy committed
63
 (setq minibuffer-frame-alist
64
   '((top . 1) (left . 1) (width . 80) (height . 2)))
65
Parameters specified here supersede the values given in
66 67 68 69 70
`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
71

72 73
(defcustom pop-up-frame-alist nil
  "*Alist of frame parameters used when creating pop-up frames.
Jim Blandy's avatar
Jim Blandy committed
74
Pop-up frames are used for completions, help, and the like.
Jim Blandy's avatar
Jim Blandy committed
75
This variable can be set in your init file, like this:
Jim Blandy's avatar
Jim Blandy committed
76
  (setq pop-up-frame-alist '((width . 80) (height . 20)))
77 78 79 80 81 82
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
83

Jim Blandy's avatar
Jim Blandy committed
84
(setq pop-up-frame-function
Jim Blandy's avatar
Jim Blandy committed
85
      (function (lambda ()
86
		  (make-frame pop-up-frame-alist))))
Jim Blandy's avatar
Jim Blandy committed
87

Richard M. Stallman's avatar
Richard M. Stallman committed
88
(defcustom special-display-frame-alist
89 90 91 92 93 94 95
  '((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
96 97 98 99 100
These supersede the values given in `default-frame-alist'."
  :type '(repeat (cons :format "%v"
			 (symbol :tag "Parameter")
			 (sexp :tag "Value")))
  :group 'frames)
101

102
(defun special-display-popup-frame (buffer &optional args)
103 104 105 106 107 108 109
  "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."
110 111 112 113 114 115 116 117 118 119 120 121 122 123
  (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))))))
124

125
(defun handle-delete-frame (event)
126
  "Handle delete-frame events from the X server."
127 128 129 130 131 132 133 134 135 136 137
  (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)
138 139
      ;; Gildea@x.org says it is ok to ask questions before terminating.
      (save-buffers-kill-emacs))))
Jim Blandy's avatar
Jim Blandy committed
140

Jim Blandy's avatar
Jim Blandy committed
141
;;;; Arrangement of frames at startup
Jim Blandy's avatar
Jim Blandy committed
142 143 144

;;; 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
145
;;; file should create any frames specified in the window system defaults.
Karl Heuer's avatar
Karl Heuer committed
146
;;;
Jim Blandy's avatar
Jim Blandy committed
147
;;; 2) If no frames have been opened, we open an initial text frame.
Jim Blandy's avatar
Jim Blandy committed
148 149
;;;
;;; 3) Once the init file is done, we apply any newly set parameters
Jim Blandy's avatar
Jim Blandy committed
150
;;; in initial-frame-alist to the frame.
Jim Blandy's avatar
Jim Blandy committed
151

Karl Heuer's avatar
Karl Heuer committed
152
;; These are now called explicitly at the proper times,
153 154 155 156
;; 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
157

Jim Blandy's avatar
Jim Blandy committed
158 159
;;; If we create the initial frame, this is it.
(defvar frame-initial-frame nil)
Jim Blandy's avatar
Jim Blandy committed
160

161 162 163
;; Record the parameters used in frame-initialize to make the initial frame.
(defvar frame-initial-frame-alist)

164 165
(defvar frame-initial-geometry-arguments nil)

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

177 178 179 180 181
	;; 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))
182
	    (progn
183
	      (setq frame-initial-frame-alist
184
		    (append initial-frame-alist default-frame-alist nil))
185 186 187 188
	      (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
		  (setq frame-initial-frame-alist
			(cons '(horizontal-scroll-bars . t)
			      frame-initial-frame-alist)))
189 190
	      (setq default-minibuffer-frame
		    (setq frame-initial-frame
191
			  (make-frame frame-initial-frame-alist)))
192 193 194 195
	      ;; 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.
196
	      (setq initial-frame-alist
197
		    (frame-remove-geometry-params initial-frame-alist))))
Karl Heuer's avatar
Karl Heuer committed
198
	;; At this point, we know that we have a frame open, so we
Jim Blandy's avatar
Jim Blandy committed
199 200 201
	;; can delete the terminal frame.
	(delete-frame terminal-frame)
	(setq terminal-frame nil))
Karl Heuer's avatar
Karl Heuer committed
202

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

214 215 216
(defvar frame-notice-user-settings t
  "Non-nil means function `frame-notice-user-settings' wasn't run yet.")

217 218 219
;;; 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
220
(defun frame-notice-user-settings ()
221 222
  "Act on user's init file settings of frame parameters.
React to settings of `default-frame-alist', `initial-frame-alist' there."
223
  ;; Make menu-bar-mode and default-frame-alist consistent.
224 225 226 227 228 229 230
  (if (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)))))
231

232 233 234 235 236 237 238
  ;; 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)))

239 240 241 242 243 244 245 246 247 248 249 250 251 252
    (when (and frame-notice-user-settings
	       (null frame-initial-frame))
      ;; This case happens when we don't have a window system.
      (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
				 (append initial-frame-alist
					 default-frame-alist
					 parms
					 nil))))

253 254 255 256 257 258 259 260 261 262
    ;; If the initial frame is still around, apply initial-frame-alist
    ;; and default-frame-alist to it.
    (if (frame-live-p frame-initial-frame)

	;; 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.
	;;
Jim Blandy's avatar
Jim Blandy committed
263 264 265 266 267
	;; 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.
268 269 270 271 272
	(if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
			      (assq 'minibuffer default-frame-alist)
			      '(minibuffer . t)))
		     t))
	    ;; Create the new frame.
273 274 275 276 277 278 279 280
	    (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))
281 282 283 284
	      (setq parms (frame-parameters frame-initial-frame))
	      ;; Get rid of `name' unless it was specified explicitly before.
	      (or (assq 'name frame-initial-frame-alist)
		  (setq parms (delq (assq 'name parms) parms)))
285
	      (setq parms (append initial-frame-alist
286
				  default-frame-alist
287
				  parms
288
				  nil))
289 290 291 292
	      ;; 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)
293
		  (setq parms (assq-delete-all 'height parms)))
294
	      (if (assq 'width frame-initial-geometry-arguments)
295
		  (setq parms (assq-delete-all 'width parms)))
296
	      (if (assq 'left frame-initial-geometry-arguments)
297
		  (setq parms (assq-delete-all 'left parms)))
298
	      (if (assq 'top frame-initial-geometry-arguments)
299
		  (setq parms (assq-delete-all 'top parms)))
300 301 302 303
	      (setq new
		    (make-frame
		     ;; Use the geometry args that created the existing
		     ;; frame, rather than the parms we get for it.
304 305 306
		     (append frame-initial-geometry-arguments
			     '((user-size . t) (user-position . t))
			     parms)))
307 308 309 310
	      ;; 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))
311
		  (make-initial-minibuffer-frame nil))
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

	      ;; 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))))
Jim Blandy's avatar
Jim Blandy committed
351 352 353

	      ;; Redirect events enqueued at this frame to the new frame.
	      ;; Is this a good idea?
354
	      (redirect-frame-focus frame-initial-frame new)
Jim Blandy's avatar
Jim Blandy committed
355

356
	      ;; Finally, get rid of the old frame.
357
	      (delete-frame frame-initial-frame t))
358 359 360

	  ;; Otherwise, we don't need all that rigamarole; just apply
	  ;; the new parameters.
361 362 363
	  (let (newparms allparms tail)
	    (setq allparms (append initial-frame-alist
				   default-frame-alist))
364
	    (if (assq 'height frame-initial-geometry-arguments)
365
		(setq allparms (assq-delete-all 'height allparms)))
366
	    (if (assq 'width frame-initial-geometry-arguments)
367
		(setq allparms (assq-delete-all 'width allparms)))
368
	    (if (assq 'left frame-initial-geometry-arguments)
369
		(setq allparms (assq-delete-all 'left allparms)))
370
	    (if (assq 'top frame-initial-geometry-arguments)
371
		(setq allparms (assq-delete-all 'top allparms)))
372 373 374 375 376 377 378 379 380 381
	    (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)
382 383
		(setq oldval (assq (car (car tail))
				   frame-initial-frame-alist))
384
		(setq newval (cdr (assq (car (car tail)) allparms)))
385
		(or (and oldval (eq (cdr oldval) newval))
386 387 388
		    (setq newparms
			  (cons (cons (car (car tail)) newval) newparms))))
	      (setq tail (cdr tail)))
389
	    (setq newparms (nreverse newparms))
390
	    (modify-frame-parameters frame-initial-frame
391
				     newparms)
392 393 394 395 396 397 398
	    ;; 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))
399 400
	    (if (assq 'font newparms)
		(frame-update-faces frame-initial-frame)))))
Jim Blandy's avatar
Jim Blandy committed
401

402 403 404 405
    ;; Restore the original buffer.
    (set-buffer old-buffer)

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

410 411 412 413 414 415
(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))))

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

Jim Blandy's avatar
Jim Blandy committed
418
(defun get-other-frame ()
419 420 421
  "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
422
  (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
423
	       (make-frame)
Jim Blandy's avatar
Jim Blandy committed
424
	     (next-frame (selected-frame)))))
Jim Blandy's avatar
Jim Blandy committed
425 426
    s))

Jim Blandy's avatar
Jim Blandy committed
427 428
(defun next-multiframe-window ()
  "Select the next window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432 433
  (interactive)
  (select-window (next-window (selected-window)
			      (> (minibuffer-depth) 0)
			      t)))

Jim Blandy's avatar
Jim Blandy committed
434 435
(defun previous-multiframe-window ()
  "Select the previous window, regardless of which frame it is on."
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439 440
  (interactive)
  (select-window (previous-window (selected-window)
				  (> (minibuffer-depth) 0)
				  t)))

441 442 443 444
(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: ")
445 446
  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
447 448
  (make-frame (cons (cons 'display display) parameters)))

449 450 451
(defun make-frame-command ()
  "Make a new frame, and select it if the terminal displays only one frame."
  (interactive)
452
  (if (and window-system (not (eq window-system 'pc)))
453 454 455
      (make-frame)
    (select-frame (make-frame))))

456 457 458 459 460 461 462
(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.")

463 464 465
(defvar after-setting-font-hooks nil
  "Functions to run after a frame's font has been changed.")

466
;; Alias, kept temporarily.
467
(defalias 'new-frame 'make-frame)
Jim Blandy's avatar
Jim Blandy committed
468

469 470 471 472
(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
473

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

476 477
 (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
478

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

481 482 483 484
 (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
485

486 487 488
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
489
  (interactive)
490 491 492 493
  (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
494

495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
(defun filtered-frame-list (predicate)
  "Return a list of all live frames which satisfy PREDICATE."
  (let ((frames (frame-list))
	good-frames)
    (while (consp frames)
      (if (funcall predicate (car frames))
	  (setq good-frames (cons (car frames) good-frames)))
      (setq frames (cdr frames)))
    good-frames))

(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)))))))

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
(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."
  (let* ((display (or display
		      (cdr (assoc 'display (frame-parameters)))))
	 (func
	  (function (lambda (frame)
		      (eq (cdr (assoc 'display (frame-parameters frame)))
			  display)))))
    (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)))))

532 533 534
(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',
535
`height', `user-size' and `user-position' parameters.
536 537 538 539 540 541
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)))
542 543 544 545 546 547
	       (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))))
548
	(setq tail (cdr tail)))))
549 550
  (setq frame-initial-geometry-arguments
	(nreverse frame-initial-geometry-arguments))
551 552 553
  (cdr param-list))


554 555 556
(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
557 558
  :group 'frames
  :version "20.3")
559

560
(defun other-frame (arg)
561
  "Select the ARG'th different visible frame, and raise it.
562 563 564 565 566 567
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)
568 569 570 571
      (setq frame (next-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (next-frame frame)))
      (setq arg (1- arg)))
572
    (while (< arg 0)
573 574 575
      (setq frame (previous-frame frame))
      (while (not (eq (frame-visible-p frame) t))
	(setq frame (previous-frame frame)))
576
      (setq arg (1+ arg)))
577
    (select-frame frame)
578
    (raise-frame frame)
579
    ;; Ensure, if possible, that frame gets input focus.
580 581 582 583 584 585 586
    (cond ((eq window-system 'x)
	   (x-focus-frame frame))
	  ((eq window-system 'w32)
	   (w32-focus-frame frame)))
    (when (and (not (eq window-system 'w32))
	       focus-follows-mouse)
      (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604

(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
605 606 607 608 609
   (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)))
610 611 612
     (if (= (length input) 0)
	 (list default)
       (list input))))
613 614
  (let* ((frame-names-alist (make-frame-names-alist))
	 (frame (cdr (assoc name frame-names-alist))))
615 616 617 618
    (or frame
	(error "There is no frame named `%s'" name))
    (make-frame-visible frame)
    (raise-frame frame)
619 620 621 622 623 624
    (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
625

Jim Blandy's avatar
Jim Blandy committed
626 627 628 629
;;;; Frame configurations

(defun current-frame-configuration ()
  "Return a list describing the positions and states of all frames.
630 631 632 633 634 635 636 637 638 639 640 641 642
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
643

644
(defun set-frame-configuration (configuration &optional nodelete)
Jim Blandy's avatar
Jim Blandy committed
645 646
  "Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
647
configuration, and other parameters set as specified in CONFIGURATION.
648 649
Ordinarily, this function deletes all existing frames not
listed in CONFIGURATION.  But if optional second argument NODELETE
650
is given and non-nil, the unwanted frames are iconified instead."
651 652 653 654 655
  (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
656
    (mapcar (function
Jim Blandy's avatar
Jim Blandy committed
657
	     (lambda (frame)
658
	       (let ((parameters (assq frame config-alist)))
Jim Blandy's avatar
Jim Blandy committed
659 660
		 (if parameters
		     (progn
661 662
		       (modify-frame-parameters
			frame
Karl Heuer's avatar
Karl Heuer committed
663
			;; Since we can't set a frame's minibuffer status,
664 665 666 667 668
			;; 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
669
		       (set-window-configuration (nth 2 parameters)))
Jim Blandy's avatar
Jim Blandy committed
670 671
		   (setq frames-to-delete (cons frame frames-to-delete))))))
	    (frame-list))
672
    (if nodelete
673 674 675 676 677
	;; 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)
678
      (mapcar 'delete-frame frames-to-delete))))
Jim Blandy's avatar
Jim Blandy committed
679

Jim Blandy's avatar
Jim Blandy committed
680 681
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
Jim Blandy's avatar
Jim Blandy committed
682

683
(defun frame-parameter (frame parameter)
684
  "Return FRAME's value for parameter PARAMETER.
685
If FRAME is nil, describe the currently selected frame."
686
  (cdr (assq parameter (frame-parameters frame))))
687

Jim Blandy's avatar
Jim Blandy committed
688
(defun frame-height (&optional frame)
Jim Blandy's avatar
Jim Blandy committed
689 690
  "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
691
  (cdr (assq 'height (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
692 693 694 695

(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
696
  (cdr (assq 'width (frame-parameters frame))))
Jim Blandy's avatar
Jim Blandy committed
697

698 699
(defalias 'set-default-font 'set-frame-font)
(defun set-frame-font (font-name)
700
  "Set the font of the selected frame to FONT-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
701 702
When called interactively, prompt for the name of the font to use.
To get the frame's current default font, use `frame-parameters'."
Jim Blandy's avatar
Jim Blandy committed
703
  (interactive "sFont name: ")
Jim Blandy's avatar
Jim Blandy committed
704
  (modify-frame-parameters (selected-frame)
705 706
			   (list (cons 'font font-name)))
  ;; Update faces that want a bold or italic version of the default font.
707 708
  (frame-update-faces (selected-frame))
  (run-hooks 'after-setting-font-hooks))
Jim Blandy's avatar
Jim Blandy committed
709

710
(defun set-background-color (color-name)
711
  "Set the background color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
712 713
When called interactively, prompt for the name of the color to use.
To get the frame's current background color, use `frame-parameters'."
714
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
715
  (modify-frame-parameters (selected-frame)
716 717
			   (list (cons 'background-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
718

719
(defun set-foreground-color (color-name)
720
  "Set the foreground color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
721 722
When called interactively, prompt for the name of the color to use.
To get the frame's current foreground color, use `frame-parameters'."
723
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
724
  (modify-frame-parameters (selected-frame)
725 726
			   (list (cons 'foreground-color color-name)))
  (frame-update-face-colors (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
727 728

(defun set-cursor-color (color-name)
729
  "Set the text cursor color of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
730 731
When called interactively, prompt for the name of the color to use.
To get the frame's current cursor color, use `frame-parameters'."
732
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
733
  (modify-frame-parameters (selected-frame)
734
			   (list (cons 'cursor-color color-name))))
Jim Blandy's avatar
Jim Blandy committed
735

736
(defun set-mouse-color (color-name)
737
  "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
738 739
When called interactively, prompt for the name of the color to use.
To get the frame's current mouse color, use `frame-parameters'."
740
  (interactive (list (facemenu-read-color)))
Jim Blandy's avatar
Jim Blandy committed
741
  (modify-frame-parameters (selected-frame)
742 743 744 745
			   (list (cons 'mouse-color
				       (or color-name
					   (cdr (assq 'mouse-color
						      (frame-parameters))))))))
746

747
(defun set-border-color (color-name)
748
  "Set the color of the border of the selected frame to COLOR-NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
749 750
When called interactively, prompt for the name of the color to use.
To get the frame's current border color, use `frame-parameters'."
751
  (interactive (list (facemenu-read-color)))
752 753 754 755
  (modify-frame-parameters (selected-frame)
			   (list (cons 'border-color color-name))))

(defun auto-raise-mode (arg)
756
  "Toggle whether or not the selected frame should auto-raise.
757 758 759 760 761
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."
762 763 764 765 766
  (interactive "P")
  (if (null arg)
      (setq arg
	    (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
		-1 1)))
767 768
  (if (> arg 0)
      (raise-frame (selected-frame)))
Jim Blandy's avatar
Jim Blandy committed
769
  (modify-frame-parameters (selected-frame)
770 771
			   (list (cons 'auto-raise (> arg 0)))))

772
(defun auto-lower-mode (arg)
773
  "Toggle whether or not the selected frame should auto-lower.
774 775 776 777 778
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."
779 780 781 782 783
  (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
784
  (modify-frame-parameters (selected-frame)
785
			   (list (cons 'auto-lower (> arg 0)))))
786 787 788 789 790 791 792 793
(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
794

795 796 797 798 799 800 801 802 803 804 805 806 807 808
;;;; 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
809 810 811 812 813
      (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))))))
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949

(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)))))

(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
950
;;;; Aliases for backward compatibility with Emacs 18.
951 952
(defalias 'screen-height 'frame-height)
(defalias 'screen-width 'frame-width)
Jim Blandy's avatar
Jim Blandy committed
953 954

(defun set-screen-width (cols &optional pretend)
955 956 957 958
  "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
959
should use `set-frame-width instead'."
Jim Blandy's avatar
Jim Blandy committed
960 961 962
  (set-frame-width (selected-frame) cols pretend))

(defun set-screen-height (lines &optional pretend)
963 964 965 966
  "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
967
should use `set-frame-height' instead."
Jim Blandy's avatar
Jim Blandy committed
968 969
  (set-frame-height (selected-frame) lines pretend))

970 971 972 973 974 975 976 977 978
(defun delete-other-frames (&optional frame)
  "Delete all frames except FRAME.
FRAME nil or omitted means delete all frames except the selected frame."
  (interactive)
  (unless frame
    (setq frame (selected-frame)))
  (mapcar 'delete-frame (delq frame (frame-list))))


Jim Blandy's avatar
Jim Blandy committed
979 980 981 982
(make-obsolete 'screen-height 'frame-height)
(make-obsolete 'screen-width  'frame-width)
(make-obsolete 'set-screen-width 'set-frame-width)
(make-obsolete 'set-screen-height 'set-frame-height)
Jim Blandy's avatar
Jim Blandy committed
983

984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000

;;; Highlighting trailing whitespace.

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

(defcustom show-trailing-whitespace nil
  "*Non-nil means highlight trailing whitespace in face `trailing-whitespace'."
  :tag "Highlight trailing whitespace."
  :set #'(lambda (symbol value) (set-default symbol value))
  :type 'boolean
  :group 'font-lock)



;;; Blinking cursor

(defgroup cursor nil
Gerd Moellmann's avatar
Gerd Moellmann committed
1001
  "Displaying text cursors."
1002
  :version "21.1"
1003 1004 1005
  :group 'frames)

(defcustom blink-cursor-delay 0.5
Gerd Moellmann's avatar
Gerd Moellmann committed
1006
  "*Seconds of idle time after which cursor starts to blink."
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
  :tag "Delay in seconds."
  :type 'number
  :group 'cursor)

(defcustom blink-cursor-interval 0.5
  "*Length of cursor blink interval in seconds."
  :tag "Blink interval in seconds."
  :type 'number
  :group 'cursor)

(defvar blink-cursor-idle-timer nil
Gerd Moellmann's avatar
Gerd Moellmann committed
1018 1019
  "Timer started after `blink-cursor-delay' seconds of Emacs idle time.
The function `blink-cursor-start' is called when the timer fires.")
1020 1021

(defvar blink-cursor-timer nil
Gerd Moellmann's avatar
Gerd Moellmann committed
1022 1023
  "Timer started from `blink-cursor-start'.
This timer calls `blink-cursor' every `blink-cursor-interval' seconds.")
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046

(defvar blink-cursor-mode nil
  "Non-nil means blinking cursor is active.")

(defun blink-cursor-mode (arg)
  "Toggle blinking cursor mode.
With arg, turn blinking cursor mode on iff arg is positive.
When blinking cursor mode is enabled, the cursor of the selected
window blinks."
  (interactive "P")
  (let ((on-p (if (null arg)
		  (not blink-cursor-mode)
		(> (prefix-numeric-value arg) 0))))
    (if blink-cursor-idle-timer
	(cancel-timer blink-cursor-idle-timer))
    (if blink-cursor-timer
	(cancel-timer blink-cursor-timer))
    (setq blink-cursor-idle-timer nil
	  blink-cursor-timer nil
	  blink-cursor-mode nil)
    (if on-p
	(progn
	  ;; Hide the cursor.
1047
	  (internal-show-cursor nil nil)
1048 1049 1050 1051
	  (setq blink-cursor-idle-timer
		(