Commit | Line | Data |
---|---|---|
0fcb495e JB |
1 | ;;; linum.el --- display line numbers in the left margin |
2 | ||
3 | ;; Copyright (C) 2008 Free Software Foundation, Inc. | |
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 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
0fcb495e | 12 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
0fcb495e JB |
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 | |
eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
0fcb495e JB |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;; Display line numbers for the current buffer. | |
27 | ;; | |
ced5b5cb | 28 | ;; Toggle display of line numbers with M-x linum-mode. To enable |
0fcb495e JB |
29 | ;; line numbering in all buffers, use M-x global-linum-mode. |
30 | ||
31 | ;;; Code: | |
32 | ||
21259ba1 | 33 | (defconst linum-version "0.9wz") |
0fcb495e JB |
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 | |
21259ba1 | 57 | '((t :inherit (shadow default))) |
0fcb495e JB |
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 | ||
21259ba1 | 68 | (defcustom linum-delay nil |
0fcb495e JB |
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 | ;; mistake in Emacs: window-size-change-functions cannot be local | |
86 | (add-hook 'window-size-change-functions 'linum-after-size) | |
87 | (add-hook 'change-major-mode-hook 'linum-delete-overlays nil t) | |
88 | (add-hook 'window-configuration-change-hook | |
89 | 'linum-after-config nil t) | |
90 | (linum-update-current)) | |
91 | (remove-hook 'post-command-hook 'linum-update-current t) | |
92 | (remove-hook 'post-command-hook 'linum-schedule t) | |
93 | (remove-hook 'window-size-change-functions 'linum-after-size) | |
94 | (remove-hook 'window-scroll-functions 'linum-after-scroll t) | |
95 | (remove-hook 'after-change-functions 'linum-after-change t) | |
96 | (remove-hook 'window-configuration-change-hook 'linum-after-config t) | |
97 | (remove-hook 'change-major-mode-hook 'linum-delete-overlays t) | |
98 | (linum-delete-overlays))) | |
99 | ||
100 | ;;;###autoload | |
101 | (define-globalized-minor-mode global-linum-mode linum-mode linum-on) | |
102 | ||
103 | (defun linum-on () | |
104 | (unless (minibufferp) | |
105 | (linum-mode 1))) | |
106 | ||
107 | (defun linum-delete-overlays () | |
108 | "Delete all overlays displaying line numbers for this buffer." | |
109 | (mapc #'delete-overlay linum-overlays) | |
110 | (setq linum-overlays nil) | |
111 | (dolist (w (get-buffer-window-list (current-buffer) nil t)) | |
112 | (set-window-margins w 0))) | |
113 | ||
114 | (defun linum-update-current () | |
115 | "Update line numbers for the current buffer." | |
116 | (linum-update (current-buffer))) | |
117 | ||
118 | (defun linum-update (buffer) | |
119 | "Update line numbers for all windows displaying BUFFER." | |
120 | (with-current-buffer buffer | |
121 | (when linum-mode | |
122 | (setq linum-available linum-overlays) | |
123 | (setq linum-overlays nil) | |
124 | (save-excursion | |
125 | (mapc #'linum-update-window | |
126 | (get-buffer-window-list buffer nil 'visible))) | |
127 | (mapc #'delete-overlay linum-available) | |
128 | (setq linum-available nil)))) | |
129 | ||
130 | (defun linum-update-window (win) | |
131 | "Update line numbers for the portion visible in window WIN." | |
132 | (goto-char (window-start win)) | |
133 | (let ((line (line-number-at-pos)) | |
21259ba1 | 134 | (limit (window-end win t)) |
0fcb495e JB |
135 | (fmt (cond ((stringp linum-format) linum-format) |
136 | ((eq linum-format 'dynamic) | |
137 | (let ((w (length (number-to-string | |
138 | (count-lines (point-min) (point-max)))))) | |
139 | (concat "%" (number-to-string w) "d"))))) | |
21259ba1 | 140 | (width 0)) |
0fcb495e JB |
141 | (run-hooks 'linum-before-numbering-hook) |
142 | ;; Create an overlay (or reuse an existing one) for each | |
143 | ;; line visible in this window, if necessary. | |
21259ba1 CY |
144 | (while (and (not (eobp)) (<= (point) limit)) |
145 | (let* ((str (if fmt | |
146 | (propertize (format fmt line) 'face 'linum) | |
147 | (funcall linum-format line))) | |
148 | (visited (catch 'visited | |
149 | (dolist (o (overlays-in (point) (point))) | |
150 | (when (string= (overlay-get o 'linum-str) str) | |
151 | (unless (memq o linum-overlays) | |
152 | (push o linum-overlays)) | |
153 | (setq linum-available (delete o linum-available)) | |
154 | (throw 'visited t)))))) | |
0fcb495e JB |
155 | (setq width (max width (length str))) |
156 | (unless visited | |
21259ba1 CY |
157 | (let (ov) |
158 | (if (null linum-available) | |
159 | (setq ov (make-overlay (point) (point))) | |
160 | (setq ov (pop linum-available)) | |
161 | (move-overlay ov (point) (point))) | |
162 | (push ov linum-overlays) | |
163 | (overlay-put ov 'before-string | |
164 | (propertize " " 'display `((margin left-margin) ,str))) | |
165 | (overlay-put ov 'linum-str str)))) | |
0fcb495e JB |
166 | (forward-line) |
167 | (setq line (1+ line))) | |
168 | (set-window-margins win width))) | |
169 | ||
170 | (defun linum-after-change (beg end len) | |
171 | ;; update overlays on deletions, and after newlines are inserted | |
172 | (when (or (= beg end) | |
173 | (= end (point-max)) | |
174 | (string-match-p "\n" (buffer-substring-no-properties beg end))) | |
175 | (linum-update-current))) | |
176 | ||
177 | (defun linum-after-scroll (win start) | |
178 | (linum-update (window-buffer win))) | |
179 | ||
180 | (defun linum-after-size (frame) | |
181 | (linum-after-config)) | |
182 | ||
183 | (defun linum-schedule () | |
184 | ;; schedule an update; the delay gives Emacs a chance for display changes | |
185 | (run-with-idle-timer 0 nil #'linum-update-current)) | |
186 | ||
187 | (defun linum-after-config () | |
a5b6e5a4 | 188 | (walk-windows (lambda (w) (linum-update (window-buffer w))) nil 'visible)) |
0fcb495e | 189 | |
08cf830b JB |
190 | (defun linum-unload-function () |
191 | "Unload the Linum library." | |
192 | (global-linum-mode -1) | |
193 | ;; continue standard unloading | |
194 | nil) | |
195 | ||
0fcb495e JB |
196 | (provide 'linum) |
197 | ||
ad38e1fc | 198 | ;; arch-tag: dea45631-ed3c-4867-8b49-1c41c80aec6a |
0fcb495e | 199 | ;;; linum.el ends here |