Commit | Line | Data |
---|---|---|
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 | ;; - check if more functions could use vc-git-command instead |
41 | ;; of start-process. | |
fff4a046 DN |
42 | ;; - changelog generation |
43 | ;; - working with revisions other than HEAD | |
53cc90ab DN |
44 | |
45 | ;; Implement the rest of the vc interface. See the comment at the | |
46 | ;; beginning of vc.el. The current status is: | |
fff4a046 | 47 | ;; |
53cc90ab DN |
48 | ;; FUNCTION NAME STATUS |
49 | ;; BACKEND PROPERTIES | |
50 | ;; * revision-granularity OK | |
51 | ;; STATE-QUERYING FUNCTIONS | |
52 | ;; * registered (file) OK | |
53 | ;; * state (file) OK | |
54 | ;; - state-heuristic (file) ?? PROBABLY NOT NEEDED | |
55 | ;; - dir-state (dir) OK | |
56 | ;; * workfile-version (file) OK | |
57 | ;; - latest-on-branch-p (file) ?? | |
58 | ;; * checkout-model (file) OK | |
59 | ;; - workfile-unchanged-p (file) MAYBE CAN BE SIMPLIFIED | |
60 | ;; - mode-line-string (file) NOT NEEDED | |
61 | ;; - dired-state-info (file) OK | |
62 | ;; STATE-CHANGING FUNCTIONS | |
63 | ;; * create-repo () OK | |
64 | ;; * register (files &optional rev comment) PORT TO NEW VC INTERFACE | |
65 | ;; - init-version (file) ?? | |
66 | ;; - responsible-p (file) OK | |
67 | ;; - could-register (file) NEEDED | |
68 | ;; - receive-file (file rev) ?? | |
69 | ;; - unregister (file) NEEDED | |
70 | ;; * checkin (files rev comment) PORT TO NEW VC INTERFACE | |
71 | ;; * find-version (file rev buffer) NEEDED! | |
72 | ;; * checkout (file &optional editable rev) OK | |
73 | ;; * revert (file &optional contents-done) OK | |
74 | ;; - rollback (files) NEEDED | |
75 | ;; - merge (file rev1 rev2) NEEDED | |
76 | ;; - merge-news (file) NEEDED | |
77 | ;; - steal-lock (file &optional version) NOT NEEDED | |
78 | ;; HISTORY FUNCTIONS | |
79 | ;; * print-log (files &optional buffer) PORT TO NEW VC INTERFACE | |
80 | ;; - log-view-mode () OK | |
81 | ;; - show-log-entry (version) NOT NEEDED, DEFAULT IS GOOD | |
82 | ;; - wash-log (file) ?? | |
83 | ;; - logentry-check () ?? | |
84 | ;; - comment-history (file) ?? | |
85 | ;; - update-changelog (files) ?? | |
86 | ;; * diff (file &optional rev1 rev2 buffer) PORT TO NEW VC INTERFACE | |
87 | ;; - revision-completion-table (file) NEEDED? | |
88 | ;; - diff-tree (dir &optional rev1 rev2) NEEDED | |
89 | ;; - annotate-command (file buf &optional rev) OK | |
90 | ;; - annotate-time () OK | |
91 | ;; - annotate-current-time () ?? NOT NEEDED | |
92 | ;; - annotate-extract-revision-at-line () OK | |
93 | ;; SNAPSHOT SYSTEM | |
94 | ;; - create-snapshot (dir name branchp) NEEDED | |
95 | ;; - assign-name (file name) NOT NEEDED | |
96 | ;; - retrieve-snapshot (dir name update) NEEDED | |
97 | ;; MISCELLANEOUS | |
98 | ;; - make-version-backups-p (file) ?? | |
99 | ;; - repository-hostname (dirname) ?? | |
100 | ;; - previous-version (file rev) ?? | |
101 | ;; - next-version (file rev) ?? | |
102 | ;; - check-headers () ?? | |
103 | ;; - clear-headers () ?? | |
104 | ;; - delete-file (file) NEEDED | |
105 | ;; - rename-file (old new) NEEDED | |
106 | ;; - find-file-hook () PROBABLY NOT NEEDED | |
107 | ;; - find-file-not-found-hook () PROBABLY NOT NEEDED | |
fff4a046 DN |
108 | |
109 | (eval-when-compile (require 'cl)) | |
110 | ||
111 | (defvar git-commits-coding-system 'utf-8 | |
112 | "Default coding system for git commits.") | |
113 | ||
53cc90ab DN |
114 | ;; XXX when this backend is considered sufficiently reliable this |
115 | ;; should be moved to vc-hooks.el | |
116 | (add-to-list 'vc-handled-backends 'GIT) | |
8b9783e0 | 117 | (add-to-list 'vc-directory-exclusion-list ".git" t) |
53cc90ab DN |
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 | ||
8b9783e0 | 215 | (defun vc-git-register (files &optional rev comment) |
fff4a046 | 216 | "Register FILE into the git version-control system." |
8b9783e0 | 217 | (vc-git-command nil 0 files "update-index" "--add" "--")) |
fff4a046 | 218 | |
53cc90ab DN |
219 | (defalias 'vc-git-responsible-p 'vc-git-root) |
220 | ||
8b9783e0 | 221 | (defun vc-git-checkin (files rev comment) |
fff4a046 | 222 | (let ((coding-system-for-write git-commits-coding-system)) |
8b9783e0 | 223 | (vc-git-command nil 0 files "commit" "-m" comment "--only" "--"))) |
fff4a046 DN |
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 | ||
8b9783e0 DN |
245 | (defun vc-git-print-log (files &optional buffer) |
246 | "Get change log associated with FILES." | |
fff4a046 DN |
247 | (let ((name (file-relative-name file)) |
248 | (coding-system-for-read git-commits-coding-system)) | |
53cc90ab DN |
249 | ;; `log-view-mode' needs to have the file name in order to function |
250 | ;; correctly. "git log" does not print it, so we insert it here by | |
251 | ;; hand. | |
252 | ||
253 | ;; `vc-do-command' creates the buffer, but we need it before running | |
254 | ;; the command. | |
255 | (vc-setup-buffer buffer) | |
256 | ;; If the buffer exists from a previous invocation it might be | |
257 | ;; read-only. | |
258 | (let ((inhibit-read-only t)) | |
8b9783e0 DN |
259 | ;; XXX Here loop and call "git rev-list" on each file separately |
260 | ;; to make sure that each file gets a "File:" header before the | |
261 | ;; corresponding log. Maybe there is a way to do this with one | |
262 | ;; command... | |
263 | (dolist (file files) | |
53cc90ab DN |
264 | (with-current-buffer |
265 | buffer | |
266 | (insert "File: " (file-name-nondirectory file) "\n"))) | |
8b9783e0 | 267 | (vc-git-command buffer 'async name "rev-list" "--pretty" "HEAD" "--")))) |
53cc90ab DN |
268 | |
269 | (defvar log-view-message-re) | |
270 | (defvar log-view-file-re) | |
271 | (defvar log-view-font-lock-keywords) | |
272 | ||
273 | (define-derived-mode vc-git-log-view-mode log-view-mode "GIT-Log-View" | |
274 | (require 'add-log) ;; we need the faces add-log | |
275 | ;; Don't have file markers, so use impossible regexp. | |
276 | (set (make-local-variable 'log-view-file-re) "^File:[ \t]+\\(.+\\)") | |
277 | (set (make-local-variable 'log-view-message-re) | |
278 | "^commit *\\([0-9a-z]+\\)") | |
279 | (set (make-local-variable 'log-view-font-lock-keywords) | |
280 | (append | |
281 | `((,log-view-message-re (1 'change-log-acknowledgement)) | |
282 | (,log-view-file-re (1 'change-log-file-face))) | |
283 | ;; Handle the case: | |
284 | ;; user: foo@bar | |
285 | '(("^Author:[ \t]+\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)" | |
286 | (1 'change-log-email)) | |
287 | ;; Handle the case: | |
288 | ;; user: FirstName LastName <foo@bar> | |
289 | ("^Author:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]" | |
290 | (1 'change-log-name) | |
291 | (2 'change-log-email)) | |
292 | ("^Date: \\(.+\\)" (1 'change-log-date)) | |
293 | ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message)))))) | |
fff4a046 DN |
294 | |
295 | (defun vc-git-diff (file &optional rev1 rev2 buffer) | |
296 | (let ((name (file-relative-name file)) | |
297 | (buf (or buffer "*vc-diff*"))) | |
298 | (if (and rev1 rev2) | |
53cc90ab DN |
299 | (vc-git-command buf 0 name "diff-tree" "-p" rev1 rev2 "--") |
300 | (vc-git-command buf 0 name "diff-index" "-p" (or rev1 "HEAD") "--")) | |
301 | ;; git-diff-index doesn't set exit status like diff does | |
fff4a046 DN |
302 | (if (vc-git-workfile-unchanged-p file) 0 1))) |
303 | ||
304 | (defun vc-git-annotate-command (file buf &optional rev) | |
53cc90ab | 305 | ;; FIXME: rev is ignored |
fff4a046 | 306 | (let ((name (file-relative-name file))) |
53cc90ab | 307 | (vc-git-command buf 0 name "blame" (if rev (concat "-r" rev))))) |
fff4a046 DN |
308 | |
309 | (defun vc-git-annotate-time () | |
310 | (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) | |
311 | (vc-annotate-convert-time | |
312 | (apply #'encode-time (mapcar (lambda (match) (string-to-number (match-string match))) '(6 5 4 3 2 1 7)))))) | |
313 | ||
53cc90ab DN |
314 | (defun vc-git-annotate-extract-revision-at-line () |
315 | (save-excursion | |
316 | (move-beginning-of-line 1) | |
317 | (and (looking-at "[0-9a-f]+") | |
318 | (buffer-substring-no-properties (match-beginning 0) (match-end 0))))) | |
319 | ||
320 | ;;; MISCELLANEOUS | |
fff4a046 DN |
321 | |
322 | (defun vc-git-previous-version (file rev) | |
53cc90ab | 323 | "Git-specific version of `vc-previous-version'." |
fff4a046 DN |
324 | (let ((default-directory (file-name-directory (expand-file-name file))) |
325 | (file (file-name-nondirectory file))) | |
326 | (vc-git-symbolic-commit | |
327 | (with-temp-buffer | |
328 | (and | |
329 | (zerop | |
330 | (call-process "git" nil '(t nil) nil "rev-list" | |
331 | "-2" rev "--" file)) | |
332 | (goto-char (point-max)) | |
333 | (bolp) | |
334 | (zerop (forward-line -1)) | |
335 | (not (bobp)) | |
336 | (buffer-substring-no-properties | |
337 | (point) | |
338 | (1- (point-max)))))))) | |
339 | ||
340 | (defun vc-git-next-version (file rev) | |
53cc90ab | 341 | "Git-specific version of `vc-next-version'." |
fff4a046 DN |
342 | (let* ((default-directory (file-name-directory |
343 | (expand-file-name file))) | |
344 | (file (file-name-nondirectory file)) | |
345 | (current-rev | |
346 | (with-temp-buffer | |
347 | (and | |
348 | (zerop | |
349 | (call-process "git" nil '(t nil) nil "rev-list" | |
350 | "-1" rev "--" file)) | |
351 | (goto-char (point-max)) | |
352 | (bolp) | |
353 | (zerop (forward-line -1)) | |
354 | (bobp) | |
355 | (buffer-substring-no-properties | |
356 | (point) | |
357 | (1- (point-max))))))) | |
358 | (and current-rev | |
359 | (vc-git-symbolic-commit | |
360 | (with-temp-buffer | |
361 | (and | |
362 | (zerop | |
363 | (call-process "git" nil '(t nil) nil "rev-list" | |
364 | "HEAD" "--" file)) | |
365 | (goto-char (point-min)) | |
366 | (search-forward current-rev nil t) | |
367 | (zerop (forward-line -1)) | |
368 | (buffer-substring-no-properties | |
369 | (point) | |
370 | (progn (forward-line 1) (1- (point)))))))))) | |
371 | ||
372 | \f | |
373 | ;; Internal commands | |
374 | ||
53cc90ab DN |
375 | (defun vc-git-root (file) |
376 | (vc-find-root file ".git")) | |
377 | ||
8b9783e0 | 378 | (defun vc-git-command (buffer okstatus file-or-list &rest flags) |
53cc90ab DN |
379 | "A wrapper around `vc-do-command' for use in vc-git.el. |
380 | The difference to vc-do-command is that this function always invokes `git'." | |
8b9783e0 | 381 | (apply 'vc-do-command buffer okstatus "git" file-or-list flags)) |
53cc90ab | 382 | |
fff4a046 DN |
383 | (defun vc-git--run-command-string (file &rest args) |
384 | "Run a git command on FILE and return its output as string." | |
385 | (let* ((ok t) | |
386 | (str (with-output-to-string | |
387 | (with-current-buffer standard-output | |
388 | (unless (eq 0 (apply #'call-process "git" nil '(t nil) nil | |
389 | (append args (list (file-relative-name file))))) | |
390 | (setq ok nil)))))) | |
391 | (and ok str))) | |
392 | ||
393 | (defun vc-git--run-command (file &rest args) | |
394 | "Run a git command on FILE, discarding any output." | |
395 | (let ((name (file-relative-name file))) | |
396 | (eq 0 (apply #'call-process "git" nil (get-buffer "*Messages") nil (append args (list name)))))) | |
397 | ||
398 | (defun vc-git-symbolic-commit (commit) | |
399 | "Translate COMMIT string into symbolic form. | |
400 | Returns nil if not possible." | |
401 | (and commit | |
402 | (with-temp-buffer | |
403 | (and | |
404 | (zerop | |
405 | (call-process "git" nil '(t nil) nil "name-rev" | |
406 | "--name-only" "--tags" | |
407 | commit)) | |
408 | (goto-char (point-min)) | |
409 | (= (forward-line 2) 1) | |
410 | (bolp) | |
411 | (buffer-substring-no-properties (point-min) (1- (point-max))))))) | |
412 | ||
413 | (provide 'vc-git) | |
53cc90ab DN |
414 | |
415 | ;;; vc-git.el ends here |