;;; ruler-mode.el --- display a ruler in the header line
-;; Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
+;; Copyright (C) 2001, 2002, 2003, 2004, 2005,
+;; 2006 Free Software Foundation, Inc.
;; Author: David Ponce <david@dponce.com>
;; Maintainer: David Ponce <david@dponce.com>
;; You should have received a copy of the GNU General Public License
;; along with this program; see the file COPYING. If not, write to
-;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; The following faces are customizable:
;;
-;; - `ruler-mode-default-face' the ruler default face.
-;; - `ruler-mode-fill-column-face' the face used to highlight the
+;; - `ruler-mode-default' the ruler default face.
+;; - `ruler-mode-fill-column' the face used to highlight the
;; `fill-column' character.
-;; - `ruler-mode-comment-column-face' the face used to highlight the
+;; - `ruler-mode-comment-column' the face used to highlight the
;; `comment-column' character.
-;; - `ruler-mode-goal-column-face' the face used to highlight the
+;; - `ruler-mode-goal-column' the face used to highlight the
;; `goal-column' character.
-;; - `ruler-mode-current-column-face' the face used to highlight the
+;; - `ruler-mode-current-column' the face used to highlight the
;; `current-column' character.
-;; - `ruler-mode-tab-stop-face' the face used to highlight tab stop
+;; - `ruler-mode-tab-stop' the face used to highlight tab stop
;; characters.
-;; - `ruler-mode-margins-face' the face used to highlight graduations
+;; - `ruler-mode-margins' the face used to highlight graduations
;; in the `window-margins' areas.
-;; - `ruler-mode-fringes-face' the face used to highlight graduations
+;; - `ruler-mode-fringes' the face used to highlight graduations
;; in the `window-fringes' areas.
-;; - `ruler-mode-column-number-face' the face used to highlight the
+;; - `ruler-mode-column-number' the face used to highlight the
;; numbered graduations.
;;
-;; `ruler-mode-default-face' inherits from the built-in `default' face.
-;; All `ruler-mode' faces inherit from `ruler-mode-default-face'.
+;; `ruler-mode-default' inherits from the built-in `default' face.
+;; All `ruler-mode' faces inherit from `ruler-mode-default'.
;;
;; WARNING: To keep ruler graduations aligned on text columns it is
;; important to use the same font family and size for ruler and text
:group 'ruler-mode
:type 'boolean)
\f
-(defface ruler-mode-default-face
+(defface ruler-mode-default
'((((type tty))
(:inherit default
:background "grey64"
"Default face used by the ruler."
:group 'ruler-mode)
-(defface ruler-mode-pad-face
+(defface ruler-mode-pad
'((((type tty))
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:background "grey50"
))
(t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:background "grey64"
)))
"Face used to pad inactive ruler areas."
:group 'ruler-mode)
-(defface ruler-mode-margins-face
+(defface ruler-mode-margins
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "white"
)))
"Face used to highlight margin areas."
:group 'ruler-mode)
-(defface ruler-mode-fringes-face
+(defface ruler-mode-fringes
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "green"
)))
"Face used to highlight fringes areas."
:group 'ruler-mode)
-(defface ruler-mode-column-number-face
+(defface ruler-mode-column-number
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "black"
)))
"Face used to highlight number graduations."
:group 'ruler-mode)
-(defface ruler-mode-fill-column-face
+(defface ruler-mode-fill-column
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "red"
)))
"Face used to highlight the fill column character."
:group 'ruler-mode)
-(defface ruler-mode-comment-column-face
+(defface ruler-mode-comment-column
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "red"
)))
"Face used to highlight the comment column character."
:group 'ruler-mode)
-(defface ruler-mode-goal-column-face
+(defface ruler-mode-goal-column
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "red"
)))
"Face used to highlight the goal column character."
:group 'ruler-mode)
-(defface ruler-mode-tab-stop-face
+(defface ruler-mode-tab-stop
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:foreground "steelblue"
)))
"Face used to highlight tab stop characters."
:group 'ruler-mode)
-(defface ruler-mode-current-column-face
+(defface ruler-mode-current-column
'((t
- (:inherit ruler-mode-default-face
+ (:inherit ruler-mode-default
:weight bold
:foreground "yellow"
)))
(message "Goal column set to %d (click on %s again to unset it)"
newc
(propertize (char-to-string ruler-mode-goal-column-char)
- 'face 'ruler-mode-goal-column-face))
+ 'face 'ruler-mode-goal-column))
nil) ;; Don't start dragging.
)
(if (eq 'click (ruler-mode-mouse-drag-any-column-iteration
;; Setup the scrollbar, fringes, and margins areas.
(lf (ruler-mode-space
'left-fringe
- 'face 'ruler-mode-fringes-face
+ 'face 'ruler-mode-fringes
'help-echo (format ruler-mode-fringe-help-echo
"Left" (or (car f) 0))))
(rf (ruler-mode-space
'right-fringe
- 'face 'ruler-mode-fringes-face
+ 'face 'ruler-mode-fringes
'help-echo (format ruler-mode-fringe-help-echo
"Right" (or (cadr f) 0))))
(lm (ruler-mode-space
'left-margin
- 'face 'ruler-mode-margins-face
+ 'face 'ruler-mode-margins
'help-echo (format ruler-mode-margin-help-echo
"Left" (or (car m) 0))))
(rm (ruler-mode-space
'right-margin
- 'face 'ruler-mode-margins-face
+ 'face 'ruler-mode-margins
'help-echo (format ruler-mode-margin-help-echo
"Right" (or (cdr m) 0))))
(sb (ruler-mode-space
'scroll-bar
- 'face 'ruler-mode-pad-face))
+ 'face 'ruler-mode-pad))
;; Remember the scrollbar vertical type.
(sbvt (car (window-current-scroll-bars)))
;; Create an "clean" ruler.
(ruler
(propertize
(make-string w ruler-mode-basic-graduation-char)
- 'face 'ruler-mode-default-face
+ 'face 'ruler-mode-default
'local-map ruler-mode-map
'help-echo (cond
(ruler-mode-show-tab-stops
m (length c)
k i)
(put-text-property
- i (1+ i) 'face 'ruler-mode-column-number-face
+ i (1+ i) 'face 'ruler-mode-column-number
ruler)
(while (and (> m 0) (>= k 0))
(aset ruler k (aref c (setq m (1- m))))
((= j (current-column))
(aset ruler i ruler-mode-current-column-char)
(put-text-property
- i (1+ i) 'face 'ruler-mode-current-column-face
+ i (1+ i) 'face 'ruler-mode-current-column
ruler))
;; Show the `goal-column' marker.
((and goal-column (= j goal-column))
(aset ruler i ruler-mode-goal-column-char)
(put-text-property
- i (1+ i) 'face 'ruler-mode-goal-column-face
+ i (1+ i) 'face 'ruler-mode-goal-column
ruler)
(put-text-property
i (1+ i) 'mouse-face 'mode-line-highlight
((= j comment-column)
(aset ruler i ruler-mode-comment-column-char)
(put-text-property
- i (1+ i) 'face 'ruler-mode-comment-column-face
+ i (1+ i) 'face 'ruler-mode-comment-column
ruler)
(put-text-property
i (1+ i) 'mouse-face 'mode-line-highlight
((= j fill-column)
(aset ruler i ruler-mode-fill-column-char)
(put-text-property
- i (1+ i) 'face 'ruler-mode-fill-column-face
+ i (1+ i) 'face 'ruler-mode-fill-column
ruler)
(put-text-property
i (1+ i) 'mouse-face 'mode-line-highlight
((and ruler-mode-show-tab-stops (member j tab-stop-list))
(aset ruler i ruler-mode-tab-stop-char)
(put-text-property
- i (1+ i) 'face 'ruler-mode-tab-stop-face
+ i (1+ i) 'face 'ruler-mode-tab-stop
ruler)))
(setq i (1+ i)
j (1+ j)))