Mercurial > emacs
annotate lisp/ruler-mode.el @ 51524:f273d07fae63
*** empty log message ***
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Sun, 08 Jun 2003 00:39:44 +0000 |
parents | a8b686f386db |
children | 695cf19ef79e |
rev | line source |
---|---|
42836
c6bcb27e426f
(ruler-mode): New keyword. Fix :version.
Pavel Janík <Pavel@Janik.cz>
parents:
42706
diff
changeset
|
1 ;;; ruler-mode.el --- display a ruler in the header line |
39731 | 2 |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
3 ;; Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc. |
39731 | 4 |
5 ;; Author: David Ponce <david@dponce.com> | |
6 ;; Maintainer: David Ponce <david@dponce.com> | |
7 ;; Created: 24 Mar 2001 | |
51389 | 8 ;; Version: 1.6 |
47183
865837df3fe7
(defgroup ruler-mode): Use `convenience' as parent.
Richard M. Stallman <rms@gnu.org>
parents:
45255
diff
changeset
|
9 ;; Keywords: convenience |
39731 | 10 |
11 ;; This file is part of GNU Emacs. | |
12 | |
13 ;; This program is free software; you can redistribute it and/or | |
14 ;; modify it under the terms of the GNU General Public License as | |
15 ;; published by the Free Software Foundation; either version 2, or (at | |
16 ;; your option) any later version. | |
17 | |
18 ;; This program is distributed in the hope that it will be useful, but | |
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
21 ;; General Public License for more details. | |
22 | |
23 ;; You should have received a copy of the GNU General Public License | |
24 ;; along with this program; see the file COPYING. If not, write to | |
25 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 ;; Boston, MA 02111-1307, USA. | |
27 | |
28 ;;; Commentary: | |
29 | |
30 ;; This library provides a minor mode to display a ruler in the header | |
31 ;; line. It works only on Emacs 21. | |
32 ;; | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
33 ;; You can use the mouse to change the `fill-column' `comment-column', |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
34 ;; `goal-column', `window-margins' and `tab-stop-list' settings: |
39731 | 35 ;; |
51389 | 36 ;; [header-line (shift down-mouse-1)] set left margin end to the ruler |
39731 | 37 ;; graduation where the mouse pointer is on. |
38 ;; | |
51389 | 39 ;; [header-line (shift down-mouse-3)] set right margin beginning to |
40 ;; the ruler graduation where the mouse pointer is on. | |
39731 | 41 ;; |
51389 | 42 ;; [header-line down-mouse-2] Drag the `fill-column', `comment-column' |
43 ;; or `goal-column' to a ruler graduation. | |
39731 | 44 ;; |
45 ;; [header-line (control down-mouse-1)] add a tab stop to the ruler | |
46 ;; graduation where the mouse pointer is on. | |
47 ;; | |
48 ;; [header-line (control down-mouse-3)] remove the tab stop at the | |
49 ;; ruler graduation where the mouse pointer is on. | |
50 ;; | |
51 ;; [header-line (control down-mouse-2)] or M-x | |
52 ;; `ruler-mode-toggle-show-tab-stops' toggle showing and visually | |
53 ;; editing `tab-stop-list' setting. The `ruler-mode-show-tab-stops' | |
54 ;; option controls if the ruler shows tab stops by default. | |
55 ;; | |
56 ;; In the ruler the character `ruler-mode-current-column-char' shows | |
57 ;; the `current-column' location, `ruler-mode-fill-column-char' shows | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
58 ;; the `fill-column' location, `ruler-mode-comment-column-char' shows |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
59 ;; the `comment-column' location, `ruler-mode-goal-column-char' shows |
51389 | 60 ;; the `goal-column' and `ruler-mode-tab-stop-char' shows tab stop |
61 ;; locations. Graduations in `window-margins' and `window-fringes' | |
62 ;; areas are shown with a different foreground color. | |
39731 | 63 ;; |
64 ;; It is also possible to customize the following characters: | |
65 ;; | |
66 ;; - `ruler-mode-basic-graduation-char' character used for basic | |
67 ;; graduations ('.' by default). | |
68 ;; - `ruler-mode-inter-graduation-char' character used for | |
69 ;; intermediate graduations ('!' by default). | |
70 ;; | |
71 ;; The following faces are customizable: | |
72 ;; | |
73 ;; - `ruler-mode-default-face' the ruler default face. | |
74 ;; - `ruler-mode-fill-column-face' the face used to highlight the | |
75 ;; `fill-column' character. | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
76 ;; - `ruler-mode-comment-column-face' the face used to highlight the |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
77 ;; `comment-column' character. |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
78 ;; - `ruler-mode-goal-column-face' the face used to highlight the |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
79 ;; `goal-column' character. |
39731 | 80 ;; - `ruler-mode-current-column-face' the face used to highlight the |
81 ;; `current-column' character. | |
82 ;; - `ruler-mode-tab-stop-face' the face used to highlight tab stop | |
83 ;; characters. | |
51389 | 84 ;; - `ruler-mode-margins-face' the face used to highlight graduations |
85 ;; in the `window-margins' areas. | |
86 ;; - `ruler-mode-fringes-face' the face used to highlight graduations | |
87 ;; in the `window-fringes' areas. | |
39731 | 88 ;; - `ruler-mode-column-number-face' the face used to highlight the |
51389 | 89 ;; numbered graduations. |
39731 | 90 ;; |
91 ;; `ruler-mode-default-face' inherits from the built-in `default' face. | |
51389 | 92 ;; All `ruler-mode' faces inherit from `ruler-mode-default-face'. |
39731 | 93 ;; |
94 ;; WARNING: To keep ruler graduations aligned on text columns it is | |
95 ;; important to use the same font family and size for ruler and text | |
96 ;; areas. | |
97 | |
98 ;; Installation | |
99 ;; | |
100 ;; To automatically display the ruler in specific major modes use: | |
101 ;; | |
102 ;; (add-hook '<major-mode>-hook 'ruler-mode) | |
103 ;; | |
104 | |
105 ;;; History: | |
106 ;; | |
41461 | 107 |
39731 | 108 ;;; Code: |
109 (eval-when-compile | |
110 (require 'wid-edit)) | |
111 | |
112 (defgroup ruler-mode nil | |
113 "Display a ruler in the header line." | |
45255
20c79f08a7da
Change all post-21.1 :version attributes to 21.4.
Eli Zaretskii <eliz@gnu.org>
parents:
42836
diff
changeset
|
114 :version "21.4" |
47183
865837df3fe7
(defgroup ruler-mode): Use `convenience' as parent.
Richard M. Stallman <rms@gnu.org>
parents:
45255
diff
changeset
|
115 :group 'convenience) |
39731 | 116 |
117 (defcustom ruler-mode-show-tab-stops nil | |
118 "*If non-nil the ruler shows tab stop positions. | |
119 Also allowing to visually change `tab-stop-list' setting using | |
120 <C-down-mouse-1> and <C-down-mouse-3> on the ruler to respectively add | |
121 or remove a tab stop. \\[ruler-mode-toggle-show-tab-stops] or | |
122 <C-down-mouse-2> on the ruler toggles showing/editing of tab stops." | |
123 :group 'ruler-mode | |
124 :type 'boolean) | |
125 | |
126 ;; IMPORTANT: This function must be defined before the following | |
127 ;; defcustoms because it is used in their :validate clause. | |
128 (defun ruler-mode-character-validate (widget) | |
129 "Ensure WIDGET value is a valid character value." | |
130 (save-excursion | |
131 (let ((value (widget-value widget))) | |
132 (if (char-valid-p value) | |
133 nil | |
134 (widget-put widget :error | |
135 (format "Invalid character value: %S" value)) | |
136 widget)))) | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
137 |
39731 | 138 (defcustom ruler-mode-fill-column-char (if window-system |
139 ?\¶ | |
140 ?\|) | |
141 "*Character used at the `fill-column' location." | |
142 :group 'ruler-mode | |
143 :type '(choice | |
144 (character :tag "Character") | |
145 (integer :tag "Integer char value" | |
146 :validate ruler-mode-character-validate))) | |
147 | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
148 (defcustom ruler-mode-comment-column-char ?\# |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
149 "*Character used at the `comment-column' location." |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
150 :group 'ruler-mode |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
151 :type '(choice |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
152 (character :tag "Character") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
153 (integer :tag "Integer char value" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
154 :validate ruler-mode-character-validate))) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
155 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
156 (defcustom ruler-mode-goal-column-char ?G |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
157 "*Character used at the `goal-column' location." |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
158 :group 'ruler-mode |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
159 :type '(choice |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
160 (character :tag "Character") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
161 (integer :tag "Integer char value" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
162 :validate ruler-mode-character-validate))) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
163 |
39731 | 164 (defcustom ruler-mode-current-column-char (if window-system |
165 ?\¦ | |
166 ?\@) | |
167 "*Character used at the `current-column' location." | |
168 :group 'ruler-mode | |
169 :type '(choice | |
170 (character :tag "Character") | |
171 (integer :tag "Integer char value" | |
172 :validate ruler-mode-character-validate))) | |
173 | |
174 (defcustom ruler-mode-tab-stop-char ?\T | |
175 "*Character used at `tab-stop-list' locations." | |
176 :group 'ruler-mode | |
177 :type '(choice | |
178 (character :tag "Character") | |
179 (integer :tag "Integer char value" | |
180 :validate ruler-mode-character-validate))) | |
181 | |
182 (defcustom ruler-mode-basic-graduation-char ?\. | |
183 "*Character used for basic graduations." | |
184 :group 'ruler-mode | |
185 :type '(choice | |
186 (character :tag "Character") | |
187 (integer :tag "Integer char value" | |
188 :validate ruler-mode-character-validate))) | |
189 | |
190 (defcustom ruler-mode-inter-graduation-char ?\! | |
191 "*Character used for intermediate graduations." | |
192 :group 'ruler-mode | |
193 :type '(choice | |
194 (character :tag "Character") | |
195 (integer :tag "Integer char value" | |
196 :validate ruler-mode-character-validate))) | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
197 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
198 (defcustom ruler-mode-set-goal-column-ding-flag t |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
199 "*Non-nil means do `ding' when `goal-column' is set." |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
200 :group 'ruler-mode |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
201 :type 'boolean) |
41461 | 202 |
39731 | 203 (defface ruler-mode-default-face |
204 '((((type tty)) | |
205 (:inherit default | |
206 :background "grey64" | |
207 :foreground "grey50" | |
208 )) | |
209 (t | |
210 (:inherit default | |
211 :background "grey76" | |
212 :foreground "grey64" | |
213 :box (:color "grey76" | |
214 :line-width 1 | |
215 :style released-button) | |
216 ))) | |
217 "Default face used by the ruler." | |
218 :group 'ruler-mode) | |
219 | |
51389 | 220 (defface ruler-mode-pad-face |
221 '((((type tty)) | |
222 (:inherit ruler-mode-default-face | |
223 :background "grey50" | |
224 )) | |
225 (t | |
226 (:inherit ruler-mode-default-face | |
227 :background "grey64" | |
228 ))) | |
229 "Face used to pad inactive ruler areas." | |
230 :group 'ruler-mode) | |
231 | |
232 (defface ruler-mode-margins-face | |
233 '((t | |
234 (:inherit ruler-mode-default-face | |
235 :foreground "white" | |
236 ))) | |
237 "Face used to highlight margin areas." | |
238 :group 'ruler-mode) | |
239 | |
240 (defface ruler-mode-fringes-face | |
241 '((t | |
242 (:inherit ruler-mode-default-face | |
243 :foreground "green" | |
244 ))) | |
245 "Face used to highlight fringes areas." | |
246 :group 'ruler-mode) | |
247 | |
39731 | 248 (defface ruler-mode-column-number-face |
249 '((t | |
250 (:inherit ruler-mode-default-face | |
251 :foreground "black" | |
252 ))) | |
253 "Face used to highlight number graduations." | |
254 :group 'ruler-mode) | |
255 | |
256 (defface ruler-mode-fill-column-face | |
257 '((t | |
258 (:inherit ruler-mode-default-face | |
259 :foreground "red" | |
260 ))) | |
261 "Face used to highlight the fill column character." | |
262 :group 'ruler-mode) | |
263 | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
264 (defface ruler-mode-comment-column-face |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
265 '((t |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
266 (:inherit ruler-mode-default-face |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
267 :foreground "red" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
268 ))) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
269 "Face used to highlight the comment column character." |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
270 :group 'ruler-mode) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
271 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
272 (defface ruler-mode-goal-column-face |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
273 '((t |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
274 (:inherit ruler-mode-default-face |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
275 :foreground "red" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
276 ))) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
277 "Face used to highlight the goal column character." |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
278 :group 'ruler-mode) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
279 |
39731 | 280 (defface ruler-mode-tab-stop-face |
281 '((t | |
282 (:inherit ruler-mode-default-face | |
283 :foreground "steelblue" | |
284 ))) | |
285 "Face used to highlight tab stop characters." | |
286 :group 'ruler-mode) | |
287 | |
288 (defface ruler-mode-current-column-face | |
289 '((t | |
290 (:inherit ruler-mode-default-face | |
291 :weight bold | |
292 :foreground "yellow" | |
293 ))) | |
294 "Face used to highlight the `current-column' character." | |
295 :group 'ruler-mode) | |
41461 | 296 |
51389 | 297 (defmacro ruler-mode-left-fringe-cols () |
298 "Return the width, measured in columns, of the left fringe area." | |
299 '(ceiling (or (car (window-fringes)) 0) | |
300 (frame-char-width))) | |
301 | |
302 (defmacro ruler-mode-right-fringe-cols () | |
303 "Return the width, measured in columns, of the right fringe area." | |
304 '(ceiling (or (nth 1 (window-fringes)) 0) | |
305 (frame-char-width))) | |
306 | |
307 (defun ruler-mode-left-scroll-bar-cols () | |
308 "Return the width, measured in columns, of the right vertical scrollbar." | |
309 (let* ((wsb (window-scroll-bars)) | |
310 (vtype (nth 2 wsb)) | |
311 (cols (nth 1 wsb))) | |
312 (if (or (eq vtype 'left) | |
313 (and (eq vtype t) | |
314 (eq (frame-parameter nil 'vertical-scroll-bars) 'left))) | |
315 (or cols | |
316 (ceiling | |
317 ;; nil means it's a non-toolkit scroll bar, | |
318 ;; and its width in columns is 14 pixels rounded up. | |
319 (or (frame-parameter nil 'scroll-bar-width) 14) | |
320 ;; Always round up to multiple of columns. | |
321 (frame-char-width))) | |
322 0))) | |
323 | |
324 (defun ruler-mode-right-scroll-bar-cols () | |
325 "Return the width, measured in columns, of the right vertical scrollbar." | |
326 (let* ((wsb (window-scroll-bars)) | |
327 (vtype (nth 2 wsb)) | |
328 (cols (nth 1 wsb))) | |
329 (if (or (eq vtype 'right) | |
330 (and (eq vtype t) | |
331 (eq (frame-parameter nil 'vertical-scroll-bars) 'right))) | |
332 (or cols | |
333 (ceiling | |
334 ;; nil means it's a non-toolkit scroll bar, | |
335 ;; and its width in columns is 14 pixels rounded up. | |
336 (or (frame-parameter nil 'scroll-bar-width) 14) | |
337 ;; Always round up to multiple of columns. | |
338 (frame-char-width))) | |
339 0))) | |
340 | |
341 (defsubst ruler-mode-full-window-width () | |
342 "Return the full width of the selected window." | |
343 (let ((edges (window-edges))) | |
344 (- (nth 2 edges) (nth 0 edges)))) | |
345 | |
346 (defsubst ruler-mode-window-col (n) | |
347 "Return a column number relative to the selected window. | |
348 N is a column number relative to selected frame." | |
349 (- n | |
350 (car (window-edges)) | |
351 (or (car (window-margins)) 0) | |
352 (ruler-mode-left-fringe-cols) | |
353 (ruler-mode-left-scroll-bar-cols))) | |
354 | |
39731 | 355 (defun ruler-mode-mouse-set-left-margin (start-event) |
51389 | 356 "Set left margin end to the graduation where the mouse pointer is on. |
39731 | 357 START-EVENT is the mouse click event." |
358 (interactive "e") | |
359 (let* ((start (event-start start-event)) | |
360 (end (event-end start-event)) | |
51389 | 361 col w lm rm) |
362 (when (eq start end) ;; mouse click | |
363 (save-selected-window | |
364 (select-window (posn-window start)) | |
365 (setq col (- (car (posn-col-row start)) (car (window-edges)) | |
366 (ruler-mode-left-scroll-bar-cols)) | |
367 w (- (ruler-mode-full-window-width) | |
368 (ruler-mode-left-scroll-bar-cols) | |
369 (ruler-mode-right-scroll-bar-cols))) | |
370 (when (and (>= col 0) (< col w)) | |
371 (setq lm (window-margins) | |
372 rm (or (cdr lm) 0) | |
373 lm (or (car lm) 0)) | |
374 (message "Left margin set to %d (was %d)" col lm) | |
375 (set-window-margins nil col rm)))))) | |
39731 | 376 |
377 (defun ruler-mode-mouse-set-right-margin (start-event) | |
51389 | 378 "Set right margin beginning to the graduation where the mouse pointer is on. |
39731 | 379 START-EVENT is the mouse click event." |
380 (interactive "e") | |
381 (let* ((start (event-start start-event)) | |
382 (end (event-end start-event)) | |
51389 | 383 col w lm rm) |
384 (when (eq start end) ;; mouse click | |
385 (save-selected-window | |
386 (select-window (posn-window start)) | |
387 (setq col (- (car (posn-col-row start)) (car (window-edges)) | |
388 (ruler-mode-left-scroll-bar-cols)) | |
389 w (- (ruler-mode-full-window-width) | |
390 (ruler-mode-left-scroll-bar-cols) | |
391 (ruler-mode-right-scroll-bar-cols))) | |
392 (when (and (>= col 0) (< col w)) | |
393 (setq lm (window-margins) | |
394 rm (or (cdr lm) 0) | |
395 lm (or (car lm) 0) | |
396 col (- w col 1)) | |
397 (message "Right margin set to %d (was %d)" col rm) | |
398 (set-window-margins nil lm col)))))) | |
39731 | 399 |
51389 | 400 (defvar ruler-mode-dragged-symbol nil |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
401 "Column symbol dragged in the ruler. |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
402 That is `fill-column', `comment-column', `goal-column', or nil when |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
403 nothing is dragged.") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
404 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
405 (defun ruler-mode-mouse-grab-any-column (start-event) |
51389 | 406 "Drag a column symbol on the ruler. |
407 Start dragging on mouse down event START-EVENT, and update the column | |
408 symbol value with the current value of the ruler graduation while | |
409 dragging. See also the variable `ruler-mode-dragged-symbol'." | |
39731 | 410 (interactive "e") |
51389 | 411 (setq ruler-mode-dragged-symbol nil) |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
412 (let* ((start (event-start start-event)) |
51389 | 413 col newc oldc) |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
414 (save-selected-window |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
415 (select-window (posn-window start)) |
51389 | 416 (setq col (ruler-mode-window-col (car (posn-col-row start))) |
417 newc (+ col (window-hscroll))) | |
418 (and | |
419 (>= col 0) (< col (window-width)) | |
420 (cond | |
421 | |
422 ;; Handle the fill column. | |
423 ((eq newc fill-column) | |
424 (setq oldc fill-column | |
425 ruler-mode-dragged-symbol 'fill-column) | |
426 t) ;; Start dragging | |
427 | |
428 ;; Handle the comment column. | |
429 ((eq newc comment-column) | |
430 (setq oldc comment-column | |
431 ruler-mode-dragged-symbol 'comment-column) | |
432 t) ;; Start dragging | |
433 | |
434 ;; Handle the goal column. | |
435 ;; A. On mouse down on the goal column character on the ruler, | |
436 ;; update the `goal-column' value while dragging. | |
437 ;; B. If `goal-column' is nil, set the goal column where the | |
438 ;; mouse is clicked. | |
439 ;; C. On mouse click on the goal column character on the | |
440 ;; ruler, unset the goal column. | |
441 ((eq newc goal-column) ; A. Drag the goal column. | |
442 (setq oldc goal-column | |
443 ruler-mode-dragged-symbol 'goal-column) | |
444 t) ;; Start dragging | |
445 | |
446 ((null goal-column) ; B. Set the goal column. | |
447 (setq oldc goal-column | |
448 goal-column newc) | |
449 ;; mouse-2 coming AFTER drag-mouse-2 invokes `ding'. This | |
450 ;; `ding' flushes the next messages about setting goal | |
451 ;; column. So here I force fetch the event(mouse-2) and | |
452 ;; throw away. | |
453 (read-event) | |
454 ;; Ding BEFORE `message' is OK. | |
455 (when ruler-mode-set-goal-column-ding-flag | |
456 (ding)) | |
457 (message "Goal column set to %d (click on %s again to unset it)" | |
458 newc | |
459 (propertize (char-to-string ruler-mode-goal-column-char) | |
460 'face 'ruler-mode-goal-column-face)) | |
461 nil) ;; Don't start dragging. | |
462 ) | |
463 (if (eq 'click (ruler-mode-mouse-drag-any-column-iteration | |
464 (posn-window start))) | |
465 (when (eq 'goal-column ruler-mode-dragged-symbol) | |
466 ;; C. Unset the goal column. | |
467 (set-goal-column t)) | |
468 ;; At end of dragging, report the updated column symbol. | |
469 (message "%s is set to %d (was %d)" | |
470 ruler-mode-dragged-symbol | |
471 (symbol-value ruler-mode-dragged-symbol) | |
472 oldc)))))) | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
473 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
474 (defun ruler-mode-mouse-drag-any-column-iteration (window) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
475 "Update the ruler while dragging the mouse. |
51389 | 476 WINDOW is the window where occurred the last down-mouse event. |
477 Return the symbol `drag' if the mouse has been dragged, or `click' if | |
478 the mouse has been clicked." | |
479 (let ((drags 0) | |
480 event) | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
481 (track-mouse |
51389 | 482 (while (mouse-movement-p (setq event (read-event))) |
483 (setq drags (1+ drags)) | |
484 (when (eq window (posn-window (event-end event))) | |
485 (ruler-mode-mouse-drag-any-column event) | |
486 (force-mode-line-update)))) | |
487 (if (and (zerop drags) (eq 'click (car (event-modifiers event)))) | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
488 'click |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
489 'drag))) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
490 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
491 (defun ruler-mode-mouse-drag-any-column (start-event) |
51389 | 492 "Update the value of the symbol dragged on the ruler. |
493 Called on each mouse motion event START-EVENT." | |
39731 | 494 (let* ((start (event-start start-event)) |
495 (end (event-end start-event)) | |
51389 | 496 col newc) |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
497 (save-selected-window |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
498 (select-window (posn-window start)) |
51389 | 499 (setq col (ruler-mode-window-col (car (posn-col-row end))) |
500 newc (+ col (window-hscroll))) | |
501 (when (and (>= col 0) (< col (window-width))) | |
502 (set ruler-mode-dragged-symbol newc))))) | |
41461 | 503 |
39731 | 504 (defun ruler-mode-mouse-add-tab-stop (start-event) |
505 "Add a tab stop to the graduation where the mouse pointer is on. | |
506 START-EVENT is the mouse click event." | |
507 (interactive "e") | |
51389 | 508 (when ruler-mode-show-tab-stops |
509 (let* ((start (event-start start-event)) | |
510 (end (event-end start-event)) | |
511 col ts) | |
512 (when (eq start end) ;; mouse click | |
513 (save-selected-window | |
514 (select-window (posn-window start)) | |
515 (setq col (ruler-mode-window-col (car (posn-col-row start))) | |
516 ts (+ col (window-hscroll))) | |
517 (and (>= col 0) (< col (window-width)) | |
518 (not (member ts tab-stop-list)) | |
519 (progn | |
520 (message "Tab stop set to %d" ts) | |
521 (setq tab-stop-list (sort (cons ts tab-stop-list) | |
522 #'<))))))))) | |
39731 | 523 |
524 (defun ruler-mode-mouse-del-tab-stop (start-event) | |
525 "Delete tab stop at the graduation where the mouse pointer is on. | |
526 START-EVENT is the mouse click event." | |
527 (interactive "e") | |
51389 | 528 (when ruler-mode-show-tab-stops |
529 (let* ((start (event-start start-event)) | |
530 (end (event-end start-event)) | |
531 col ts) | |
532 (when (eq start end) ;; mouse click | |
533 (save-selected-window | |
534 (select-window (posn-window start)) | |
535 (setq col (ruler-mode-window-col (car (posn-col-row start))) | |
536 ts (+ col (window-hscroll))) | |
537 (and (>= col 0) (< col (window-width)) | |
538 (member ts tab-stop-list) | |
539 (progn | |
540 (message "Tab stop at %d deleted" ts) | |
541 (setq tab-stop-list (delete ts tab-stop-list))))))))) | |
39731 | 542 |
543 (defun ruler-mode-toggle-show-tab-stops () | |
544 "Toggle showing of tab stops on the ruler." | |
545 (interactive) | |
41461 | 546 (setq ruler-mode-show-tab-stops (not ruler-mode-show-tab-stops)) |
547 (force-mode-line-update)) | |
548 | |
39731 | 549 (defvar ruler-mode-map |
550 (let ((km (make-sparse-keymap))) | |
551 (define-key km [header-line down-mouse-1] | |
552 #'ignore) | |
553 (define-key km [header-line down-mouse-3] | |
554 #'ignore) | |
555 (define-key km [header-line down-mouse-2] | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
556 #'ruler-mode-mouse-grab-any-column) |
39731 | 557 (define-key km [header-line (shift down-mouse-1)] |
558 #'ruler-mode-mouse-set-left-margin) | |
559 (define-key km [header-line (shift down-mouse-3)] | |
560 #'ruler-mode-mouse-set-right-margin) | |
561 (define-key km [header-line (control down-mouse-1)] | |
562 #'ruler-mode-mouse-add-tab-stop) | |
563 (define-key km [header-line (control down-mouse-3)] | |
564 #'ruler-mode-mouse-del-tab-stop) | |
565 (define-key km [header-line (control down-mouse-2)] | |
566 #'ruler-mode-toggle-show-tab-stops) | |
567 km) | |
568 "Keymap for ruler minor mode.") | |
569 | |
570 (defvar ruler-mode-header-line-format-old nil | |
571 "Hold previous value of `header-line-format'.") | |
572 (make-variable-buffer-local 'ruler-mode-header-line-format-old) | |
573 | |
574 (defconst ruler-mode-header-line-format | |
575 '(:eval (ruler-mode-ruler)) | |
576 "`header-line-format' used in ruler mode.") | |
577 | |
578 ;;;###autoload | |
579 (define-minor-mode ruler-mode | |
580 "Display a ruler in the header line if ARG > 0." | |
581 nil nil | |
582 ruler-mode-map | |
583 :group 'ruler-mode | |
584 (if ruler-mode | |
585 (progn | |
586 ;; When `ruler-mode' is on save previous header line format | |
587 ;; and install the ruler header line format. | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
588 (when (local-variable-p 'header-line-format) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
589 (setq ruler-mode-header-line-format-old header-line-format)) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
590 (setq header-line-format ruler-mode-header-line-format) |
39731 | 591 (add-hook 'post-command-hook ; add local hook |
592 #'force-mode-line-update nil t)) | |
593 ;; When `ruler-mode' is off restore previous header line format if | |
594 ;; the current one is the ruler header line format. | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
595 (when (eq header-line-format ruler-mode-header-line-format) |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
596 (kill-local-variable 'header-line-format) |
51389 | 597 (when (local-variable-p 'ruler-mode-header-line-format-old) |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
598 (setq header-line-format ruler-mode-header-line-format-old))) |
39731 | 599 (remove-hook 'post-command-hook ; remove local hook |
600 #'force-mode-line-update t))) | |
41461 | 601 |
42706 | 602 ;; Add ruler-mode to the minor mode menu in the mode line |
39731 | 603 (define-key mode-line-mode-menu [ruler-mode] |
604 `(menu-item "Ruler" ruler-mode | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
605 :button (:toggle . ruler-mode))) |
39731 | 606 |
607 (defconst ruler-mode-ruler-help-echo | |
608 "\ | |
609 S-mouse-1/3: set L/R margin, \ | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
610 mouse-2: set goal column, \ |
39731 | 611 C-mouse-2: show tabs" |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
612 "Help string shown when mouse is over the ruler. |
39731 | 613 `ruler-mode-show-tab-stops' is nil.") |
614 | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
615 (defconst ruler-mode-ruler-help-echo-when-goal-column |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
616 "\ |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
617 S-mouse-1/3: set L/R margin, \ |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
618 C-mouse-2: show tabs" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
619 "Help string shown when mouse is over the ruler. |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
620 `goal-column' is set and `ruler-mode-show-tab-stops' is nil.") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
621 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
622 (defconst ruler-mode-ruler-help-echo-when-tab-stops |
39731 | 623 "\ |
624 C-mouse1/3: set/unset tab, \ | |
625 C-mouse-2: hide tabs" | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
626 "Help string shown when mouse is over the ruler. |
39731 | 627 `ruler-mode-show-tab-stops' is non-nil.") |
628 | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
629 (defconst ruler-mode-fill-column-help-echo |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
630 "drag-mouse-2: set fill column" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
631 "Help string shown when mouse is on the fill column character.") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
632 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
633 (defconst ruler-mode-comment-column-help-echo |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
634 "drag-mouse-2: set comment column" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
635 "Help string shown when mouse is on the comment column character.") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
636 |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
637 (defconst ruler-mode-goal-column-help-echo |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
638 "\ |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
639 drag-mouse-2: set goal column, \ |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
640 mouse-2: unset goal column" |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
641 "Help string shown when mouse is on the goal column character.") |
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
642 |
51389 | 643 (defconst ruler-mode-margin-help-echo |
644 "%s margin %S" | |
645 "Help string shown when mouse is over a margin area.") | |
42020
6e891121e1cc
(ruler-mode-extra-left-cols): Removed.
Richard M. Stallman <rms@gnu.org>
parents:
42003
diff
changeset
|
646 |
51389 | 647 (defconst ruler-mode-fringe-help-echo |
648 "%s fringe %S" | |
649 "Help string shown when mouse is over a fringe area.") | |
41461 | 650 |
39731 | 651 (defun ruler-mode-ruler () |
652 "Return a string ruler." | |
51389 | 653 (when ruler-mode |
654 (let* ((fullw (ruler-mode-full-window-width)) | |
655 (w (window-width)) | |
656 (m (window-margins)) | |
657 (lsb (ruler-mode-left-scroll-bar-cols)) | |
658 (lf (ruler-mode-left-fringe-cols)) | |
659 (lm (or (car m) 0)) | |
660 (rsb (ruler-mode-right-scroll-bar-cols)) | |
661 (rf (ruler-mode-right-fringe-cols)) | |
662 (rm (or (cdr m) 0)) | |
663 (ruler (make-string fullw ruler-mode-basic-graduation-char)) | |
664 (o (+ lsb lf lm)) | |
665 (x 0) | |
666 (i o) | |
667 (j (window-hscroll)) | |
668 k c l1 l2 r2 r1 h1 h2 f1 f2) | |
39731 | 669 |
51389 | 670 ;; Setup the default properties. |
671 (put-text-property 0 fullw 'face 'ruler-mode-default-face ruler) | |
672 (put-text-property 0 fullw | |
673 'help-echo | |
674 (cond | |
675 (ruler-mode-show-tab-stops | |
676 ruler-mode-ruler-help-echo-when-tab-stops) | |
677 (goal-column | |
678 ruler-mode-ruler-help-echo-when-goal-column) | |
679 (t | |
680 ruler-mode-ruler-help-echo)) | |
681 ruler) | |
682 ;; Setup the local map. | |
683 (put-text-property 0 fullw 'local-map ruler-mode-map ruler) | |
39731 | 684 |
51389 | 685 ;; Setup the active area. |
686 (while (< x w) | |
687 ;; Graduations. | |
688 (cond | |
689 ;; Show a number graduation. | |
690 ((= (mod j 10) 0) | |
691 (setq c (number-to-string (/ j 10)) | |
692 m (length c) | |
693 k i) | |
694 (put-text-property | |
695 i (1+ i) 'face 'ruler-mode-column-number-face | |
696 ruler) | |
697 (while (and (> m 0) (>= k 0)) | |
698 (aset ruler k (aref c (setq m (1- m)))) | |
699 (setq k (1- k)))) | |
700 ;; Show an intermediate graduation. | |
701 ((= (mod j 5) 0) | |
702 (aset ruler i ruler-mode-inter-graduation-char))) | |
703 ;; Special columns. | |
704 (cond | |
705 ;; Show the `current-column' marker. | |
706 ((= j (current-column)) | |
707 (aset ruler i ruler-mode-current-column-char) | |
708 (put-text-property | |
709 i (1+ i) 'face 'ruler-mode-current-column-face | |
710 ruler)) | |
711 ;; Show the `goal-column' marker. | |
712 ((and goal-column (= j goal-column)) | |
713 (aset ruler i ruler-mode-goal-column-char) | |
714 (put-text-property | |
715 i (1+ i) 'face 'ruler-mode-goal-column-face | |
716 ruler) | |
717 (put-text-property | |
718 i (1+ i) 'help-echo ruler-mode-goal-column-help-echo | |
719 ruler)) | |
720 ;; Show the `comment-column' marker. | |
721 ((= j comment-column) | |
722 (aset ruler i ruler-mode-comment-column-char) | |
723 (put-text-property | |
724 i (1+ i) 'face 'ruler-mode-comment-column-face | |
725 ruler) | |
726 (put-text-property | |
727 i (1+ i) 'help-echo ruler-mode-comment-column-help-echo | |
728 ruler)) | |
729 ;; Show the `fill-column' marker. | |
730 ((= j fill-column) | |
731 (aset ruler i ruler-mode-fill-column-char) | |
732 (put-text-property | |
733 i (1+ i) 'face 'ruler-mode-fill-column-face | |
734 ruler) | |
735 (put-text-property | |
736 i (1+ i) 'help-echo ruler-mode-fill-column-help-echo | |
737 ruler)) | |
738 ;; Show the `tab-stop-list' markers. | |
739 ((and ruler-mode-show-tab-stops (member j tab-stop-list)) | |
740 (aset ruler i ruler-mode-tab-stop-char) | |
741 (put-text-property | |
742 i (1+ i) 'face 'ruler-mode-tab-stop-face | |
743 ruler))) | |
744 (setq i (1+ i) | |
745 j (1+ j) | |
746 x (1+ x))) | |
49195
c297d31ef382
(ruler-mode-comment-column-char, ruler-mode-goal-column-char)
Juanma Barranquero <lekktu@gmail.com>
parents:
47425
diff
changeset
|
747 |
51389 | 748 ;; Highlight the fringes and margins. |
749 (if (nth 2 (window-fringes)) | |
750 ;; fringes outside margins. | |
751 (setq l1 lf | |
752 l2 lm | |
753 r2 rm | |
754 r1 rf | |
755 h1 ruler-mode-fringe-help-echo | |
756 h2 ruler-mode-margin-help-echo | |
757 f1 'ruler-mode-fringes-face | |
758 f2 'ruler-mode-margins-face) | |
759 ;; fringes inside margins. | |
760 (setq l1 lm | |
761 l2 lf | |
762 r2 rf | |
763 r1 rm | |
764 h1 ruler-mode-margin-help-echo | |
765 h2 ruler-mode-fringe-help-echo | |
766 f1 'ruler-mode-margins-face | |
767 f2 'ruler-mode-fringes-face)) | |
768 (setq i lsb j (+ i l1)) | |
769 (put-text-property i j 'face f1 ruler) | |
770 (put-text-property i j 'help-echo (format h1 "Left" l1) ruler) | |
771 (setq i j j (+ i l2)) | |
772 (put-text-property i j 'face f2 ruler) | |
773 (put-text-property i j 'help-echo (format h2 "Left" l2) ruler) | |
774 (setq i (+ o w) j (+ i r2)) | |
775 (put-text-property i j 'face f2 ruler) | |
776 (put-text-property i j 'help-echo (format h2 "Right" r2) ruler) | |
777 (setq i j j (+ i r1)) | |
778 (put-text-property i j 'face f1 ruler) | |
779 (put-text-property i j 'help-echo (format h1 "Right" r1) ruler) | |
39731 | 780 |
51389 | 781 ;; Show inactive areas. |
782 (put-text-property 0 lsb 'face 'ruler-mode-pad-face ruler) | |
783 (put-text-property j fullw 'face 'ruler-mode-pad-face ruler) | |
39731 | 784 |
51389 | 785 ;; Return the ruler propertized string. |
786 ruler))) | |
39731 | 787 |
788 (provide 'ruler-mode) | |
789 | |
790 ;; Local Variables: | |
791 ;; coding: iso-latin-1 | |
792 ;; End: | |
793 | |
794 ;;; ruler-mode.el ends here |