;;; frame.el --- multi-frame management independent of window systems.
+;;;; Copyright (C) 1993 Free Software Foundation, Inc.
+
;; Maintainer: FSF
-;; Last-Modified: 09 Jul 92
;; Keywords: internal
-;;;; Copyright (C) 1990, 1992 Free Software Foundation, Inc.
-
;;; This file is part of GNU Emacs.
;;;
;;; GNU Emacs is free software; you can redistribute it and/or modify
The window system startup file should set this to its frame creation
function, which should take an alist of parameters as its argument.")
-;;; The default value for this must ask for a minibuffer. There must
-;;; always exist a frame with a minibuffer, and after we delete the
-;;; terminal frame, this will be the only frame.
-(defvar initial-frame-alist '((minibuffer . nil))
- "Alist of values used when creating the initial emacs text frame.
-These may be set in your init file, like this:
+;;; The initial value given here for this must ask for a minibuffer.
+;;; There must always exist a frame with a minibuffer, and after we
+;;; delete the terminal frame, this will be the only frame.
+(defvar initial-frame-alist '((minibuffer . t))
+ "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)))
-These supercede the values given in frame-default-alist.")
-
-(defvar minibuffer-frame-alist nil
- "Alist of values to apply to a minibuffer frame.
-These may be set in your init file, like this:
+If the value calls for a frame without a minibuffer, and you do not create a
+minibuffer frame on your own, one is created according to
+`minibuffer-frame-alist'.
+Parameters specified here supersede the values given in
+`default-frame-alist'.")
+
+(defvar 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 . 1)))
-These supercede the values given in default-frame-alist.")
+ '((top . 1) (left . 1) (width . 80) (height . 2)))
+Parameters specified here supersede the values given in
+`default-frame-alist'.")
(defvar pop-up-frame-alist nil
- "Alist of values used when creating pop-up frames.
+ "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 supercede the values given in default-frame-alist.")
+These supercede the values given in `default-frame-alist'.")
(setq pop-up-frame-function
(function (lambda ()
;; Are we actually running under a window system at all?
(if (and window-system (not noninteractive))
- (let ((frames (frame-list)))
-
- ;; Look for a frame that has a minibuffer.
- (while (and frames
- (or (eq (car frames) terminal-frame)
- (not (cdr (assq 'minibuffer
- (frame-parameters
- (car frames)))))))
- (setq frames (cdr frames)))
-
- ;; If there was none, then we need to create the opening frame.
- (or frames
+ (progn
+ ;; 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))
(setq default-minibuffer-frame
(setq frame-initial-frame
(new-frame initial-frame-alist))))
-
+
;; At this point, we know that we have a frame open, so we
;; can delete the terminal frame.
(delete-frame terminal-frame)
(function
(lambda (parameters)
(error
- "Can't create multiple frames without a window system."))))))
+ "Can't create multiple frames without a window system"))))))
-;;; startup.el calls this function after loading the user's init file.
-;;; If we created a minibuffer before knowing if we had permission, we
-;;; need to see if it should go away or change. Create a text frame
-;;; here.
+;;; 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.
(defun frame-notice-user-settings ()
- (if frame-initial-frame
- (progn
-
- ;; If the user wants a minibuffer-only frame, we'll have to
- ;; make a new one; you can't remove or add a root window to/from
- ;; an existing frame.
- (if (eq (cdr (or (assq 'minibuffer initial-frame-alist)
- '(minibuffer . t)))
- 'only)
- (progn
- (setq default-minibuffer-frame
- (new-frame
- (append initial-frame-alist
- (frame-parameters frame-initial-frame))))
+
+ ;; 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)))
+
+ ;; 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.
+ ;;
+ ;; 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.
+ (if (not (eq (cdr (or (assq 'minibuffer initial-frame-alist)
+ (assq 'minibuffer default-frame-alist)
+ '(minibuffer . t)))
+ t))
+ ;; Create the new frame.
+ (let ((new
+ (new-frame
+ (append initial-frame-alist
+ default-frame-alist
+ (frame-parameters frame-initial-frame)))))
+
+ ;; 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))
+ (new-frame (append minibuffer-frame-alist
+ '((minibuffer . only)))))
+
+ ;; 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))
+
+ ;; Otherwise, we don't need all that rigamarole; just apply
+ ;; the new parameters.
(modify-frame-parameters frame-initial-frame
- initial-frame-alist))))
+ (append initial-frame-alist
+ default-frame-alist))))
- ;; Make sure the initial frame can be GC'd if it is ever deleted.
- (makunbound 'frame-initial-frame))
+ ;; Restore the original buffer.
+ (set-buffer old-buffer)
+
+ ;; Make sure the initial frame can be GC'd if it is ever deleted.
+ (makunbound 'frame-initial-frame)))
\f
-;;;; Creation of additional frames
+;;;; Creation of additional frames, and other frame miscellanea
-;;; Return some frame other than the current frame,
-;;; creating one if neccessary. Note that the minibuffer frame, if
-;;; separate, is not considered (see next-frame).
-(defun get-frame ()
+;;; Return some frame other than the current frame, creating one if
+;;; neccessary. Note that the minibuffer frame, if separate, is not
+;;; considered (see next-frame).
+(defun get-other-frame ()
(let ((s (if (equal (next-frame (selected-frame)) (selected-frame))
(new-frame)
(next-frame (selected-frame)))))
(> (minibuffer-depth) 0)
t)))
-(defun new-frame (&optional parameters)
+;; Alias, kept temporarily.
+(defalias 'new-frame 'make-frame)
+(defun make-frame (&optional parameters)
"Create a new frame, displaying the current buffer.
Optional argument PARAMETERS is an alist of parameters for the new
frame. Specifically, PARAMETERS is a list of pairs, each having one
of the following forms:
-(name . STRING) - The frame should be named STRING.
+\(name . STRING) - The frame should be named STRING.
-(height . NUMBER) - The frame should be NUMBER text lines high. If
+\(height . NUMBER) - The frame should be NUMBER text lines high. If
this parameter is present, the width parameter must also be
given.
-(width . NUMBER) - The frame should be NUMBER characters in width.
+\(width . NUMBER) - The frame should be NUMBER characters in width.
If this parameter is present, the height parameter must also
be given.
-(minibuffer . t) - the frame should have a minibuffer
-(minibuffer . none) - 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.
-
-(NAME . VALUE), specifying the parameter and the value it should have.
-NAME should be one of the following symbols:
- name VALUE
+\(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.
-The documentation for the function x-create-frame describes
-additional frame parameters that Emacs will recognize when running
-under the X Window System."
+The documentation for the function `x-create-frame' describes
+additional frame parameters that Emacs recognizes for X window frames."
(interactive)
(funcall frame-creation-function parameters))
-\f
-;;;; Iconification
-
-;;; A possible enhancement for the below: if you iconify a surrogate
-;;; minibuffer frame, iconify all of its minibuffer's users too;
-;;; de-iconify them as a group. This will need to wait until frames
-;;; have mapping and unmapping hooks.
-
-(defun iconify ()
- "Iconify or deiconify the selected frame."
- (interactive)
- (let ((frame (selected-frame)))
- (if (eq (frame-visible-p frame) t)
- (iconify-frame frame)
- (make-frame-visible frame))))
+(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)))))))
\f
;;;; Frame configurations
(defun current-frame-configuration ()
"Return a list describing the positions and states of all frames.
-Each element 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."
- (mapcar (function
- (lambda (frame)
- (list frame
- (frame-parameters frame)
- (current-window-configuration frame))))
- (frame-list)))
+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))))
(defun set-frame-configuration (configuration)
"Restore the frames to the state described by CONFIGURATION.
Each frame listed in CONFIGURATION has its position, size, window
configuration, and other parameters set as specified in CONFIGURATION."
- (let (frames-to-delete)
+ (or (frame-configuration-p configuration)
+ (signal 'wrong-type-argument
+ (list 'frame-configuration-p configuration)))
+ (let ((config-alist (cdr configuration))
+ frames-to-delete)
(mapcar (function
(lambda (frame)
- (let ((parameters (assq frame configuration)))
+ (let ((parameters (assq frame config-alist)))
(if parameters
(progn
(modify-frame-parameters frame (nth 1 parameters))
(frame-list))
(mapcar 'delete-frame frames-to-delete)))
+(defun frame-configuration-p (object)
+ "Return non-nil if OBJECT seems to be a frame configuration.
+Any list whose car is `frame-configuration' is assumed to be a frame
+configuration."
+ (and (consp object)
+ (eq (car object) 'frame-configuration)))
+
\f
;;;; Convenience functions for accessing and interactively changing
;;;; frame parameters.
-(defun frame-width (&optional frame)
+(defun frame-height (&optional frame)
"Return number of lines available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
- (cdr (assq 'width (frame-parameters frame))))
+ (cdr (assq 'height (frame-parameters frame))))
(defun frame-width (&optional frame)
"Return number of columns available for display on FRAME.
If FRAME is omitted, describe the currently selected frame."
- (cdr (assq 'height (frame-parameters frame))))
-
-(defun set-frame-height (h)
- (interactive "NHeight: ")
- (let* ((frame (selected-frame))
- (width (cdr (assoc 'width (frame-parameters (selected-frame))))))
- (set-frame-size (selected-frame) width h)))
-
-(defun set-frame-width (w)
- (interactive "NWidth: ")
- (let* ((frame (selected-frame))
- (height (cdr (assoc 'height (frame-parameters (selected-frame))))))
- (set-frame-size (selected-frame) w height)))
+ (cdr (assq 'width (frame-parameters frame))))
(defun set-default-font (font-name)
+ "Set the font of the selected frame to FONT.
+When called interactively, prompt for the name of the font to use."
(interactive "sFont name: ")
(modify-frame-parameters (selected-frame)
- (list (cons 'font font-name))))
+ (list (cons 'font font-name))))
-(defun set-frame-background (color-name)
+(defun set-background-color (color-name)
+ "Set the background color of the selected frame to COLOR.
+When called interactively, prompt for the name of the color to use."
(interactive "sColor: ")
(modify-frame-parameters (selected-frame)
- (list (cons 'background-color color-name))))
+ (list (cons 'background-color color-name))))
-(defun set-frame-foreground (color-name)
+(defun set-foreground-color (color-name)
+ "Set the foreground color of the selected frame to COLOR.
+When called interactively, prompt for the name of the color to use."
(interactive "sColor: ")
(modify-frame-parameters (selected-frame)
- (list (cons 'foreground-color color-name))))
+ (list (cons 'foreground-color color-name))))
(defun set-cursor-color (color-name)
+ "Set the text cursor color of the selected frame to COLOR.
+When called interactively, prompt for the name of the color to use."
(interactive "sColor: ")
(modify-frame-parameters (selected-frame)
- (list (cons 'cursor-color color-name))))
+ (list (cons 'cursor-color color-name))))
-(defun set-pointer-color (color-name)
+(defun set-mouse-color (color-name)
+ "Set the color of the mouse pointer of the selected frame to COLOR.
+When called interactively, prompt for the name of the color to use."
(interactive "sColor: ")
(modify-frame-parameters (selected-frame)
- (list (cons 'mouse-color color-name))))
+ (list (cons 'mouse-color color-name))))
-(defun set-auto-raise (toggle)
- (interactive "xt or nil? ")
+(defun set-border-color (color-name)
+ "Set the color of the border of the selected frame to COLOR.
+When called interactively, prompt for the name of the color to use."
+ (interactive "sColor: ")
(modify-frame-parameters (selected-frame)
- (list (cons 'auto-raise toggle))))
-
-(defun set-auto-lower (toggle)
- (interactive "xt or nil? ")
+ (list (cons 'border-color color-name))))
+
+(defun auto-raise-mode (arg)
+ "Toggle whether or not the selected frame should auto-raise.
+With arg, turn auto-raise mode on if and only if arg is positive."
+ (interactive "P")
+ (if (null arg)
+ (setq arg
+ (if (cdr (assq 'auto-raise (frame-parameters (selected-frame))))
+ -1 1)))
(modify-frame-parameters (selected-frame)
- (list (cons 'auto-lower toggle))))
-
-(defun set-vertical-bar (toggle)
- (interactive "xt or nil? ")
+ (list (cons 'auto-raise (> arg 0)))))
+
+(defun auto-lower-mode (arg)
+ "Toggle whether or not the selected frame should auto-lower.
+With arg, turn auto-lower mode on if and only if arg is positive."
+ (interactive "P")
+ (if (null arg)
+ (setq arg
+ (if (cdr (assq 'auto-lower (frame-parameters (selected-frame))))
+ -1 1)))
(modify-frame-parameters (selected-frame)
- (list (cons 'vertical-scroll-bar toggle))))
-
-(defun set-horizontal-bar (toggle)
- (interactive "xt or nil? ")
+ (list (cons 'auto-lower (> arg 0)))))
+
+(defun toggle-vertical-scroll-bar (arg)
+ "Toggle whether or not the selected frame has vertical scroll bars.
+With arg, turn vertical scroll bars on if and only if arg is positive."
+ (interactive "P")
+ (if (null arg)
+ (setq arg
+ (if (cdr (assq 'vertical-scroll-bars
+ (frame-parameters (selected-frame))))
+ -1 1)))
(modify-frame-parameters (selected-frame)
- (list (cons 'horizontal-scroll-bar toggle))))
+ (list (cons 'vertical-scroll-bars (> arg 0)))))
+
+(defun toggle-horizontal-scroll-bar (arg)
+ "Toggle whether or not the selected frame has horizontal scroll bars.
+With arg, turn horizontal scroll bars on if and only if arg is positive.
+Horizontal scroll bars aren't implemented yet."
+ (interactive "P")
+ (error "Horizontal scroll bars aren't implemented yet"))
+
\f
;;;; Aliases for backward compatibility with Emacs 18.
-(fset 'screen-height 'frame-height)
-(fset 'screen-width 'frame-width)
-(fset 'set-screen-width 'set-frame-width)
-(fset 'set-screen-height 'set-frame-height)
+(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\
+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\
+should use `set-frame-width' instead."
+ (set-frame-height (selected-frame) lines pretend))
+
+(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)
\f
;;;; Key bindings
(defvar ctl-x-5-map (make-sparse-keymap)
"Keymap for frame commands.")
-(fset 'ctl-x-5-prefix ctl-x-5-map)
+(defalias 'ctl-x-5-prefix ctl-x-5-map)
(define-key ctl-x-map "5" 'ctl-x-5-prefix)
(define-key ctl-x-5-map "2" 'new-frame)