]> code.delx.au - gnu-emacs/blobdiff - lisp/frame.el
(blink-cursor-mode): Call internal-show-cursor instead
[gnu-emacs] / lisp / frame.el
index 96d103e1229d44de86ea1da2c85b06be1ad862e6..3f35adc5f5bfe176874f6fcd8f853f6cf449fbde 100644 (file)
@@ -32,8 +32,8 @@ function, which should take an alist of parameters as its argument.")
 ;;; 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.
-(defvar initial-frame-alist nil
-  "Alist of frame parameters for creating the initial X window frame.
+(defcustom initial-frame-alist nil
+  "*Alist of frame parameters for creating the initial X window frame.
 You can set this in your `.emacs' file; for example,
  (setq initial-frame-alist '((top . 1) (left . 1) (width . 80) (height . 55)))
 Parameters specified here supersede the values given in `default-frame-alist'.
@@ -51,22 +51,35 @@ as it appears, you need to use this three-step process:
 * 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,
-  to override what you put in `default-frame-alist'.")
+  to override what you put in `default-frame-alist'."
+  :type '(repeat (cons :format "%v"
+                      (symbol :tag "Parameter")
+                      (sexp :tag "Value")))
+  :group 'frames)
 
-(defvar minibuffer-frame-alist '((width . 80) (height . 2))
-  "Alist of frame parameters for initially creating a minibuffer frame.
+(defcustom minibuffer-frame-alist '((width . 80) (height . 2))
+  "*Alist of frame parameters for initially creating a minibuffer frame.
 You can set this in your `.emacs' file; for example,
  (setq minibuffer-frame-alist
    '((top . 1) (left . 1) (width . 80) (height . 2)))
 Parameters specified here supersede the values given in
-`default-frame-alist'.")
+`default-frame-alist', for a minibuffer frame."
+  :type '(repeat (cons :format "%v"
+                      (symbol :tag "Parameter")
+                      (sexp :tag "Value")))
+  :group 'frames)
 
-(defvar pop-up-frame-alist nil
-  "Alist of frame parameters used when creating pop-up frames.
+(defcustom pop-up-frame-alist nil
+  "*Alist of frame parameters used when creating pop-up frames.
 Pop-up frames are used for completions, help, and the like.
 This variable can be set in your init file, like this:
   (setq pop-up-frame-alist '((width . 80) (height . 20)))
-These supersede the values given in `default-frame-alist'.")
+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)
 
 (setq pop-up-frame-function
       (function (lambda ()
@@ -86,14 +99,14 @@ These supersede the values given in `default-frame-alist'."
                         (sexp :tag "Value")))
   :group 'frames)
 
-;; 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.
 (defun special-display-popup-frame (buffer &optional args)
+  "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."
   (if (and args (symbolp (car args)))
       (apply (car args) buffer (cdr args))
     (let ((window (get-buffer-window buffer t)))
@@ -109,8 +122,8 @@ These supersede the values given in `default-frame-alist'."
          (set-window-dedicated-p (frame-selected-window frame) t)
          (frame-selected-window frame))))))
 
-;; Handle delete-frame events from the X server.
 (defun handle-delete-frame (event)
+  "Handle delete-frame events from the X server."
   (interactive "e")
   (let ((frame (posn-window (event-start event)))
        (i 0)
@@ -154,7 +167,7 @@ These supersede the values given in `default-frame-alist'."
 ;;; file - if there is no frame with a minibuffer open now, create
 ;;; one to display messages while loading the init file.
 (defun frame-initialize ()
-
+  "Create an in initial frame if necessary."
   ;; Are we actually running under a window system at all?
   (if (and window-system (not noninteractive) (not (eq window-system 'pc)))
       (progn
@@ -168,7 +181,7 @@ These supersede the values given in `default-frame-alist'."
        (or (delq terminal-frame (minibuffer-frame-list))
            (progn
              (setq frame-initial-frame-alist
-                   (append initial-frame-alist default-frame-alist))
+                   (append initial-frame-alist default-frame-alist nil))
              (or (assq 'horizontal-scroll-bars frame-initial-frame-alist)
                  (setq frame-initial-frame-alist
                        (cons '(horizontal-scroll-bars . t)
@@ -191,8 +204,8 @@ These supersede the values given in `default-frame-alist'."
     ;; we support that feature, otherwise arrange to cause errors.
     (or (eq window-system 'pc)
        (setq frame-creation-function
-             (if (fboundp 'make-terminal-frame)
-                 'make-terminal-frame
+             (if (fboundp 'tty-create-frame-with-faces)
+                 'tty-create-frame-with-faces
                (function
                 (lambda (parameters)
                   (error
@@ -202,7 +215,8 @@ These supersede the values given in `default-frame-alist'."
 ;;; file.  Now default-frame-alist and initial-frame-alist contain
 ;;; information to which we must react; do what needs to be done.
 (defun frame-notice-user-settings ()
-
+  "Act on user's init file settings of frame parameters.
+React to settings of `default-frame-alist', `initial-frame-alist' there."
   ;; Make menu-bar-mode and default-frame-alist consistent.
   (if (boundp 'menu-bar-mode)
       (let ((default (assq 'menu-bar-lines default-frame-alist)))
@@ -259,13 +273,13 @@ These supersede the values given in `default-frame-alist'."
              ;; when we first made the frame.
              (setq parms (cons '(reverse) (delq (assq 'reverse parms) parms)))
              (if (assq 'height frame-initial-geometry-arguments)
-                 (setq parms (frame-delete-all 'height parms)))
+                 (setq parms (assoc-delete-all 'height parms)))
              (if (assq 'width frame-initial-geometry-arguments)
-                 (setq parms (frame-delete-all 'width parms)))
+                 (setq parms (assoc-delete-all 'width parms)))
              (if (assq 'left frame-initial-geometry-arguments)
-                 (setq parms (frame-delete-all 'left parms)))
+                 (setq parms (assoc-delete-all 'left parms)))
              (if (assq 'top frame-initial-geometry-arguments)
-                 (setq parms (frame-delete-all 'top parms)))
+                 (setq parms (assoc-delete-all 'top parms)))
              (setq new
                    (make-frame
                     ;; Use the geometry args that created the existing
@@ -331,13 +345,13 @@ These supersede the values given in `default-frame-alist'."
            (setq allparms (append initial-frame-alist
                                   default-frame-alist))
            (if (assq 'height frame-initial-geometry-arguments)
-               (setq allparms (frame-delete-all 'height allparms)))
+               (setq allparms (assoc-delete-all 'height allparms)))
            (if (assq 'width frame-initial-geometry-arguments)
-               (setq allparms (frame-delete-all 'width allparms)))
+               (setq allparms (assoc-delete-all 'width allparms)))
            (if (assq 'left frame-initial-geometry-arguments)
-               (setq allparms (frame-delete-all 'left allparms)))
+               (setq allparms (assoc-delete-all 'left allparms)))
            (if (assq 'top frame-initial-geometry-arguments)
-               (setq allparms (frame-delete-all 'top allparms)))
+               (setq allparms (assoc-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
@@ -358,6 +372,13 @@ These supersede the values given in `default-frame-alist'."
            (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))
            (if (assq 'font newparms)
                (frame-update-faces frame-initial-frame)))))
 
@@ -374,23 +395,12 @@ These supersede the values given in `default-frame-alist'."
        (make-frame-on-display display parms)
       (make-frame parms))))
 
-;; Delete from ALIST all elements whose car is KEY.
-;; Return the modified alist.
-(defun frame-delete-all (key alist)
-  (setq alist (copy-sequence alist))
-  (let ((tail alist))
-    (while tail
-      (if (eq (car (car tail)) key)
-         (setq alist (delq (car tail) alist)))
-      (setq tail (cdr tail)))
-    alist))
-\f
 ;;;; Creation of additional frames, and other frame miscellanea
 
-;;; Return some frame other than the current frame, creating one if
-;;; necessary.  Note that the minibuffer frame, if separate, is not
-;;; considered (see next-frame).
 (defun get-other-frame ()
+  "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')."
   (let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
               (make-frame)
             (next-frame (selected-frame)))))
@@ -414,6 +424,8 @@ These supersede the values given in `default-frame-alist'."
   "Make a frame on display DISPLAY.
 The optional second argument PARAMETERS specifies additional frame parameters."
   (interactive "sMake frame on display: ")
+  (or (string-match "\\`[^:]*:[0-9]+\\(\\.[0-9]+\\)?\\'" display)
+      (error "Invalid display, not HOST:SERVER or HOST:SERVER.SCREEN"))
   (make-frame (cons (cons 'display display) parameters)))
 
 (defun make-frame-command ()
@@ -430,6 +442,9 @@ The optional second argument PARAMETERS specifies additional frame parameters."
   "Functions to run after a frame is created.
 The functions are run with one arg, the newly created frame.")
 
+(defvar after-setting-font-hooks nil
+  "Functions to run after a frame's font has been changed.")
+
 ;; Alias, kept temporarily.
 (defalias 'new-frame 'make-frame)
 
@@ -497,6 +512,12 @@ the user during startup."
   (cdr param-list))
 
 
+(defcustom focus-follows-mouse t
+  "*Non-nil if window system changes focus when you move the mouse."
+  :type 'boolean
+  :group 'frames
+  :version "20.3")
+
 (defun other-frame (arg)
   "Select the ARG'th different visible frame, and raise it.
 All frames are arranged in a cyclic order.
@@ -519,7 +540,46 @@ A negative ARG moves in the opposite order."
     ;; Ensure, if possible, that frame gets input focus.
     (if (eq window-system 'w32)
        (w32-focus-frame frame)
-      (set-mouse-position (selected-frame) (1- (frame-width)) 0))))
+      (when focus-follows-mouse
+       (set-mouse-position (selected-frame) (1- (frame-width)) 0)))))
+
+(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
+   (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)))
+     (if (= (length input) 0)
+        (list default)
+       (list input))))
+  (let* ((frame-names-alist (make-frame-names-alist))
+        (frame (cdr (assoc name frame-names-alist))))
+    (or frame
+       (error "There is no frame named `%s'" name))
+    (make-frame-visible frame)
+    (raise-frame frame)
+    (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)))))
 \f
 ;;;; Frame configurations
 
@@ -580,7 +640,7 @@ is given and non-nil, the unwanted frames are iconified instead."
 
 (defun frame-parameter (frame parameter)
   "Return FRAME's value for parameter PARAMETER.
-If FRAME is omitted, describe the currently selected frame."
+If FRAME is nil, describe the currently selected frame."
   (cdr (assq parameter (frame-parameters frame))))
 
 (defun frame-height (&optional frame)
@@ -595,54 +655,58 @@ If FRAME is omitted, describe the currently selected frame."
 
 (defalias 'set-default-font 'set-frame-font)
 (defun set-frame-font (font-name)
-  "Set the font of the selected frame to FONT.
+  "Set the font of the selected frame to FONT-NAME.
 When called interactively, prompt for the name of the font to use.
 To get the frame's current default font, use `frame-parameters'."
   (interactive "sFont name: ")
   (modify-frame-parameters (selected-frame)
                           (list (cons 'font font-name)))
   ;; Update faces that want a bold or italic version of the default font.
-  (frame-update-faces (selected-frame)))
+  (frame-update-faces (selected-frame))
+  (run-hooks 'after-setting-font-hooks))
 
 (defun set-background-color (color-name)
-  "Set the background color of the selected frame to COLOR.
+  "Set the background color of the selected frame to COLOR-NAME.
 When called interactively, prompt for the name of the color to use.
 To get the frame's current background color, use `frame-parameters'."
-  (interactive "sColor: ")
+  (interactive (list (facemenu-read-color)))
   (modify-frame-parameters (selected-frame)
                           (list (cons 'background-color color-name)))
   (frame-update-face-colors (selected-frame)))
 
 (defun set-foreground-color (color-name)
-  "Set the foreground color of the selected frame to COLOR.
+  "Set the foreground color of the selected frame to COLOR-NAME.
 When called interactively, prompt for the name of the color to use.
 To get the frame's current foreground color, use `frame-parameters'."
-  (interactive "sColor: ")
+  (interactive (list (facemenu-read-color)))
   (modify-frame-parameters (selected-frame)
                           (list (cons 'foreground-color color-name)))
   (frame-update-face-colors (selected-frame)))
 
 (defun set-cursor-color (color-name)
-  "Set the text cursor color of the selected frame to COLOR.
+  "Set the text cursor color of the selected frame to COLOR-NAME.
 When called interactively, prompt for the name of the color to use.
 To get the frame's current cursor color, use `frame-parameters'."
-  (interactive "sColor: ")
+  (interactive (list (facemenu-read-color)))
   (modify-frame-parameters (selected-frame)
                           (list (cons 'cursor-color color-name))))
 
 (defun set-mouse-color (color-name)
-  "Set the color of the mouse pointer of the selected frame to COLOR.
+  "Set the color of the mouse pointer of the selected frame to COLOR-NAME.
 When called interactively, prompt for the name of the color to use.
 To get the frame's current mouse color, use `frame-parameters'."
-  (interactive "sColor: ")
+  (interactive (list (facemenu-read-color)))
   (modify-frame-parameters (selected-frame)
-                          (list (cons 'mouse-color color-name))))
+                          (list (cons 'mouse-color
+                                      (or color-name
+                                          (cdr (assq 'mouse-color
+                                                     (frame-parameters))))))))
 
 (defun set-border-color (color-name)
-  "Set the color of the border of the selected frame to COLOR.
+  "Set the color of the border of the selected frame to COLOR-NAME.
 When called interactively, prompt for the name of the color to use.
 To get the frame's current border color, use `frame-parameters'."
-  (interactive "sColor: ")
+  (interactive (list (facemenu-read-color)))
   (modify-frame-parameters (selected-frame)
                           (list (cons 'border-color color-name))))
 
@@ -658,6 +722,8 @@ that is beyond the control of Emacs and this command has no effect on it."
       (setq arg
            (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
                -1 1)))
+  (if (> arg 0)
+      (raise-frame (selected-frame)))
   (modify-frame-parameters (selected-frame)
                           (list (cons 'auto-raise (> arg 0)))))
 
@@ -675,24 +741,32 @@ that is beyond the control of Emacs and this command has no effect on it."
                -1 1)))
   (modify-frame-parameters (selected-frame)
                           (list (cons 'auto-lower (> arg 0)))))
+(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))))
 \f
 ;;;; Aliases for backward compatibility with Emacs 18.
 (defalias 'screen-height 'frame-height)
 (defalias 'screen-width 'frame-width)
 
 (defun set-screen-width (cols &optional pretend)
-  "Obsolete function to change the size of the screen to COLS columns.\n\
-Optional second arg non-nil means that redisplay should use COLS columns\n\
-but that the idea of the actual width of the frame should not be changed.\n\
-This function is provided only for compatibility with Emacs 18; new code\n\
+  "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
 should use `set-frame-width instead'."
   (set-frame-width (selected-frame) cols pretend))
 
 (defun set-screen-height (lines &optional pretend)
-  "Obsolete function to change the height of the screen to LINES lines.\n\
-Optional second arg non-nil means that redisplay should use LINES lines\n\
-but that the idea of the actual height of the screen should not be changed.\n\
-This function is provided only for compatibility with Emacs 18; new code\n\
+  "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
 should use `set-frame-height' instead."
   (set-frame-height (selected-frame) lines pretend))
 
@@ -701,6 +775,120 @@ should use `set-frame-height' instead."
 (make-obsolete 'set-screen-width 'set-frame-width)
 (make-obsolete 'set-screen-height 'set-frame-height)
 
+\f
+;;; 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)
+
+
+\f
+;;; Blinking cursor
+
+(defgroup cursor nil
+  "Cursor on frames."
+  :version "21.1"
+  :group 'frames)
+
+(defcustom blink-cursor-delay 0.5
+  "*Seconds of Emacs idle time after which cursor starts to blink."
+  :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
+  "Timer started after blink-cursor-delay seconds of Emacs idle time.
+The function blink-cursor-start is called when the timer fires.")
+
+(defvar blink-cursor-timer nil
+  "Time started from blink-cursor-start.  This timer calls blink-cursor
+every blink-cursor-interval seconds.")
+
+(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.
+         (internal-show-cursor 0)
+         (setq blink-cursor-idle-timer
+               (run-with-idle-timer blink-cursor-delay
+                                    blink-cursor-delay
+                                    'blink-cursor-start))
+         (setq blink-cursor-mode t)))))
+
+(defcustom blink-cursor (not (eq system-type 'ms-dos))
+  "*Non-nil means blink-cursor-mode is active."
+  :tag "Blinking cursor"
+  :type 'boolean
+  :group 'cursor
+  :set #'(lambda (symbol value)
+          (set-default symbol value)
+          (blink-cursor-mode (or value 0))))
+
+(defun blink-cursor-start ()
+  "Timer function called from timer blink-cursor-idle-timer.
+Starts the timer blink-cursor-timer which lets the cursor blink
+if the selected frame has a non-nil `cursor-blinking' frame parameter.
+Arranges to cancel that timer by installing a pre command hook."
+  (when (null blink-cursor-timer)
+    (add-hook 'pre-command-hook 'blink-cursor-end)
+    (setq blink-cursor-timer
+         (run-with-timer blink-cursor-interval blink-cursor-interval
+                         'internal-show-cursor))))
+
+(defun blink-cursor-end ()
+  "Stop cursor blinking.
+Installed as a pre-command hook by blink-cursor-start.  Cancels
+the timer blink-cursor-timer and removes itself from the hook."
+  (remove-hook 'pre-command-hook 'blink-cursor-end)
+  (internal-show-cursor 0)
+  (cancel-timer blink-cursor-timer)
+  (setq blink-cursor-timer nil))
+
+
+\f
+;;; Busy-cursor.
+
+(defcustom busy-cursor t
+  "*Non-nil means show a busy-cursor when running under a window-system."
+  :tag "Busy-cursor"
+  :type 'boolean
+  :group 'cursor
+  :get #'(lambda (symbol) display-busy-cursor)
+  :set #'(lambda (symbol value)
+          (set-default symbol value)
+          (setq display-busy-cursor value)))
+
+
 \f
 ;;;; Key bindings
 
@@ -711,3 +899,4 @@ should use `set-frame-height' instead."
 (provide 'frame)
 
 ;;; frame.el ends here
+(frame-notice-user-settings):