Mercurial > emacs
annotate lisp/linum.el @ 101716:79f16674b60b
(elp-results-symname-map): Add follow-link.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Sat, 31 Jan 2009 17:00:54 +0000 |
parents | 4bcf5c96d5ee |
children | fe22bf79af7f |
rev | line source |
---|---|
97899 | 1 ;;; linum.el --- display line numbers in the left margin |
2 | |
100908 | 3 ;; Copyright (C) 2008, 2009 Free Software Foundation, Inc. |
97899 | 4 |
5 ;; Author: Markus Triska <markus.triska@gmx.at> | |
6 ;; Maintainer: FSF | |
7 ;; Keywords: convenience | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software: you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation, either version 3 of the License, or | |
14 ;; (at your option) any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
23 | |
24 ;;; Commentary: | |
25 | |
26 ;; Display line numbers for the current buffer. | |
27 ;; | |
28 ;; Toggle display of line numbers with M-x linum-mode. To enable | |
29 ;; line numbering in all buffers, use M-x global-linum-mode. | |
30 | |
31 ;;; Code: | |
32 | |
33 (defconst linum-version "0.9x") | |
34 | |
35 (defvar linum-overlays nil "Overlays used in this buffer.") | |
36 (defvar linum-available nil "Overlays available for reuse.") | |
37 (defvar linum-before-numbering-hook nil | |
38 "Functions run in each buffer before line numbering starts.") | |
39 | |
40 (mapc #'make-variable-buffer-local '(linum-overlays linum-available)) | |
41 | |
42 (defgroup linum nil | |
43 "Show line numbers in the left margin." | |
44 :group 'convenience) | |
45 | |
46 ;;;###autoload | |
47 (defcustom linum-format 'dynamic | |
48 "Format used to display line numbers. | |
49 Either a format string like \"%7d\", `dynamic' to adapt the width | |
50 as needed, or a function that is called with a line number as its | |
51 argument and should evaluate to a string to be shown on that line. | |
52 See also `linum-before-numbering-hook'." | |
53 :group 'linum | |
54 :type 'sexp) | |
55 | |
56 (defface linum | |
57 '((t :inherit (shadow default))) | |
58 "Face for displaying line numbers in the display margin." | |
59 :group 'linum) | |
60 | |
61 (defcustom linum-eager t | |
62 "Whether line numbers should be updated after each command. | |
63 The conservative setting `nil' might miss some buffer changes, | |
64 and you have to scroll or press \\[recenter-top-bottom] to update the numbers." | |
65 :group 'linum | |
66 :type 'boolean) | |
67 | |
68 (defcustom linum-delay nil | |
69 "Delay updates to give Emacs a chance for other changes." | |
70 :group 'linum | |
71 :type 'boolean) | |
72 | |
73 ;;;###autoload | |
74 (define-minor-mode linum-mode | |
75 "Toggle display of line numbers in the left margin." | |
76 :lighter "" ; for desktop.el | |
77 (if linum-mode | |
78 (progn | |
79 (if linum-eager | |
80 (add-hook 'post-command-hook (if linum-delay | |
81 'linum-schedule | |
82 'linum-update-current) nil t) | |
83 (add-hook 'after-change-functions 'linum-after-change nil t)) | |
84 (add-hook 'window-scroll-functions 'linum-after-scroll nil t) | |
85 (add-hook 'window-size-change-functions 'linum-after-size nil t) | |
86 (add-hook 'change-major-mode-hook 'linum-delete-overlays nil t) | |
87 (add-hook 'window-configuration-change-hook | |
88 'linum-after-config nil t) | |
89 (linum-update-current)) | |
90 (remove-hook 'post-command-hook 'linum-update-current t) | |
91 (remove-hook 'post-command-hook 'linum-schedule t) | |
92 (remove-hook 'window-size-change-functions 'linum-after-size t) | |
93 (remove-hook 'window-scroll-functions 'linum-after-scroll t) | |
94 (remove-hook 'after-change-functions 'linum-after-change t) | |
95 (remove-hook 'window-configuration-change-hook 'linum-after-config t) | |
96 (remove-hook 'change-major-mode-hook 'linum-delete-overlays t) | |
97 (linum-delete-overlays))) | |
98 | |
99 ;;;###autoload | |
100 (define-globalized-minor-mode global-linum-mode linum-mode linum-on) | |
101 | |
102 (defun linum-on () | |
103 (unless (minibufferp) | |
104 (linum-mode 1))) | |
105 | |
106 (defun linum-delete-overlays () | |
107 "Delete all overlays displaying line numbers for this buffer." | |
108 (mapc #'delete-overlay linum-overlays) | |
109 (setq linum-overlays nil) | |
110 (dolist (w (get-buffer-window-list (current-buffer) nil t)) | |
111 (set-window-margins w 0))) | |
112 | |
113 (defun linum-update-current () | |
114 "Update line numbers for the current buffer." | |
115 (linum-update (current-buffer))) | |
116 | |
117 (defun linum-update (buffer) | |
118 "Update line numbers for all windows displaying BUFFER." | |
119 (with-current-buffer buffer | |
120 (when linum-mode | |
121 (setq linum-available linum-overlays) | |
122 (setq linum-overlays nil) | |
123 (save-excursion | |
124 (mapc #'linum-update-window | |
125 (get-buffer-window-list buffer nil 'visible))) | |
126 (mapc #'delete-overlay linum-available) | |
127 (setq linum-available nil)))) | |
128 | |
129 (defun linum-update-window (win) | |
130 "Update line numbers for the portion visible in window WIN." | |
131 (goto-char (window-start win)) | |
132 (let ((line (line-number-at-pos)) | |
133 (limit (window-end win t)) | |
134 (fmt (cond ((stringp linum-format) linum-format) | |
135 ((eq linum-format 'dynamic) | |
136 (let ((w (length (number-to-string | |
137 (count-lines (point-min) (point-max)))))) | |
138 (concat "%" (number-to-string w) "d"))))) | |
139 (width 0)) | |
140 (run-hooks 'linum-before-numbering-hook) | |
141 ;; Create an overlay (or reuse an existing one) for each | |
142 ;; line visible in this window, if necessary. | |
143 (while (and (not (eobp)) (<= (point) limit)) | |
144 (let* ((str (if fmt | |
145 (propertize (format fmt line) 'face 'linum) | |
146 (funcall linum-format line))) | |
147 (visited (catch 'visited | |
148 (dolist (o (overlays-in (point) (point))) | |
101274
4bcf5c96d5ee
* linum.el (linum-update-window): Use `delq' instead of `delete';
Juanma Barranquero <lekktu@gmail.com>
parents:
100908
diff
changeset
|
149 (when (equal-including-properties |
4bcf5c96d5ee
* linum.el (linum-update-window): Use `delq' instead of `delete';
Juanma Barranquero <lekktu@gmail.com>
parents:
100908
diff
changeset
|
150 (overlay-get o 'linum-str) str) |
97899 | 151 (unless (memq o linum-overlays) |
152 (push o linum-overlays)) | |
101274
4bcf5c96d5ee
* linum.el (linum-update-window): Use `delq' instead of `delete';
Juanma Barranquero <lekktu@gmail.com>
parents:
100908
diff
changeset
|
153 (setq linum-available (delq o linum-available)) |
97899 | 154 (throw 'visited t)))))) |
155 (setq width (max width (length str))) | |
156 (unless visited | |
157 (let ((ov (if (null linum-available) | |
158 (make-overlay (point) (point)) | |
159 (move-overlay (pop linum-available) (point) (point))))) | |
160 (push ov linum-overlays) | |
161 (overlay-put ov 'before-string | |
162 (propertize " " 'display `((margin left-margin) ,str))) | |
163 (overlay-put ov 'linum-str str)))) | |
164 (forward-line) | |
165 (setq line (1+ line))) | |
166 (set-window-margins win width))) | |
167 | |
168 (defun linum-after-change (beg end len) | |
169 ;; update overlays on deletions, and after newlines are inserted | |
170 (when (or (= beg end) | |
171 (= end (point-max)) | |
172 (string-match-p "\n" (buffer-substring-no-properties beg end))) | |
173 (linum-update-current))) | |
174 | |
175 (defun linum-after-scroll (win start) | |
176 (linum-update (window-buffer win))) | |
177 | |
178 (defun linum-after-size (frame) | |
179 (linum-after-config)) | |
180 | |
181 (defun linum-schedule () | |
182 ;; schedule an update; the delay gives Emacs a chance for display changes | |
183 (run-with-idle-timer 0 nil #'linum-update-current)) | |
184 | |
185 (defun linum-after-config () | |
186 (walk-windows (lambda (w) (linum-update (window-buffer w))) nil 'visible)) | |
187 | |
188 (defun linum-unload-function () | |
189 "Unload the Linum library." | |
190 (global-linum-mode -1) | |
191 ;; continue standard unloading | |
192 nil) | |
193 | |
194 (provide 'linum) | |
195 | |
196 ;; arch-tag: dea45631-ed3c-4867-8b49-1c41c80aec6a | |
197 ;;; linum.el ends here |