* lisp/international/mule-cmds.el (read-char-by-name): Move let-binding

[gnu-emacs] / lisp / ruler-mode.el

diff --git a/lisp/ruler-mode.el b/lisp/ruler-mode.el
index 7c6d50aba5baacdb676c99b3aaef1e50db3469aa..08c4ba519058f7c5290fcd6bdd9cc3501f47701d 100644 (file)
--- a/lisp/ruler-mode.el
+++ b/lisp/ruler-mode.el
@@ -1,7 +1,6 @@
 ;;; ruler-mode.el --- display a ruler in the header line
 
-;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007,
-;;   2008 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
 
 ;; Author: David Ponce <david@dponce.com>
 ;; Maintainer: David Ponce <david@dponce.com>
@@ -119,7 +118,7 @@
   :group 'convenience)
 
 (defcustom ruler-mode-show-tab-stops nil
-  "*If non-nil the ruler shows tab stop positions.
+  "If non-nil the ruler shows tab stop positions.
 Also allowing to visually change `tab-stop-list' setting using
 <C-down-mouse-1> and <C-down-mouse-3> on the ruler to respectively add
 or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
@@ -141,7 +140,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
 (defcustom ruler-mode-fill-column-char (if (char-displayable-p ?¶)
                                            ?\¶
                                          ?\|)
-  "*Character used at the `fill-column' location."
+  "Character used at the `fill-column' location."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -149,7 +148,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
                    :validate ruler-mode-character-validate)))
 
 (defcustom ruler-mode-comment-column-char ?\#
-  "*Character used at the `comment-column' location."
+  "Character used at the `comment-column' location."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -157,7 +156,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
                    :validate ruler-mode-character-validate)))
 
 (defcustom ruler-mode-goal-column-char ?G
-  "*Character used at the `goal-column' location."
+  "Character used at the `goal-column' location."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -167,7 +166,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
 (defcustom ruler-mode-current-column-char (if (char-displayable-p ?¦)
                                               ?\¦
                                             ?\@)
-  "*Character used at the `current-column' location."
+  "Character used at the `current-column' location."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -175,7 +174,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
                    :validate ruler-mode-character-validate)))
 
 (defcustom ruler-mode-tab-stop-char ?\T
-  "*Character used at `tab-stop-list' locations."
+  "Character used at `tab-stop-list' locations."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -183,7 +182,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
                    :validate ruler-mode-character-validate)))
 
 (defcustom ruler-mode-basic-graduation-char ?\.
-  "*Character used for basic graduations."
+  "Character used for basic graduations."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -191,7 +190,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
                    :validate ruler-mode-character-validate)))
 
 (defcustom ruler-mode-inter-graduation-char ?\!
-  "*Character used for intermediate graduations."
+  "Character used for intermediate graduations."
   :group 'ruler-mode
   :type '(choice
           (character :tag "Character")
@@ -199,7 +198,7 @@ or remove a tab stop.  \\[ruler-mode-toggle-show-tab-stops] or
                    :validate ruler-mode-character-validate)))
 
 (defcustom ruler-mode-set-goal-column-ding-flag t
-  "*Non-nil means do `ding' when `goal-column' is set."
+  "Non-nil means do `ding' when `goal-column' is set."
   :group 'ruler-mode
   :type 'boolean)
 \f
@@ -549,22 +548,39 @@ This variable is expected to be made buffer-local by modes.")
   "`header-line-format' used in ruler mode.
 Call `ruler-mode-ruler-function' to compute the ruler value.")
 
+;;;###autoload
+(defvar ruler-mode nil
+  "Non-nil if Ruler mode is enabled.
+Use the command `ruler-mode' to change this variable.")
+(make-variable-buffer-local 'ruler-mode)
+
+(defun ruler--save-header-line-format ()
+  "Install the header line format for Ruler mode.
+Unless Ruler mode is already enabled, save the old header line
+format first."
+  (when (and (not ruler-mode)
+            (local-variable-p 'header-line-format)
+            (not (local-variable-p 'ruler-mode-header-line-format-old)))
+    (set (make-local-variable 'ruler-mode-header-line-format-old)
+        header-line-format))
+  (setq header-line-format ruler-mode-header-line-format))
+
 ;;;###autoload
 (define-minor-mode ruler-mode
-  "Display a ruler in the header line if ARG > 0."
+  "Toggle display of ruler in header line (Ruler mode).
+With a prefix argument ARG, enable Ruler mode if ARG is positive,
+and disable it otherwise.  If called from Lisp, enable the mode
+if ARG is omitted or nil."
   nil nil
   ruler-mode-map
   :group 'ruler-mode
+  :variable (ruler-mode
+            . (lambda (enable)
+                (when enable
+                  (ruler--save-header-line-format))
+                (setq ruler-mode enable)))
   (if ruler-mode
-      (progn
-        ;; When `ruler-mode' is on save previous header line format
-        ;; and install the ruler header line format.
-        (when (and (local-variable-p 'header-line-format)
-                  (not (local-variable-p 'ruler-mode-header-line-format-old)))
-          (set (make-local-variable 'ruler-mode-header-line-format-old)
-               header-line-format))
-        (setq header-line-format ruler-mode-header-line-format)
-        (add-hook 'post-command-hook 'force-mode-line-update nil t))
+      (add-hook 'post-command-hook 'force-mode-line-update nil t)
     ;; When `ruler-mode' is off restore previous header line format if
     ;; the current one is the ruler header line format.
     (when (eq header-line-format ruler-mode-header-line-format)
@@ -664,7 +680,7 @@ Optional argument PROPS specifies other text properties to apply."
          ;; Create an "clean" ruler.
          (ruler
           (propertize
-           (string-to-multibyte 
+           (string-to-multibyte
            (make-string w ruler-mode-basic-graduation-char))
            'face 'ruler-mode-default
            'local-map ruler-mode-map
@@ -761,5 +777,4 @@ Optional argument PROPS specifies other text properties to apply."
 ;; coding: iso-latin-1
 ;; End:
 
-;; arch-tag: b2f24546-5605-44c4-b67b-c9a4eeba3ee8
 ;;; ruler-mode.el ends here