(diff-refine-ignore-spaces-hunk): Rename from
[bpt/emacs.git] / lisp / vc-git.el
CommitLineData
fff4a046
DN
1;;; vc-git.el --- VC backend for the git version control system
2
3;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.
4
5;; Author: Alexandre Julliard
6;; Keywords: tools
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
12;; the Free Software Foundation; either version 2, or (at your option)
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23;; Boston, MA 02110-1301, USA.
24
25;;; Commentary:
26
27;; This file contains a VC backend for the git version control
28;; system.
29;;
30
31;;; Installation:
32
33;; To install: put this file on the load-path and add GIT to the list
34;; of supported backends in `vc-handled-backends'; the following line,
35;; placed in your ~/.emacs, will accomplish this:
36;;
37;; (add-to-list 'vc-handled-backends 'GIT)
38
39;;; Todo:
53cc90ab
DN
40;; - !!!port to the new VC interface with multiple file arguments!!!
41;; - check if more functions could use vc-git-command instead
42;; of start-process.
fff4a046
DN
43;; - changelog generation
44;; - working with revisions other than HEAD
53cc90ab
DN
45
46;; Implement the rest of the vc interface. See the comment at the
47;; beginning of vc.el. The current status is:
fff4a046 48;;
53cc90ab
DN
49;; FUNCTION NAME STATUS
50;; BACKEND PROPERTIES
51;; * revision-granularity OK
52;; STATE-QUERYING FUNCTIONS
53;; * registered (file) OK
54;; * state (file) OK
55;; - state-heuristic (file) ?? PROBABLY NOT NEEDED
56;; - dir-state (dir) OK
57;; * workfile-version (file) OK
58;; - latest-on-branch-p (file) ??
59;; * checkout-model (file) OK
60;; - workfile-unchanged-p (file) MAYBE CAN BE SIMPLIFIED
61;; - mode-line-string (file) NOT NEEDED
62;; - dired-state-info (file) OK
63;; STATE-CHANGING FUNCTIONS
64;; * create-repo () OK
65;; * register (files &optional rev comment) PORT TO NEW VC INTERFACE
66;; - init-version (file) ??
67;; - responsible-p (file) OK
68;; - could-register (file) NEEDED
69;; - receive-file (file rev) ??
70;; - unregister (file) NEEDED
71;; * checkin (files rev comment) PORT TO NEW VC INTERFACE
72;; * find-version (file rev buffer) NEEDED!
73;; * checkout (file &optional editable rev) OK
74;; * revert (file &optional contents-done) OK
75;; - rollback (files) NEEDED
76;; - merge (file rev1 rev2) NEEDED
77;; - merge-news (file) NEEDED
78;; - steal-lock (file &optional version) NOT NEEDED
79;; HISTORY FUNCTIONS
80;; * print-log (files &optional buffer) PORT TO NEW VC INTERFACE
81;; - log-view-mode () OK
82;; - show-log-entry (version) NOT NEEDED, DEFAULT IS GOOD
83;; - wash-log (file) ??
84;; - logentry-check () ??
85;; - comment-history (file) ??
86;; - update-changelog (files) ??
87;; * diff (file &optional rev1 rev2 buffer) PORT TO NEW VC INTERFACE
88;; - revision-completion-table (file) NEEDED?
89;; - diff-tree (dir &optional rev1 rev2) NEEDED
90;; - annotate-command (file buf &optional rev) OK
91;; - annotate-time () OK
92;; - annotate-current-time () ?? NOT NEEDED
93;; - annotate-extract-revision-at-line () OK
94;; SNAPSHOT SYSTEM
95;; - create-snapshot (dir name branchp) NEEDED
96;; - assign-name (file name) NOT NEEDED
97;; - retrieve-snapshot (dir name update) NEEDED
98;; MISCELLANEOUS
99;; - make-version-backups-p (file) ??
100;; - repository-hostname (dirname) ??
101;; - previous-version (file rev) ??
102;; - next-version (file rev) ??
103;; - check-headers () ??
104;; - clear-headers () ??
105;; - delete-file (file) NEEDED
106;; - rename-file (old new) NEEDED
107;; - find-file-hook () PROBABLY NOT NEEDED
108;; - find-file-not-found-hook () PROBABLY NOT NEEDED
fff4a046
DN
109
110(eval-when-compile (require 'cl))
111
112(defvar git-commits-coding-system 'utf-8
113 "Default coding system for git commits.")
114
53cc90ab
DN
115;; XXX when this backend is considered sufficiently reliable this
116;; should be moved to vc-hooks.el
117(add-to-list 'vc-handled-backends 'GIT)
118
119;;; BACKEND PROPERTIES
120
121(defun vc-git-revision-granularity ()
122 'repository)
123
124;;; STATE-QUERYING FUNCTIONS
125
126;;;###autoload (defun vc-git-registered (file)
127;;;###autoload "Return non-nil if FILE is registered with git."
128;;;###autoload (if (vc-find-root file ".git") ; short cut
129;;;###autoload (progn
130;;;###autoload (load "vc-git")
131;;;###autoload (vc-git-registered file))))
132
fff4a046
DN
133(defun vc-git-registered (file)
134 "Check whether FILE is registered with git."
53cc90ab
DN
135 (when (vc-git-root file)
136 (with-temp-buffer
137 (let* ((dir (file-name-directory file))
138 (name (file-relative-name file dir)))
139 (and (ignore-errors
140 (when dir (cd dir))
141 (eq 0 (call-process "git" nil '(t nil) nil "ls-files" "-c" "-z" "--" name)))
142 (let ((str (buffer-string)))
143 (and (> (length str) (length name))
144 (string= (substring str 0 (1+ (length name))) (concat name "\0")))))))))
145
fff4a046 146(defun vc-git-state (file)
53cc90ab 147 "Git-specific version of `vc-state'."
fff4a046
DN
148 (let ((diff (vc-git--run-command-string file "diff-index" "-z" "HEAD" "--")))
149 (if (and diff (string-match ":[0-7]\\{6\\} [0-7]\\{6\\} [0-9a-f]\\{40\\} [0-9a-f]\\{40\\} [ADMU]\0[^\0]+\0" diff))
150 'edited
151 'up-to-date)))
152
53cc90ab
DN
153(defun vc-git-dir-state (dir)
154 (with-temp-buffer
155 (vc-git-command (current-buffer) nil nil "ls-files" "-t")
156 (goto-char (point-min))
157 (let ((status-char nil)
158 (file nil))
159 (while (not (eobp))
160 (setq status-char (char-after))
161 (setq file
162 (expand-file-name
163 (buffer-substring-no-properties (+ (point) 2) (line-end-position))))
164 (cond
165 ;; The rest of the possible states in "git ls-files -t" output:
166 ;; R removed/deleted
167 ;; K to be killed
168 ;; should not show up in vc-dired, so don't deal with them
169 ;; here.
170 ((eq status-char ?H)
171 (vc-file-setprop file 'vc-state 'up-to-date))
172 ((eq status-char ?M)
173 (vc-file-setprop file 'vc-state 'edited))
174 ((eq status-char ?C)
175 (vc-file-setprop file 'vc-state 'edited))
176 ((eq status-char ??)
177 (vc-file-setprop file 'vc-backend 'none)
178 (vc-file-setprop file 'vc-state 'nil)))
179 (forward-line)))))
180
fff4a046 181(defun vc-git-workfile-version (file)
53cc90ab 182 "Git-specific version of `vc-workfile-version'."
fff4a046
DN
183 (let ((str (with-output-to-string
184 (with-current-buffer standard-output
185 (call-process "git" nil '(t nil) nil "symbolic-ref" "HEAD")))))
186 (if (string-match "^\\(refs/heads/\\)?\\(.+\\)$" str)
187 (match-string 2 str)
188 str)))
189
190(defun vc-git-checkout-model (file)
191 'implicit)
192
53cc90ab 193;; XXX Can't this just use the result of vc-git-state?
fff4a046
DN
194(defun vc-git-workfile-unchanged-p (file)
195 (let ((sha1 (vc-git--run-command-string file "hash-object" "--"))
196 (head (vc-git--run-command-string file "ls-tree" "-z" "HEAD" "--")))
197 (and head
198 (string-match "[0-7]\\{6\\} blob \\([0-9a-f]\\{40\\}\\)\t[^\0]+\0" head)
199 (string= (car (split-string sha1 "\n")) (match-string 1 head)))))
200
53cc90ab
DN
201(defun vc-git-dired-state-info (file)
202 "Git-specific version of `vc-dired-state-info'."
203 (let ((git-state (vc-state file)))
204 (if (eq git-state 'edited)
205 "(modified)"
206 ;; fall back to the default VC representation
207 (vc-default-dired-state-info 'GIT file))))
208
209;;; STATE-CHANGING FUNCTIONS
210
211(defun vc-git-create-repo ()
212 "Create a new GIT repository."
213 (vc-git-command "init" nil 0 nil))
214
fff4a046
DN
215(defun vc-git-register (file &optional rev comment)
216 "Register FILE into the git version-control system."
217 (vc-git--run-command file "update-index" "--add" "--"))
218
53cc90ab
DN
219(defalias 'vc-git-responsible-p 'vc-git-root)
220
fff4a046
DN
221(defun vc-git-checkin (file rev comment)
222 (let ((coding-system-for-write git-commits-coding-system))
223 (vc-git--run-command file "commit" "-m" comment "--only" "--")))
224
225(defun vc-git-checkout (file &optional editable rev destfile)
226 (if destfile
227 (let ((fullname (substring
228 (vc-git--run-command-string file "ls-files" "-z" "--full-name" "--")
229 0 -1))
230 (coding-system-for-read 'no-conversion)
231 (coding-system-for-write 'no-conversion))
232 (with-temp-file destfile
233 (eq 0 (call-process "git" nil t nil "cat-file" "blob"
234 (concat (or rev "HEAD") ":" fullname)))))
235 (vc-git--run-command file "checkout" (or rev "HEAD"))))
236
237(defun vc-git-revert (file &optional contents-done)
238 "Revert FILE to the version stored in the git repository."
239 (if contents-done
240 (vc-git--run-command file "update-index" "--")
241 (vc-git--run-command file "checkout" "HEAD")))
242
53cc90ab
DN
243;;; HISTORY FUNCTIONS
244
fff4a046
DN
245(defun vc-git-print-log (file &optional buffer)
246 (let ((name (file-relative-name file))
247 (coding-system-for-read git-commits-coding-system))
53cc90ab
DN
248 ;; `log-view-mode' needs to have the file name in order to function
249 ;; correctly. "git log" does not print it, so we insert it here by
250 ;; hand.
251
252 ;; `vc-do-command' creates the buffer, but we need it before running
253 ;; the command.
254 (vc-setup-buffer buffer)
255 ;; If the buffer exists from a previous invocation it might be
256 ;; read-only.
257 (let ((inhibit-read-only t))
258 (with-current-buffer
259 buffer
260 (insert "File: " (file-name-nondirectory file) "\n")))
261 (vc-git-command buffer 'async name "rev-list" "--pretty" "HEAD" "--")))
262
263(defvar log-view-message-re)
264(defvar log-view-file-re)
265(defvar log-view-font-lock-keywords)
266
267(define-derived-mode vc-git-log-view-mode log-view-mode "GIT-Log-View"
268 (require 'add-log) ;; we need the faces add-log
269 ;; Don't have file markers, so use impossible regexp.
270 (set (make-local-variable 'log-view-file-re) "^File:[ \t]+\\(.+\\)")
271 (set (make-local-variable 'log-view-message-re)
272 "^commit *\\([0-9a-z]+\\)")
273 (set (make-local-variable 'log-view-font-lock-keywords)
274 (append
275 `((,log-view-message-re (1 'change-log-acknowledgement))
276 (,log-view-file-re (1 'change-log-file-face)))
277 ;; Handle the case:
278 ;; user: foo@bar
279 '(("^Author:[ \t]+\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
280 (1 'change-log-email))
281 ;; Handle the case:
282 ;; user: FirstName LastName <foo@bar>
283 ("^Author:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
284 (1 'change-log-name)
285 (2 'change-log-email))
286 ("^Date: \\(.+\\)" (1 'change-log-date))
287 ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message))))))
fff4a046
DN
288
289(defun vc-git-diff (file &optional rev1 rev2 buffer)
290 (let ((name (file-relative-name file))
291 (buf (or buffer "*vc-diff*")))
292 (if (and rev1 rev2)
53cc90ab
DN
293 (vc-git-command buf 0 name "diff-tree" "-p" rev1 rev2 "--")
294 (vc-git-command buf 0 name "diff-index" "-p" (or rev1 "HEAD") "--"))
295 ;; git-diff-index doesn't set exit status like diff does
fff4a046
DN
296 (if (vc-git-workfile-unchanged-p file) 0 1)))
297
298(defun vc-git-annotate-command (file buf &optional rev)
53cc90ab 299 ;; FIXME: rev is ignored
fff4a046 300 (let ((name (file-relative-name file)))
53cc90ab 301 (vc-git-command buf 0 name "blame" (if rev (concat "-r" rev)))))
fff4a046
DN
302
303(defun vc-git-annotate-time ()
304 (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)
305 (vc-annotate-convert-time
306 (apply #'encode-time (mapcar (lambda (match) (string-to-number (match-string match))) '(6 5 4 3 2 1 7))))))
307
53cc90ab
DN
308(defun vc-git-annotate-extract-revision-at-line ()
309 (save-excursion
310 (move-beginning-of-line 1)
311 (and (looking-at "[0-9a-f]+")
312 (buffer-substring-no-properties (match-beginning 0) (match-end 0)))))
313
314;;; MISCELLANEOUS
fff4a046
DN
315
316(defun vc-git-previous-version (file rev)
53cc90ab 317 "Git-specific version of `vc-previous-version'."
fff4a046
DN
318 (let ((default-directory (file-name-directory (expand-file-name file)))
319 (file (file-name-nondirectory file)))
320 (vc-git-symbolic-commit
321 (with-temp-buffer
322 (and
323 (zerop
324 (call-process "git" nil '(t nil) nil "rev-list"
325 "-2" rev "--" file))
326 (goto-char (point-max))
327 (bolp)
328 (zerop (forward-line -1))
329 (not (bobp))
330 (buffer-substring-no-properties
331 (point)
332 (1- (point-max))))))))
333
334(defun vc-git-next-version (file rev)
53cc90ab 335 "Git-specific version of `vc-next-version'."
fff4a046
DN
336 (let* ((default-directory (file-name-directory
337 (expand-file-name file)))
338 (file (file-name-nondirectory file))
339 (current-rev
340 (with-temp-buffer
341 (and
342 (zerop
343 (call-process "git" nil '(t nil) nil "rev-list"
344 "-1" rev "--" file))
345 (goto-char (point-max))
346 (bolp)
347 (zerop (forward-line -1))
348 (bobp)
349 (buffer-substring-no-properties
350 (point)
351 (1- (point-max)))))))
352 (and current-rev
353 (vc-git-symbolic-commit
354 (with-temp-buffer
355 (and
356 (zerop
357 (call-process "git" nil '(t nil) nil "rev-list"
358 "HEAD" "--" file))
359 (goto-char (point-min))
360 (search-forward current-rev nil t)
361 (zerop (forward-line -1))
362 (buffer-substring-no-properties
363 (point)
364 (progn (forward-line 1) (1- (point))))))))))
365
366\f
367;; Internal commands
368
53cc90ab
DN
369(defun vc-git-root (file)
370 (vc-find-root file ".git"))
371
372(defun vc-git-command (buffer okstatus file &rest flags)
373 "A wrapper around `vc-do-command' for use in vc-git.el.
374The difference to vc-do-command is that this function always invokes `git'."
375 (apply 'vc-do-command buffer okstatus "git" file flags))
376
fff4a046
DN
377(defun vc-git--run-command-string (file &rest args)
378 "Run a git command on FILE and return its output as string."
379 (let* ((ok t)
380 (str (with-output-to-string
381 (with-current-buffer standard-output
382 (unless (eq 0 (apply #'call-process "git" nil '(t nil) nil
383 (append args (list (file-relative-name file)))))
384 (setq ok nil))))))
385 (and ok str)))
386
387(defun vc-git--run-command (file &rest args)
388 "Run a git command on FILE, discarding any output."
389 (let ((name (file-relative-name file)))
390 (eq 0 (apply #'call-process "git" nil (get-buffer "*Messages") nil (append args (list name))))))
391
392(defun vc-git-symbolic-commit (commit)
393 "Translate COMMIT string into symbolic form.
394Returns nil if not possible."
395 (and commit
396 (with-temp-buffer
397 (and
398 (zerop
399 (call-process "git" nil '(t nil) nil "name-rev"
400 "--name-only" "--tags"
401 commit))
402 (goto-char (point-min))
403 (= (forward-line 2) 1)
404 (bolp)
405 (buffer-substring-no-properties (point-min) (1- (point-max)))))))
406
407(provide 'vc-git)
53cc90ab
DN
408
409;;; vc-git.el ends here