Merge branch 'master-for-junio' of git://repo.or.cz/git/fastimport; branch 'maint'
[gitweb.git] / contrib / emacs / git-blame.el
index c99437e5e5bdd337b4538e695a9a3a6a94af0ffc..64ad50b3274d00199f5b3fc724eb5746b8eef480 100644 (file)
     colors))
 
 (defvar git-blame-dark-colors
-  (color-scale '("00" "04" "08" "0c"
-                 "10" "14" "18" "1c"
-                 "20" "24" "28" "2c"
-                 "30" "34" "38" "3c")))
+  (color-scale '("0c" "04" "24" "1c" "2c" "34" "14" "3c")))
 
 (defvar git-blame-light-colors
-  (color-scale '("c0" "c4" "c8" "cc"
-                 "d0" "d4" "d8" "dc"
-                 "e0" "e4" "e8" "ec"
-                 "f0" "f4" "f8" "fc")))
+  (color-scale '("c4" "d4" "cc" "dc" "f4" "e4" "fc" "ec")))
 
 (defvar git-blame-ancient-color "dark green")
 
-(defvar git-blame-overlays nil)
-(defvar git-blame-cache nil)
+(defvar git-blame-autoupdate t
+  "*Automatically update the blame display while editing")
+
+(defvar git-blame-proc nil
+  "The running git-blame process")
+(make-variable-buffer-local 'git-blame-proc)
+
+(defvar git-blame-overlays nil
+  "The git-blame overlays used in the current buffer.")
+(make-variable-buffer-local 'git-blame-overlays)
+
+(defvar git-blame-cache nil
+  "A cache of git-blame information for the current buffer")
+(make-variable-buffer-local 'git-blame-cache)
+
+(defvar git-blame-idle-timer nil
+  "An idle timer that updates the blame")
+(make-variable-buffer-local 'git-blame-cache)
+
+(defvar git-blame-update-queue nil
+  "A queue of update requests")
+(make-variable-buffer-local 'git-blame-update-queue)
 
 (defvar git-blame-mode nil)
 (make-variable-buffer-local 'git-blame-mode)
 
 ;;;###autoload
 (defun git-blame-mode (&optional arg)
+  "Minor mode for displaying Git blame"
   (interactive "P")
   (if arg
       (setq git-blame-mode (eq arg 1))
     (setq git-blame-mode (not git-blame-mode)))
-  (make-local-variable 'git-blame-overlays)
   (make-local-variable 'git-blame-colors)
-  (make-local-variable 'git-blame-cache)
-  (let ((bgmode (cdr (assoc 'background-mode (frame-parameters)))))
-    (if (eq bgmode 'dark)
-        (setq git-blame-colors git-blame-dark-colors)
-      (setq git-blame-colors git-blame-light-colors)))
+  (if git-blame-autoupdate
+      (add-hook 'after-change-functions 'git-blame-after-change nil t)
+    (remove-hook 'after-change-functions 'git-blame-after-change t))
+  (git-blame-cleanup)
   (if git-blame-mode
-      (git-blame-run)
-    (git-blame-cleanup)))
-
-(defun git-blame-run ()
-  (let* ((display-buf (current-buffer))
-         (blame-buf (get-buffer-create
-                     (concat " git blame for " (buffer-name))))
-         (proc (start-process "git-blame" blame-buf
-                             "git" "blame" "--incremental"
-                             (file-name-nondirectory buffer-file-name))))
-    (mapcar 'delete-overlay git-blame-overlays)
-    (setq git-blame-overlays nil)
-    (setq git-blame-cache (make-hash-table :test 'equal))
-    (with-current-buffer blame-buf
-      (erase-buffer)
-      (make-local-variable 'git-blame-file)
-      (make-local-variable 'git-blame-current)
-      (setq git-blame-file display-buf)
-      (setq git-blame-current nil))
-    (set-process-filter proc 'git-blame-filter)
-    (set-process-sentinel proc 'git-blame-sentinel)))
+      (progn
+        (let ((bgmode (cdr (assoc 'background-mode (frame-parameters)))))
+          (if (eq bgmode 'dark)
+              (setq git-blame-colors git-blame-dark-colors)
+            (setq git-blame-colors git-blame-light-colors)))
+        (setq git-blame-cache (make-hash-table :test 'equal))
+        (git-blame-run))
+    (cancel-timer git-blame-idle-timer)))
+
+;;;###autoload
+(defun git-reblame ()
+  "Recalculate all blame information in the current buffer"
+  (unless git-blame-mode
+    (error "git-blame is not active"))
+  (interactive)
+  (git-blame-cleanup)
+  (git-blame-run))
+
+(defun git-blame-run (&optional startline endline)
+  (if git-blame-proc
+      ;; Should maybe queue up a new run here
+      (message "Already running git blame")
+    (let ((display-buf (current-buffer))
+          (blame-buf (get-buffer-create
+                      (concat " git blame for " (buffer-name))))
+          (args '("--incremental" "--contents" "-")))
+      (if startline
+          (setq args (append args
+                             (list "-L" (format "%d,%d" startline endline)))))
+      (setq args (append args
+                         (list (file-name-nondirectory buffer-file-name))))
+      (setq git-blame-proc
+            (apply 'start-process
+                   "git-blame" blame-buf
+                   "git" "blame"
+                   args))
+      (with-current-buffer blame-buf
+        (erase-buffer)
+        (make-local-variable 'git-blame-file)
+        (make-local-variable 'git-blame-current)
+        (setq git-blame-file display-buf)
+        (setq git-blame-current nil))
+      (set-process-filter git-blame-proc 'git-blame-filter)
+      (set-process-sentinel git-blame-proc 'git-blame-sentinel)
+      (process-send-region git-blame-proc (point-min) (point-max))
+      (process-send-eof git-blame-proc))))
+
+(defun remove-git-blame-text-properties (start end)
+  (let ((modified (buffer-modified-p))
+        (inhibit-read-only t))
+    (remove-text-properties start end '(point-entered nil))
+    (set-buffer-modified-p modified)))
 
 (defun git-blame-cleanup ()
   "Remove all blame properties"
     (mapcar 'delete-overlay git-blame-overlays)
     (setq git-blame-overlays nil)
-    (let ((modified (buffer-modified-p)))
-      (remove-text-properties (point-min) (point-max) '(point-entered nil))
-      (set-buffer-modified-p modified)))
+    (remove-git-blame-text-properties (point-min) (point-max)))
+
+(defun git-blame-update-region (start end)
+  "Rerun blame to get updates between START and END"
+  (let ((overlays (overlays-in start end)))
+    (while overlays
+      (let ((overlay (pop overlays)))
+        (if (< (overlay-start overlay) start)
+            (setq start (overlay-start overlay)))
+        (if (> (overlay-end overlay) end)
+            (setq end (overlay-end overlay)))
+        (setq git-blame-overlays (delete overlay git-blame-overlays))
+        (delete-overlay overlay))))
+  (remove-git-blame-text-properties start end)
+  ;; We can be sure that start and end are at line breaks
+  (git-blame-run (1+ (count-lines (point-min) start))
+                 (count-lines (point-min) end)))
 
 (defun git-blame-sentinel (proc status)
+  (with-current-buffer (process-buffer proc)
+    (with-current-buffer git-blame-file
+      (setq git-blame-proc nil)
+      (if git-blame-update-queue
+          (git-blame-delayed-update))))
   ;;(kill-buffer (process-buffer proc))
-  (message "git blame finished"))
+  ;;(message "git blame finished")
+  )
 
 (defvar in-blame-filter nil)
 
   (save-excursion
     (set-buffer git-blame-file)
     (let ((info (gethash hash git-blame-cache))
-          (inhibit-point-motion-hooks t))
+          (inhibit-point-motion-hooks t)
+          (inhibit-modification-hooks t))
       (when (not info)
         (let ((color (pop git-blame-colors)))
           (unless color
       (message "%s" (nth 4 info))
       (setq git-blame-last-identification info))))
 
+;; (defun git-blame-after-save ()
+;;   (when git-blame-mode
+;;     (git-blame-cleanup)
+;;     (git-blame-run)))
+;; (add-hook 'after-save-hook 'git-blame-after-save)
+
+(defun git-blame-after-change (start end length)
+  (when git-blame-mode
+    (git-blame-enq-update start end)))
+
+(defvar git-blame-last-update nil)
+(make-variable-buffer-local 'git-blame-last-update)
+(defun git-blame-enq-update (start end)
+  "Mark the region between START and END as needing blame update"
+  ;; Try to be smart and avoid multiple callouts for sequential
+  ;; editing
+  (cond ((and git-blame-last-update
+              (= start (cdr git-blame-last-update)))
+         (setcdr git-blame-last-update end))
+        ((and git-blame-last-update
+              (= end (car git-blame-last-update)))
+         (setcar git-blame-last-update start))
+        (t
+         (setq git-blame-last-update (cons start end))
+         (setq git-blame-update-queue (nconc git-blame-update-queue
+                                             (list git-blame-last-update)))))
+  (unless (or git-blame-proc git-blame-idle-timer)
+    (setq git-blame-idle-timer
+          (run-with-idle-timer 0.5 nil 'git-blame-delayed-update))))
+
+(defun git-blame-delayed-update ()
+  (setq git-blame-idle-timer nil)
+  (if git-blame-update-queue
+      (let ((first (pop git-blame-update-queue))
+            (inhibit-point-motion-hooks t))
+        (git-blame-update-region (car first) (cdr first)))))
+
 (provide 'git-blame)
 
 ;;; git-blame.el ends here