]> code.delx.au - gnu-emacs/blobdiff - lisp/fringe.el
(enum event_kind) [MAC_OS]: Update comment for MAC_APPLE_EVENT.
[gnu-emacs] / lisp / fringe.el
index f52ecdf64d279cb639d85d588d96ecf4caf7d399..317fff0973c1b33197330a5c06d3cfbf24b04b18 100644 (file)
@@ -1,6 +1,6 @@
-;;; 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:
 
-;; Standard fringe bitmaps
-
-(defconst no-fringe-bitmap 0)
-(defconst undef-fringe-bitmap 1)
-(defconst left-truncation-fringe-bitmap 2)
-(defconst right-truncation-fringe-bitmap 3)
-(defconst up-arrow-fringe-bitmap 4)
-(defconst down-arrow-fringe-bitmap 5)
-(defconst continued-line-fringe-bitmap 6)
-(defconst continuation-line-fringe-bitmap 7)
-(defconst overlay-arrow-fringe-bitmap 8)
-(defconst top-left-angle-fringe-bitmap 9)
-(defconst top-right-angle-fringe-bitmap 10)
-(defconst bottom-left-angle-fringe-bitmap 11)
-(defconst bottom-right-angle-fringe-bitmap 12)
-(defconst left-bracket-fringe-bitmap 13)
-(defconst right-bracket-fringe-bitmap 14)
-(defconst filled-box-cursor-fringe-bitmap 15)
-(defconst hollow-box-cursor-fringe-bitmap 16)
-(defconst hollow-square-fringe-bitmap 17)
-(defconst bar-cursor-fringe-bitmap 18)
-(defconst hbar-cursor-fringe-bitmap 19)
-(defconst empty-line-fringe-bitmap 20)
+(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
@@ -110,7 +139,25 @@ See `fringe-mode' for possible values and their effect."
                                   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
@@ -123,7 +170,7 @@ To set this variable in a Lisp program, use `set-fringe-mode' to make
 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))
@@ -134,8 +181,9 @@ you can use the interactive function `toggle-fringe'"
                 (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)
@@ -146,7 +194,10 @@ If ALL-FRAMES, the negation of the fringe values in
 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 (type ? 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))))
@@ -164,7 +215,6 @@ frame parameter is used."
               nil
             0)))))
 
-;;;###autoload
 (defun fringe-mode (&optional mode)
   "Set the default appearance of fringes on all frames.
 
@@ -190,7 +240,6 @@ 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 the default appearance of fringes on the selected frame.
 
@@ -228,7 +277,7 @@ SIDE must be the symbol `left' or `right'."
                        (window-fringes))
               0)
            (float (frame-char-width))))
-  
+
 (provide 'fringe)
 
 ;;; arch-tag: 6611ef60-0869-47ed-8b93-587ee7d3ff5d