-;;; fringe.el --- change fringes appearance in various ways
+;;; fringe.el --- fringe setup and control
-;; Copyright (C) 2002, 2003 Free Software Foundation, Inc.
+;; Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
;; Author: Simon Josefsson <simon@josefsson.org>
;; Maintainer: FSF
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
-;; This file contains helpful functions for customizing the appearance
-;; of the fringe.
+;; This file contains code to initialize the built-in fringe bitmaps
+;; as well as helpful functions for customizing the appearance of the
+;; fringe.
;; The code is influenced by scroll-bar.el and avoid.el. The author
;; gratefully acknowledge comments and suggestions made by Miles
;;; Code:
+(defgroup fringe nil
+ "Window fringes."
+ :version "22.1"
+ :group 'frames)
+
+;; Define the built-in fringe bitmaps and setup default mappings
+
+(when (boundp 'fringe-bitmaps)
+ (let ((bitmaps '(question-mark
+ left-arrow right-arrow up-arrow down-arrow
+ left-curly-arrow right-curly-arrow
+ left-triangle right-triangle
+ top-left-angle top-right-angle
+ bottom-left-angle bottom-right-angle
+ left-bracket right-bracket
+ filled-rectangle hollow-rectangle
+ filled-square hollow-square
+ vertical-bar horizontal-bar
+ empty-line))
+ (bn 1))
+ (while bitmaps
+ (push (car bitmaps) fringe-bitmaps)
+ (put (car bitmaps) 'fringe bn)
+ (setq bitmaps (cdr bitmaps)
+ bn (1+ bn))))
+
+ (setq-default fringe-indicator-alist
+ '((truncation . (left-arrow right-arrow))
+ (continuation . (left-curly-arrow right-curly-arrow))
+ (overlay-arrow . right-triangle)
+ (up . up-arrow)
+ (down . down-arrow)
+ (top . (top-left-angle top-right-angle))
+ (bottom . (bottom-left-angle bottom-right-angle
+ top-right-angle top-left-angle))
+ (top-bottom . (left-bracket right-bracket
+ top-right-angle top-left-angle))
+ (empty-line . empty-line)
+ (unknown . question-mark)))
+
+ (setq-default fringe-cursor-alist
+ '((box . filled-rectangle)
+ (hollow . hollow-rectangle)
+ (bar . vertical-bar)
+ (hbar . horizontal-bar)
+ (hollow-small . hollow-square))))
+
+
+(defmacro fringe-bitmap-p (symbol)
+ "Return non-nil if SYMBOL is a fringe bitmap."
+ `(get ,symbol 'fringe))
+
+
+;; Control presence of fringes
+
(defvar fringe-mode)
(defun set-fringe-mode-1 (ignore value)
fringe-mode))))
(setq frames (cdr frames)))))
-;;;###autoload
+;; For initialization of fringe-mode, take account of changes
+;; made explicitly to default-frame-alist.
+(defun fringe-mode-initialize (symbol value)
+ (let* ((left-pair (assq 'left-fringe default-frame-alist))
+ (right-pair (assq 'right-fringe default-frame-alist))
+ (left (cdr left-pair))
+ (right (cdr right-pair)))
+ (if (or left-pair right-pair)
+ ;; If there's something in default-frame-alist for fringes,
+ ;; don't change it, but reflect that into the value of fringe-mode.
+ (progn
+ (setq fringe-mode (cons left right))
+ (if (equal fringe-mode '(nil . nil))
+ (setq fringe-mode nil))
+ (if (equal fringe-mode '(0 . 0))
+ (setq fringe-mode 0)))
+ ;; Otherwise impose the user-specified value of fringe-mode.
+ (custom-initialize-reset symbol value))))
+
(defcustom fringe-mode nil
"*Specify appearance of fringes on all frames.
This variable can be nil (the default) meaning the fringes should have
it take real effect.
Setting the variable with a customization buffer also takes effect.
If you only want to modify the appearance of the fringe in one frame,
-you can use the interactive function `toggle-fringe'"
+you can use the interactive function `set-fringe-style'."
:type '(choice (const :tag "Default width" nil)
(const :tag "No fringes" 0)
(const :tag "Only right" (0 . nil))
(cons :tag "Different left/right sizes"
(integer :tag "Left width")
(integer :tag "Right width")))
- :group 'frames
+ :group 'fringe
:require 'fringe
+ :initialize 'fringe-mode-initialize
:set 'set-fringe-mode-1)
(defun fringe-query-style (&optional all-frames)
Otherwise the negation of the fringe value in the currently selected
frame parameter is used."
(let ((mode (intern (completing-read
- "Select fringe mode for all frames (SPACE for list): "
+ (concat
+ "Select fringe mode for "
+ (if all-frames "all frames" "selected frame")
+ " (type ? for list): ")
'(("none") ("default") ("left-only")
("right-only") ("half") ("minimal"))
nil t))))
nil
0)))))
-;;;###autoload
(defun fringe-mode (&optional mode)
- "Toggle appearance of fringes on all frames.
-Valid values for MODE include `none', `default', `left-only',
-`right-only', `minimal' and `half'. MODE can also be a cons cell
-where the integer in car will be used as left fringe width and the
-integer in cdr will be used as right fringe width. If MODE is not
-specified, the user is queried.
-It applies to all frames that exist and frames to be created in the
-future.
-If you want to set appearance of fringes on the selected frame only,
-see `set-fringe-style'."
+ "Set the default appearance of fringes on all frames.
+
+When called interactively, query the user for MODE. Valid values
+for MODE include `none', `default', `left-only', `right-only',
+`minimal' and `half'.
+
+When used in a Lisp program, MODE can be a cons cell where the
+integer in car specifies the left fringe width and the integer in
+cdr specifies the right fringe width. MODE can also be a single
+integer that specifies both the left and the right fringe width.
+If a fringe width specification is nil, that means to use the
+default width (8 pixels). This command may round up the left and
+right width specifications to ensure that their sum is a multiple
+of the character width of a frame. It never rounds up a fringe
+width of 0.
+
+Fringe widths set by `set-window-fringes' override the default
+fringe widths set by this command. This command applies to all
+frames that exist and frames to be created in the future. If you
+want to set the default appearance of fringes on the selected
+frame only, see the command `set-fringe-style'."
(interactive (list (fringe-query-style 'all-frames)))
(set-fringe-mode mode))
-;;;###autoload
(defun set-fringe-style (&optional mode)
- "Set appearance of fringes on selected frame.
-Valid values for MODE include `none', `default', `left-only',
-`right-only', `minimal' and `half'. MODE can also be a cons cell
-where the integer in car will be used as left fringe width and the
-integer in cdr will be used as right fringe width. If MODE is not
-specified, the user is queried.
-If you want to set appearance of fringes on all frames, see `fringe-mode'."
+ "Set the default appearance of fringes on the selected frame.
+
+When called interactively, query the user for MODE. Valid values
+for MODE include `none', `default', `left-only', `right-only',
+`minimal' and `half'.
+
+When used in a Lisp program, MODE can be a cons cell where the
+integer in car specifies the left fringe width and the integer in
+cdr specifies the right fringe width. MODE can also be a single
+integer that specifies both the left and the right fringe width.
+If a fringe width specification is nil, that means to use the
+default width (8 pixels). This command may round up the left and
+right width specifications to ensure that their sum is a multiple
+of the character width of a frame. It never rounds up a fringe
+width of 0.
+
+Fringe widths set by `set-window-fringes' override the default
+fringe widths set by this command. If you want to set the
+default appearance of fringes on all frames, see the command
+`fringe-mode'."
(interactive (list (fringe-query-style)))
(modify-frame-parameters
(selected-frame)
(list (cons 'left-fringe (if (consp mode) (car mode) mode))
(cons 'right-fringe (if (consp mode) (cdr mode) mode)))))
+(defsubst fringe-columns (side &optional real)
+ "Return the width, measured in columns, of the fringe area on SIDE.
+If optional argument REAL is non-nil, return a real floating point
+number instead of a rounded integer value.
+SIDE must be the symbol `left' or `right'."
+ (funcall (if real '/ 'ceiling)
+ (or (funcall (if (eq side 'left) 'car 'cadr)
+ (window-fringes))
+ 0)
+ (float (frame-char-width))))
+
(provide 'fringe)
;;; arch-tag: 6611ef60-0869-47ed-8b93-587ee7d3ff5d