Fetching contributors…
Cannot retrieve contributors at this time
1116 lines (956 sloc) 40.6 KB
;;; git-gutter.el --- Port of Sublime Text plugin GitGutter -*- lexical-binding: t; -*-
;; Copyright (C) 2016 by Syohei YOSHIDA
;; Author: Syohei YOSHIDA <>
;; URL:
;; Version: 0.90
;; Package-Requires: ((emacs "24.3"))
;; 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
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Commentary:
;; Port of GitGutter which is a plugin of Sublime Text
;;; Code:
(require 'cl-lib)
(defgroup git-gutter nil
"Port GitGutter"
:prefix "git-gutter:"
:group 'vc)
(defcustom git-gutter:exp-to-create-diff nil
"It could be string, expression, function.
If it's a string, it's passed to `shell-command-to-string' as parameter.
If it's an expression, it will be evaluated.
If it's a function, it is executed.
The returned string is expected to be in diff Unified Format.
When it's not nil, it will overrides all the existing backends.
It's recommended to set it up in `.dir-locals.el'.
A sample `.dir-locals.el' for perforce:
`((nil (git-gutter:exp-to-create-diff . (shell-command-to-string (format \"p4 diff -du -db %s\" (file-relative-name buffer-file-name))))))'")
(defcustom git-gutter:window-width nil
"Character width of gutter window. Emacs mistakes width of some characters.
It is better to explicitly assign width to this variable, if you use full-width
character for signs of changes"
:type 'integer)
(defcustom git-gutter:diff-option ""
"Option of 'git diff'"
:type 'string)
(defcustom git-gutter:subversion-diff-option ""
"Option of 'svn diff'"
:type 'string)
(defcustom git-gutter:mercurial-diff-option ""
"Option of 'hg diff'"
:type 'string)
(defcustom git-gutter:bazaar-diff-option ""
"Option of 'bzr diff'"
:type 'string)
(defcustom git-gutter:update-commands
'(ido-switch-buffer helm-buffers-list)
"Each command of this list is executed, gutter information is updated."
:type '(list (function :tag "Update command")
(repeat :inline t (function :tag "Update command"))))
(defcustom git-gutter:update-windows-commands
'(kill-buffer ido-kill-buffer)
"Each command of this list is executed, gutter information is updated and
gutter information of other windows."
:type '(list (function :tag "Update command")
(repeat :inline t (function :tag "Update command"))))
(defcustom git-gutter:update-hooks
'(after-save-hook after-revert-hook find-file-hook after-change-major-mode-hook
"hook points of updating gutter"
:type '(list (hook :tag "HookPoint")
(repeat :inline t (hook :tag "HookPoint"))))
(defcustom git-gutter:always-show-separator nil
"Show separator even if there are no changes."
:type 'boolean)
(defcustom git-gutter:separator-sign nil
"Separator sign"
:type 'string)
(defcustom git-gutter:modified-sign "="
"Modified sign"
:type 'string)
(defcustom git-gutter:added-sign "+"
"Added sign"
:type 'string)
(defcustom git-gutter:deleted-sign "-"
"Deleted sign"
:type 'string)
(defcustom git-gutter:unchanged-sign nil
"Unchanged sign"
:type 'string)
(defcustom git-gutter:hide-gutter nil
"Hide gutter if there are no changes"
:type 'boolean)
(defcustom git-gutter:lighter " GitGutter"
"Minor mode lighter in mode-line"
:type 'string)
(defcustom git-gutter:verbosity 0
"Log/message level. 4 means all, 0 nothing."
:type 'integer)
(defcustom git-gutter:visual-line nil
"Show sign at gutter by visual line."
:type 'boolean)
(defface git-gutter:separator
'((t (:foreground "cyan" :weight bold :inherit default)))
"Face of separator")
(defface git-gutter:modified
'((t (:foreground "magenta" :weight bold :inherit default)))
"Face of modified")
(defface git-gutter:added
'((t (:foreground "green" :weight bold :inherit default)))
"Face of added")
(defface git-gutter:deleted
'((t (:foreground "red" :weight bold)))
"Face of deleted")
(defface git-gutter:unchanged
'((t (:background "yellow")))
"Face of unchanged")
(defcustom git-gutter:disabled-modes nil
"A list of modes which `global-git-gutter-mode' should be disabled."
:type '(repeat symbol))
(defcustom git-gutter:handled-backends '(git)
"List of version control backends for which `git-gutter.el` will be used.
`git', `svn', `hg', and `bzr' are supported."
:type '(repeat symbol))
(defvar git-gutter:view-diff-function #'git-gutter:view-diff-infos
"Function of viewing changes")
(defvar git-gutter:clear-function #'git-gutter:clear-diff-infos
"Function of clear changes")
(defvar git-gutter:init-function 'nil
"Function of initialize")
(defcustom git-gutter-mode-on-hook nil
"Hook run when git-gutter mode enable"
:type 'hook)
(defcustom git-gutter-mode-off-hook nil
"Hook run when git-gutter mode disable"
:type 'hook)
(defcustom git-gutter:update-interval 0
"Time interval in seconds for updating diff information."
:type 'integer)
(defcustom git-gutter:ask-p t
"Ask whether commit/revert or not"
:type 'boolean)
(defcustom git-gutter:display-p t
"Display diff information or not."
:type 'boolean)
(cl-defstruct git-gutter-hunk
type content start-line end-line)
(defvar git-gutter:enabled nil)
(defvar git-gutter:diffinfos nil)
(defvar git-gutter:has-indirect-buffers nil)
(defvar git-gutter:real-this-command nil)
(defvar git-gutter:linum-enabled nil)
(defvar git-gutter:linum-prev-window-margin nil)
(defvar git-gutter:vcs-type nil)
(defvar git-gutter:start-revision nil)
(defvar git-gutter:revision-history nil)
(defvar git-gutter:update-timer nil)
(defvar git-gutter:last-sha1 nil)
(defvar git-gutter:popup-buffer "*git-gutter:diff*")
(defvar git-gutter:ignore-commands
(defmacro git-gutter:awhen (test &rest body)
"Anaphoric when."
(declare (indent 1))
`(let ((it ,test))
(when it ,@body)))
(defsubst git-gutter:execute-command (cmd output &rest args)
(apply #'process-file cmd nil output nil args))
(defun git-gutter:in-git-repository-p ()
(when (executable-find "git")
(when (zerop (git-gutter:execute-command "git" t "rev-parse" "--is-inside-work-tree"))
(goto-char (point-min))
(looking-at-p "true")))))
(defun git-gutter:in-repository-common-p (cmd check-subcmd repodir)
(and (executable-find cmd)
(locate-dominating-file default-directory repodir)
(zerop (apply #'git-gutter:execute-command cmd nil check-subcmd))
(not (string-match-p (regexp-quote (concat "/" repodir "/")) default-directory))))
(defun git-gutter:vcs-check-function (vcs)
(cl-case vcs
(git (git-gutter:in-git-repository-p))
(svn (git-gutter:in-repository-common-p "svn" '("info") ".svn"))
(hg (git-gutter:in-repository-common-p "hg" '("root") ".hg"))
(bzr (git-gutter:in-repository-common-p "bzr" '("root") ".bzr"))))
(defun git-gutter:in-repository-p ()
(setq git-gutter:vcs-type 'unknown))
(cl-loop for vcs in git-gutter:handled-backends
when (git-gutter:vcs-check-function vcs)
return (setq-local git-gutter:vcs-type vcs)))))
(defsubst git-gutter:changes-to-number (str)
(if (string= str "")
(string-to-number str)))
(defsubst git-gutter:base-file ()
(buffer-file-name (buffer-base-buffer)))
(defun git-gutter:diff-content ()
(goto-char (line-beginning-position))
(let ((curpoint (point)))
(forward-line 1)
(if (re-search-forward "^@@" nil t)
(backward-char 3) ;; for '@@'
(goto-char (point-max)))
(buffer-substring curpoint (point)))))
(defun git-gutter:process-diff-output (buf)
(when (buffer-live-p buf)
(with-current-buffer buf
(goto-char (point-min))
(cl-loop with regexp = "^@@ -\\(?:[0-9]+\\),?\\([0-9]*\\) \\+\\([0-9]+\\),?\\([0-9]*\\) @@"
while (re-search-forward regexp nil t)
for new-line = (string-to-number (match-string 2))
for orig-changes = (git-gutter:changes-to-number (match-string 1))
for new-changes = (git-gutter:changes-to-number (match-string 3))
for type = (cond ((zerop orig-changes) 'added)
((zerop new-changes) 'deleted)
(t 'modified))
for end-line = (if (eq type 'deleted)
(1- (+ new-line new-changes)))
for content = (git-gutter:diff-content)
(let ((start (if (zerop new-line) 1 new-line))
(end (if (zerop end-line) 1 end-line)))
:type type :content content :start-line start :end-line end))))))
(defsubst git-gutter:window-margin ()
(or git-gutter:window-width (git-gutter:longest-sign-width)))
(defun git-gutter:set-window-margin (width)
(when (and (not git-gutter:linum-enabled) (>= width 0))
(let ((curwin (get-buffer-window)))
(set-window-margins curwin width (cdr (window-margins curwin))))))
(defsubst git-gutter:revision-set-p ()
(and git-gutter:start-revision (not (string= git-gutter:start-revision ""))))
(defun git-gutter:git-diff-arguments (file)
(let (args)
(unless (string= git-gutter:diff-option "")
(setq args (nreverse (split-string git-gutter:diff-option))))
(when (git-gutter:revision-set-p)
(push git-gutter:start-revision args))
(nreverse (cons file args))))
(defun git-gutter:start-git-diff-process (file proc-buf)
(let ((arg (git-gutter:git-diff-arguments file)))
(apply #'start-file-process "git-gutter" proc-buf
"git" "--no-pager" "-c" "diff.autorefreshindex=0"
"diff" "--no-color" "--no-ext-diff" "--relative" "-U0"
(defun git-gutter:svn-diff-arguments (file)
(let (args)
(unless (string= git-gutter:subversion-diff-option "")
(setq args (nreverse (split-string git-gutter:subversion-diff-option))))
(when (git-gutter:revision-set-p)
(push "-r" args)
(push git-gutter:start-revision args))
(nreverse (cons file args))))
(defsubst git-gutter:start-svn-diff-process (file proc-buf)
(let ((args (git-gutter:svn-diff-arguments file)))
(apply #'start-file-process "git-gutter" proc-buf "svn" "diff" "--diff-cmd"
"diff" "-x" "-U0" args)))
(defun git-gutter:hg-diff-arguments (file)
(let (args)
(unless (string= git-gutter:mercurial-diff-option "")
(setq args (nreverse (split-string git-gutter:mercurial-diff-option))))
(when (git-gutter:revision-set-p)
(push "-r" args)
(push git-gutter:start-revision args))
(nreverse (cons file args))))
(defsubst git-gutter:start-hg-diff-process (file proc-buf)
(let ((args (git-gutter:hg-diff-arguments file))
(process-environment (cons "HGPLAIN=1" process-environment)))
(apply #'start-file-process "git-gutter" proc-buf "hg" "diff" "-U0" args)))
(defun git-gutter:bzr-diff-arguments (file)
(let (args)
(unless (string= git-gutter:bazaar-diff-option "")
(setq args (nreverse (split-string git-gutter:bazaar-diff-option))))
(when (git-gutter:revision-set-p)
(push "-r" args)
(push git-gutter:start-revision args))
(nreverse (cons file args))))
(defsubst git-gutter:start-bzr-diff-process (file proc-buf)
(let ((args (git-gutter:bzr-diff-arguments file)))
(apply #'start-file-process "git-gutter" proc-buf
"bzr" "diff" "--context=0" args)))
(defun git-gutter:start-diff-process1 (file proc-buf)
(cl-case git-gutter:vcs-type
(git (git-gutter:start-git-diff-process file proc-buf))
(svn (git-gutter:start-svn-diff-process file proc-buf))
(hg (git-gutter:start-hg-diff-process file proc-buf))
(bzr (git-gutter:start-bzr-diff-process file proc-buf))))
(defun git-gutter:start-diff-process (curfile proc-buf)
(git-gutter:set-window-margin (git-gutter:window-margin))
(git-gutter:insert-diff-content proc-buf)
(git-gutter:update-current-buffer proc-buf)
(kill-buffer proc-buf))
(let ((file (git-gutter:base-file)) ;; for tramp
(process (git-gutter:start-diff-process1 curfile proc-buf)))
(set-process-query-on-exit-flag process nil)
(lambda (proc _event)
(when (eq (process-status proc) 'exit)
(git-gutter:update-current-buffer (process-buffer proc) file)
(kill-buffer proc-buf))))))))
(defsubst git-gutter:gutter-sperator ()
(when git-gutter:separator-sign
(propertize git-gutter:separator-sign 'face 'git-gutter:separator)))
(defun git-gutter:before-string (sign)
(let ((gutter-sep (concat sign (git-gutter:gutter-sperator))))
(propertize " " 'display `((margin left-margin) ,gutter-sep))))
(defun git-gutter:propertized-sign (type)
(let (sign face)
(cl-case type
(added (setq sign git-gutter:added-sign
face 'git-gutter:added))
(modified (setq sign git-gutter:modified-sign
face 'git-gutter:modified))
(deleted (setq sign git-gutter:deleted-sign
face 'git-gutter:deleted)))
(propertize sign 'face face)))
(defsubst git-gutter:linum-get-overlay (pos)
(cl-loop for ov in (overlays-in pos pos)
when (overlay-get ov 'linum-str)
return ov))
(defun git-gutter:put-signs-linum (sign points)
(dolist (pos points)
(git-gutter:awhen (git-gutter:linum-get-overlay pos)
(overlay-put it 'before-string
(propertize " "
`((margin left-margin)
,(concat sign (overlay-get it 'linum-str))))))))
(defun git-gutter:put-signs (sign points)
(if git-gutter:linum-enabled
(git-gutter:put-signs-linum sign points)
(dolist (pos points)
(let ((ov (make-overlay pos pos))
(gutter-sign (git-gutter:before-string sign)))
(overlay-put ov 'before-string gutter-sign)
(overlay-put ov 'git-gutter t)))))
(defsubst git-gutter:sign-width (sign)
(cl-loop for s across sign
sum (char-width s)))
(defun git-gutter:longest-sign-width ()
(let ((signs (list git-gutter:modified-sign
(when git-gutter:unchanged-sign
(push git-gutter:unchanged-sign signs))
(+ (apply #'max (mapcar 'git-gutter:sign-width signs))
(git-gutter:sign-width git-gutter:separator-sign))))
(defun git-gutter:next-visual-line (arg)
(let ((line-move-visual t))
(next-line arg))))
(defun git-gutter:view-for-unchanged ()
(let ((sign (if git-gutter:unchanged-sign
(propertize git-gutter:unchanged-sign
'face 'git-gutter:unchanged)
" "))
(move-fn (if git-gutter:visual-line
(goto-char (point-min))
(while (not (eobp))
(push (point) points)
(funcall move-fn 1))
(git-gutter:put-signs sign points))))
(defsubst git-gutter:check-file-and-directory ()
(and (git-gutter:base-file)
default-directory (file-directory-p default-directory)))
(defun git-gutter:pre-command-hook ()
(unless (memq this-command git-gutter:ignore-commands)
(setq git-gutter:real-this-command this-command)))
(defun git-gutter:update-other-window-buffers (curwin curbuf)
(cl-loop for win in (window-list)
unless (eq win curwin)
(select-window win)
(let ((win-width (window-margins win)))
(unless (car win-width)
(if (eq (current-buffer) curbuf)
(git-gutter:set-window-margin (git-gutter:window-margin))
(git-gutter:update-diffinfo git-gutter:diffinfos))))))))
(defun git-gutter:post-command-hook ()
(cond ((memq git-gutter:real-this-command git-gutter:update-commands)
((memq git-gutter:real-this-command git-gutter:update-windows-commands)
(unless global-linum-mode
(git-gutter:update-other-window-buffers (selected-window) (current-buffer))))))
(defsubst git-gutter:diff-process-buffer (curfile)
(concat " *git-gutter-" curfile "-*"))
(defun git-gutter:kill-buffer-hook ()
(let ((buf (git-gutter:diff-process-buffer (git-gutter:base-file))))
(git-gutter:awhen (get-buffer buf)
(kill-buffer it))))
(defsubst git-gutter:linum-padding ()
(cl-loop repeat (git-gutter:window-margin)
collect " " into paddings
finally return (apply #'concat paddings)))
(defun git-gutter:linum-prepend-spaces ()
(goto-char (point-min))
(let ((padding (git-gutter:linum-padding))
(while (not (eobp))
(push (point) points)
(forward-line 1))
(git-gutter:put-signs-linum padding points))))
(defun git-gutter:linum-update (diffinfos)
(let ((linum-width (car (window-margins))))
(when linum-width
(git-gutter:view-set-overlays diffinfos)
(let ((curwin (get-buffer-window))
(margin (+ linum-width (git-gutter:window-margin))))
(setq git-gutter:linum-prev-window-margin margin)
(set-window-margins curwin margin (cdr (window-margins curwin)))))))
(defun git-gutter:linum-init ()
(setq-local git-gutter:linum-enabled t)
(make-local-variable 'git-gutter:linum-prev-window-margin))
(defun git-gutter:linum-setup ()
"Setup for linum-mode."
(setq git-gutter:init-function 'git-gutter:linum-init
git-gutter:view-diff-function nil)
(defadvice linum-update-window (after git-gutter:linum-update-window activate)
(when git-gutter:display-p
(if (and git-gutter-mode git-gutter:diffinfos)
(git-gutter:linum-update git-gutter:diffinfos)
(let ((curwin (get-buffer-window))
(margin (or git-gutter:linum-prev-window-margin
(car (window-margins)))))
(set-window-margins curwin margin (cdr (window-margins curwin))))))))
(defun git-gutter:show-backends ()
(mapconcat (lambda (backend)
(capitalize (symbol-name backend)))
git-gutter:handled-backends "/"))
(define-minor-mode git-gutter-mode
"Git-Gutter mode"
:init-value nil
:global nil
:lighter git-gutter:lighter
(if git-gutter-mode
(if (and (git-gutter:check-file-and-directory)
(when git-gutter:init-function
(funcall git-gutter:init-function))
(make-local-variable 'git-gutter:enabled)
(setq-local git-gutter:has-indirect-buffers nil)
(make-local-variable 'git-gutter:diffinfos)
(setq-local git-gutter:start-revision nil)
(add-hook 'kill-buffer-hook 'git-gutter:kill-buffer-hook nil t)
(add-hook 'pre-command-hook 'git-gutter:pre-command-hook)
(add-hook 'post-command-hook 'git-gutter:post-command-hook nil t)
(dolist (hook git-gutter:update-hooks)
(add-hook hook 'git-gutter nil t))
(when (and (not git-gutter:update-timer) (> git-gutter:update-interval 0))
(setq git-gutter:update-timer
(run-with-idle-timer git-gutter:update-interval t 'git-gutter:live-update))))
(when (> git-gutter:verbosity 2)
(message "Here is not %s work tree" (git-gutter:show-backends)))
(git-gutter-mode -1))
(remove-hook 'kill-buffer-hook 'git-gutter:kill-buffer-hook t)
(remove-hook 'pre-command-hook 'git-gutter:pre-command-hook)
(remove-hook 'post-command-hook 'git-gutter:post-command-hook t)
(dolist (hook git-gutter:update-hooks)
(remove-hook hook 'git-gutter t))
(defun git-gutter--turn-on ()
(when (and (buffer-file-name)
(not (memq major-mode git-gutter:disabled-modes)))
(git-gutter-mode +1)))
(define-global-minor-mode global-git-gutter-mode git-gutter-mode git-gutter--turn-on)
(defsubst git-gutter:show-gutter-p (diffinfos)
(if git-gutter:hide-gutter
(or diffinfos git-gutter:unchanged-sign)
(or global-git-gutter-mode git-gutter:unchanged-sign diffinfos)))
(defun git-gutter:show-gutter (diffinfos)
(when (git-gutter:show-gutter-p diffinfos)
(git-gutter:set-window-margin (git-gutter:window-margin))))
(defun git-gutter:view-set-overlays (diffinfos)
(when (or git-gutter:unchanged-sign git-gutter:separator-sign)
(goto-char (point-min))
(cl-loop with curline = 1
with move-fn = (if git-gutter:visual-line
for info in diffinfos
for start-line = (git-gutter-hunk-start-line info)
for end-line = (git-gutter-hunk-end-line info)
for type = (git-gutter-hunk-type info)
for sign = (git-gutter:propertized-sign type)
for points = nil
(let ((bound (progn
(forward-line (- end-line curline))
(forward-line (- start-line end-line))
(cl-case type
((modified added)
(while (and (<= (point) bound) (not (eobp)))
(push (point) points)
(funcall move-fn 1))
(git-gutter:put-signs sign points))
(git-gutter:put-signs sign (list (point)))
(forward-line 1)))
(setq curline (1+ end-line))))))
(defun git-gutter:view-diff-infos (diffinfos)
(when (or diffinfos git-gutter:always-show-separator)
(git-gutter:view-set-overlays diffinfos))
(git-gutter:show-gutter diffinfos))
(defsubst git-gutter:reset-window-margin-p ()
(or git-gutter:hide-gutter (not global-git-gutter-mode)))
(defun git-gutter:clear-diff-infos ()
(when (git-gutter:reset-window-margin-p)
(git-gutter:set-window-margin 0))
(remove-overlays (point-min) (point-max) 'git-gutter t))
(defun git-gutter:clear-gutter ()
(when git-gutter:clear-function
(funcall git-gutter:clear-function)))
(setq git-gutter:enabled nil
git-gutter:diffinfos nil))
(defun git-gutter:update-diffinfo (diffinfos)
(setq git-gutter:diffinfos diffinfos)
(when (and git-gutter:display-p git-gutter:view-diff-function)
(funcall git-gutter:view-diff-function diffinfos))))
(defun git-gutter:search-near-diff-index (diffinfos is-reverse)
(cl-loop with current-line = (line-number-at-pos)
with cmp-fn = (if is-reverse #'> #'<)
for diffinfo in (if is-reverse (reverse diffinfos) diffinfos)
for index = 0 then (1+ index)
for start-line = (git-gutter-hunk-start-line diffinfo)
when (funcall cmp-fn current-line start-line)
return (if is-reverse
(1- (- (length diffinfos) index))
(defun git-gutter:search-here-diffinfo (diffinfos)
(cl-loop with current-line = (line-number-at-pos)
for diffinfo in diffinfos
for start = (git-gutter-hunk-start-line diffinfo)
for end = (or (git-gutter-hunk-end-line diffinfo) (1+ start))
when (and (>= current-line start) (<= current-line end))
return diffinfo
finally do (error "Here is not changed!!"))))
(defun git-gutter:collect-deleted-line (str)
(insert str)
(goto-char (point-min))
(cl-loop while (re-search-forward "^-\\(.*?\\)$" nil t)
collect (match-string 1) into deleted-lines
finally return deleted-lines)))
(defun git-gutter:delete-added-lines (start-line end-line)
(forward-line (1- start-line))
(let ((start-point (point)))
(forward-line (1+ (- end-line start-line)))
(delete-region start-point (point))))
(defun git-gutter:insert-deleted-lines (content)
(dolist (line (git-gutter:collect-deleted-line content))
(insert (concat line "\n"))))
(defsubst git-gutter:delete-from-first-line-p (start-line end-line)
(and (not (= start-line 1)) (not (= end-line 1))))
(defun git-gutter:do-revert-hunk (diffinfo)
(goto-char (point-min))
(let ((start-line (git-gutter-hunk-start-line diffinfo))
(end-line (git-gutter-hunk-end-line diffinfo))
(content (git-gutter-hunk-content diffinfo)))
(cl-case (git-gutter-hunk-type diffinfo)
(added (git-gutter:delete-added-lines start-line end-line))
(deleted (when (git-gutter:delete-from-first-line-p start-line end-line)
(forward-line start-line))
(git-gutter:insert-deleted-lines content))
(modified (git-gutter:delete-added-lines start-line end-line)
(git-gutter:insert-deleted-lines content))))))
(defsubst git-gutter:popup-buffer-window ()
(get-buffer-window (get-buffer git-gutter:popup-buffer)))
(defun git-gutter:query-action (action action-fn update-fn)
(git-gutter:awhen (git-gutter:search-here-diffinfo git-gutter:diffinfos)
(when git-gutter:ask-p
(git-gutter:popup-hunk it))
(when (or (not git-gutter:ask-p) (yes-or-no-p (format "%s current hunk ? " action)))
(funcall action-fn it)
(funcall update-fn))
(if git-gutter:ask-p
(delete-window (git-gutter:popup-buffer-window))
(message "%s current hunk." action)))))
(defun git-gutter:revert-hunk ()
"Revert current hunk."
(git-gutter:query-action "Revert" #'git-gutter:do-revert-hunk #'save-buffer))
(defun git-gutter:extract-hunk-header ()
(git-gutter:awhen (git-gutter:base-file)
(when (zerop (git-gutter:execute-command
"git" t "--no-pager" "-c" "diff.autorefreshindex=0"
"diff" "--no-color" "--no-ext-diff"
"--relative" (file-name-nondirectory it)))
(goto-char (point-min))
(forward-line 4)
(buffer-substring-no-properties (point-min) (point))))))
(defun git-gutter:read-hunk-header (header)
(let ((header-regexp "^@@ -\\([0-9]+\\),?\\([0-9]*\\) \\+\\([0-9]+\\),?\\([0-9]*\\) @@"))
(when (string-match header-regexp header)
(list (string-to-number (match-string 1 header))
(git-gutter:changes-to-number (match-string 2 header))
(string-to-number (match-string 3 header))
(git-gutter:changes-to-number (match-string 4 header))))))
(defun git-gutter:convert-hunk-header (type)
(let ((header (buffer-substring-no-properties (point) (line-end-position))))
(delete-region (point) (line-end-position))
(orig-line orig-changes new-line new-changes) (git-gutter:read-hunk-header header)
(cl-case type
(added (setq new-line (1+ orig-line)))
(t (setq new-line orig-line)))
(let ((new-header (format "@@ -%d,%d +%d,%d @@"
orig-line orig-changes new-line new-changes)))
(insert new-header)))))
(defun git-gutter:insert-staging-hunk (hunk type)
(insert hunk "\n"))
(git-gutter:convert-hunk-header type))
(defun git-gutter:apply-directory-option ()
(let ((root (locate-dominating-file default-directory ".git")))
(file-name-directory (file-relative-name (git-gutter:base-file) root))))
(defun git-gutter:do-stage-hunk (diff-info)
(let ((content (git-gutter-hunk-content diff-info))
(type (git-gutter-hunk-type diff-info))
(header (git-gutter:extract-hunk-header))
(patch (make-temp-name "git-gutter")))
(when header
(with-temp-file patch
(insert header)
(git-gutter:insert-staging-hunk content type))
(let ((dir-option (git-gutter:apply-directory-option))
(options (list "--cached" patch)))
(when dir-option
(setq options (cons "--directory" (cons dir-option options))))
(unless (zerop (apply #'git-gutter:execute-command
"git" nil "apply" "--unidiff-zero"
(message "Failed: stating this hunk"))
(delete-file patch)))))
(defun git-gutter:stage-hunk ()
"Stage this hunk like 'git add -p'."
(git-gutter:query-action "Stage" #'git-gutter:do-stage-hunk #'git-gutter))
(defsubst git-gutter:line-point (line)
(goto-char (point-min))
(forward-line (1- line))
(defun git-gutter:mark-hunk ()
(git-gutter:awhen (git-gutter:search-here-diffinfo git-gutter:diffinfos)
(let ((start (git-gutter:line-point (git-gutter-hunk-start-line it)))
(end (git-gutter:line-point (1+ (git-gutter-hunk-end-line it)))))
(goto-char start)
(push-mark end nil t))))
(defun git-gutter:update-popuped-buffer (diffinfo)
(with-current-buffer (get-buffer-create git-gutter:popup-buffer)
(view-mode -1)
(setq buffer-read-only nil)
(insert (git-gutter-hunk-content diffinfo))
(insert "\n")
(goto-char (point-min))
(view-mode +1)
(defun git-gutter:popup-hunk (&optional diffinfo)
"Popup current diff hunk."
(git-gutter:awhen (or diffinfo
(git-gutter:search-here-diffinfo git-gutter:diffinfos))
(pop-to-buffer (git-gutter:update-popuped-buffer it)))))
(defun git-gutter:next-hunk (arg)
"Move to next diff hunk"
(interactive "p")
(if (not git-gutter:diffinfos)
(when (> git-gutter:verbosity 3)
(message "There are no changes!!"))
(let* ((is-reverse (< arg 0))
(diffinfos git-gutter:diffinfos)
(len (length diffinfos))
(index (git-gutter:search-near-diff-index diffinfos is-reverse))
(real-index (if index
(let ((next (if is-reverse (1+ index) (1- index))))
(mod (+ arg next) len))
(if is-reverse (1- len) 0)))
(diffinfo (nth real-index diffinfos)))
(goto-char (point-min))
(forward-line (1- (git-gutter-hunk-start-line diffinfo)))
(when (> git-gutter:verbosity 0)
(message "Move to %d/%d hunk" (1+ real-index) len))
(when (buffer-live-p (get-buffer git-gutter:popup-buffer))
(git-gutter:update-popuped-buffer diffinfo)))))
(defun git-gutter:previous-hunk (arg)
"Move to previous diff hunk"
(interactive "p")
(git-gutter:next-hunk (- arg)))
(defun git-gutter:end-of-hunk ()
"Move to end of current diff hunk"
(git-gutter:awhen (git-gutter:search-here-diffinfo git-gutter:diffinfos)
(let ((lines (- (git-gutter-hunk-end-line it) (line-number-at-pos))))
(forward-line lines))))
(defalias 'git-gutter:next-diff 'git-gutter:next-hunk)
(make-obsolete 'git-gutter:next-diff 'git-gutter:next-hunk "0.60")
(defalias 'git-gutter:previous-diff 'git-gutter:previous-hunk)
(make-obsolete 'git-gutter:previous-diff 'git-gutter:previous-hunk "0.60")
(defalias 'git-gutter:popup-diff 'git-gutter:popup-hunk)
(make-obsolete 'git-gutter:popup-diff 'git-gutter:popup-hunk "0.60")
(defun git-gutter:update-indirect-buffers (orig-file)
(cl-loop with diffinfos = git-gutter:diffinfos
for win in (window-list)
for buf = (window-buffer win)
for base = (buffer-base-buffer buf)
when (and base (string= (buffer-file-name base) orig-file))
(with-current-buffer buf
(git-gutter:update-diffinfo diffinfos))))
(defun git-gutter ()
"Show diff information in gutter"
(when (or git-gutter:vcs-type (git-gutter:in-repository-p))
(let* ((file (git-gutter:base-file))
(proc-buf (git-gutter:diff-process-buffer file)))
(when (and (called-interactively-p 'interactive) (get-buffer proc-buf))
(kill-buffer proc-buf))
(when (and file (file-exists-p file) (not (get-buffer proc-buf)))
(git-gutter:start-diff-process (file-name-nondirectory file)
(get-buffer-create proc-buf))))))
(defadvice make-indirect-buffer (before git-gutter:has-indirect-buffers activate)
(when (and git-gutter-mode (not (buffer-base-buffer)))
(setq git-gutter:has-indirect-buffers t)))
(defadvice vc-revert (after git-gutter:vc-revert activate)
(when git-gutter-mode
(run-with-idle-timer 0.1 nil 'git-gutter)))
(defadvice toggle-truncate-lines (after git-gutter:toggle-truncate-lines activate)
(when (and git-gutter-mode git-gutter:visual-line)
(run-with-idle-timer 0.1 nil 'git-gutter)))
;; `quit-window' and `switch-to-buffer' are called from other
;; commands. So we should use `defadvice' instead of `post-command-hook'.
(defadvice quit-window (after git-gutter:quit-window activate)
(when git-gutter-mode
(defadvice switch-to-buffer (after git-gutter:switch-to-buffer activate)
(when git-gutter-mode
(defun git-gutter:clear ()
"Clear diff information in gutter."
(git-gutter-mode -1))
(make-obsolete 'git-gutter:clear #'git-gutter-mode "0.86")
(defun git-gutter:toggle ()
"Toggle to show diff information."
(if git-gutter-mode
(git-gutter-mode -1)
(git-gutter-mode +1)))
(make-obsolete 'git-gutter:toggle #'git-gutter-mode "0.86")
(defun git-gutter:revision-valid-p (revision)
(zerop (cl-case git-gutter:vcs-type
(git (git-gutter:execute-command "git" nil
"rev-parse" "--quiet" "--verify"
(svn (git-gutter:execute-command "svn" nil "info" "-r" revision
(file-relative-name (buffer-file-name))))
(hg (git-gutter:execute-command "hg" nil "id" "-r" revision))
(bzr (git-gutter:execute-command "bzr" nil
"revno" "-r" revision)))))
(defun git-gutter:set-start-revision (start-rev)
"Set start revision. If `start-rev' is nil or empty string then reset
start revision."
(list (read-string "Start Revision: "
nil 'git-gutter:revision-history)))
(when (and start-rev (not (string= start-rev "")))
(unless (git-gutter:revision-valid-p start-rev)
(error "Revision '%s' is not valid." start-rev)))
(setq git-gutter:start-revision start-rev)
(defun git-gutter:update-all-windows ()
"Update git-gutter information for all visible buffers."
(dolist (win (window-list))
(let ((buf (window-buffer win)))
(with-current-buffer buf
(when git-gutter-mode
(defun git-gutter:start-update-timer ()
(when git-gutter:update-timer
(error "Update timer is already running."))
(setq git-gutter:update-timer
(run-with-idle-timer git-gutter:update-interval t 'git-gutter:live-update)))
(defun git-gutter:cancel-update-timer ()
(unless git-gutter:update-timer
(error "Timer is no running."))
(cancel-timer git-gutter:update-timer)
(setq git-gutter:update-timer nil))
(defsubst git-gutter:write-current-content (tmpfile)
(let ((content (buffer-substring-no-properties (point-min) (point-max))))
(with-temp-file tmpfile
(insert content))))
(defsubst git-gutter:original-file-content (file)
(when (zerop (process-file "git" nil t nil "show" (concat ":" file)))
(buffer-substring-no-properties (point-min) (point-max)))))
(defun git-gutter:write-original-content (tmpfile filename)
(git-gutter:awhen (git-gutter:original-file-content filename)
(with-temp-file tmpfile
(insert it)
(defsubst git-gutter:start-raw-diff-process (proc-buf original now)
(start-file-process "git-gutter:update-timer" proc-buf
"diff" "-U0" original now))
(defun git-gutter:update-current-buffer (diff-buf &optional file)
(setq git-gutter:enabled nil)
(let* ((curbuf (current-buffer))
(diffinfos (git-gutter:process-diff-output diff-buf)))
(when (buffer-live-p curbuf)
(with-current-buffer curbuf
(git-gutter:update-diffinfo diffinfos)
(if (and file git-gutter:has-indirect-buffers)
(git-gutter:update-indirect-buffers file))
(setq git-gutter:enabled t)))))
(defun git-gutter:insert-diff-content (buf)
(let* ((backend git-gutter:exp-to-create-diff)
(content (cond
;; shell command
((stringp backend)
(shell-command-to-string backend))
;; function
((functionp backend)
(funcall backend))
;; lisp expression
((consp backend)
(funcall `(lambda () ,backend))))))
(set-buffer buf)
(insert content))))
(defun git-gutter:start-live-update (file original now)
(let* (proc-buf
(proc-bufname (git-gutter:diff-process-buffer file)))
(if (get-buffer proc-bufname)
(kill-buffer proc-bufname))
(setq proc-buf (get-buffer-create proc-bufname))
(git-gutter:insert-diff-content proc-buf)
(git-gutter:update-current-buffer proc-buf)
(kill-buffer proc-buf)
(delete-file original)
(delete-file now))
(let* ((process (git-gutter:start-raw-diff-process proc-buf original now)))
(set-process-query-on-exit-flag process nil)
(lambda (proc _event)
(when (eq (process-status proc) 'exit)
(git-gutter:update-current-buffer (process-buffer proc))
(kill-buffer proc-buf)
(delete-file original)
(delete-file now)))))))))
(defun git-gutter:should-update-p ()
(let ((sha1 (secure-hash 'sha1 (current-buffer))))
(unless (equal sha1 git-gutter:last-sha1)
(setq git-gutter:last-sha1 sha1))))
(defun git-gutter:live-update ()
(git-gutter:awhen (git-gutter:base-file)
(when (and git-gutter:enabled
(let ((file (file-name-nondirectory it))
(now (make-temp-file "git-gutter-cur"))
(original (make-temp-file "git-gutter-orig")))
(when (git-gutter:write-original-content original file)
(git-gutter:write-current-content now)
(git-gutter:start-live-update file original now))))))
;; for linum-user
(when (and global-linum-mode (not (boundp 'git-gutter-fringe)))
(defun git-gutter:all-hunks ()
"Cound unstaged hunks in all buffers"
(let ((sum 0))
(dolist (buf (buffer-list))
(with-current-buffer buf
(when git-gutter-mode
(cl-incf sum (git-gutter:buffer-hunks)))))
(defun git-gutter:buffer-hunks ()
"Count unstaged hunks in current buffer."
(length git-gutter:diffinfos))
(defun git-gutter:stat-hunk (hunk)
(cl-case (git-gutter-hunk-type hunk)
(modified (with-temp-buffer
(insert (git-gutter-hunk-content hunk))
(goto-char (point-min))
(let ((added 0)
(deleted 0))
(while (not (eobp))
(cond ((looking-at-p "\\+") (cl-incf added))
((looking-at-p "\\-") (cl-incf deleted)))
(forward-line 1))
(cons added deleted))))
(added (cons (- (git-gutter-hunk-end-line hunk) (git-gutter-hunk-start-line hunk)) 0))
(deleted (cons 0 (- (git-gutter-hunk-end-line hunk) (git-gutter-hunk-start-line hunk))))))
(defun git-gutter:statistic ()
"Return statistic unstaged hunks in current buffer."
(cl-loop for hunk in git-gutter:diffinfos
for (add . del) = (git-gutter:stat-hunk hunk)
sum add into added
sum del into deleted
return (progn
(when (called-interactively-p 'interactive)
(message "Added %d lines, Deleted %d lines" added deleted))
(cons added deleted))))
(provide 'git-gutter)
;;; git-gutter.el ends here