Merge commit '3abcd90ddc2f446ddf0fb874dd79ba870c26ad2d' from js2-mode

[gnu-emacs-elpa] / packages / nlinum / nlinum.el

diff --git a/packages/nlinum/nlinum.el b/packages/nlinum/nlinum.el
index 40d6214c2ed5d8271a5a8ff17a4c0eb8a684b022..82e274c7a90bc295762581d636652e2075bc1585 100644 (file)
--- a/packages/nlinum/nlinum.el
+++ b/packages/nlinum/nlinum.el
@@ -4,7 +4,7 @@
 
 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
 ;; Keywords: convenience
-;; Version: 1.2
+;; Version: 1.5
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -26,6 +26,10 @@
 
 ;;; News:
 
+;; v1.3:
+;; - New custom variable `nlinum-format'.
+;; - Change in calling convention of `nlinum-format-function'.
+
 ;; v1.2:
 ;; - New global mode `global-nlinum-mode'.
 ;; - New config var `nlinum-format-function'.
@@ -50,20 +54,34 @@ Linum mode is a buffer-local minor mode."
   :lighter nil ;; (" NLinum" nlinum--desc)
   (jit-lock-unregister #'nlinum--region)
   (remove-hook 'window-configuration-change-hook #'nlinum--setup-window t)
-  (remove-hook 'after-change-functions #'nlinum--after-change)
+  (remove-hook 'after-change-functions #'nlinum--after-change t)
   (kill-local-variable 'nlinum--line-number-cache)
   (remove-overlays (point-min) (point-max) 'nlinum t)
   ;; (kill-local-variable 'nlinum--ol-counter)
   (kill-local-variable 'nlinum--width)
   (when nlinum-mode
+    ;; FIXME: Another approach would be to make the mode permanent-local,
+    ;; which might indeed be preferable.
+    (add-hook 'change-major-mode-hook (lambda () (nlinum-mode -1)))
     (add-hook 'window-configuration-change-hook #'nlinum--setup-window nil t)
     (add-hook 'after-change-functions #'nlinum--after-change nil t)
     (jit-lock-register #'nlinum--region t))
   (nlinum--setup-windows))
 
+(defun nlinum--face-height (face)
+  (aref (font-info (face-font face)) 2))
+
 (defun nlinum--setup-window ()
-  (set-window-margins nil (if nlinum-mode nlinum--width)
-                      (cdr (window-margins))))
+  (let ((width (if (display-graphic-p)
+                   (ceiling
+                    ;; We'd really want to check the widths rather than the
+                    ;; heights, but it's a start.
+                    (/ (* nlinum--width 1.0
+                          (nlinum--face-height 'linum))
+                       (frame-char-height)))
+                 nlinum--width)))
+    (set-window-margins nil (if nlinum-mode width)
+                        (cdr (window-margins)))))
 
 (defun nlinum--setup-windows ()
   (dolist (win (get-buffer-window-list nil nil t))
@@ -77,6 +95,8 @@ Linum mode is a buffer-local minor mode."
                   (lambda (buf)
                     (with-current-buffer buf
                       (with-silent-modifications
+                        ;; FIXME: only remove `fontified' on those parts of the
+                        ;; buffer that had an nlinum overlay!
                         (remove-text-properties
                          (point-min) (point-max) '(fontified)))))
                   (current-buffer)))
@@ -130,6 +150,14 @@ Linum mode is a buffer-local minor mode."
 (defvar nlinum--line-number-cache nil)
 (make-variable-buffer-local 'nlinum--line-number-cache)
 
+;; We could try and avoid flushing the cache at every change, e.g. with:
+;;   (defun nlinum--before-change (start _end)
+;;     (if (and nlinum--line-number-cache
+;;              (< start (car nlinum--line-number-cache)))
+;;         (save-excursion (goto-char start) (nlinum--line-number-at-pos))))
+;; But it's far from clear that it's worth the trouble.  The current simplistic
+;; approach seems to be good enough in practice.
+
 (defun nlinum--after-change (&rest _args)
   (setq nlinum--line-number-cache nil))
 
@@ -149,14 +177,24 @@ Linum mode is a buffer-local minor mode."
     (setq nlinum--line-number-cache (cons (point) pos))
     pos))
 
+(defcustom nlinum-format "%d"
+  "Format of the line numbers.
+Used by the default `nlinum-format-function'."
+  :type 'string
+  :group 'linum)
+
 (defvar nlinum-format-function
-  (lambda (line)
-    (let* ((fmt (format "%%%dd" nlinum--width))
-           (str (propertize (format fmt line) 'face 'linum)))
+  (lambda (line width)
+    (let ((str (format nlinum-format line)))
+      (when (< (length str) width)
+        ;; Left pad to try and right-align the line-numbers.
+        (setq str (concat (make-string (- width (length str)) ?\ ) str)))
+      (put-text-property 0 width 'face 'linum str)
       str))
   "Function to build the string representing the line number.
-Takes one argument (the line number) and returns a string whose width
-should be at least equal to `nlinum--width'.")
+Takes 2 arguments LINE and WIDTH, both of them numbers, and should return
+a string.  WIDTH is the ideal width of the result.  If the result is larger,
+it may cause the margin to be resized and line numbers to be recomputed.")
 
 (defun nlinum--region (start limit)
   (save-excursion
@@ -170,7 +208,8 @@ should be at least equal to `nlinum--width'.")
         (while
             (and (not (eobp)) (< (point) limit)
                  (let* ((ol (make-overlay (point) (1+ (point))))
-                        (str (funcall nlinum-format-function line))
+                        (str (funcall nlinum-format-function
+                                      line nlinum--width))
                         (width (string-width str)))
                    (when (< nlinum--width width)
                      (setq nlinum--width width)