vc-git.el 16.8 KB
Newer Older
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1 2 3 4
;;; vc-git.el --- VC backend for the git version control system

;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.

5
;; Author: Alexandre Julliard <julliard@winehq.org>
Dan Nicolaescu's avatar
Dan Nicolaescu committed
6 7 8 9 10 11
;; Keywords: tools

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
12
;; the Free Software Foundation; either version 3, or (at your option)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; This file contains a VC backend for the git version control
;; system.
;;

;;; Installation:

33
;; To install: put this file on the load-path and add Git to the list
Dan Nicolaescu's avatar
Dan Nicolaescu committed
34 35 36
;; of supported backends in `vc-handled-backends'; the following line,
;; placed in your ~/.emacs, will accomplish this:
;;
37
;;     (add-to-list 'vc-handled-backends 'Git)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
38 39

;;; Todo:
40 41
;;  - check if more functions could use vc-git-command instead
;;     of start-process.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
42
;;  - changelog generation
43 44 45

;; Implement the rest of the vc interface. See the comment at the
;; beginning of vc.el. The current status is:
46
;; ("??" means: "figure out what to do about it")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
47
;;
48 49 50 51 52 53
;; FUNCTION NAME                                   STATUS
;; BACKEND PROPERTIES
;; * revision-granularity                          OK
;; STATE-QUERYING FUNCTIONS
;; * registered (file)				   OK
;; * state (file)				   OK
54
;; - state-heuristic (file)			   NOT NEEDED
55
;; - dir-state (dir)				   OK
Eric S. Raymond's avatar
Eric S. Raymond committed
56
;; * working-revision (file)			   OK
57
;; - latest-on-branch-p (file)			   NOT NEEDED
58
;; * checkout-model (file)			   OK
59
;; - workfile-unchanged-p (file)		   OK
60
;; - mode-line-string (file)			   OK
61 62 63
;; - dired-state-info (file)			   OK
;; STATE-CHANGING FUNCTIONS
;; * create-repo ()				   OK
Dan Nicolaescu's avatar
Dan Nicolaescu committed
64
;; * register (files &optional rev comment)	   OK
Eric S. Raymond's avatar
Eric S. Raymond committed
65
;; - init-revision (file)			   NOT NEEDED
66
;; - responsible-p (file)			   OK
67 68
;; - could-register (file)			   NOT NEEDED, DEFAULT IS GOOD
;; - receive-file (file rev)			   NOT NEEDED
69
;; - unregister (file)				   OK
Dan Nicolaescu's avatar
Dan Nicolaescu committed
70
;; * checkin (files rev comment)		   OK
Eric S. Raymond's avatar
Eric S. Raymond committed
71
;; * find-revision (file rev buffer)		   OK
72 73
;; * checkout (file &optional editable rev)	   OK
;; * revert (file &optional contents-done)	   OK
74 75 76 77
;; - rollback (files)				   COULD BE SUPPORTED
;; - merge (file rev1 rev2)			   It would be possible to merge changes into
;;                                                 a single file, but when committing they
;;                                                 wouldn't be identified as a merge by git,
78 79
;;                                                 so it's probably not a good idea.
;; - merge-news (file)				   see `merge'
80
;; - steal-lock (file &optional revision)	   NOT NEEDED
81
;; HISTORY FUNCTIONS
Dan Nicolaescu's avatar
Dan Nicolaescu committed
82
;; * print-log (files &optional buffer)		   OK
83
;; - log-view-mode ()				   OK
84
;; - show-log-entry (revision)			   NOT NEEDED, DEFAULT IS GOOD
85 86
;; - wash-log (file)				   COULD BE SUPPORTED
;; - logentry-check ()				   NOT NEEDED
87
;; - comment-history (file)			   ??
88
;; - update-changelog (files)			   COULD BE SUPPORTED
89
;; * diff (file &optional rev1 rev2 buffer)	   OK
90
;; - revision-completion-table (file)		   NEEDED?
91
;; - diff-tree (dir &optional rev1 rev2)	   OK
92 93
;; - annotate-command (file buf &optional rev)	   OK
;; - annotate-time ()				   OK
94
;; - annotate-current-time ()			   NOT NEEDED
95 96
;; - annotate-extract-revision-at-line ()	   OK
;; SNAPSHOT SYSTEM
97
;; - create-snapshot (dir name branchp)		   OK
98
;; - assign-name (file name)			   NOT NEEDED
Dan Nicolaescu's avatar
Dan Nicolaescu committed
99
;; - retrieve-snapshot (dir name update)	   OK, needs to update buffers
100
;; MISCELLANEOUS
101 102
;; - make-version-backups-p (file)		   NOT NEEDED
;; - repository-hostname (dirname)		   NOT NEEDED
103 104
;; - previous-revision (file rev)		   OK
;; - next-revision (file rev)			   OK
105 106
;; - check-headers ()				   COULD BE SUPPORTED
;; - clear-headers ()				   NOT NEEDED
107 108
;; - delete-file (file)				   OK
;; - rename-file (old new)			   OK
109 110
;; - find-file-hook ()				   NOT NEEDED
;; - find-file-not-found-hook ()                   NOT NEEDED
Dan Nicolaescu's avatar
Dan Nicolaescu committed
111

112
(eval-when-compile (require 'cl) (require 'vc))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
113 114 115 116

(defvar git-commits-coding-system 'utf-8
  "Default coding system for git commits.")

117 118 119 120 121 122 123 124 125 126 127 128 129 130
;;; BACKEND PROPERTIES

(defun vc-git-revision-granularity ()
     'repository)

;;; STATE-QUERYING FUNCTIONS

;;;###autoload (defun vc-git-registered (file)
;;;###autoload   "Return non-nil if FILE is registered with git."
;;;###autoload   (if (vc-find-root file ".git")       ; short cut
;;;###autoload       (progn
;;;###autoload         (load "vc-git")
;;;###autoload         (vc-git-registered file))))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
131 132
(defun vc-git-registered (file)
  "Check whether FILE is registered with git."
133 134 135 136 137 138 139 140 141 142
  (when (vc-git-root file)
    (with-temp-buffer
      (let* ((dir (file-name-directory file))
	     (name (file-relative-name file dir)))
	(and (ignore-errors
	      (when dir (cd dir))
	      (eq 0 (call-process "git" nil '(t nil) nil "ls-files" "-c" "-z" "--" name)))
	     (let ((str (buffer-string)))
	       (and (> (length str) (length name))
		    (string= (substring str 0 (1+ (length name))) (concat name "\0")))))))))
143

Dan Nicolaescu's avatar
Dan Nicolaescu committed
144
(defun vc-git-state (file)
145
  "Git-specific version of `vc-state'."
146
  (call-process "git" nil nil nil "add" "--refresh" "--" (file-relative-name file))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
147 148 149 150 151
  (let ((diff (vc-git--run-command-string file "diff-index" "-z" "HEAD" "--")))
    (if (and diff (string-match ":[0-7]\\{6\\} [0-7]\\{6\\} [0-9a-f]\\{40\\} [0-9a-f]\\{40\\} [ADMU]\0[^\0]+\0" diff))
        'edited
      'up-to-date)))

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
(defun vc-git-dir-state (dir)
  (with-temp-buffer
    (vc-git-command (current-buffer) nil nil "ls-files" "-t")
    (goto-char (point-min))
    (let ((status-char nil)
	  (file nil))
      (while (not (eobp))
	(setq status-char (char-after))
	(setq file
	      (expand-file-name
	       (buffer-substring-no-properties (+ (point) 2) (line-end-position))))
	(cond
	 ;; The rest of the possible states in "git ls-files -t" output:
         ;;      R              removed/deleted
	 ;;      K              to be killed
	 ;; should not show up in vc-dired, so don't deal with them
	 ;; here.
	 ((eq status-char ?H)
	  (vc-file-setprop file 'vc-state 'up-to-date))
	 ((eq status-char ?M)
	  (vc-file-setprop file 'vc-state 'edited))
	 ((eq status-char ?C)
	  (vc-file-setprop file 'vc-state 'edited))
	 ((eq status-char ??)
	  (vc-file-setprop file 'vc-backend 'none)
	  (vc-file-setprop file 'vc-state 'nil)))
	(forward-line)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
180 181
(defun vc-git-working-revision (file)
  "Git-specific version of `vc-working-revision'."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
182 183 184 185 186 187 188 189 190 191 192
  (let ((str (with-output-to-string
               (with-current-buffer standard-output
                 (call-process "git" nil '(t nil) nil "symbolic-ref" "HEAD")))))
    (if (string-match "^\\(refs/heads/\\)?\\(.+\\)$" str)
        (match-string 2 str)
      str)))

(defun vc-git-checkout-model (file)
  'implicit)

(defun vc-git-workfile-unchanged-p (file)
193
  (eq 'up-to-date (vc-git-state file)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
194

195 196
(defun vc-git-mode-line-string (file)
  "Return string for placement into the modeline for FILE."
Eric S. Raymond's avatar
Eric S. Raymond committed
197
  (let* ((branch (vc-git-working-revision file))
198 199 200 201 202 203 204 205 206
         (def-ml (vc-default-mode-line-string 'Git file))
         (help-echo (get-text-property 0 'help-echo def-ml)))
    (if (zerop (length branch))
        (propertize
         (concat def-ml "!")
         'help-echo (concat help-echo "\nNo current branch (detached HEAD)"))
      (propertize def-ml
                  'help-echo (concat help-echo "\nCurrent branch: " branch)))))

207 208 209 210 211 212
(defun vc-git-dired-state-info (file)
  "Git-specific version of `vc-dired-state-info'."
  (let ((git-state (vc-state file)))
    (if (eq git-state 'edited)
	"(modified)"
      ;; fall back to the default VC representation
213
      (vc-default-dired-state-info 'Git file))))
214 215 216 217

;;; STATE-CHANGING FUNCTIONS

(defun vc-git-create-repo ()
218
  "Create a new Git repository."
219
  (vc-git-command nil 0 nil "init"))
220

221
(defun vc-git-register (files &optional rev comment)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
222
  "Register FILE into the git version-control system."
223
  (vc-git-command nil 0 files "update-index" "--add" "--"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
224

225 226
(defalias 'vc-git-responsible-p 'vc-git-root)

227 228
(defun vc-git-unregister (file)
  (vc-git-command nil 0 file "rm" "-f" "--cached" "--"))
229

230

231
(defun vc-git-checkin (files rev comment)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
232
  (let ((coding-system-for-write git-commits-coding-system))
233
    (vc-git-command nil 0 files "commit" "-m" comment "--only" "--")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
234

Eric S. Raymond's avatar
Eric S. Raymond committed
235
(defun vc-git-find-revision (file rev buffer)
236
  (let ((coding-system-for-read 'binary)
237 238
        (coding-system-for-write 'binary)
	(fullname (substring
239
		   (vc-git--run-command-string
240 241
		    file "ls-files" "-z" "--full-name" "--")
		   0 -1)))
242 243
    (vc-git-command
     buffer 0
244
     (concat (if rev rev "HEAD") ":" fullname) "cat-file" "blob")))
245 246

(defun vc-git-checkout (file &optional editable rev)
247
  (vc-git-command nil 0 file "checkout" (or rev "HEAD")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
248 249 250 251

(defun vc-git-revert (file &optional contents-done)
  "Revert FILE to the version stored in the git repository."
  (if contents-done
252 253
      (vc-git-command nil 0 file "update-index" "--")
    (vc-git-command nil 0 file "checkout" "HEAD")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
254

255 256
;;; HISTORY FUNCTIONS

257 258
(defun vc-git-print-log (files &optional buffer)
  "Get change log associated with FILES."
259 260 261 262
  (let ((coding-system-for-read git-commits-coding-system)
	;; Support both the old print-log interface that passes a
	;; single file, and the new one that passes a file list.
	(flist (if (listp files) files (list files))))
263 264 265 266 267 268
    ;; `vc-do-command' creates the buffer, but we need it before running
    ;; the command.
    (vc-setup-buffer buffer)
    ;; If the buffer exists from a previous invocation it might be
    ;; read-only.
    (let ((inhibit-read-only t))
269 270 271 272 273 274
      ;; XXX `log-view-mode' needs to have something to identify where
      ;; the log for each individual file starts. It seems that by
      ;; default git does not output this info. So loop here and call
      ;; "git rev-list" on each file separately to make sure that each
      ;; file gets a "File:" header before the corresponding
      ;; log. Maybe there is a way to do this with one command...
275
      (dolist (file flist)
276 277 278
	(with-current-buffer
	    buffer
	  (insert "File: " (file-name-nondirectory file) "\n"))
279
	(vc-git-command buffer 'async (file-relative-name file)
280
			"rev-list" "--pretty" "HEAD" "--")))))
281 282 283 284 285

(defvar log-view-message-re)
(defvar log-view-file-re)
(defvar log-view-font-lock-keywords)

286
(define-derived-mode vc-git-log-view-mode log-view-mode "Git-Log-View"
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  (require 'add-log) ;; we need the faces add-log
  ;; Don't have file markers, so use impossible regexp.
  (set (make-local-variable 'log-view-file-re) "^File:[ \t]+\\(.+\\)")
  (set (make-local-variable 'log-view-message-re)
       "^commit *\\([0-9a-z]+\\)")
  (set (make-local-variable 'log-view-font-lock-keywords)
       (append
       `((,log-view-message-re  (1 'change-log-acknowledgement))
         (,log-view-file-re (1 'change-log-file-face)))
         ;; Handle the case:
         ;; user: foo@bar
         '(("^Author:[ \t]+\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
            (1 'change-log-email))
	   ;; Handle the case:
	   ;; user: FirstName LastName <foo@bar>
	   ("^Author:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
	    (1 'change-log-name)
	    (2 'change-log-email))
305 306 307 308 309 310 311 312
	   ("^ +\\(?:\\(?:[Aa]cked\\|[Ss]igned-[Oo]ff\\)-[Bb]y:\\)[ \t]+\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
	    (1 'change-log-name))
	   ("^ +\\(?:\\(?:[Aa]cked\\|[Ss]igned-[Oo]ff\\)-[Bb]y:\\)[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
	    (1 'change-log-name)
	    (2 'change-log-email))
	   ("^Merge: \\([0-9a-z]+\\) \\([0-9a-z]+\\)"
	    (1 'change-log-acknowledgement)
	    (2 'change-log-acknowledgement))
313 314
	   ("^Date:   \\(.+\\)" (1 'change-log-date))
	   ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
315

316 317
(defun vc-git-diff (files &optional rev1 rev2 buffer)
  (let ((buf (or buffer "*vc-diff*")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
318
    (if (and rev1 rev2)
319 320
        (vc-git-command buf 1 files "diff-tree" "--exit-code" "-p" rev1 rev2 "--")
      (vc-git-command buf 1 files "diff-index" "--exit-code" "-p" (or rev1 "HEAD") "--"))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
321

322 323
(defun vc-git-revision-table (files)
  ;; What about `files'?!?  --Stef
324 325 326 327 328 329 330 331
  (let ((table (list "HEAD")))
    (with-temp-buffer
      (vc-git-command t nil nil "for-each-ref" "--format=%(refname)")
      (goto-char (point-min))
      (while (re-search-forward "^refs/\\(heads\\|tags\\)/\\(.*\\)$" nil t)
        (push (match-string 2) table)))
    table))

332 333
(defun vc-git-revision-completion-table (files)
  (lexical-let ((files files)
334 335
                table)
    (setq table (lazy-completion-table
336
                 table (lambda () (vc-git-revision-table files))))
337 338
    table))

339 340 341
(defun vc-git-diff-tree (dir &optional rev1 rev2)
  (vc-git-diff dir rev1 rev2))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
342
(defun vc-git-annotate-command (file buf &optional rev)
343
  ;; FIXME: rev is ignored
Dan Nicolaescu's avatar
Dan Nicolaescu committed
344
  (let ((name (file-relative-name file)))
345
    (vc-git-command buf 0 name "blame" (if rev (concat "-r" rev)))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
346 347 348 349 350 351

(defun vc-git-annotate-time ()
  (and (re-search-forward "[0-9a-f]+ (.* \\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\) \\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\) \\([-+0-9]+\\) +[0-9]+)" nil t)
       (vc-annotate-convert-time
        (apply #'encode-time (mapcar (lambda (match) (string-to-number (match-string match))) '(6 5 4 3 2 1 7))))))

352 353 354 355 356 357
(defun vc-git-annotate-extract-revision-at-line ()
 (save-excursion
   (move-beginning-of-line 1)
   (and (looking-at "[0-9a-f]+")
        (buffer-substring-no-properties (match-beginning 0) (match-end 0)))))

358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
;;; SNAPSHOT SYSTEM

(defun vc-git-create-snapshot (dir name branchp)
  (let ((default-directory dir))
    (and (vc-git-command nil 0 nil "update-index" "--refresh")
         (if branchp
             (vc-git-command nil 0 nil "checkout" "-b" name)
           (vc-git-command nil 0 nil "tag" name)))))

(defun vc-git-retrieve-snapshot (dir name update)
  (let ((default-directory dir))
    (vc-git-command nil 0 nil "checkout" name)
    ;; FIXME: update buffers if `update' is true
    ))


374
;;; MISCELLANEOUS
Dan Nicolaescu's avatar
Dan Nicolaescu committed
375

376 377
(defun vc-git-previous-revision (file rev)
  "Git-specific version of `vc-previous-revision'."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
  (let ((default-directory (file-name-directory (expand-file-name file)))
	(file (file-name-nondirectory file)))
    (vc-git-symbolic-commit
     (with-temp-buffer
       (and
	(zerop
	 (call-process "git" nil '(t nil) nil "rev-list"
		       "-2" rev "--" file))
	(goto-char (point-max))
	(bolp)
	(zerop (forward-line -1))
	(not (bobp))
	(buffer-substring-no-properties
	   (point)
	   (1- (point-max))))))))

394 395
(defun vc-git-next-revision (file rev)
  "Git-specific version of `vc-next-revision'."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  (let* ((default-directory (file-name-directory
			     (expand-file-name file)))
	(file (file-name-nondirectory file))
	(current-rev
	 (with-temp-buffer
	   (and
	    (zerop
	     (call-process "git" nil '(t nil) nil "rev-list"
			   "-1" rev "--" file))
	    (goto-char (point-max))
	    (bolp)
	    (zerop (forward-line -1))
	    (bobp)
	    (buffer-substring-no-properties
	     (point)
	     (1- (point-max)))))))
    (and current-rev
	 (vc-git-symbolic-commit
	  (with-temp-buffer
	    (and
	     (zerop
	      (call-process "git" nil '(t nil) nil "rev-list"
			    "HEAD" "--" file))
	     (goto-char (point-min))
	     (search-forward current-rev nil t)
	     (zerop (forward-line -1))
	     (buffer-substring-no-properties
	      (point)
	      (progn (forward-line 1) (1- (point))))))))))

426 427
(defun vc-git-delete-file (file)
  (vc-git-command nil 0 file "rm" "-f" "--"))
428

429 430
(defun vc-git-rename-file (old new)
  (vc-git-command nil 0 (list old new) "mv" "-f" "--"))
431

Dan Nicolaescu's avatar
Dan Nicolaescu committed
432

433
;;; Internal commands
Dan Nicolaescu's avatar
Dan Nicolaescu committed
434

435 436 437
(defun vc-git-root (file)
  (vc-find-root file ".git"))

438
(defun vc-git-command (buffer okstatus file-or-list &rest flags)
439 440
  "A wrapper around `vc-do-command' for use in vc-git.el.
The difference to vc-do-command is that this function always invokes `git'."
441
  (apply 'vc-do-command buffer okstatus "git" file-or-list flags))
442

Dan Nicolaescu's avatar
Dan Nicolaescu committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
(defun vc-git--run-command-string (file &rest args)
  "Run a git command on FILE and return its output as string."
  (let* ((ok t)
         (str (with-output-to-string
                (with-current-buffer standard-output
                  (unless (eq 0 (apply #'call-process "git" nil '(t nil) nil
                                       (append args (list (file-relative-name file)))))
                    (setq ok nil))))))
    (and ok str)))

(defun vc-git-symbolic-commit (commit)
  "Translate COMMIT string into symbolic form.
Returns nil if not possible."
  (and commit
       (with-temp-buffer
	 (and
	  (zerop
	   (call-process "git" nil '(t nil) nil "name-rev"
			 "--name-only" "--tags"
			 commit))
	  (goto-char (point-min))
	  (= (forward-line 2) 1)
	  (bolp)
	  (buffer-substring-no-properties (point-min) (1- (point-max)))))))

(provide 'vc-git)
469

Miles Bader's avatar
Miles Bader committed
470
;; arch-tag: bd10664a-0e5b-48f5-a877-6c17b135be12
471
;;; vc-git.el ends here